Sophie

Sophie

distrib > Mandriva > 2010.0 > i586 > by-pkgid > 052d79447130ebaf90b2730395954d11 > files > 974

openvrml-doc-0.18.3-1mdv2010.0.i586.rpm

<!doctype html public "-//W3C//DTD HTML 4.01 Transitional//EN"
               "http://www.w3.org/TR/html4/loose.dtd">

<html>
<head>
<title>OpenVRML: openvrml::color Struct Reference</title>
<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<link rel="icon" href="../vrml-16">
<link rel="start" href="http://openvrml.org/index" title="OpenVRML Home">
<link rel="prev" href="http://openvrml.org/discussion" title="Discussion">
<link rel="contents" href="index" title="Documentation Main Page">
<link rel="index" href="functions" title="OpenVRML Compound Members">
<link rel="appendix" href="conformance" title="Conformance Test Results">
<style type="text/css">
@import url("tabs.css");
@import url("http://openvrml.org/openvrml.css");

table {
  width: 100%;
}

h2 {
  border-bottom-style: solid;
  border-bottom-width: 1px;
}

/*
 * Doxygen as of 1.5.4-20071217 uses the class "navpath" instead of "nav".
 * For now, we'll do both.
 */

div.nav,
div.navpath {
  background-color: transparent;
  text-align: left;
  margin-top: 1em;
  margin-bottom: 1em;
  border-color: black;
  border-left: none;
  border-right: none;
  padding-top: 0.5em;
  padding-bottom: 0.5em;
}

div.nav :link, div.nav :visited,
div.navpath :link, div.navpath :visited {
  border-width: 1px;
  border-style: solid;
  border-color: silver;
  padding: 2px;
}

div.nav :link:hover, div.nav :visited:hover,
div.navpath :link:hover, div.navpath :visited:hover {
  border-style: outset;
  border-color: gray;
}

div.nav :active,
div.navpath :active {
  border-style: inset;
  border-color: gray;
}

.body td {
  background-color: transparent;
}

.el {
  text-decoration: inherit;
  font-weight: inherit
}
.elRef {
  font-weight: inherit
}
.code:link, .code:visited {
  text-decoration: inherit;
  font-weight: inherit;
  color: inherit;
}
.codeRef:link {
  font-weight: normal;
  color: inherit;
}
:visited {
  color: silver;
}
:link:hover {
  color: inherit;
  text-decoration: inherit;
  background-color: transparent;
}

h1 {
  line-height: 1.2em;
}

td.memItemLeft, td.memItemRight,
td.memTemplParams, td.memTemplItemLeft, td.memTemplItemRight,
.memtemplate, .memname td {
  font-family: Consolas, "DejaVu Sans Mono", "Bitstream Vera Sans Mono", "Lucida Console", LucidaTypewriter, monospace;
}

td.memItemLeft, td.memItemRight, td.mdescLeft, td.mdescRight {
  background-color: rgb(95%, 95%, 95%);
  border-color: rgb(65%, 65%, 65%);
  border-width: 1px;
  font-size: smaller;
}

.memItemLeft {
  margin-top: 0.5em;
  border-top-style: solid;
}
.mdescLeft {
  border-bottom-style: solid;
}
.memItemRight {
  border-top-style: solid;
  margin-top: 0.5em;
}
.mdescRight {
  border-bottom-style: solid;
}

.mdescRight {
  font-style: italic;
}

.mdTable {
  background-color: rgb(95%, 95%, 95%);
}

.memproto td code {
  font-family: inherit;
  font-style: italic;
}

td.pass {
  background-color: rgb(50%, 100%, 50%);
}

td.fail {
  background-color: rgb(100%, 50%, 50%);
}

td.invalid {
  background-color: rgb(75%, 75%, 75%);
}

.memitem {
  padding: 0;
}

.memitem table {
  width: auto;
}

.memproto, .memdoc {
  border-width: 1px;
  border-color: rgb(65%, 65%, 65%);
}

.memproto {
  background-color: rgb(90%, 90%, 90%);
  font-weight: inherit;
  font-size: smaller;
  border-top-style: solid;
  border-left-style: solid;
  border-right-style: solid;
  -webkit-border-top-left-radius: 0.6em;
  -webkit-border-top-right-radius: 0.6em;
  -moz-border-radius-topleft: 0.6em;
  -moz-border-radius-topright: 0.6em;
}

.memdoc {
  background-color: rgb(95%, 95%, 95%);
  padding: 2px 5px;
  border-style: solid;
  -webkit-border-bottom-left-radius: 0.6em;
  -webkit-border-bottom-right-radius: 0.6em;
  -moz-border-radius-bottomleft: 0.6em;
  -moz-border-radius-bottomright: 0.6em;
}

.memname {
  font-weight: inherit;
}

div.tabs {
  background-image: url("tab_b-openvrml.png");
}

div.tabs span {
  background-image: url("tab_l-openvrml.png");
}

div.tabs a {
  background-image: url("tab_r-openvrml.png");
  border-bottom: 1px solid #a5a5a5;
}

div.tabs a:link, div.tabs a:visited, div.tabs a:active, div.tabs a:hover {
  color: black;
}

table {
  border-collapse: collapse;
  border-spacing: 0;
}

.note {
  border: 1px solid rgb(65%, 65%, 65%);
  background-color: rgb(95%, 95%, 95%);
  margin-left: 10%;
  margin-right: 10%;
}
</style>
</head>
<body>
<table class="sitenav">
  <tr>
    <th><a href="http://openvrml.org/index" title="Home">Home</a></th>
    <th><a href="http://openvrml.org/download" title="Download">Download</a></th>
    <th><a href="http://openvrml.org/screenshots/index" title="Screen shots">Screen shots</a></th>
    <th><a href="http://openvrml.org/discussion" title="Mailing lists and IRC">Discussion</a></th>
    <th>Documentation</th>
  </tr>
</table>
<div class="body">
<!-- Generated by Doxygen 1.5.8 -->
<div class="navigation" id="top">
  <div class="tabs">
    <ul>
      <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
      <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
      <li><a href="namespaces.html"><span>Namespaces</span></a></li>
      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
      <li><a href="files.html"><span>Files</span></a></li>
      <li><a href="examples.html"><span>Examples</span></a></li>
    </ul>
  </div>
  <div class="tabs">
    <ul>
      <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
      <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
    </ul>
  </div>
  <div class="navpath"><a class="el" href="namespaceopenvrml.html">openvrml</a>::<a class="el" href="structopenvrml_1_1color.html">color</a>
  </div>
</div>
<div class="contents">
<h1>openvrml::color Struct Reference</h1><!-- doxytag: class="openvrml::color" -->A POD-struct comprising a <a class="el" href="structopenvrml_1_1color.html" title="A POD-struct comprising a color.">color</a>.  
<a href="#_details">More...</a>
<p>
<code>#include &lt;openvrml/basetypes.h&gt;</code>
<p>

<p>
<a href="structopenvrml_1_1color-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const float &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structopenvrml_1_1color.html#f49b5e3990238c50ef8a26bd7e1f0200">operator[]</a> (std::size_t index) const   throw ()</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Index-based component access.  <a href="#f49b5e3990238c50ef8a26bd7e1f0200"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">float&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structopenvrml_1_1color.html#68bfc8fa05eba536f5f02a365ece4e1e">r</a> () const   throw ()</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the red component.  <a href="#68bfc8fa05eba536f5f02a365ece4e1e"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">float&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structopenvrml_1_1color.html#5f9168954cdbaf6143035dfb91bb42d8">g</a> () const   throw ()</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the green component.  <a href="#5f9168954cdbaf6143035dfb91bb42d8"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">float&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structopenvrml_1_1color.html#bb465bec9b8b1101d18b4ce768c12200">b</a> () const   throw ()</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the blue component.  <a href="#bb465bec9b8b1101d18b4ce768c12200"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structopenvrml_1_1color.html#2efb024aff122dd8ad102eacfa282ad3">r</a> (float value)  throw ()</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set the red component.  <a href="#2efb024aff122dd8ad102eacfa282ad3"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structopenvrml_1_1color.html#6faa9ec45c4abb23419eb28dd16da251">g</a> (float value)  throw ()</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set the green component.  <a href="#6faa9ec45c4abb23419eb28dd16da251"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structopenvrml_1_1color.html#f1c5af766aac2fcee9caf060984c3d10">b</a> (float value)  throw ()</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set the blue component.  <a href="#f1c5af766aac2fcee9caf060984c3d10"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structopenvrml_1_1color.html#da5438aad11f2ef241396291effa711d">hsv</a> (float(&amp;result)[3]) const   throw ()</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the <a class="el" href="structopenvrml_1_1color.html" title="A POD-struct comprising a color.">color</a> as hue, saturation, and value.  <a href="#da5438aad11f2ef241396291effa711d"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structopenvrml_1_1color.html#d80df2b7e07debb0aa9f6fbe27076a6c">hsv</a> (float h, float s, float v)  throw ()</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set the <a class="el" href="structopenvrml_1_1color.html" title="A POD-struct comprising a color.">color</a> from hue, saturation, and value.  <a href="#d80df2b7e07debb0aa9f6fbe27076a6c"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Public Attributes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">float&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structopenvrml_1_1color.html#b73f682d9ab412f565cdfc8d11b9f8ff">rgb</a> [3]</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">RGB triplet.  <a href="#b73f682d9ab412f565cdfc8d11b9f8ff"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Related Functions</h2></td></tr>
<tr><td colspan="2">(Note that these are not member functions.) <br><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const <a class="el" href="structopenvrml_1_1color.html">openvrml::color</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structopenvrml_1_1color.html#4d7f77fc77a424f3b3ce1ac6d2696912">make_color</a> () throw()</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Create a zero-initialized <a class="el" href="structopenvrml_1_1color.html" title="A POD-struct comprising a color.">color</a>.  <a href="#4d7f77fc77a424f3b3ce1ac6d2696912"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const <a class="el" href="structopenvrml_1_1color.html">openvrml::color</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structopenvrml_1_1color.html#4bab83ea73b85136d20e9c59f164b91e">make_color</a> (const float(&amp;<a class="el" href="structopenvrml_1_1color.html#b73f682d9ab412f565cdfc8d11b9f8ff">rgb</a>)[3]) throw()</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Create a <a class="el" href="structopenvrml_1_1color.html" title="A POD-struct comprising a color.">color</a>.  <a href="#4bab83ea73b85136d20e9c59f164b91e"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const <a class="el" href="structopenvrml_1_1color.html">openvrml::color</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structopenvrml_1_1color.html#1aea12b9e6e60eaf3c2f4ae48f671407">make_color</a> (const float r, const float g, const float b) throw()</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Create a <a class="el" href="structopenvrml_1_1color.html" title="A POD-struct comprising a color.">color</a>.  <a href="#1aea12b9e6e60eaf3c2f4ae48f671407"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structopenvrml_1_1color.html#c373a79e04ee9defdb3885f890c9cd49">operator==</a> (const <a class="el" href="structopenvrml_1_1color.html">color</a> &amp;lhs, const <a class="el" href="structopenvrml_1_1color.html">color</a> &amp;rhs) throw()</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Compare for equality.  <a href="#c373a79e04ee9defdb3885f890c9cd49"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structopenvrml_1_1color.html#86707a427052caa66747d127d9fb9adc">operator!=</a> (const <a class="el" href="structopenvrml_1_1color.html">color</a> &amp;lhs, const <a class="el" href="structopenvrml_1_1color.html">color</a> &amp;rhs) throw()</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Compare for inequality.  <a href="#86707a427052caa66747d127d9fb9adc"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">std::istream &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structopenvrml_1_1color.html#c491cf2e907c06cb5e1ca135b8174759">operator&gt;&gt;</a> (std::istream &amp;in, <a class="el" href="structopenvrml_1_1color.html">color</a> &amp;c)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Stream input.  <a href="#c491cf2e907c06cb5e1ca135b8174759"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">std::ostream &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structopenvrml_1_1color.html#47b141bac0a97692fb7a18d11aefc7b2">operator&lt;&lt;</a> (std::ostream &amp;out, const <a class="el" href="structopenvrml_1_1color.html">color</a> &amp;c)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Stream output.  <a href="#47b141bac0a97692fb7a18d11aefc7b2"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
A POD-struct comprising a <a class="el" href="structopenvrml_1_1color.html" title="A POD-struct comprising a color.">color</a>. 
<p>
VRML colors are represented as three single-precision floating point components&mdash;red, green, and blue&mdash;ranging from 0.0 to 1.0. <hr><h2>Member Function Documentation</h2>
<a class="anchor" name="f49b5e3990238c50ef8a26bd7e1f0200"></a><!-- doxytag: member="openvrml::color::operator[]" ref="f49b5e3990238c50ef8a26bd7e1f0200" args="(std::size_t index) const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">const float &amp; openvrml::color::operator[]           </td>
          <td>(</td>
          <td class="paramtype">std::size_t&nbsp;</td>
          <td class="paramname"> <em>index</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td> const  throw ()<code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Index-based component access. 
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"><tt>[in]</tt>&nbsp;</td><td valign="top"><em>index</em>&nbsp;</td><td>0 is the red component, 1 is the green component, and 2 is the blue component.</td></tr>
  </table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>the component corresponding to <code>index</code>. </dd></dl>

</div>
</div><p>
<a class="anchor" name="68bfc8fa05eba536f5f02a365ece4e1e"></a><!-- doxytag: member="openvrml::color::r" ref="68bfc8fa05eba536f5f02a365ece4e1e" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">float openvrml::color::r           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td> const  throw ()<code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Get the red component. 
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>the red component. </dd></dl>

</div>
</div><p>
<a class="anchor" name="5f9168954cdbaf6143035dfb91bb42d8"></a><!-- doxytag: member="openvrml::color::g" ref="5f9168954cdbaf6143035dfb91bb42d8" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">float openvrml::color::g           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td> const  throw ()<code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Get the green component. 
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>the green component. </dd></dl>

</div>
</div><p>
<a class="anchor" name="bb465bec9b8b1101d18b4ce768c12200"></a><!-- doxytag: member="openvrml::color::b" ref="bb465bec9b8b1101d18b4ce768c12200" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">float openvrml::color::b           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td> const  throw ()<code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Get the blue component. 
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>the blue component. </dd></dl>

</div>
</div><p>
<a class="anchor" name="2efb024aff122dd8ad102eacfa282ad3"></a><!-- doxytag: member="openvrml::color::r" ref="2efb024aff122dd8ad102eacfa282ad3" args="(float value)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void openvrml::color::r           </td>
          <td>(</td>
          <td class="paramtype">float&nbsp;</td>
          <td class="paramname"> <em>value</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td>  throw ()<code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Set the red component. 
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"><tt>[in]</tt>&nbsp;</td><td valign="top"><em>value</em>&nbsp;</td><td>the new component value. </td></tr>
  </table>
</dl>

</div>
</div><p>
<a class="anchor" name="6faa9ec45c4abb23419eb28dd16da251"></a><!-- doxytag: member="openvrml::color::g" ref="6faa9ec45c4abb23419eb28dd16da251" args="(float value)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void openvrml::color::g           </td>
          <td>(</td>
          <td class="paramtype">float&nbsp;</td>
          <td class="paramname"> <em>value</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td>  throw ()<code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Set the green component. 
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"><tt>[in]</tt>&nbsp;</td><td valign="top"><em>value</em>&nbsp;</td><td>the new component value. </td></tr>
  </table>
</dl>

</div>
</div><p>
<a class="anchor" name="f1c5af766aac2fcee9caf060984c3d10"></a><!-- doxytag: member="openvrml::color::b" ref="f1c5af766aac2fcee9caf060984c3d10" args="(float value)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void openvrml::color::b           </td>
          <td>(</td>
          <td class="paramtype">float&nbsp;</td>
          <td class="paramname"> <em>value</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td>  throw ()<code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Set the blue component. 
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"><tt>[in]</tt>&nbsp;</td><td valign="top"><em>value</em>&nbsp;</td><td>the new component value. </td></tr>
  </table>
</dl>

</div>
</div><p>
<a class="anchor" name="da5438aad11f2ef241396291effa711d"></a><!-- doxytag: member="openvrml::color::hsv" ref="da5438aad11f2ef241396291effa711d" args="(float(&amp;result)[3]) const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void openvrml::color::hsv           </td>
          <td>(</td>
          <td class="paramtype">float(&amp;)&nbsp;</td>
          <td class="paramname"> <em>result</em>[3]          </td>
          <td>&nbsp;)&nbsp;</td>
          <td> const  throw ()</td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Get the <a class="el" href="structopenvrml_1_1color.html" title="A POD-struct comprising a color.">color</a> as hue, saturation, and value. 
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"><tt>[out]</tt>&nbsp;</td><td valign="top"><em>result</em>&nbsp;</td><td>the hue, saturation, and value. </td></tr>
  </table>
</dl>

</div>
</div><p>
<a class="anchor" name="d80df2b7e07debb0aa9f6fbe27076a6c"></a><!-- doxytag: member="openvrml::color::hsv" ref="d80df2b7e07debb0aa9f6fbe27076a6c" args="(float h, float s, float v)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void openvrml::color::hsv           </td>
          <td>(</td>
          <td class="paramtype">float&nbsp;</td>
          <td class="paramname"> <em>h</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">float&nbsp;</td>
          <td class="paramname"> <em>s</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">float&nbsp;</td>
          <td class="paramname"> <em>v</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td>  throw ()</td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Set the <a class="el" href="structopenvrml_1_1color.html" title="A POD-struct comprising a color.">color</a> from hue, saturation, and value. 
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"><tt>[in]</tt>&nbsp;</td><td valign="top"><em>h</em>&nbsp;</td><td>hue. </td></tr>
    <tr><td valign="top"><tt>[in]</tt>&nbsp;</td><td valign="top"><em>s</em>&nbsp;</td><td>saturation. </td></tr>
    <tr><td valign="top"><tt>[in]</tt>&nbsp;</td><td valign="top"><em>v</em>&nbsp;</td><td>value. </td></tr>
  </table>
</dl>

</div>
</div><p>
<hr><h2>Friends And Related Function Documentation</h2>
<a class="anchor" name="4d7f77fc77a424f3b3ce1ac6d2696912"></a><!-- doxytag: member="openvrml::color::make_color" ref="4d7f77fc77a424f3b3ce1ac6d2696912" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">const <a class="el" href="structopenvrml_1_1color.html">openvrml::color</a> make_color           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td> throw()<code> [related]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Create a zero-initialized <a class="el" href="structopenvrml_1_1color.html" title="A POD-struct comprising a color.">color</a>. 
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>a zero-initialized <a class="el" href="structopenvrml_1_1color.html" title="A POD-struct comprising a color.">color</a>. </dd></dl>

</div>
</div><p>
<a class="anchor" name="4bab83ea73b85136d20e9c59f164b91e"></a><!-- doxytag: member="openvrml::color::make_color" ref="4bab83ea73b85136d20e9c59f164b91e" args="(const float(&amp;rgb)[3])" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">const <a class="el" href="structopenvrml_1_1color.html">openvrml::color</a> make_color           </td>
          <td>(</td>
          <td class="paramtype">const float(&amp;)&nbsp;</td>
          <td class="paramname"> <em>rgb</em>[3]          </td>
          <td>&nbsp;)&nbsp;</td>
          <td> throw()<code> [related]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Create a <a class="el" href="structopenvrml_1_1color.html" title="A POD-struct comprising a color.">color</a>. 
<p>
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. <dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"><tt>[in]</tt>&nbsp;</td><td valign="top"><em>rgb</em>&nbsp;</td><td>an array comprising red, green, and blue components.</td></tr>
  </table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>a <a class="el" href="structopenvrml_1_1color.html" title="A POD-struct comprising a color.">color</a>. </dd></dl>

</div>
</div><p>
<a class="anchor" name="1aea12b9e6e60eaf3c2f4ae48f671407"></a><!-- doxytag: member="openvrml::color::make_color" ref="1aea12b9e6e60eaf3c2f4ae48f671407" args="(const float r, const float g, const float b)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">const <a class="el" href="structopenvrml_1_1color.html">openvrml::color</a> make_color           </td>
          <td>(</td>
          <td class="paramtype">const float&nbsp;</td>
          <td class="paramname"> <em>r</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const float&nbsp;</td>
          <td class="paramname"> <em>g</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const float&nbsp;</td>
          <td class="paramname"> <em>b</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td> throw()<code> [related]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Create a <a class="el" href="structopenvrml_1_1color.html" title="A POD-struct comprising a color.">color</a>. 
<p>
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. <dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"><tt>[in]</tt>&nbsp;</td><td valign="top"><em>r</em>&nbsp;</td><td>red component. </td></tr>
    <tr><td valign="top"><tt>[in]</tt>&nbsp;</td><td valign="top"><em>g</em>&nbsp;</td><td>green component. </td></tr>
    <tr><td valign="top"><tt>[in]</tt>&nbsp;</td><td valign="top"><em>b</em>&nbsp;</td><td>blue component.</td></tr>
  </table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>a <a class="el" href="structopenvrml_1_1color.html" title="A POD-struct comprising a color.">color</a>. </dd></dl>

</div>
</div><p>
<a class="anchor" name="c373a79e04ee9defdb3885f890c9cd49"></a><!-- doxytag: member="openvrml::color::operator==" ref="c373a79e04ee9defdb3885f890c9cd49" args="(const color &amp;lhs, const color &amp;rhs)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool operator==           </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="structopenvrml_1_1color.html">color</a> &amp;&nbsp;</td>
          <td class="paramname"> <em>lhs</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const <a class="el" href="structopenvrml_1_1color.html">color</a> &amp;&nbsp;</td>
          <td class="paramname"> <em>rhs</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td> throw()<code> [related]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Compare for equality. 
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"><tt>[in]</tt>&nbsp;</td><td valign="top"><em>lhs</em>&nbsp;</td><td>left-hand operand. </td></tr>
    <tr><td valign="top"><tt>[in]</tt>&nbsp;</td><td valign="top"><em>rhs</em>&nbsp;</td><td>right-hand operand.</td></tr>
  </table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd><code>true</code> if <code>lhs</code> and <code>rhs</code> have the same value; <code>false</code> otherwise. </dd></dl>

</div>
</div><p>
<a class="anchor" name="86707a427052caa66747d127d9fb9adc"></a><!-- doxytag: member="openvrml::color::operator!=" ref="86707a427052caa66747d127d9fb9adc" args="(const color &amp;lhs, const color &amp;rhs)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool operator!=           </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="structopenvrml_1_1color.html">color</a> &amp;&nbsp;</td>
          <td class="paramname"> <em>lhs</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const <a class="el" href="structopenvrml_1_1color.html">color</a> &amp;&nbsp;</td>
          <td class="paramname"> <em>rhs</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td> throw()<code> [related]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Compare for inequality. 
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"><tt>[in]</tt>&nbsp;</td><td valign="top"><em>lhs</em>&nbsp;</td><td>left-hand operand. </td></tr>
    <tr><td valign="top"><tt>[in]</tt>&nbsp;</td><td valign="top"><em>rhs</em>&nbsp;</td><td>right-hand operand.</td></tr>
  </table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd><code>true</code> if <code>lhs</code> and <code>rhs</code> do not have the same value; <code>false</code> otherwise. </dd></dl>

</div>
</div><p>
<a class="anchor" name="c491cf2e907c06cb5e1ca135b8174759"></a><!-- doxytag: member="openvrml::color::operator&gt;&gt;" ref="c491cf2e907c06cb5e1ca135b8174759" args="(std::istream &amp;in, color &amp;c)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">std::istream &amp; operator&gt;&gt;           </td>
          <td>(</td>
          <td class="paramtype">std::istream &amp;&nbsp;</td>
          <td class="paramname"> <em>in</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="structopenvrml_1_1color.html">color</a> &amp;&nbsp;</td>
          <td class="paramname"> <em>c</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td><code> [related]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Stream input. 
<p>
Consistent with the VRML97 convention, commas (&ldquo;<code></code>,&rdquo;) in the input are treated as whitespace.<p>
If any of the <a class="el" href="structopenvrml_1_1color.html" title="A POD-struct comprising a color.">color</a> components is outside the the range [0.0, 1.0], the <code>failbit</code> will be set on <code>in</code> and <code>c</code> will be left in an arbitrary state.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"><tt>[in,out]</tt>&nbsp;</td><td valign="top"><em>in</em>&nbsp;</td><td>input stream. </td></tr>
    <tr><td valign="top"><tt>[out]</tt>&nbsp;</td><td valign="top"><em>c</em>&nbsp;</td><td>a <code><a class="el" href="structopenvrml_1_1color.html" title="A POD-struct comprising a color.">color</a></code>.</td></tr>
  </table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd><code>in</code>. </dd></dl>

</div>
</div><p>
<a class="anchor" name="47b141bac0a97692fb7a18d11aefc7b2"></a><!-- doxytag: member="openvrml::color::operator&lt;&lt;" ref="47b141bac0a97692fb7a18d11aefc7b2" args="(std::ostream &amp;out, const color &amp;c)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">std::ostream &amp; operator&lt;&lt;           </td>
          <td>(</td>
          <td class="paramtype">std::ostream &amp;&nbsp;</td>
          <td class="paramname"> <em>out</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const <a class="el" href="structopenvrml_1_1color.html">color</a> &amp;&nbsp;</td>
          <td class="paramname"> <em>c</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td><code> [related]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Stream output. 
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"><tt>[in,out]</tt>&nbsp;</td><td valign="top"><em>out</em>&nbsp;</td><td>output stream. </td></tr>
    <tr><td valign="top"><tt>[in]</tt>&nbsp;</td><td valign="top"><em>c</em>&nbsp;</td><td>a <code><a class="el" href="structopenvrml_1_1color.html" title="A POD-struct comprising a color.">color</a></code>.</td></tr>
  </table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd><code>out</code>. </dd></dl>
<dl compact><dt><b>Examples: </b></dt><dd>
<a class="el" href="pretty__print_8cpp-example.html#a0">pretty_print.cpp</a>.</dl>
</div>
</div><p>
<hr><h2>Member Data Documentation</h2>
<a class="anchor" name="b73f682d9ab412f565cdfc8d11b9f8ff"></a><!-- doxytag: member="openvrml::color::rgb" ref="b73f682d9ab412f565cdfc8d11b9f8ff" args="[3]" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">float <a class="el" href="structopenvrml_1_1color.html#b73f682d9ab412f565cdfc8d11b9f8ff">openvrml::color::rgb</a>[3]          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
RGB triplet. 
<p>

</div>
</div><p>
</div>
</div>
<address class="footer"><span class="images"><a href="http://web3d.org/x3d/"><img src="x3d-white-on-black.png" width="43" height="32" border="0" alt="X3D"></a><a href="http://opengl.org"><img src="OGL_sm_wht.png" width="68" height="32" border="0" alt="OpenGL"></a><a href="http://sourceforge.net/projects/openvrml"><img src="http://sourceforge.net/sflogo.php?group_id=7151&amp;type=11" width="120" height="30" border="0" alt="SourceForge.net"></a></span><a href="https://sourceforge.net/apps/trac/openvrml/newticket">Report error</a><br>Generated Thu Aug 13 02:49:16 2009 by Doxygen 1.5.8</address>
<script src="http://www.google-analytics.com/urchin.js" type="text/javascript"></script>
<script type="text/javascript">_uacct = "UA-446379-2"; urchinTracker();</script>
<!-- Piwik -->
<script type="text/javascript">
var pkBaseURL = (("https:" == document.location.protocol) ? "https://sourceforge.net/apps/piwik/openvrml/" : "http://sourceforge.net/apps/piwik/openvrml/");
document.write(unescape("%3Cscript src='" + pkBaseURL + "piwik.js' type='text/javascript'%3E%3C/script%3E"));
</script><script type="text/javascript">
piwik_action_name = '';
piwik_idsite = 1;
piwik_url = pkBaseURL + "piwik.php";
piwik_log(piwik_action_name, piwik_idsite, piwik_url);
</script>
<object><noscript><p><img src="http://sourceforge.net/apps/piwik/openvrml/piwik.php?idsite=1" alt="piwik"/></p></noscript></object>
<!-- End Piwik Tag -->
</body>
</html>