Sophie

Sophie

distrib > Mandriva > 2010.0 > i586 > media > contrib-release > by-pkgid > 60f1dc962abad0f3b492991a4fbef9be > files > 5333

vtk-doc-5.4.2-5mdv2010.0.noarch.rpm

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>VTK: dox/Rendering/vtkScalarBarActor.h Source File</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.5.6 -->
<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><a href="classes.html"><span>Classes</span></a></li>
      <li class="current"><a href="files.html"><span>Files</span></a></li>
    </ul>
  </div>
<h1>dox/Rendering/vtkScalarBarActor.h</h1><a href="a03541.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/*=========================================================================</span>
<a name="l00002"></a>00002 <span class="comment"></span>
<a name="l00003"></a>00003 <span class="comment">  Program:   Visualization Toolkit</span>
<a name="l00004"></a>00004 <span class="comment">  Module:    $RCSfile: vtkScalarBarActor.h,v $</span>
<a name="l00005"></a>00005 <span class="comment"></span>
<a name="l00006"></a>00006 <span class="comment">  Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen</span>
<a name="l00007"></a>00007 <span class="comment">  All rights reserved.</span>
<a name="l00008"></a>00008 <span class="comment">  See Copyright.txt or http://www.kitware.com/Copyright.htm for details.</span>
<a name="l00009"></a>00009 <span class="comment"></span>
<a name="l00010"></a>00010 <span class="comment">     This software is distributed WITHOUT ANY WARRANTY; without even</span>
<a name="l00011"></a>00011 <span class="comment">     the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR</span>
<a name="l00012"></a>00012 <span class="comment">     PURPOSE.  See the above copyright notice for more information.</span>
<a name="l00013"></a>00013 <span class="comment"></span>
<a name="l00014"></a>00014 <span class="comment">=========================================================================*/</span>
<a name="l00058"></a>00058 <span class="preprocessor">#ifndef __vtkScalarBarActor_h</span>
<a name="l00059"></a>00059 <span class="preprocessor"></span><span class="preprocessor">#define __vtkScalarBarActor_h</span>
<a name="l00060"></a>00060 <span class="preprocessor"></span>
<a name="l00061"></a>00061 <span class="preprocessor">#include "<a class="code" href="a02186.html">vtkActor2D.h</a>"</span>
<a name="l00062"></a>00062 
<a name="l00063"></a>00063 <span class="keyword">class </span><a class="code" href="a01260.html" title="concrete dataset represents vertices, lines, polygons, and triangle strips">vtkPolyData</a>;
<a name="l00064"></a>00064 <span class="keyword">class </span><a class="code" href="a01266.html" title="draw vtkPolyData onto the image plane">vtkPolyDataMapper2D</a>;
<a name="l00065"></a>00065 <span class="keyword">class </span><a class="code" href="a01513.html" title="map scalar values into colors">vtkScalarsToColors</a>;
<a name="l00066"></a>00066 <span class="keyword">class </span><a class="code" href="a01691.html" title="2D text annotation">vtkTextMapper</a>;
<a name="l00067"></a>00067 <span class="keyword">class </span><a class="code" href="a01692.html" title="represent text properties.">vtkTextProperty</a>;
<a name="l00068"></a>00068 <span class="keyword">class </span><a class="code" href="a01695.html" title="handles properties associated with a texture map">vtkTexture</a>;
<a name="l00069"></a>00069 
<a name="l00070"></a><a class="code" href="a03541.html#8c43ac39b7236ef56f57407cf77b6abd">00070</a> <span class="preprocessor">#define VTK_ORIENT_HORIZONTAL 0</span>
<a name="l00071"></a><a class="code" href="a03541.html#67b13870799e602d2c66e68022cbee44">00071</a> <span class="preprocessor"></span><span class="preprocessor">#define VTK_ORIENT_VERTICAL 1</span>
<a name="l00072"></a>00072 <span class="preprocessor"></span>
<a name="l00073"></a><a class="code" href="a01510.html">00073</a> <span class="keyword">class </span><a class="code" href="a02170.html#4019f67b2e7d601f2cf984e448308dbb">VTK_RENDERING_EXPORT</a> <a class="code" href="a01510.html" title="Create a scalar bar with labels.">vtkScalarBarActor</a> : <span class="keyword">public</span> <a class="code" href="a00093.html" title="a actor that draws 2D data">vtkActor2D</a>
<a name="l00074"></a>00074 {
<a name="l00075"></a>00075 <span class="keyword">public</span>:
<a name="l00076"></a><a class="code" href="a01510.html#f07c81706e21581724f15931987b2337">00076</a>   vtkTypeRevisionMacro(<a class="code" href="a01510.html" title="Create a scalar bar with labels.">vtkScalarBarActor</a>,<a class="code" href="a00093.html" title="a actor that draws 2D data">vtkActor2D</a>);
<a name="l00077"></a>00077   <span class="keywordtype">void</span> <a class="code" href="a00093.html#f0bb6b3aeeaa23e0f408990a40a1607a">PrintSelf</a>(ostream&amp; os, <a class="code" href="a00869.html" title="a simple class to control print indentation">vtkIndent</a> indent);
<a name="l00078"></a>00078 
<a name="l00082"></a>00082   <span class="keyword">static</span> <a class="code" href="a01510.html" title="Create a scalar bar with labels.">vtkScalarBarActor</a> *<a class="code" href="a00093.html#470c524c4d719ddf82b0a32bc55beb6e">New</a>();
<a name="l00083"></a>00083 
<a name="l00085"></a>00085 
<a name="l00086"></a>00086   <span class="keywordtype">int</span> <a class="code" href="a00093.html#e26bc15689de9781fdf6ecc6ab80c2fe">RenderOpaqueGeometry</a>(<a class="code" href="a01833.html" title="abstract specification for Viewports">vtkViewport</a>* viewport);
<a name="l00087"></a><a class="code" href="a01510.html#a95e6150ea93cd35e40412cc253d3cb0">00087</a>   <span class="keyword">virtual</span> <span class="keywordtype">int</span> <a class="code" href="a00093.html#f7a2adb46eba24bb78c825750d46a482">RenderTranslucentPolygonalGeometry</a>(<a class="code" href="a01833.html" title="abstract specification for Viewports">vtkViewport</a>*) { <span class="keywordflow">return</span> 0; };
<a name="l00088"></a>00088   <span class="keywordtype">int</span> <a class="code" href="a00093.html#95232573f645b775c88dd81a6067addc">RenderOverlay</a>(<a class="code" href="a01833.html" title="abstract specification for Viewports">vtkViewport</a>* viewport);
<a name="l00090"></a>00090 
<a name="l00092"></a>00092   <span class="keyword">virtual</span> <span class="keywordtype">int</span> <a class="code" href="a00093.html#a8f4fb9da8d8a683cf1c4f8541a21ff1">HasTranslucentPolygonalGeometry</a>();
<a name="l00093"></a>00093   
<a name="l00097"></a>00097   <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="a00093.html#dd99f157501a85867005664f4d74008d">ReleaseGraphicsResources</a>(<a class="code" href="a01886.html" title="window superclass for vtkRenderWindow">vtkWindow</a> *);
<a name="l00098"></a>00098 
<a name="l00100"></a>00100 
<a name="l00103"></a>00103   <span class="keyword">virtual</span> <span class="keywordtype">void</span> SetLookupTable(<a class="code" href="a01513.html" title="map scalar values into colors">vtkScalarsToColors</a>*);
<a name="l00104"></a>00104   vtkGetObjectMacro(LookupTable,<a class="code" href="a01513.html" title="map scalar values into colors">vtkScalarsToColors</a>);
<a name="l00106"></a>00106 
<a name="l00108"></a>00108 
<a name="l00113"></a>00113   vtkSetMacro( UseOpacity, <span class="keywordtype">int</span> );
<a name="l00114"></a>00114   vtkGetMacro( UseOpacity, <span class="keywordtype">int</span> );
<a name="l00115"></a>00115   vtkBooleanMacro( UseOpacity, <span class="keywordtype">int</span> );
<a name="l00117"></a>00117 
<a name="l00119"></a>00119 
<a name="l00122"></a>00122   vtkSetClampMacro(MaximumNumberOfColors, <span class="keywordtype">int</span>, 2, <a class="code" href="a02149.html#804f55a35836c1770f9176f3a01c4d5e">VTK_LARGE_INTEGER</a>);
<a name="l00123"></a>00123   vtkGetMacro(MaximumNumberOfColors, <span class="keywordtype">int</span>);
<a name="l00125"></a>00125   
<a name="l00127"></a>00127 
<a name="l00128"></a>00128   vtkSetClampMacro(NumberOfLabels, <span class="keywordtype">int</span>, 0, 64);
<a name="l00129"></a>00129   vtkGetMacro(NumberOfLabels, <span class="keywordtype">int</span>);
<a name="l00131"></a>00131   
<a name="l00133"></a>00133 
<a name="l00134"></a>00134   vtkSetClampMacro(Orientation,<span class="keywordtype">int</span>,<a class="code" href="a03541.html#8c43ac39b7236ef56f57407cf77b6abd">VTK_ORIENT_HORIZONTAL</a>, <a class="code" href="a03541.html#67b13870799e602d2c66e68022cbee44">VTK_ORIENT_VERTICAL</a>);
<a name="l00135"></a>00135   vtkGetMacro(Orientation, <span class="keywordtype">int</span>);
<a name="l00136"></a><a class="code" href="a01510.html#47ef9cebdf416fc1c90d61083dc78722">00136</a>   <span class="keywordtype">void</span> SetOrientationToHorizontal()
<a name="l00137"></a>00137        {this-&gt;SetOrientation(<a class="code" href="a03541.html#8c43ac39b7236ef56f57407cf77b6abd">VTK_ORIENT_HORIZONTAL</a>);};
<a name="l00138"></a><a class="code" href="a01510.html#35406ea611a2a4b7660f99bb14c4dfaa">00138</a>   <span class="keywordtype">void</span> SetOrientationToVertical() {this-&gt;SetOrientation(<a class="code" href="a03541.html#67b13870799e602d2c66e68022cbee44">VTK_ORIENT_VERTICAL</a>);};
<a name="l00140"></a>00140 
<a name="l00142"></a>00142 
<a name="l00143"></a>00143   <span class="keyword">virtual</span> <span class="keywordtype">void</span> SetTitleTextProperty(<a class="code" href="a01692.html" title="represent text properties.">vtkTextProperty</a> *p);
<a name="l00144"></a>00144   vtkGetObjectMacro(TitleTextProperty,<a class="code" href="a01692.html" title="represent text properties.">vtkTextProperty</a>);
<a name="l00146"></a>00146   
<a name="l00148"></a>00148 
<a name="l00149"></a>00149   <span class="keyword">virtual</span> <span class="keywordtype">void</span> SetLabelTextProperty(<a class="code" href="a01692.html" title="represent text properties.">vtkTextProperty</a> *p);
<a name="l00150"></a>00150   vtkGetObjectMacro(LabelTextProperty,<a class="code" href="a01692.html" title="represent text properties.">vtkTextProperty</a>);
<a name="l00152"></a>00152     
<a name="l00154"></a>00154 
<a name="l00155"></a>00155   vtkSetStringMacro(LabelFormat);
<a name="l00156"></a>00156   vtkGetStringMacro(LabelFormat);
<a name="l00158"></a>00158 
<a name="l00160"></a>00160 
<a name="l00161"></a>00161   vtkSetStringMacro(Title);
<a name="l00162"></a>00162   vtkGetStringMacro(Title);
<a name="l00164"></a>00164 
<a name="l00167"></a>00167   <span class="keywordtype">void</span> <a class="code" href="a00093.html#0b8bceafaea20d00f8a3083e3518b457">ShallowCopy</a>(<a class="code" href="a01317.html" title="abstract superclass for all actors, volumes and annotations">vtkProp</a> *prop);
<a name="l00168"></a>00168 
<a name="l00170"></a>00170 
<a name="l00171"></a>00171   vtkSetMacro( TextureGridWidth, <span class="keywordtype">double</span> );
<a name="l00172"></a>00172   vtkGetMacro( TextureGridWidth, <span class="keywordtype">double</span> );
<a name="l00174"></a>00174 
<a name="l00176"></a>00176 
<a name="l00177"></a>00177   vtkGetObjectMacro( TextureActor, <a class="code" href="a00093.html" title="a actor that draws 2D data">vtkActor2D</a> );
<a name="l00179"></a>00179 
<a name="l00180"></a>00180 <span class="comment">//BTX</span>
<a name="l00181"></a><a class="code" href="a01510.html#4acd905c7e7b240fd1bd715faa9f0c04b6860385f7b7106ffc584d2e2f675040">00181</a>   <span class="keyword">enum</span> { PrecedeScalarBar = 0, SucceedScalarBar };
<a name="l00182"></a>00182 <span class="comment">//ETX</span>
<a name="l00183"></a>00183 
<a name="l00185"></a>00185 
<a name="l00189"></a>00189   vtkSetClampMacro( TextPosition, <span class="keywordtype">int</span>, PrecedeScalarBar, SucceedScalarBar);
<a name="l00190"></a>00190   vtkGetMacro( TextPosition, <span class="keywordtype">int</span> );
<a name="l00191"></a><a class="code" href="a01510.html#7c56b463015bb366af36effe5744aa11">00191</a>   <span class="keyword">virtual</span> <span class="keywordtype">void</span> SetTextPositionToPrecedeScalarBar()
<a name="l00192"></a>00192     { this-&gt;SetTextPosition( <a class="code" href="a01510.html#4acd905c7e7b240fd1bd715faa9f0c04dd76ba924dcac300424d04a8b6510280">vtkScalarBarActor::PrecedeScalarBar</a> ); }
<a name="l00193"></a><a class="code" href="a01510.html#7d8b54ef9192593576328dff5540f598">00193</a>   <span class="keyword">virtual</span> <span class="keywordtype">void</span> SetTextPositionToSucceedScalarBar()
<a name="l00194"></a>00194     { this-&gt;SetTextPosition( <a class="code" href="a01510.html#4acd905c7e7b240fd1bd715faa9f0c04b6860385f7b7106ffc584d2e2f675040">vtkScalarBarActor::SucceedScalarBar</a> ); }
<a name="l00196"></a>00196 
<a name="l00197"></a>00197 <span class="keyword">protected</span>:
<a name="l00198"></a>00198   <a class="code" href="a01510.html" title="Create a scalar bar with labels.">vtkScalarBarActor</a>();
<a name="l00199"></a>00199   ~<a class="code" href="a01510.html" title="Create a scalar bar with labels.">vtkScalarBarActor</a>();
<a name="l00200"></a>00200 
<a name="l00201"></a><a class="code" href="a01510.html#fb57bd1314cfde55e6f8c6010e3554d3">00201</a>   <a class="code" href="a01513.html" title="map scalar values into colors">vtkScalarsToColors</a> *LookupTable;
<a name="l00202"></a><a class="code" href="a01510.html#69e58f0a444f48719fd33549ea7fe754">00202</a>   <a class="code" href="a01692.html" title="represent text properties.">vtkTextProperty</a> *TitleTextProperty;
<a name="l00203"></a><a class="code" href="a01510.html#96a2d8456b3f936958ca94d40ec4c3e4">00203</a>   <a class="code" href="a01692.html" title="represent text properties.">vtkTextProperty</a> *LabelTextProperty;
<a name="l00204"></a>00204 
<a name="l00205"></a><a class="code" href="a01510.html#37fb6a5ccf192657ee1b158fc1ab87f1">00205</a>   <span class="keywordtype">int</span>   MaximumNumberOfColors;
<a name="l00206"></a><a class="code" href="a01510.html#433d79f27976fa5ce4e4349732b20b5d">00206</a>   <span class="keywordtype">int</span>   NumberOfLabels;
<a name="l00207"></a><a class="code" href="a01510.html#f84a3c644b1359ce1f98e982876cc4c0">00207</a>   <span class="keywordtype">int</span>   NumberOfLabelsBuilt;
<a name="l00208"></a><a class="code" href="a01510.html#2a8bbe6bb01611aab3decc89b7404338">00208</a>   <span class="keywordtype">int</span>   Orientation;
<a name="l00209"></a><a class="code" href="a01510.html#7f93e632959f4d2ddb3bf48153084d0d">00209</a>   <span class="keywordtype">char</span>  *Title;
<a name="l00210"></a><a class="code" href="a01510.html#2123ac5af450c8c8175d3ebac222a316">00210</a>   <span class="keywordtype">char</span>  *LabelFormat;
<a name="l00211"></a><a class="code" href="a01510.html#a715e24b77a1db86f9a1d66de2a0153a">00211</a>   <span class="keywordtype">int</span>   UseOpacity; <span class="comment">// off by default</span>
<a name="l00212"></a><a class="code" href="a01510.html#d7a40e8b4d229318c14f5d4d0015909b">00212</a>   <span class="keywordtype">double</span> TextureGridWidth;
<a name="l00213"></a><a class="code" href="a01510.html#5d35832b9ccc5795b9015f151cb9d63b">00213</a>   <span class="keywordtype">int</span> TextPosition;
<a name="l00214"></a>00214 
<a name="l00215"></a><a class="code" href="a01510.html#2c540839b0fcbd4138c63fbb076a961d">00215</a>   <a class="code" href="a01691.html" title="2D text annotation">vtkTextMapper</a> **TextMappers;
<a name="l00216"></a><a class="code" href="a01510.html#4208ab9beb27ff196b8bc1fc4d13af37">00216</a>   <a class="code" href="a00093.html" title="a actor that draws 2D data">vtkActor2D</a>    **TextActors;
<a name="l00217"></a>00217   <span class="keyword">virtual</span> <span class="keywordtype">void</span> AllocateAndSizeLabels(<span class="keywordtype">int</span> *labelSize, <span class="keywordtype">int</span> *<a class="code" href="a03761.html#c6551f7bf833e8254b2b3ecdaea0d210e3d5e7c015dff08d8daf72a0102e1444">size</a>,
<a name="l00218"></a>00218                                      <a class="code" href="a01833.html" title="abstract specification for Viewports">vtkViewport</a> *viewport, <span class="keywordtype">double</span> *<a class="code" href="a03761.html#c6551f7bf833e8254b2b3ecdaea0d21076786d084c43d32f242990f932679539">range</a>);
<a name="l00219"></a>00219 
<a name="l00220"></a><a class="code" href="a01510.html#82b1e2b74d2742786766f3cc56375231">00220</a>   <a class="code" href="a01691.html" title="2D text annotation">vtkTextMapper</a> *TitleMapper;
<a name="l00221"></a><a class="code" href="a01510.html#e14d96ad0cbeffec639097356d031a0a">00221</a>   <a class="code" href="a00093.html" title="a actor that draws 2D data">vtkActor2D</a>    *TitleActor;
<a name="l00222"></a>00222   <span class="keyword">virtual</span> <span class="keywordtype">void</span> SizeTitle(<span class="keywordtype">int</span> *titleSize, <span class="keywordtype">int</span> *<a class="code" href="a03761.html#c6551f7bf833e8254b2b3ecdaea0d210e3d5e7c015dff08d8daf72a0102e1444">size</a>, <a class="code" href="a01833.html" title="abstract specification for Viewports">vtkViewport</a> *viewport);
<a name="l00223"></a>00223 
<a name="l00224"></a><a class="code" href="a01510.html#512de456cd87f3254957c1b5367dc354">00224</a>   <a class="code" href="a01260.html" title="concrete dataset represents vertices, lines, polygons, and triangle strips">vtkPolyData</a>         *ScalarBar;
<a name="l00225"></a><a class="code" href="a01510.html#ceee4dc0f521ed50b7456ea83708cc58">00225</a>   <a class="code" href="a01266.html" title="draw vtkPolyData onto the image plane">vtkPolyDataMapper2D</a> *ScalarBarMapper;
<a name="l00226"></a><a class="code" href="a01510.html#d2c14d8da391edb8ba94646c403be815">00226</a>   <a class="code" href="a00093.html" title="a actor that draws 2D data">vtkActor2D</a>          *ScalarBarActor;
<a name="l00227"></a>00227 
<a name="l00228"></a><a class="code" href="a01510.html#76b12039e8b812221139137954fa62df">00228</a>   <a class="code" href="a01260.html" title="concrete dataset represents vertices, lines, polygons, and triangle strips">vtkPolyData</a>         *TexturePolyData;
<a name="l00229"></a><a class="code" href="a01510.html#cfd2790dcf444e129bd39895238562ce">00229</a>   <a class="code" href="a01695.html" title="handles properties associated with a texture map">vtkTexture</a>          *Texture;
<a name="l00230"></a><a class="code" href="a01510.html#31d3f86a348c503a53ae477101b81edf">00230</a>   <a class="code" href="a00093.html" title="a actor that draws 2D data">vtkActor2D</a>          *TextureActor;
<a name="l00231"></a>00231 
<a name="l00232"></a><a class="code" href="a01510.html#d932dbb1390798c41b2b12ad982e1db3">00232</a>   <a class="code" href="a01719.html" title="record modification and/or execution time">vtkTimeStamp</a>  BuildTime;
<a name="l00233"></a><a class="code" href="a01510.html#45f6e40ccea77c845cd8bfac7b6027ee">00233</a>   <span class="keywordtype">int</span> LastSize[2];
<a name="l00234"></a><a class="code" href="a01510.html#86f29d6fc60ee031c00c80908d9e8dd7">00234</a>   <span class="keywordtype">int</span> LastOrigin[2];
<a name="l00235"></a>00235 
<a name="l00236"></a>00236 
<a name="l00237"></a>00237 <span class="keyword">private</span>:
<a name="l00238"></a>00238   <a class="code" href="a01510.html" title="Create a scalar bar with labels.">vtkScalarBarActor</a>(<span class="keyword">const</span> <a class="code" href="a01510.html" title="Create a scalar bar with labels.">vtkScalarBarActor</a>&amp;);  <span class="comment">// Not implemented.</span>
<a name="l00239"></a>00239   <span class="keywordtype">void</span> operator=(<span class="keyword">const</span> <a class="code" href="a01510.html" title="Create a scalar bar with labels.">vtkScalarBarActor</a>&amp;);  <span class="comment">// Not implemented.</span>
<a name="l00240"></a>00240 };
<a name="l00241"></a>00241 
<a name="l00242"></a>00242 
<a name="l00243"></a>00243 <span class="preprocessor">#endif</span>
<a name="l00244"></a>00244 <span class="preprocessor"></span>
</pre></div></div>
<hr size="1"><address style="text-align: right;"><small>Generated on Wed Jun 3 18:35:49 2009 for VTK by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address>
</body>
</html>