<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>OpenSceneGraph: osgSim::ColorRange Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.7.4 -->
<div id="top">
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">OpenSceneGraph <span id="projectnumber">2.8.4</span></div>
</td>
</tr>
</tbody>
</table>
</div>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related 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="dirs.html"><span>Directories</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="classes.html"><span>Class Index</span></a></li>
<li><a href="inherits.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="a01637.html">osgSim</a> </li>
<li class="navelem"><a class="el" href="a00112.html">ColorRange</a> </li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> </div>
<div class="headertitle">
<div class="title">osgSim::ColorRange Class Reference</div> </div>
</div>
<div class="contents">
<!-- doxytag: class="osgSim::ColorRange" --><!-- doxytag: inherits="osgSim::ScalarsToColors" -->
<p><a class="el" href="a00112.html" title="ColorRange is a ScalarsToColors object to define a color spectrum for a scalar range.">ColorRange</a> is a <a class="el" href="a00676.html" title="ScalarsToColors defines the interface to map a scalar value to a color, and provides a default implem...">ScalarsToColors</a> object to define a color spectrum for a scalar range.
<a href="a00112.html#details">More...</a></p>
<div class="dynheader">
Inheritance diagram for osgSim::ColorRange:</div>
<div class="dyncontent">
<div class="center"><img src="a03191.png" border="0" usemap="#osgSim_1_1ColorRange_inherit__map" alt="Inheritance graph"/></div>
<map name="osgSim_1_1ColorRange_inherit__map" id="osgSim_1_1ColorRange_inherit__map">
<area shape="rect" id="node2" href="a00676.html" title="ScalarsToColors defines the interface to map a scalar value to a color, and provides a default implem..." alt="" coords="5,83,187,112"/><area shape="rect" id="node4" href="a00627.html" title="Base class from providing referencing counted objects." alt="" coords="29,5,163,35"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<p><a href="a03192.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00112.html#a693d949b4769dd0d4df196550836d65b">ColorRange</a> (float min, float max)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Constructor for a <a class="el" href="a00112.html" title="ColorRange is a ScalarsToColors object to define a color spectrum for a scalar range.">ColorRange</a> with a default list of colors set to Red-Yellow-Green-Blue-Cyan. <a href="#a693d949b4769dd0d4df196550836d65b"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00112.html#a25653b59831b4266eb6ca2c88570cfb5">ColorRange</a> (float min, float max, const std::vector< <a class="el" href="a01074.html">osg::Vec4</a> > &colors)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Constructor for a <a class="el" href="a00112.html" title="ColorRange is a ScalarsToColors object to define a color spectrum for a scalar range.">ColorRange</a>. <a href="#a25653b59831b4266eb6ca2c88570cfb5"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00112.html#aca031cb8afbfe362b2d3aa60bff6b361">setColors</a> (const std::vector< <a class="el" href="a01074.html">osg::Vec4</a> > &colors)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the range of colors. <a href="#aca031cb8afbfe362b2d3aa60bff6b361"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="a01074.html">osg::Vec4</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00112.html#ad395724fa68a4bcbae999449788360e4">getColor</a> (float scalar) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the color for a given scalar value. <a href="#ad395724fa68a4bcbae999449788360e4"></a><br/></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p><a class="el" href="a00112.html" title="ColorRange is a ScalarsToColors object to define a color spectrum for a scalar range.">ColorRange</a> is a <a class="el" href="a00676.html" title="ScalarsToColors defines the interface to map a scalar value to a color, and provides a default implem...">ScalarsToColors</a> object to define a color spectrum for a scalar range. </p>
<p>An optional vector of colors may be passed in at construction time. The range of colors will be mapped to the scalar range, and interpolation between the colors will be performed as necessary. By default, the color range will run Red-Yellow-Green-Cyan-Blue. </p>
</div><hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a693d949b4769dd0d4df196550836d65b"></a><!-- doxytag: member="osgSim::ColorRange::ColorRange" ref="a693d949b4769dd0d4df196550836d65b" args="(float min, float max)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">osgSim::ColorRange::ColorRange </td>
<td>(</td>
<td class="paramtype">float </td>
<td class="paramname"><em>min</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float </td>
<td class="paramname"><em>max</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Constructor for a <a class="el" href="a00112.html" title="ColorRange is a ScalarsToColors object to define a color spectrum for a scalar range.">ColorRange</a> with a default list of colors set to Red-Yellow-Green-Blue-Cyan. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">min</td><td>minimum scalar value </td></tr>
<tr><td class="paramname">max</td><td>maximum scalar value </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a25653b59831b4266eb6ca2c88570cfb5"></a><!-- doxytag: member="osgSim::ColorRange::ColorRange" ref="a25653b59831b4266eb6ca2c88570cfb5" args="(float min, float max, const std::vector< osg::Vec4 > &colors)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">osgSim::ColorRange::ColorRange </td>
<td>(</td>
<td class="paramtype">float </td>
<td class="paramname"><em>min</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float </td>
<td class="paramname"><em>max</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::vector< <a class="el" href="a01074.html">osg::Vec4</a> > & </td>
<td class="paramname"><em>colors</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Constructor for a <a class="el" href="a00112.html" title="ColorRange is a ScalarsToColors object to define a color spectrum for a scalar range.">ColorRange</a>. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">min</td><td>minimum scalar value </td></tr>
<tr><td class="paramname">max</td><td>maximum scalar value </td></tr>
<tr><td class="paramname">colors</td><td>optional range of colors, </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="ad395724fa68a4bcbae999449788360e4"></a><!-- doxytag: member="osgSim::ColorRange::getColor" ref="ad395724fa68a4bcbae999449788360e4" args="(float scalar) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a01074.html">osg::Vec4</a> osgSim::ColorRange::getColor </td>
<td>(</td>
<td class="paramtype">float </td>
<td class="paramname"><em>scalar</em></td><td>)</td>
<td> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get the color for a given scalar value. </p>
<p>Reimplemented from <a class="el" href="a00676.html#a2560c56823b5c15b8033d7ba9c0c5989">osgSim::ScalarsToColors</a>.</p>
</div>
</div>
<a class="anchor" id="aca031cb8afbfe362b2d3aa60bff6b361"></a><!-- doxytag: member="osgSim::ColorRange::setColors" ref="aca031cb8afbfe362b2d3aa60bff6b361" args="(const std::vector< osg::Vec4 > &colors)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void osgSim::ColorRange::setColors </td>
<td>(</td>
<td class="paramtype">const std::vector< <a class="el" href="a01074.html">osg::Vec4</a> > & </td>
<td class="paramname"><em>colors</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set the range of colors. </p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>osgSim/<a class="el" href="a01512.html">ColorRange</a></li>
</ul>
</div>
<hr>
<table border="0"><tr><td>
<img src="osg32-32.png" alt="osg logo" />
</td><td>
<address><small>Generated at Tue May 31 2011 04:19:37 for the <a href="http://www.openscenegraph.org/">OpenSceneGraph</a>
by <a href="http://www.doxygen.org">doxygen</a> 1.7.4.</small></address>
<!-- Dimitri van Heesch's e-mail address removed, lest he get messages on the OpenSceneGraph -->
</td></tr></table>
</body>
</html>
