<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>HippoDraw Class Library</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
<link rel="shortcut icon" href="hippoApp.ico">
</head><body>
<!-- Generated by Doxygen 1.6.2 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<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 class="tabs">
<ul>
<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="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
<div class="navpath"><a class="el" href="namespacehippodraw.html">hippodraw</a>::<a class="el" href="classhippodraw_1_1BinToUsrDefinedScale.html">BinToUsrDefinedScale</a>
</div>
</div>
<div class="contents">
<h1>BinToUsrDefinedScale Class Reference</h1><!-- doxytag: class="hippodraw::BinToUsrDefinedScale" --><!-- doxytag: inherits="hippodraw::BinToColor" -->
<p>The class derived from the <a class="el" href="classhippodraw_1_1BinToColor.html" title="The base class for the value to the color transformation.">BinToColor</a> class.
<a href="#_details">More...</a></p>
<p><code>#include <<a class="el" href="BinToUsrDefinedScale_8h_source.html">BinToUsrDefinedScale.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for BinToUsrDefinedScale:</div>
<div class="dynsection">
<div class="center"><img src="classhippodraw_1_1BinToUsrDefinedScale__inherit__graph.gif" border="0" usemap="#BinToUsrDefinedScale_inherit__map" alt="Inheritance graph"/></div>
<map name="BinToUsrDefinedScale_inherit__map" id="BinToUsrDefinedScale_inherit__map">
<area shape="rect" id="node2" href="classhippodraw_1_1BinToColor.html" title="The base class for the value to the color transformation." alt="" coords="40,5,125,35"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<div class="dynheader">
Collaboration diagram for BinToUsrDefinedScale:</div>
<div class="dynsection">
<div class="center"><img src="classhippodraw_1_1BinToUsrDefinedScale__coll__graph.gif" border="0" usemap="#BinToUsrDefinedScale_coll__map" alt="Collaboration graph"/></div>
<map name="BinToUsrDefinedScale_coll__map" id="BinToUsrDefinedScale_coll__map">
<area shape="rect" id="node2" href="classhippodraw_1_1BinToColor.html" title="The base class for the value to the color transformation." alt="" coords="107,299,192,328"/><area shape="rect" id="node6" title="STL class." alt="" coords="259,200,312,229"/><area shape="rect" id="node8" title="STL class." alt="" coords="216,101,357,131"/><area shape="rect" id="node13" title="STL class." alt="" coords="101,101,192,131"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<p><a href="classhippodraw_1_1BinToUsrDefinedScale-members.html">List of all members.</a></p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classhippodraw_1_1BinToColor.html#a7bac923c9e9891d5f395654c6b9d72f0">acceptChangeColor</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns <code>true</code> if object can accept changing color,i.e. <a href="#a7bac923c9e9891d5f395654c6b9d72f0"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classhippodraw_1_1BinToUsrDefinedScale.html#a83d1d6133d6e46a22aa95ca1abe181f0">BinToUsrDefinedScale</a> (const <a class="el" href="classhippodraw_1_1BinToUsrDefinedScale.html">BinToUsrDefinedScale</a> &)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The copy constructor. <a href="#a83d1d6133d6e46a22aa95ca1abe181f0"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classhippodraw_1_1BinToUsrDefinedScale.html#a06383306468d496760c9b29d967e6998">BinToUsrDefinedScale</a> (const std::string &model_name)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Another constructor with control points specified. <a href="#a06383306468d496760c9b29d967e6998"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classhippodraw_1_1BinToUsrDefinedScale.html#a6df8cc5dcc77419dd26fcb1db580dc1d">BinToUsrDefinedScale</a> (const char *name)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The constructor. <a href="#a6df8cc5dcc77419dd26fcb1db580dc1d"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classhippodraw_1_1BinToColor.html">BinToColor</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classhippodraw_1_1BinToUsrDefinedScale.html#acf2d9ae0de44b8efbce24084b3ea5184">clone</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Creates a copy of itself. <a href="#acf2d9ae0de44b8efbce24084b3ea5184"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classhippodraw_1_1BinToUsrDefinedScale.html#a63a596c7bccb4282016c1a5a4f0cf8a0">doubleToColor</a> (double value, <a class="el" href="classhippodraw_1_1Color.html">Color</a> &color) const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const std::vector< double > & </td><td class="memItemRight" valign="bottom"><a class="el" href="classhippodraw_1_1BinToColor.html#a3557580aa76c9bff88bb7767d2d1431b">getControlPoints</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns a list of control points. <a href="#a3557580aa76c9bff88bb7767d2d1431b"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classhippodraw_1_1Range.html">Range</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classhippodraw_1_1BinToColor.html#aa242fc96cb71313a51f25aefcf152e88">getRange</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the <a class="el" href="classhippodraw_1_1Range.html" title="Expresses a range of values.">Range</a> of expected values. <a href="#aa242fc96cb71313a51f25aefcf152e88"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classhippodraw_1_1BinToUsrDefinedScale.html#af4a0148f4d3a3e07a421300b9521d135">hasControlPoints</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns <code>true</code>. <a href="#af4a0148f4d3a3e07a421300b9521d135"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classhippodraw_1_1BinToUsrDefinedScale.html#acd3fc1e3dfc1929003fd153689615756">isUserDefined</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns <code>true</code>. <a href="#acd3fc1e3dfc1929003fd153689615756"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const std::string & </td><td class="memItemRight" valign="bottom"><a class="el" href="classhippodraw_1_1BinToColor.html#af8370604529de0f829b8424e1288a104">name</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the name of the value to color transform. <a href="#af8370604529de0f829b8424e1288a104"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classhippodraw_1_1BinToColor.html#a6947116ba25f31da074809f0ca8b9cb2">setControlPoints</a> (const std::vector< double > &points)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the value of the control points. <a href="#a6947116ba25f31da074809f0ca8b9cb2"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classhippodraw_1_1BinToColor.html#aefa9ad4c052c74bda4ab2655e027c26f">setRange</a> (const <a class="el" href="classhippodraw_1_1Range.html">Range</a> &r)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the range of the values passed. <a href="#aefa9ad4c052c74bda4ab2655e027c26f"></a><br/></td></tr>
<tr><td colspan="2"><h2>Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">std::vector< double > </td><td class="memItemRight" valign="bottom"><a class="el" href="classhippodraw_1_1BinToColor.html#a81832d0db8b53d015516aadc7b13060b">m_control_points</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">A set of control points that might be used for the value to color transform. <a href="#a81832d0db8b53d015516aadc7b13060b"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">double </td><td class="memItemRight" valign="bottom"><a class="el" href="classhippodraw_1_1BinToColor.html#ae9fd181c15aa94a45d97274d011e7b26">m_dv</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The distance of the expected values, i.e. <a href="#ae9fd181c15aa94a45d97274d011e7b26"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classhippodraw_1_1BinToColor.html#adb41893ba19e889e56c559f25fc1a68a">m_name</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The name of this value transform. <a href="#adb41893ba19e889e56c559f25fc1a68a"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">double </td><td class="memItemRight" valign="bottom"><a class="el" href="classhippodraw_1_1BinToColor.html#a48e433b9625c7e774073dce89c270905">m_vmin</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The minimum value expected. <a href="#a48e433b9625c7e774073dce89c270905"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>The class derived from the <a class="el" href="classhippodraw_1_1BinToColor.html" title="The base class for the value to the color transformation.">BinToColor</a> class. </p>
<p>This class implements the transformation of a value to a color like the classic rainbow, but has two control parameters(user specified) to vary the transform. Unlike the other models with control parameters this model does not have sliders to change the parameters. They can be explicitly changed my the user by clicking on the Edit model button in the <a class="el" href="classhippodraw_1_1Inspector.html" title="A derived class of InspectorBase class which is generated by the Qt designer.">Inspector</a>. One parameter is the distance between the break points and the other is the position of the center between the break points.</p>
<dl class="author"><dt><b>Author:</b></dt><dd>Joy Rajiv <<a href="mailto:jrajiv@stanford.edu">jrajiv@stanford.edu</a>></dd></dl>
<p>The member function <a class="el" href="classhippodraw_1_1BinToUsrDefinedScale.html#a63a596c7bccb4282016c1a5a4f0cf8a0">doubleToColor()</a> was taken from C code written by </p>
<dl class="author"><dt><b>Author:</b></dt><dd>Paul Bourke <<a href="mailto:pdb@swin.edu.au">pdb@swin.edu.au</a>></dd></dl>
<p>Found on this web page <a href="http://astronomy.swin.edu.au/~pbourke/colour/colourramp/">http://astronomy.swin.edu.au/~pbourke/colour/colourramp/</a> </p>
<p>Definition at line <a class="el" href="BinToUsrDefinedScale_8h_source.html#l00039">39</a> of file <a class="el" href="BinToUsrDefinedScale_8h_source.html">BinToUsrDefinedScale.h</a>.</p>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a6df8cc5dcc77419dd26fcb1db580dc1d"></a><!-- doxytag: member="hippodraw::BinToUsrDefinedScale::BinToUsrDefinedScale" ref="a6df8cc5dcc77419dd26fcb1db580dc1d" args="(const char *name)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classhippodraw_1_1BinToUsrDefinedScale.html">BinToUsrDefinedScale</a> </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>name</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>The constructor. </p>
<p>Definition at line <a class="el" href="BinToUsrDefinedScale_8cxx_source.html#l00019">19</a> of file <a class="el" href="BinToUsrDefinedScale_8cxx_source.html">BinToUsrDefinedScale.cxx</a>.</p>
<p>References <a class="el" href="BinToColor_8h_source.html#l00046">BinToColor::m_control_points</a>.</p>
<p>Referenced by <a class="el" href="BinToUsrDefinedScale_8cxx_source.html#l00032">BinToUsrDefinedScale::clone()</a>.</p>
</div>
</div>
<a class="anchor" id="a06383306468d496760c9b29d967e6998"></a><!-- doxytag: member="hippodraw::BinToUsrDefinedScale::BinToUsrDefinedScale" ref="a06383306468d496760c9b29d967e6998" args="(const std::string &model_name)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classhippodraw_1_1BinToUsrDefinedScale.html">BinToUsrDefinedScale</a> </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"> <em>model_name</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Another constructor with control points specified. </p>
</div>
</div>
<a class="anchor" id="a83d1d6133d6e46a22aa95ca1abe181f0"></a><!-- doxytag: member="hippodraw::BinToUsrDefinedScale::BinToUsrDefinedScale" ref="a83d1d6133d6e46a22aa95ca1abe181f0" args="(const BinToUsrDefinedScale &)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classhippodraw_1_1BinToUsrDefinedScale.html">BinToUsrDefinedScale</a> </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classhippodraw_1_1BinToUsrDefinedScale.html">BinToUsrDefinedScale</a> & </td>
<td class="paramname"> <em>bin_to_color</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>The copy constructor. </p>
<p>Definition at line <a class="el" href="BinToUsrDefinedScale_8cxx_source.html#l00027">27</a> of file <a class="el" href="BinToUsrDefinedScale_8cxx_source.html">BinToUsrDefinedScale.cxx</a>.</p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a7bac923c9e9891d5f395654c6b9d72f0"></a><!-- doxytag: member="hippodraw::BinToUsrDefinedScale::acceptChangeColor" ref="a7bac923c9e9891d5f395654c6b9d72f0" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool acceptChangeColor </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const<code> [virtual, inherited]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns <code>true</code> if object can accept changing color,i.e. </p>
<p>enable the "Change color" button in plot inspector tabbed panel within inspector. Reimplemented in <a class="el" href="classhippodraw_1_1BinToBlack.html" title="The class derived from the BinToColor class.">BinToBlack</a> and <a class="el" href="classhippodraw_1_1BinToGreyScale.html" title="The class derived from the BinToColor class.">BinToGreyScale</a>. The base class implementation returns <code>false</code>. </p>
<p>Reimplemented in <a class="el" href="classhippodraw_1_1BinToBlack.html#a7bac923c9e9891d5f395654c6b9d72f0">BinToBlack</a>, <a class="el" href="classhippodraw_1_1BinToGamma.html#a7bac923c9e9891d5f395654c6b9d72f0">BinToGamma</a>, <a class="el" href="classhippodraw_1_1BinToGreyScale.html#a7bac923c9e9891d5f395654c6b9d72f0">BinToGreyScale</a>, and <a class="el" href="classhippodraw_1_1BinToLineStyle.html#a7bac923c9e9891d5f395654c6b9d72f0">BinToLineStyle</a>.</p>
<p>Definition at line <a class="el" href="BinToColor_8cxx_source.html#l00094">94</a> of file <a class="el" href="BinToColor_8cxx_source.html">BinToColor.cxx</a>.</p>
</div>
</div>
<a class="anchor" id="acf2d9ae0de44b8efbce24084b3ea5184"></a><!-- doxytag: member="hippodraw::BinToUsrDefinedScale::clone" ref="acf2d9ae0de44b8efbce24084b3ea5184" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classhippodraw_1_1BinToColor.html">BinToColor</a> * clone </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Creates a copy of itself. </p>
<p>Implements <a class="el" href="classhippodraw_1_1BinToColor.html#a46eacf61d9e40313506dc0cc639888da">BinToColor</a>.</p>
<p>Definition at line <a class="el" href="BinToUsrDefinedScale_8cxx_source.html#l00032">32</a> of file <a class="el" href="BinToUsrDefinedScale_8cxx_source.html">BinToUsrDefinedScale.cxx</a>.</p>
<p>References <a class="el" href="BinToUsrDefinedScale_8cxx_source.html#l00019">BinToUsrDefinedScale::BinToUsrDefinedScale()</a>.</p>
</div>
</div>
<a class="anchor" id="a63a596c7bccb4282016c1a5a4f0cf8a0"></a><!-- doxytag: member="hippodraw::BinToUsrDefinedScale::doubleToColor" ref="a63a596c7bccb4282016c1a5a4f0cf8a0" args="(double value, Color &color) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void doubleToColor </td>
<td>(</td>
<td class="paramtype">double </td>
<td class="paramname"> <em>value</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classhippodraw_1_1Color.html">Color</a> & </td>
<td class="paramname"> <em>color</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<dl class="todo"><dt><b><a class="el" href="todo.html#_todo000020">Todo:</a></b></dt><dd>This is copy of member function of same name in BinToColorSaleMovingBrkPt. </dd></dl>
<p>Implements <a class="el" href="classhippodraw_1_1BinToColor.html#aa1feadf0b266c72cb4e75e5c4e2e6bb4">BinToColor</a>.</p>
<p>Definition at line <a class="el" href="BinToUsrDefinedScale_8cxx_source.html#l00042">42</a> of file <a class="el" href="BinToUsrDefinedScale_8cxx_source.html">BinToUsrDefinedScale.cxx</a>.</p>
<p>References <a class="el" href="BinToColor_8h_source.html#l00046">BinToColor::m_control_points</a>, <a class="el" href="BinToColor_8h_source.html#l00050">BinToColor::m_dv</a>, <a class="el" href="BinToColor_8h_source.html#l00054">BinToColor::m_vmin</a>, and <a class="el" href="Color_8cxx_source.html#l00112">Color::setColor()</a>.</p>
</div>
</div>
<a class="anchor" id="a3557580aa76c9bff88bb7767d2d1431b"></a><!-- doxytag: member="hippodraw::BinToUsrDefinedScale::getControlPoints" ref="a3557580aa76c9bff88bb7767d2d1431b" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const std::vector< double > & getControlPoints </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const<code> [inherited]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns a list of control points. </p>
<p>If a derived class has control points to vary the transform of value to color returns the list of control points. Otherwise, the returned list is empty. </p>
<p>Definition at line <a class="el" href="BinToColor_8cxx_source.html#l00071">71</a> of file <a class="el" href="BinToColor_8cxx_source.html">BinToColor.cxx</a>.</p>
<p>References <a class="el" href="BinToColor_8h_source.html#l00046">BinToColor::m_control_points</a>.</p>
<p>Referenced by <a class="el" href="BinToColorXML_8cxx_source.html#l00041">BinToColorXML::createElement()</a>.</p>
</div>
</div>
<a class="anchor" id="aa242fc96cb71313a51f25aefcf152e88"></a><!-- doxytag: member="hippodraw::BinToUsrDefinedScale::getRange" ref="aa242fc96cb71313a51f25aefcf152e88" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classhippodraw_1_1Range.html">Range</a> getRange </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const<code> [inherited]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get the <a class="el" href="classhippodraw_1_1Range.html" title="Expresses a range of values.">Range</a> of expected values. </p>
<p>Definition at line <a class="el" href="BinToColor_8cxx_source.html#l00055">55</a> of file <a class="el" href="BinToColor_8cxx_source.html">BinToColor.cxx</a>.</p>
<p>References <a class="el" href="BinToColor_8h_source.html#l00050">BinToColor::m_dv</a>, and <a class="el" href="BinToColor_8h_source.html#l00054">BinToColor::m_vmin</a>.</p>
<p>Referenced by <a class="el" href="ContourPointRep_8cxx_source.html#l00371">ContourPointRep::createContours()</a>, and <a class="el" href="AxisRepColor_8cxx_source.html#l00237">AxisRepColor::drawColorScale()</a>.</p>
</div>
</div>
<a class="anchor" id="af4a0148f4d3a3e07a421300b9521d135"></a><!-- doxytag: member="hippodraw::BinToUsrDefinedScale::hasControlPoints" ref="af4a0148f4d3a3e07a421300b9521d135" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool hasControlPoints </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns <code>true</code>. </p>
<p>Returns <code>true</code> as this class has control points with which the value to color transform can be varied. </p>
<p>Reimplemented from <a class="el" href="classhippodraw_1_1BinToColor.html#af4a0148f4d3a3e07a421300b9521d135">BinToColor</a>.</p>
<p>Definition at line <a class="el" href="BinToUsrDefinedScale_8cxx_source.html#l00182">182</a> of file <a class="el" href="BinToUsrDefinedScale_8cxx_source.html">BinToUsrDefinedScale.cxx</a>.</p>
</div>
</div>
<a class="anchor" id="acd3fc1e3dfc1929003fd153689615756"></a><!-- doxytag: member="hippodraw::BinToUsrDefinedScale::isUserDefined" ref="acd3fc1e3dfc1929003fd153689615756" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool isUserDefined </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns <code>true</code>. </p>
<p>Reimplemented from <a class="el" href="classhippodraw_1_1BinToColor.html#acd3fc1e3dfc1929003fd153689615756">BinToColor</a>.</p>
<p>Definition at line <a class="el" href="BinToUsrDefinedScale_8cxx_source.html#l00189">189</a> of file <a class="el" href="BinToUsrDefinedScale_8cxx_source.html">BinToUsrDefinedScale.cxx</a>.</p>
</div>
</div>
<a class="anchor" id="af8370604529de0f829b8424e1288a104"></a><!-- doxytag: member="hippodraw::BinToUsrDefinedScale::name" ref="af8370604529de0f829b8424e1288a104" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const std::string & name </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const<code> [inherited]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the name of the value to color transform. </p>
<p>Reimplemented in <a class="el" href="classhippodraw_1_1BinToColorMap.html#a324e8c54c4c5161913681a1a52fef959">BinToColorMap</a>.</p>
<p>Definition at line <a class="el" href="BinToColor_8cxx_source.html#l00042">42</a> of file <a class="el" href="BinToColor_8cxx_source.html">BinToColor.cxx</a>.</p>
<p>References <a class="el" href="BinToColor_8h_source.html#l00036">BinToColor::m_name</a>.</p>
<p>Referenced by <a class="el" href="BinToColorXML_8cxx_source.html#l00041">BinToColorXML::createElement()</a>, <a class="el" href="ContourPointRep_8cxx_source.html#l00762">ContourPointRep::drawProjectedValues()</a>, and <a class="el" href="DisplayController_8cxx_source.html#l00188">DisplayController::saveValueCtrlPts()</a>.</p>
</div>
</div>
<a class="anchor" id="a6947116ba25f31da074809f0ca8b9cb2"></a><!-- doxytag: member="hippodraw::BinToUsrDefinedScale::setControlPoints" ref="a6947116ba25f31da074809f0ca8b9cb2" args="(const std::vector< double > &points)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void setControlPoints </td>
<td>(</td>
<td class="paramtype">const std::vector< double > & </td>
<td class="paramname"> <em>points</em></td>
<td> ) </td>
<td><code> [virtual, inherited]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set the value of the control points. </p>
<p>Interpretation of control points is left to derived classes. </p>
<p>Reimplemented in <a class="el" href="classhippodraw_1_1BinToColorMap.html#a6947116ba25f31da074809f0ca8b9cb2">BinToColorMap</a>.</p>
<p>Definition at line <a class="el" href="BinToColor_8cxx_source.html#l00078">78</a> of file <a class="el" href="BinToColor_8cxx_source.html">BinToColor.cxx</a>.</p>
<p>References <a class="el" href="BinToColor_8h_source.html#l00046">BinToColor::m_control_points</a>.</p>
</div>
</div>
<a class="anchor" id="aefa9ad4c052c74bda4ab2655e027c26f"></a><!-- doxytag: member="hippodraw::BinToUsrDefinedScale::setRange" ref="aefa9ad4c052c74bda4ab2655e027c26f" args="(const Range &r)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void setRange </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classhippodraw_1_1Range.html">Range</a> & </td>
<td class="paramname"> <em>r</em></td>
<td> ) </td>
<td><code> [inherited]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Sets the range of the values passed. </p>
<p>Definition at line <a class="el" href="BinToColor_8cxx_source.html#l00047">47</a> of file <a class="el" href="BinToColor_8cxx_source.html">BinToColor.cxx</a>.</p>
<p>References <a class="el" href="Range_8h_source.html#l00156">Range::length()</a>, <a class="el" href="Range_8cxx_source.html#l00086">Range::low()</a>, <a class="el" href="BinToColor_8h_source.html#l00050">BinToColor::m_dv</a>, and <a class="el" href="BinToColor_8h_source.html#l00054">BinToColor::m_vmin</a>.</p>
<p>Referenced by <a class="el" href="ContourPointRep_8cxx_source.html#l00762">ContourPointRep::drawProjectedValues()</a>, <a class="el" href="ColorSymbolPointRep_8cxx_source.html#l00083">ColorSymbolPointRep::drawProjectedValues()</a>, and <a class="el" href="ColorBoxPointRep_8cxx_source.html#l00082">ColorBoxPointRep::drawProjectedValues()</a>.</p>
</div>
</div>
<hr/><h2>Member Data Documentation</h2>
<a class="anchor" id="a81832d0db8b53d015516aadc7b13060b"></a><!-- doxytag: member="hippodraw::BinToUsrDefinedScale::m_control_points" ref="a81832d0db8b53d015516aadc7b13060b" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::vector< double > <a class="el" href="classhippodraw_1_1BinToColor.html#a81832d0db8b53d015516aadc7b13060b">m_control_points</a><code> [protected, inherited]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>A set of control points that might be used for the value to color transform. </p>
<dl class="note"><dt><b>Note:</b></dt><dd>This vector is declared in the base class so that the implementation of getControlPoints in this base class can return an empty vector, otherwise some compilers would flag an error for not returning anything. </dd></dl>
<p>Definition at line <a class="el" href="BinToColor_8h_source.html#l00046">46</a> of file <a class="el" href="BinToColor_8h_source.html">BinToColor.h</a>.</p>
<p>Referenced by <a class="el" href="BinToColor_8cxx_source.html#l00028">BinToColor::BinToColor()</a>, <a class="el" href="BinToColorMap_8cxx_source.html#l00021">BinToColorMap::BinToColorMap()</a>, <a class="el" href="BinToColorScaleMovingBrkPt_8cxx_source.html#l00022">BinToColorScaleMovingBrkPt::BinToColorScaleMovingBrkPt()</a>, <a class="el" href="BinToGamma_8cxx_source.html#l00022">BinToGamma::BinToGamma()</a>, <a class="el" href="BinToMovingBrkPt_8cxx_source.html#l00019">BinToMovingBrkPt::BinToMovingBrkPt()</a>, <a class="el" href="BinToUsrDefinedScale_8cxx_source.html#l00019">BinToUsrDefinedScale::BinToUsrDefinedScale()</a>, <a class="el" href="BinToColorMap_8cxx_source.html#l00045">BinToColorMap::calcGamma()</a>, <a class="el" href="BinToUsrDefinedScale_8cxx_source.html#l00042">BinToUsrDefinedScale::doubleToColor()</a>, <a class="el" href="BinToMovingBrkPt_8cxx_source.html#l00044">BinToMovingBrkPt::doubleToColor()</a>, <a class="el" href="BinToGamma_8cxx_source.html#l00042">BinToGamma::doubleToColor()</a>, <a class="el" href="BinToColorScaleMovingBrkPt_8cxx_source.html#l00063">BinToColorScaleMovingBrkPt::doubleToColor()</a>, <a class="el" href="BinToColor_8cxx_source.html#l00071">BinToColor::getControlPoints()</a>, <a class="el" href="BinToColorMap_8cxx_source.html#l00037">BinToColorMap::setControlPoints()</a>, and <a class="el" href="BinToColor_8cxx_source.html#l00078">BinToColor::setControlPoints()</a>.</p>
</div>
</div>
<a class="anchor" id="ae9fd181c15aa94a45d97274d011e7b26"></a><!-- doxytag: member="hippodraw::BinToUsrDefinedScale::m_dv" ref="ae9fd181c15aa94a45d97274d011e7b26" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">double <a class="el" href="classhippodraw_1_1BinToColor.html#ae9fd181c15aa94a45d97274d011e7b26">m_dv</a><code> [protected, inherited]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>The distance of the expected values, i.e. </p>
<p>maximum - minimum. </p>
<p>Definition at line <a class="el" href="BinToColor_8h_source.html#l00050">50</a> of file <a class="el" href="BinToColor_8h_source.html">BinToColor.h</a>.</p>
<p>Referenced by <a class="el" href="BinToUsrDefinedScale_8cxx_source.html#l00042">BinToUsrDefinedScale::doubleToColor()</a>, <a class="el" href="BinToMovingBrkPt_8cxx_source.html#l00044">BinToMovingBrkPt::doubleToColor()</a>, <a class="el" href="BinToKamaeScale_8cxx_source.html#l00038">BinToKamaeScale::doubleToColor()</a>, <a class="el" href="BinToGreyScale_8cxx_source.html#l00034">BinToGreyScale::doubleToColor()</a>, <a class="el" href="BinToGamma_8cxx_source.html#l00042">BinToGamma::doubleToColor()</a>, <a class="el" href="BinToFullColorScale_8cxx_source.html#l00037">BinToFullColorScale::doubleToColor()</a>, <a class="el" href="BinToColorScaleMovingBrkPt_8cxx_source.html#l00063">BinToColorScaleMovingBrkPt::doubleToColor()</a>, <a class="el" href="BinToColorMap_8cxx_source.html#l00070">BinToColorMap::doubleToColor()</a>, <a class="el" href="BinToColor_8cxx_source.html#l00055">BinToColor::getRange()</a>, and <a class="el" href="BinToColor_8cxx_source.html#l00047">BinToColor::setRange()</a>.</p>
</div>
</div>
<a class="anchor" id="adb41893ba19e889e56c559f25fc1a68a"></a><!-- doxytag: member="hippodraw::BinToUsrDefinedScale::m_name" ref="adb41893ba19e889e56c559f25fc1a68a" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string <a class="el" href="classhippodraw_1_1BinToColor.html#adb41893ba19e889e56c559f25fc1a68a">m_name</a><code> [protected, inherited]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>The name of this value transform. </p>
<p>Definition at line <a class="el" href="BinToColor_8h_source.html#l00036">36</a> of file <a class="el" href="BinToColor_8h_source.html">BinToColor.h</a>.</p>
<p>Referenced by <a class="el" href="BinToColor_8cxx_source.html#l00042">BinToColor::name()</a>.</p>
</div>
</div>
<a class="anchor" id="a48e433b9625c7e774073dce89c270905"></a><!-- doxytag: member="hippodraw::BinToUsrDefinedScale::m_vmin" ref="a48e433b9625c7e774073dce89c270905" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">double <a class="el" href="classhippodraw_1_1BinToColor.html#a48e433b9625c7e774073dce89c270905">m_vmin</a><code> [protected, inherited]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>The minimum value expected. </p>
<p>Definition at line <a class="el" href="BinToColor_8h_source.html#l00054">54</a> of file <a class="el" href="BinToColor_8h_source.html">BinToColor.h</a>.</p>
<p>Referenced by <a class="el" href="BinToUsrDefinedScale_8cxx_source.html#l00042">BinToUsrDefinedScale::doubleToColor()</a>, <a class="el" href="BinToMovingBrkPt_8cxx_source.html#l00044">BinToMovingBrkPt::doubleToColor()</a>, <a class="el" href="BinToKamaeScale_8cxx_source.html#l00038">BinToKamaeScale::doubleToColor()</a>, <a class="el" href="BinToGreyScale_8cxx_source.html#l00034">BinToGreyScale::doubleToColor()</a>, <a class="el" href="BinToGamma_8cxx_source.html#l00042">BinToGamma::doubleToColor()</a>, <a class="el" href="BinToFullColorScale_8cxx_source.html#l00037">BinToFullColorScale::doubleToColor()</a>, <a class="el" href="BinToColorScaleMovingBrkPt_8cxx_source.html#l00063">BinToColorScaleMovingBrkPt::doubleToColor()</a>, <a class="el" href="BinToColorMap_8cxx_source.html#l00070">BinToColorMap::doubleToColor()</a>, <a class="el" href="BinToColor_8cxx_source.html#l00055">BinToColor::getRange()</a>, and <a class="el" href="BinToColor_8cxx_source.html#l00047">BinToColor::setRange()</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="BinToUsrDefinedScale_8h_source.html">BinToUsrDefinedScale.h</a></li>
<li><a class="el" href="BinToUsrDefinedScale_8cxx_source.html">BinToUsrDefinedScale.cxx</a></li>
</ul>
</div>
<hr size="1"><address style="align: right;"><small>
Generated for HippoDraw Class Library by <a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border=0>
</a> </small></address>
</body>
</html>
