1 <!doctype html public "-//w3c//dtd html 4.0 transitional//en">
4 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
5 <meta name="GENERATOR" content="Mozilla/4.73 [en] (WinNT; I) [Netscape]">
6 <title>Main Page</title>
7 <link href="doxygen.css" rel="stylesheet" type="text/css">
13 <!-- Generated by Doxygen 1.4.6 -->
14 <h1>VISU.ScalarMap Interface Reference</h1><!-- doxytag: class="VISU::ScalarMap" --><!-- doxytag: inherits="VISU::ColoredPrs3d" -->Interface of the Scalar Map.
15 <a href="#_details">More...</a>
17 <code>import "<a class="el" href="VISU__Gen_8idl-source.html">VISU_Gen.idl</a>";</code>
19 Inheritance diagram for VISU.ScalarMap:<p><center><img src="interfaceVISU_1_1ScalarMap__inherit__graph.jpg" border="0" alt="Inheritance graph"></center>
20 <table border="0" cellpadding="0" cellspacing="0">
22 <tr><td colspan="2"><br><h2>Public Types</h2></td></tr>
23 <tr><td class="memItemLeft" nowrap align="right" valign="top">enum </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceVISU_1_1ScalarMap.html#f772d6f2c08313f1cf5fdf29e7924f72">Orientation</a> { <a class="el" href="interfaceVISU_1_1ScalarMap.html#f772d6f2c08313f1cf5fdf29e7924f7285eb3ae7cd8746a335d44f2c242f405d">HORIZONTAL</a>,
24 <a class="el" href="interfaceVISU_1_1ScalarMap.html#f772d6f2c08313f1cf5fdf29e7924f72f2a821d4ca82c4052bf55b6869225f3a">VERTICAL</a>
27 <tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
28 <tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceVISU_1_1ScalarMap.html#533517f061d61d34128a7ebd40ec3df2">SetScaling</a> (in Scaling theScaling)</td></tr>
30 <tr><td class="memItemLeft" nowrap align="right" valign="top">Scaling </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceVISU_1_1ScalarMap.html#af368a29e0046f847a2af205e7040c23">GetScaling</a> ()</td></tr>
32 <tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceVISU_1_1ScalarMap.html#76016f8035d5fb342c64b13ca2e30a66">SetRange</a> (in double theMin, in double theMax)</td></tr>
34 <tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceVISU_1_1ScalarMap.html#a6ed1b0bab197328075cf1010c176fe4">SetBarOrientation</a> (in <a class="el" href="interfaceVISU_1_1ScalarMap.html#f772d6f2c08313f1cf5fdf29e7924f72">Orientation</a> theOrientation)</td></tr>
36 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="interfaceVISU_1_1ScalarMap.html#f772d6f2c08313f1cf5fdf29e7924f72">Orientation</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceVISU_1_1ScalarMap.html#de70daa2d7a203a5b939a3c063ff07bf">GetBarOrientation</a> ()</td></tr>
38 <tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceVISU_1_1ColoredPrs3d.html#0cb01513d53cac1cf26699344580962a">SetScalarMode</a> (in long theScalarMode)</td></tr>
40 <tr><td class="memItemLeft" nowrap align="right" valign="top">long </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceVISU_1_1ColoredPrs3d.html#bd7047f0543f356e7e0853285679c8a0">GetScalarMode</a> ()</td></tr>
42 <tr><td class="memItemLeft" nowrap align="right" valign="top">double </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceVISU_1_1ColoredPrs3d.html#df97f8522a471c2e90470584cf7c92d9">GetMin</a> ()</td></tr>
44 <tr><td class="memItemLeft" nowrap align="right" valign="top">double </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceVISU_1_1ColoredPrs3d.html#294cd1fcd6a6c21d76a6d03dc28b5a85">GetMax</a> ()</td></tr>
46 <tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceVISU_1_1ColoredPrs3d.html#e5d7bfff180529eedad1a140e5a449c3">SetPosition</a> (in double X, in double Y)</td></tr>
48 <tr><td class="mdescLeft"> </td><td class="mdescRight">Position of the scalar bar. <a href="#e5d7bfff180529eedad1a140e5a449c3"></a><br></td></tr>
49 <tr><td class="memItemLeft" nowrap align="right" valign="top">double </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceVISU_1_1ColoredPrs3d.html#ddd48392a778ada1e0153ddcc781edbc">GetPosX</a> ()</td></tr>
51 <tr><td class="memItemLeft" nowrap align="right" valign="top">double </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceVISU_1_1ColoredPrs3d.html#a20c6859e00c881a7db6fa3259a33e51">GetPosY</a> ()</td></tr>
53 <tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceVISU_1_1ColoredPrs3d.html#e9331edc9bb097dd99556ee27735710c">SetSize</a> (in double theWidth, in double theHeight)</td></tr>
55 <tr><td class="mdescLeft"> </td><td class="mdescRight">Size of this presentable object. <a href="#e9331edc9bb097dd99556ee27735710c"></a><br></td></tr>
56 <tr><td class="memItemLeft" nowrap align="right" valign="top">double </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceVISU_1_1ColoredPrs3d.html#fb5593e03da36959bcd7ac2e25c387ef">GetWidth</a> ()</td></tr>
58 <tr><td class="memItemLeft" nowrap align="right" valign="top">double </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceVISU_1_1ColoredPrs3d.html#75cb62b325060b5d268159e53e7a9de4">GetHeight</a> ()</td></tr>
60 <tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceVISU_1_1ColoredPrs3d.html#caf0e43c7f94f9c3c2a2482a1ab0db06">SetNbColors</a> (in long theNbColors)</td></tr>
62 <tr><td class="memItemLeft" nowrap align="right" valign="top">long </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceVISU_1_1ColoredPrs3d.html#2164a8ce3d888c7ac6b3644c0b7347c2">GetNbColors</a> ()</td></tr>
64 <tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceVISU_1_1ColoredPrs3d.html#21dd013631e20ce6c72368e7ac568802">SetLabels</a> (in long theNbLabels)</td></tr>
66 <tr><td class="memItemLeft" nowrap align="right" valign="top">long </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceVISU_1_1ColoredPrs3d.html#085c23900301c3a4eb274584ee7d8ca6">GetLabels</a> ()</td></tr>
68 <tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceVISU_1_1ColoredPrs3d.html#449207525dc96443b81f42cef38047dd">SetTitle</a> (in string theName)</td></tr>
70 <tr><td class="memItemLeft" nowrap align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceVISU_1_1ColoredPrs3d.html#3618c82757da8f8471dd20ab13cbc27b">GetTitle</a> ()</td></tr>
72 <tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceVISU_1_1Prs3d.html#347812588c93643946de30dfc62cf765">SetOffset</a> (in float theDx, in float theDy, in float theDz)</td></tr>
74 <tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceVISU_1_1Prs3d.html#fec212476adf7396e8672ae1c3e7fb78">GetOffset</a> (out float theDx, out float theDy, out float theDz)</td></tr>
76 <tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceVISU_1_1RemovableObject.html#7d053f4324b26edd325024cd45424f13">RemoveFromStudy</a> ()</td></tr>
78 <tr><td class="memItemLeft" nowrap align="right" valign="top">IdType </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceVISU_1_1Base.html#5da28cc23f3657dd24a3b8598319c522">GetID</a> ()</td></tr>
80 <tr><td class="memItemLeft" nowrap align="right" valign="top">VISUType </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceVISU_1_1Base.html#6f62d77b0451737114b5a10bf23be21e">GetType</a> ()</td></tr>
83 <hr><a name="_details"></a><h2>Detailed Description</h2>
84 This interface is responsable for coloring of 3D field presentations according the scalar values applied to different cells. As well it contains presentation parameters of the scalar bar. The scalar bar is displayed along with each colored field presentation and serves for consulting the correspondance between colors and data values.
86 <hr><h2>Member Enumeration Documentation</h2>
87 <a class="anchor" name="f772d6f2c08313f1cf5fdf29e7924f72"></a><!-- doxytag: member="VISU::ScalarMap::Orientation" ref="f772d6f2c08313f1cf5fdf29e7924f72" args="" --><p>
88 <table class="mdTable" cellpadding="2" cellspacing="0">
91 <table cellpadding="0" cellspacing="0" border="0">
93 <td class="md" nowrap valign="top">enum <a class="el" href="interfaceVISU_1_1ScalarMap.html#f772d6f2c08313f1cf5fdf29e7924f72">VISU::ScalarMap::Orientation</a> </td>
99 <table cellspacing="5" cellpadding="0" border="0">
107 Orientation of the scalar bar (to provide backward compatibility). <dl compact><dt><b>Enumerator: </b></dt><dd>
108 <table border="0" cellspacing="2" cellpadding="0">
109 <tr><td valign="top"><em><a class="anchor" name="f772d6f2c08313f1cf5fdf29e7924f7285eb3ae7cd8746a335d44f2c242f405d"></a><!-- doxytag: member="HORIZONTAL" ref="f772d6f2c08313f1cf5fdf29e7924f7285eb3ae7cd8746a335d44f2c242f405d" args="" -->HORIZONTAL</em> </td><td>
110 Horizontal orientation of the scalar bar. </td></tr>
111 <tr><td valign="top"><em><a class="anchor" name="f772d6f2c08313f1cf5fdf29e7924f72f2a821d4ca82c4052bf55b6869225f3a"></a><!-- doxytag: member="VERTICAL" ref="f772d6f2c08313f1cf5fdf29e7924f72f2a821d4ca82c4052bf55b6869225f3a" args="" -->VERTICAL</em> </td><td>
112 Vertical orientation of the scalar bar. </td></tr>
117 Implemented in <a class="el" href="interfaceVISU_1_1Plot3D.html#7fd6d4048589d7e44364c1d3070a5713">VISU.Plot3D</a>, and <a class="el" href="interfaceVISU_1_1CutPlanes.html#e6323ddacff1f78376488b92a5cdd3d8">VISU.CutPlanes</a>. </td>
120 <hr><h2>Member Function Documentation</h2>
121 <a class="anchor" name="533517f061d61d34128a7ebd40ec3df2"></a><!-- doxytag: member="VISU::ScalarMap::SetScaling" ref="533517f061d61d34128a7ebd40ec3df2" args="(in Scaling theScaling)" --><p>
122 <table class="mdTable" cellpadding="2" cellspacing="0">
125 <table cellpadding="0" cellspacing="0" border="0">
127 <td class="md" nowrap valign="top">void VISU.ScalarMap.SetScaling </td>
128 <td class="md" valign="top">( </td>
129 <td class="md" nowrap valign="top">in Scaling </td>
130 <td class="mdname1" valign="top" nowrap> <em>theScaling</em> </td>
131 <td class="md" valign="top"> ) </td>
132 <td class="md" nowrap></td>
138 <table cellspacing="5" cellpadding="0" border="0">
146 Sets the type of scaling of the values reflected by the scalar bar. <dl compact><dt><b>Parameters:</b></dt><dd>
147 <table border="0" cellspacing="2" cellpadding="0">
148 <tr><td valign="top"></td><td valign="top"><em>theScaling</em> </td><td>The value of this parameter is taken from the <em>Scaling</em> enumeration. </td></tr>
154 <a class="anchor" name="af368a29e0046f847a2af205e7040c23"></a><!-- doxytag: member="VISU::ScalarMap::GetScaling" ref="af368a29e0046f847a2af205e7040c23" args="()" --><p>
155 <table class="mdTable" cellpadding="2" cellspacing="0">
158 <table cellpadding="0" cellspacing="0" border="0">
160 <td class="md" nowrap valign="top">Scaling VISU.ScalarMap.GetScaling </td>
161 <td class="md" valign="top">( </td>
162 <td class="mdname1" valign="top" nowrap> </td>
163 <td class="md" valign="top"> ) </td>
164 <td class="md" nowrap></td>
170 <table cellspacing="5" cellpadding="0" border="0">
178 Gets the type of scaling of the values reflected by this presentation. </td>
181 <a class="anchor" name="76016f8035d5fb342c64b13ca2e30a66"></a><!-- doxytag: member="VISU::ScalarMap::SetRange" ref="76016f8035d5fb342c64b13ca2e30a66" args="(in double theMin, in double theMax)" --><p>
182 <table class="mdTable" cellpadding="2" cellspacing="0">
185 <table cellpadding="0" cellspacing="0" border="0">
187 <td class="md" nowrap valign="top">void VISU.ScalarMap.SetRange </td>
188 <td class="md" valign="top">( </td>
189 <td class="md" nowrap valign="top">in double </td>
190 <td class="mdname" nowrap> <em>theMin</em>, </td>
193 <td class="md" nowrap align="right"></td>
195 <td class="md" nowrap>in double </td>
196 <td class="mdname" nowrap> <em>theMax</em></td>
200 <td class="md">) </td>
201 <td class="md" colspan="2"></td>
207 <table cellspacing="5" cellpadding="0" border="0">
215 Sets scalar range - min and max boundaries of the scalar bar. <dl compact><dt><b>Parameters:</b></dt><dd>
216 <table border="0" cellspacing="2" cellpadding="0">
217 <tr><td valign="top"></td><td valign="top"><em>theMin</em> </td><td>Min boundary of the scalar bar. </td></tr>
218 <tr><td valign="top"></td><td valign="top"><em>theMax</em> </td><td>Max boundary of the scalar bar. </td></tr>
224 <a class="anchor" name="a6ed1b0bab197328075cf1010c176fe4"></a><!-- doxytag: member="VISU::ScalarMap::SetBarOrientation" ref="a6ed1b0bab197328075cf1010c176fe4" args="(in Orientation theOrientation)" --><p>
225 <table class="mdTable" cellpadding="2" cellspacing="0">
228 <table cellpadding="0" cellspacing="0" border="0">
230 <td class="md" nowrap valign="top">void VISU.ScalarMap.SetBarOrientation </td>
231 <td class="md" valign="top">( </td>
232 <td class="md" nowrap valign="top">in <a class="el" href="interfaceVISU_1_1ScalarMap.html#f772d6f2c08313f1cf5fdf29e7924f72">Orientation</a> </td>
233 <td class="mdname1" valign="top" nowrap> <em>theOrientation</em> </td>
234 <td class="md" valign="top"> ) </td>
235 <td class="md" nowrap></td>
241 <table cellspacing="5" cellpadding="0" border="0">
249 Sets the type of orientation of the scalar bar (to provide backward compatibility). <dl compact><dt><b>Parameters:</b></dt><dd>
250 <table border="0" cellspacing="2" cellpadding="0">
251 <tr><td valign="top"></td><td valign="top"><em>theOrientation</em> </td><td>This parameter defines the orientation of the scalar bar. It is taken from the <em>Orientaton</em> enumeration. </td></tr>
257 <a class="anchor" name="de70daa2d7a203a5b939a3c063ff07bf"></a><!-- doxytag: member="VISU::ScalarMap::GetBarOrientation" ref="de70daa2d7a203a5b939a3c063ff07bf" args="()" --><p>
258 <table class="mdTable" cellpadding="2" cellspacing="0">
261 <table cellpadding="0" cellspacing="0" border="0">
263 <td class="md" nowrap valign="top"><a class="el" href="interfaceVISU_1_1ScalarMap.html#f772d6f2c08313f1cf5fdf29e7924f72">Orientation</a> VISU.ScalarMap.GetBarOrientation </td>
264 <td class="md" valign="top">( </td>
265 <td class="mdname1" valign="top" nowrap> </td>
266 <td class="md" valign="top"> ) </td>
267 <td class="md" nowrap></td>
273 <table cellspacing="5" cellpadding="0" border="0">
281 Gets the type of orientation of the scalar bar (to provide backward compatibility). </td>
284 <a class="anchor" name="0cb01513d53cac1cf26699344580962a"></a><!-- doxytag: member="VISU::ScalarMap::SetScalarMode" ref="0cb01513d53cac1cf26699344580962a" args="(in long theScalarMode)" --><p>
285 <table class="mdTable" cellpadding="2" cellspacing="0">
288 <table cellpadding="0" cellspacing="0" border="0">
290 <td class="md" nowrap valign="top">void VISU.ColoredPrs3d.SetScalarMode </td>
291 <td class="md" valign="top">( </td>
292 <td class="md" nowrap valign="top">in long </td>
293 <td class="mdname1" valign="top" nowrap> <em>theScalarMode</em> </td>
294 <td class="md" valign="top"> ) </td>
295 <td class="md" nowrap><code> [inherited]</code></td>
301 <table cellspacing="5" cellpadding="0" border="0">
309 Sets the method of coloring of the elements composing a 3D presentation. </td>
312 <a class="anchor" name="bd7047f0543f356e7e0853285679c8a0"></a><!-- doxytag: member="VISU::ScalarMap::GetScalarMode" ref="bd7047f0543f356e7e0853285679c8a0" args="()" --><p>
313 <table class="mdTable" cellpadding="2" cellspacing="0">
316 <table cellpadding="0" cellspacing="0" border="0">
318 <td class="md" nowrap valign="top">long VISU.ColoredPrs3d.GetScalarMode </td>
319 <td class="md" valign="top">( </td>
320 <td class="mdname1" valign="top" nowrap> </td>
321 <td class="md" valign="top"> ) </td>
322 <td class="md" nowrap><code> [inherited]</code></td>
328 <table cellspacing="5" cellpadding="0" border="0">
336 Gets the method of coloring of the elements composing a 3D presentation. </td>
339 <a class="anchor" name="df97f8522a471c2e90470584cf7c92d9"></a><!-- doxytag: member="VISU::ScalarMap::GetMin" ref="df97f8522a471c2e90470584cf7c92d9" args="()" --><p>
340 <table class="mdTable" cellpadding="2" cellspacing="0">
343 <table cellpadding="0" cellspacing="0" border="0">
345 <td class="md" nowrap valign="top">double VISU.ColoredPrs3d.GetMin </td>
346 <td class="md" valign="top">( </td>
347 <td class="mdname1" valign="top" nowrap> </td>
348 <td class="md" valign="top"> ) </td>
349 <td class="md" nowrap><code> [inherited]</code></td>
355 <table cellspacing="5" cellpadding="0" border="0">
363 Gets the min boundary of the scalar bar. </td>
366 <a class="anchor" name="294cd1fcd6a6c21d76a6d03dc28b5a85"></a><!-- doxytag: member="VISU::ScalarMap::GetMax" ref="294cd1fcd6a6c21d76a6d03dc28b5a85" args="()" --><p>
367 <table class="mdTable" cellpadding="2" cellspacing="0">
370 <table cellpadding="0" cellspacing="0" border="0">
372 <td class="md" nowrap valign="top">double VISU.ColoredPrs3d.GetMax </td>
373 <td class="md" valign="top">( </td>
374 <td class="mdname1" valign="top" nowrap> </td>
375 <td class="md" valign="top"> ) </td>
376 <td class="md" nowrap><code> [inherited]</code></td>
382 <table cellspacing="5" cellpadding="0" border="0">
390 Gets the max boundary of the scalar bar. </td>
393 <a class="anchor" name="e5d7bfff180529eedad1a140e5a449c3"></a><!-- doxytag: member="VISU::ScalarMap::SetPosition" ref="e5d7bfff180529eedad1a140e5a449c3" args="(in double X, in double Y)" --><p>
394 <table class="mdTable" cellpadding="2" cellspacing="0">
397 <table cellpadding="0" cellspacing="0" border="0">
399 <td class="md" nowrap valign="top">void VISU.ColoredPrs3d.SetPosition </td>
400 <td class="md" valign="top">( </td>
401 <td class="md" nowrap valign="top">in double </td>
402 <td class="mdname" nowrap> <em>X</em>, </td>
405 <td class="md" nowrap align="right"></td>
407 <td class="md" nowrap>in double </td>
408 <td class="mdname" nowrap> <em>Y</em></td>
412 <td class="md">) </td>
413 <td class="md" colspan="2"><code> [inherited]</code></td>
419 <table cellspacing="5" cellpadding="0" border="0">
427 Sets the position of the scalar bar origin on the screen. <dl compact><dt><b>Parameters:</b></dt><dd>
428 <table border="0" cellspacing="2" cellpadding="0">
429 <tr><td valign="top"></td><td valign="top"><em>X</em> </td><td>Horizontal position. The value can be between 0 and 1. </td></tr>
430 <tr><td valign="top"></td><td valign="top"><em>Y</em> </td><td>Vertical position. The value can be between 0 and 1. </td></tr>
436 <a class="anchor" name="ddd48392a778ada1e0153ddcc781edbc"></a><!-- doxytag: member="VISU::ScalarMap::GetPosX" ref="ddd48392a778ada1e0153ddcc781edbc" args="()" --><p>
437 <table class="mdTable" cellpadding="2" cellspacing="0">
440 <table cellpadding="0" cellspacing="0" border="0">
442 <td class="md" nowrap valign="top">double VISU.ColoredPrs3d.GetPosX </td>
443 <td class="md" valign="top">( </td>
444 <td class="mdname1" valign="top" nowrap> </td>
445 <td class="md" valign="top"> ) </td>
446 <td class="md" nowrap><code> [inherited]</code></td>
452 <table cellspacing="5" cellpadding="0" border="0">
460 Gets horizontal position of the scalar bar origin. </td>
463 <a class="anchor" name="a20c6859e00c881a7db6fa3259a33e51"></a><!-- doxytag: member="VISU::ScalarMap::GetPosY" ref="a20c6859e00c881a7db6fa3259a33e51" args="()" --><p>
464 <table class="mdTable" cellpadding="2" cellspacing="0">
467 <table cellpadding="0" cellspacing="0" border="0">
469 <td class="md" nowrap valign="top">double VISU.ColoredPrs3d.GetPosY </td>
470 <td class="md" valign="top">( </td>
471 <td class="mdname1" valign="top" nowrap> </td>
472 <td class="md" valign="top"> ) </td>
473 <td class="md" nowrap><code> [inherited]</code></td>
479 <table cellspacing="5" cellpadding="0" border="0">
487 Gets vertical position of the scalar bar origin. </td>
490 <a class="anchor" name="e9331edc9bb097dd99556ee27735710c"></a><!-- doxytag: member="VISU::ScalarMap::SetSize" ref="e9331edc9bb097dd99556ee27735710c" args="(in double theWidth, in double theHeight)" --><p>
491 <table class="mdTable" cellpadding="2" cellspacing="0">
494 <table cellpadding="0" cellspacing="0" border="0">
496 <td class="md" nowrap valign="top">void VISU.ColoredPrs3d.SetSize </td>
497 <td class="md" valign="top">( </td>
498 <td class="md" nowrap valign="top">in double </td>
499 <td class="mdname" nowrap> <em>theWidth</em>, </td>
502 <td class="md" nowrap align="right"></td>
504 <td class="md" nowrap>in double </td>
505 <td class="mdname" nowrap> <em>theHeight</em></td>
509 <td class="md">) </td>
510 <td class="md" colspan="2"><code> [inherited]</code></td>
516 <table cellspacing="5" cellpadding="0" border="0">
524 Sets the size of the scalar bar. <dl compact><dt><b>Parameters:</b></dt><dd>
525 <table border="0" cellspacing="2" cellpadding="0">
526 <tr><td valign="top"></td><td valign="top"><em>theWidth</em> </td><td>Width of this presentable object. The value can be between 0 and 1. </td></tr>
527 <tr><td valign="top"></td><td valign="top"><em>theHeight</em> </td><td>Height of this presentable object. The value can be between 0 and 1. </td></tr>
533 <a class="anchor" name="fb5593e03da36959bcd7ac2e25c387ef"></a><!-- doxytag: member="VISU::ScalarMap::GetWidth" ref="fb5593e03da36959bcd7ac2e25c387ef" args="()" --><p>
534 <table class="mdTable" cellpadding="2" cellspacing="0">
537 <table cellpadding="0" cellspacing="0" border="0">
539 <td class="md" nowrap valign="top">double VISU.ColoredPrs3d.GetWidth </td>
540 <td class="md" valign="top">( </td>
541 <td class="mdname1" valign="top" nowrap> </td>
542 <td class="md" valign="top"> ) </td>
543 <td class="md" nowrap><code> [inherited]</code></td>
549 <table cellspacing="5" cellpadding="0" border="0">
557 Gets the width of this presentable object. <dl compact><dt><b>Returns:</b></dt><dd>A double value corresponding to the width of this presentable object. </dd></dl>
561 <a class="anchor" name="75cb62b325060b5d268159e53e7a9de4"></a><!-- doxytag: member="VISU::ScalarMap::GetHeight" ref="75cb62b325060b5d268159e53e7a9de4" args="()" --><p>
562 <table class="mdTable" cellpadding="2" cellspacing="0">
565 <table cellpadding="0" cellspacing="0" border="0">
567 <td class="md" nowrap valign="top">double VISU.ColoredPrs3d.GetHeight </td>
568 <td class="md" valign="top">( </td>
569 <td class="mdname1" valign="top" nowrap> </td>
570 <td class="md" valign="top"> ) </td>
571 <td class="md" nowrap><code> [inherited]</code></td>
577 <table cellspacing="5" cellpadding="0" border="0">
585 Gets the height of this presentable object. <dl compact><dt><b>Returns:</b></dt><dd>A double value corresponding to the height of this presentable object. </dd></dl>
589 <a class="anchor" name="caf0e43c7f94f9c3c2a2482a1ab0db06"></a><!-- doxytag: member="VISU::ScalarMap::SetNbColors" ref="caf0e43c7f94f9c3c2a2482a1ab0db06" args="(in long theNbColors)" --><p>
590 <table class="mdTable" cellpadding="2" cellspacing="0">
593 <table cellpadding="0" cellspacing="0" border="0">
595 <td class="md" nowrap valign="top">void VISU.ColoredPrs3d.SetNbColors </td>
596 <td class="md" valign="top">( </td>
597 <td class="md" nowrap valign="top">in long </td>
598 <td class="mdname1" valign="top" nowrap> <em>theNbColors</em> </td>
599 <td class="md" valign="top"> ) </td>
600 <td class="md" nowrap><code> [inherited]</code></td>
606 <table cellspacing="5" cellpadding="0" border="0">
614 Sets the number of colors which will be used for presentation of this presentable object. <dl compact><dt><b>Parameters:</b></dt><dd>
615 <table border="0" cellspacing="2" cellpadding="0">
616 <tr><td valign="top"></td><td valign="top"><em>theNbColors</em> </td><td>A long value defining the number of colors. </td></tr>
622 <a class="anchor" name="2164a8ce3d888c7ac6b3644c0b7347c2"></a><!-- doxytag: member="VISU::ScalarMap::GetNbColors" ref="2164a8ce3d888c7ac6b3644c0b7347c2" args="()" --><p>
623 <table class="mdTable" cellpadding="2" cellspacing="0">
626 <table cellpadding="0" cellspacing="0" border="0">
628 <td class="md" nowrap valign="top">long VISU.ColoredPrs3d.GetNbColors </td>
629 <td class="md" valign="top">( </td>
630 <td class="mdname1" valign="top" nowrap> </td>
631 <td class="md" valign="top"> ) </td>
632 <td class="md" nowrap><code> [inherited]</code></td>
638 <table cellspacing="5" cellpadding="0" border="0">
646 Gets the number of colors which will be used for visualization of this presentable object. <dl compact><dt><b>Returns:</b></dt><dd>A long value corresponding to the number of colors which will be used for visualization of this presentable object. </dd></dl>
650 <a class="anchor" name="21dd013631e20ce6c72368e7ac568802"></a><!-- doxytag: member="VISU::ScalarMap::SetLabels" ref="21dd013631e20ce6c72368e7ac568802" args="(in long theNbLabels)" --><p>
651 <table class="mdTable" cellpadding="2" cellspacing="0">
654 <table cellpadding="0" cellspacing="0" border="0">
656 <td class="md" nowrap valign="top">void VISU.ColoredPrs3d.SetLabels </td>
657 <td class="md" valign="top">( </td>
658 <td class="md" nowrap valign="top">in long </td>
659 <td class="mdname1" valign="top" nowrap> <em>theNbLabels</em> </td>
660 <td class="md" valign="top"> ) </td>
661 <td class="md" nowrap><code> [inherited]</code></td>
667 <table cellspacing="5" cellpadding="0" border="0">
675 Sets the number of labels which will be used for indication of color gradation of the scalar bar. <dl compact><dt><b>Parameters:</b></dt><dd>
676 <table border="0" cellspacing="2" cellpadding="0">
677 <tr><td valign="top"></td><td valign="top"><em>theNbLabels</em> </td><td>A long value defining the number of labels. </td></tr>
683 <a class="anchor" name="085c23900301c3a4eb274584ee7d8ca6"></a><!-- doxytag: member="VISU::ScalarMap::GetLabels" ref="085c23900301c3a4eb274584ee7d8ca6" args="()" --><p>
684 <table class="mdTable" cellpadding="2" cellspacing="0">
687 <table cellpadding="0" cellspacing="0" border="0">
689 <td class="md" nowrap valign="top">long VISU.ColoredPrs3d.GetLabels </td>
690 <td class="md" valign="top">( </td>
691 <td class="mdname1" valign="top" nowrap> </td>
692 <td class="md" valign="top"> ) </td>
693 <td class="md" nowrap><code> [inherited]</code></td>
699 <table cellspacing="5" cellpadding="0" border="0">
707 Gets the number of labels which will be used for indication of color gradation of the scalar bar. <dl compact><dt><b>Returns:</b></dt><dd>A long value corresponding to the number of labels which will be used for indication of color gradation of the scalar bar. </dd></dl>
711 <a class="anchor" name="449207525dc96443b81f42cef38047dd"></a><!-- doxytag: member="VISU::ScalarMap::SetTitle" ref="449207525dc96443b81f42cef38047dd" args="(in string theName)" --><p>
712 <table class="mdTable" cellpadding="2" cellspacing="0">
715 <table cellpadding="0" cellspacing="0" border="0">
717 <td class="md" nowrap valign="top">void VISU.ColoredPrs3d.SetTitle </td>
718 <td class="md" valign="top">( </td>
719 <td class="md" nowrap valign="top">in string </td>
720 <td class="mdname1" valign="top" nowrap> <em>theName</em> </td>
721 <td class="md" valign="top"> ) </td>
722 <td class="md" nowrap><code> [inherited]</code></td>
728 <table cellspacing="5" cellpadding="0" border="0">
736 Sets the title of the scalar bar. By default - the name of the selected result is used. <dl compact><dt><b>Parameters:</b></dt><dd>
737 <table border="0" cellspacing="2" cellpadding="0">
738 <tr><td valign="top"></td><td valign="top"><em>theName</em> </td><td>String parameter defining the name of the scalar bar. </td></tr>
744 <a class="anchor" name="3618c82757da8f8471dd20ab13cbc27b"></a><!-- doxytag: member="VISU::ScalarMap::GetTitle" ref="3618c82757da8f8471dd20ab13cbc27b" args="()" --><p>
745 <table class="mdTable" cellpadding="2" cellspacing="0">
748 <table cellpadding="0" cellspacing="0" border="0">
750 <td class="md" nowrap valign="top">string VISU.ColoredPrs3d.GetTitle </td>
751 <td class="md" valign="top">( </td>
752 <td class="mdname1" valign="top" nowrap> </td>
753 <td class="md" valign="top"> ) </td>
754 <td class="md" nowrap><code> [inherited]</code></td>
760 <table cellspacing="5" cellpadding="0" border="0">
768 Gets the title of the scalar bar. </td>
771 <a class="anchor" name="347812588c93643946de30dfc62cf765"></a><!-- doxytag: member="VISU::ScalarMap::SetOffset" ref="347812588c93643946de30dfc62cf765" args="(in float theDx, in float theDy, in float theDz)" --><p>
772 <table class="mdTable" cellpadding="2" cellspacing="0">
775 <table cellpadding="0" cellspacing="0" border="0">
777 <td class="md" nowrap valign="top">void VISU.Prs3d.SetOffset </td>
778 <td class="md" valign="top">( </td>
779 <td class="md" nowrap valign="top">in float </td>
780 <td class="mdname" nowrap> <em>theDx</em>, </td>
783 <td class="md" nowrap align="right"></td>
785 <td class="md" nowrap>in float </td>
786 <td class="mdname" nowrap> <em>theDy</em>, </td>
789 <td class="md" nowrap align="right"></td>
791 <td class="md" nowrap>in float </td>
792 <td class="mdname" nowrap> <em>theDz</em></td>
796 <td class="md">) </td>
797 <td class="md" colspan="2"><code> [inherited]</code></td>
803 <table cellspacing="5" cellpadding="0" border="0">
814 <a class="anchor" name="fec212476adf7396e8672ae1c3e7fb78"></a><!-- doxytag: member="VISU::ScalarMap::GetOffset" ref="fec212476adf7396e8672ae1c3e7fb78" args="(out float theDx, out float theDy, out float theDz)" --><p>
815 <table class="mdTable" cellpadding="2" cellspacing="0">
818 <table cellpadding="0" cellspacing="0" border="0">
820 <td class="md" nowrap valign="top">void VISU.Prs3d.GetOffset </td>
821 <td class="md" valign="top">( </td>
822 <td class="md" nowrap valign="top">out float </td>
823 <td class="mdname" nowrap> <em>theDx</em>, </td>
826 <td class="md" nowrap align="right"></td>
828 <td class="md" nowrap>out float </td>
829 <td class="mdname" nowrap> <em>theDy</em>, </td>
832 <td class="md" nowrap align="right"></td>
834 <td class="md" nowrap>out float </td>
835 <td class="mdname" nowrap> <em>theDz</em></td>
839 <td class="md">) </td>
840 <td class="md" colspan="2"><code> [inherited]</code></td>
846 <table cellspacing="5" cellpadding="0" border="0">
857 <a class="anchor" name="7d053f4324b26edd325024cd45424f13"></a><!-- doxytag: member="VISU::ScalarMap::RemoveFromStudy" ref="7d053f4324b26edd325024cd45424f13" args="()" --><p>
858 <table class="mdTable" cellpadding="2" cellspacing="0">
861 <table cellpadding="0" cellspacing="0" border="0">
863 <td class="md" nowrap valign="top">void VISU.RemovableObject.RemoveFromStudy </td>
864 <td class="md" valign="top">( </td>
865 <td class="mdname1" valign="top" nowrap> </td>
866 <td class="md" valign="top"> ) </td>
867 <td class="md" nowrap><code> [inherited]</code></td>
873 <table cellspacing="5" cellpadding="0" border="0">
881 Remove object from study. </td>
884 <a class="anchor" name="5da28cc23f3657dd24a3b8598319c522"></a><!-- doxytag: member="VISU::ScalarMap::GetID" ref="5da28cc23f3657dd24a3b8598319c522" args="()" --><p>
885 <table class="mdTable" cellpadding="2" cellspacing="0">
888 <table cellpadding="0" cellspacing="0" border="0">
890 <td class="md" nowrap valign="top">IdType VISU.Base.GetID </td>
891 <td class="md" valign="top">( </td>
892 <td class="mdname1" valign="top" nowrap> </td>
893 <td class="md" valign="top"> ) </td>
894 <td class="md" nowrap><code> [inherited]</code></td>
900 <table cellspacing="5" cellpadding="0" border="0">
908 Returns ID of the object. </td>
911 <a class="anchor" name="6f62d77b0451737114b5a10bf23be21e"></a><!-- doxytag: member="VISU::ScalarMap::GetType" ref="6f62d77b0451737114b5a10bf23be21e" args="()" --><p>
912 <table class="mdTable" cellpadding="2" cellspacing="0">
915 <table cellpadding="0" cellspacing="0" border="0">
917 <td class="md" nowrap valign="top">VISUType VISU.Base.GetType </td>
918 <td class="md" valign="top">( </td>
919 <td class="mdname1" valign="top" nowrap> </td>
920 <td class="md" valign="top"> ) </td>
921 <td class="md" nowrap><code> [inherited]</code></td>
927 <table cellspacing="5" cellpadding="0" border="0">
935 Returns the type of the presentable object </td>