doc/salome/gui/VISU/visugenidl_doc/interfaceVISU_1_1Mesh.html

   1 <!doctype html public "-//w3c//dtd html 4.0 transitional//en">
   2 <html>
   3 <head>
   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">
   8 </head>
   9 <body>
  10 &nbsp;
  11 </body>
  12 </html>
  13 <!-- Generated by Doxygen 1.4.6 -->
  14 <h1>VISU.Mesh Interface Reference</h1><!-- doxytag: class="VISU::Mesh" --><!-- doxytag: inherits="VISU::Prs3d" -->Interface of the mesh.
  15 <a href="#_details">More...</a>
  16 <p>
  17 <code>import &quot;<a class="el" href="VISU__Gen_8idl-source.html">VISU_Gen.idl</a>&quot;;</code>
  18 <p>
  19 Inheritance diagram for VISU.Mesh:<p><center><img src="interfaceVISU_1_1Mesh__inherit__graph.jpg" border="0" alt="Inheritance graph"></center>
  20 <table border="0" cellpadding="0" cellspacing="0">
  21 <tr><td></td></tr>
  22 <tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
  23 <tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceVISU_1_1Mesh.html#94a807af486d9f98f87cb2378da457b8">SetCellColor</a> (in SALOMEDS::Color theColor)</td></tr>
  24
  25 <tr><td class="memItemLeft" nowrap align="right" valign="top">SALOMEDS::Color&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceVISU_1_1Mesh.html#7cd1fb68ad3a990c6163e41439306cd2">GetCellColor</a> ()</td></tr>
  26
  27 <tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceVISU_1_1Mesh.html#d00acdc4bbbcb15a9047629ff95d0f5e">SetNodeColor</a> (in SALOMEDS::Color theColor)</td></tr>
  28
  29 <tr><td class="memItemLeft" nowrap align="right" valign="top">SALOMEDS::Color&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceVISU_1_1Mesh.html#cf933e539fb7e3a3e544fad8c6bb1446">GetNodeColor</a> ()</td></tr>
  30
  31 <tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceVISU_1_1Mesh.html#099e0c5c12343ecef6c53a99aa49a29b">SetLinkColor</a> (in SALOMEDS::Color theColor)</td></tr>
  32
  33 <tr><td class="memItemLeft" nowrap align="right" valign="top">SALOMEDS::Color&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceVISU_1_1Mesh.html#659e1a3b6e17ccb78a4a04897c5b6643">GetLinkColor</a> ()</td></tr>
  34
  35 <tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceVISU_1_1Mesh.html#d53d47a80d086867b78f2b87f51eb6f0">SetPresentationType</a> (in PresentationType theType)</td></tr>
  36
  37 <tr><td class="memItemLeft" nowrap align="right" valign="top">PresentationType&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceVISU_1_1Mesh.html#076b35153202b948820538a2d00136e3">GetPresentationType</a> ()</td></tr>
  38
  39 <tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</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>
  40
  41 <tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</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>
  42
  43 <tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceVISU_1_1RemovableObject.html#7d053f4324b26edd325024cd45424f13">RemoveFromStudy</a> ()</td></tr>
  44
  45 <tr><td class="memItemLeft" nowrap align="right" valign="top">IdType&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceVISU_1_1Base.html#5da28cc23f3657dd24a3b8598319c522">GetID</a> ()</td></tr>
  46
  47 <tr><td class="memItemLeft" nowrap align="right" valign="top">VISUType&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceVISU_1_1Base.html#6f62d77b0451737114b5a10bf23be21e">GetType</a> ()</td></tr>
  48
  49 </table>
  50 <hr><a name="_details"></a><h2>Detailed Description</h2>
  51 Manages presentation parameters of a 3D presentation of a mesh. This object can be used for presentation of set of curves using <a class="el" href="interfaceVISU_1_1Container.html">Container</a> class.
  52 <p>
  53 <hr><h2>Member Function Documentation</h2>
  54 <a class="anchor" name="94a807af486d9f98f87cb2378da457b8"></a><!-- doxytag: member="VISU::Mesh::SetCellColor" ref="94a807af486d9f98f87cb2378da457b8" args="(in SALOMEDS::Color theColor)" --><p>
  55 <table class="mdTable" cellpadding="2" cellspacing="0">
  56   <tr>
  57     <td class="mdRow">
  58       <table cellpadding="0" cellspacing="0" border="0">
  59         <tr>
  60           <td class="md" nowrap valign="top">void VISU.Mesh.SetCellColor           </td>
  61           <td class="md" valign="top">(&nbsp;</td>
  62           <td class="md" nowrap valign="top">in SALOMEDS::Color&nbsp;</td>
  63           <td class="mdname1" valign="top" nowrap> <em>theColor</em>          </td>
  64           <td class="md" valign="top">&nbsp;)&nbsp;</td>
  65           <td class="md" nowrap></td>
  66         </tr>
  67       </table>
  68     </td>
  69   </tr>
  70 </table>
  71 <table cellspacing="5" cellpadding="0" border="0">
  72   <tr>
  73     <td>
  74       &nbsp;
  75     </td>
  76     <td>
  77
  78 <p>
  79 Sets the color of mesh cells. <dl compact><dt><b>Parameters:</b></dt><dd>
  80   <table border="0" cellspacing="2" cellpadding="0">
  81     <tr><td valign="top"></td><td valign="top"><em>theColor</em>&nbsp;</td><td>The color of the cells. This parameter is taken from <em>Color</em> enumeration. </td></tr>
  82   </table>
  83 </dl>
  84     </td>
  85   </tr>
  86 </table>
  87 <a class="anchor" name="7cd1fb68ad3a990c6163e41439306cd2"></a><!-- doxytag: member="VISU::Mesh::GetCellColor" ref="7cd1fb68ad3a990c6163e41439306cd2" args="()" --><p>
  88 <table class="mdTable" cellpadding="2" cellspacing="0">
  89   <tr>
  90     <td class="mdRow">
  91       <table cellpadding="0" cellspacing="0" border="0">
  92         <tr>
  93           <td class="md" nowrap valign="top">SALOMEDS::Color VISU.Mesh.GetCellColor           </td>
  94           <td class="md" valign="top">(&nbsp;</td>
  95           <td class="mdname1" valign="top" nowrap>          </td>
  96           <td class="md" valign="top">&nbsp;)&nbsp;</td>
  97           <td class="md" nowrap></td>
  98         </tr>
  99       </table>
 100     </td>
 101   </tr>
 102 </table>
 103 <table cellspacing="5" cellpadding="0" border="0">
 104   <tr>
 105     <td>
 106       &nbsp;
 107     </td>
 108     <td>
 109
 110 <p>
 111 Gets the color of mesh cells.     </td>
 112   </tr>
 113 </table>
 114 <a class="anchor" name="d00acdc4bbbcb15a9047629ff95d0f5e"></a><!-- doxytag: member="VISU::Mesh::SetNodeColor" ref="d00acdc4bbbcb15a9047629ff95d0f5e" args="(in SALOMEDS::Color theColor)" --><p>
 115 <table class="mdTable" cellpadding="2" cellspacing="0">
 116   <tr>
 117     <td class="mdRow">
 118       <table cellpadding="0" cellspacing="0" border="0">
 119         <tr>
 120           <td class="md" nowrap valign="top">void VISU.Mesh.SetNodeColor           </td>
 121           <td class="md" valign="top">(&nbsp;</td>
 122           <td class="md" nowrap valign="top">in SALOMEDS::Color&nbsp;</td>
 123           <td class="mdname1" valign="top" nowrap> <em>theColor</em>          </td>
 124           <td class="md" valign="top">&nbsp;)&nbsp;</td>
 125           <td class="md" nowrap></td>
 126         </tr>
 127       </table>
 128     </td>
 129   </tr>
 130 </table>
 131 <table cellspacing="5" cellpadding="0" border="0">
 132   <tr>
 133     <td>
 134       &nbsp;
 135     </td>
 136     <td>
 137
 138 <p>
 139 Sets the color of mesh nodes. <dl compact><dt><b>Parameters:</b></dt><dd>
 140   <table border="0" cellspacing="2" cellpadding="0">
 141     <tr><td valign="top"></td><td valign="top"><em>theColor</em>&nbsp;</td><td>The color of the nodes. This parameter is taken from <em>Color</em> enumeration. </td></tr>
 142   </table>
 143 </dl>
 144     </td>
 145   </tr>
 146 </table>
 147 <a class="anchor" name="cf933e539fb7e3a3e544fad8c6bb1446"></a><!-- doxytag: member="VISU::Mesh::GetNodeColor" ref="cf933e539fb7e3a3e544fad8c6bb1446" args="()" --><p>
 148 <table class="mdTable" cellpadding="2" cellspacing="0">
 149   <tr>
 150     <td class="mdRow">
 151       <table cellpadding="0" cellspacing="0" border="0">
 152         <tr>
 153           <td class="md" nowrap valign="top">SALOMEDS::Color VISU.Mesh.GetNodeColor           </td>
 154           <td class="md" valign="top">(&nbsp;</td>
 155           <td class="mdname1" valign="top" nowrap>          </td>
 156           <td class="md" valign="top">&nbsp;)&nbsp;</td>
 157           <td class="md" nowrap></td>
 158         </tr>
 159       </table>
 160     </td>
 161   </tr>
 162 </table>
 163 <table cellspacing="5" cellpadding="0" border="0">
 164   <tr>
 165     <td>
 166       &nbsp;
 167     </td>
 168     <td>
 169
 170 <p>
 171 Gets the color of mesh nodes.     </td>
 172   </tr>
 173 </table>
 174 <a class="anchor" name="099e0c5c12343ecef6c53a99aa49a29b"></a><!-- doxytag: member="VISU::Mesh::SetLinkColor" ref="099e0c5c12343ecef6c53a99aa49a29b" args="(in SALOMEDS::Color theColor)" --><p>
 175 <table class="mdTable" cellpadding="2" cellspacing="0">
 176   <tr>
 177     <td class="mdRow">
 178       <table cellpadding="0" cellspacing="0" border="0">
 179         <tr>
 180           <td class="md" nowrap valign="top">void VISU.Mesh.SetLinkColor           </td>
 181           <td class="md" valign="top">(&nbsp;</td>
 182           <td class="md" nowrap valign="top">in SALOMEDS::Color&nbsp;</td>
 183           <td class="mdname1" valign="top" nowrap> <em>theColor</em>          </td>
 184           <td class="md" valign="top">&nbsp;)&nbsp;</td>
 185           <td class="md" nowrap></td>
 186         </tr>
 187       </table>
 188     </td>
 189   </tr>
 190 </table>
 191 <table cellspacing="5" cellpadding="0" border="0">
 192   <tr>
 193     <td>
 194       &nbsp;
 195     </td>
 196     <td>
 197
 198 <p>
 199 Sets the color of mesh links. <dl compact><dt><b>Parameters:</b></dt><dd>
 200   <table border="0" cellspacing="2" cellpadding="0">
 201     <tr><td valign="top"></td><td valign="top"><em>theColor</em>&nbsp;</td><td>The color of the links. This parameter is taken from <em>Color</em> enumeration. </td></tr>
 202   </table>
 203 </dl>
 204     </td>
 205   </tr>
 206 </table>
 207 <a class="anchor" name="659e1a3b6e17ccb78a4a04897c5b6643"></a><!-- doxytag: member="VISU::Mesh::GetLinkColor" ref="659e1a3b6e17ccb78a4a04897c5b6643" args="()" --><p>
 208 <table class="mdTable" cellpadding="2" cellspacing="0">
 209   <tr>
 210     <td class="mdRow">
 211       <table cellpadding="0" cellspacing="0" border="0">
 212         <tr>
 213           <td class="md" nowrap valign="top">SALOMEDS::Color VISU.Mesh.GetLinkColor           </td>
 214           <td class="md" valign="top">(&nbsp;</td>
 215           <td class="mdname1" valign="top" nowrap>          </td>
 216           <td class="md" valign="top">&nbsp;)&nbsp;</td>
 217           <td class="md" nowrap></td>
 218         </tr>
 219       </table>
 220     </td>
 221   </tr>
 222 </table>
 223 <table cellspacing="5" cellpadding="0" border="0">
 224   <tr>
 225     <td>
 226       &nbsp;
 227     </td>
 228     <td>
 229
 230 <p>
 231 Gets the color of mesh links.     </td>
 232   </tr>
 233 </table>
 234 <a class="anchor" name="d53d47a80d086867b78f2b87f51eb6f0"></a><!-- doxytag: member="VISU::Mesh::SetPresentationType" ref="d53d47a80d086867b78f2b87f51eb6f0" args="(in PresentationType theType)" --><p>
 235 <table class="mdTable" cellpadding="2" cellspacing="0">
 236   <tr>
 237     <td class="mdRow">
 238       <table cellpadding="0" cellspacing="0" border="0">
 239         <tr>
 240           <td class="md" nowrap valign="top">void VISU.Mesh.SetPresentationType           </td>
 241           <td class="md" valign="top">(&nbsp;</td>
 242           <td class="md" nowrap valign="top">in PresentationType&nbsp;</td>
 243           <td class="mdname1" valign="top" nowrap> <em>theType</em>          </td>
 244           <td class="md" valign="top">&nbsp;)&nbsp;</td>
 245           <td class="md" nowrap></td>
 246         </tr>
 247       </table>
 248     </td>
 249   </tr>
 250 </table>
 251 <table cellspacing="5" cellpadding="0" border="0">
 252   <tr>
 253     <td>
 254       &nbsp;
 255     </td>
 256     <td>
 257
 258 <p>
 259 Sets the type of representation of a mesh. <dl compact><dt><b>Parameters:</b></dt><dd>
 260   <table border="0" cellspacing="2" cellpadding="0">
 261     <tr><td valign="top"></td><td valign="top"><em>theType</em>&nbsp;</td><td>The of representation of a mesh. This parameter is taken from <em>PresentationType</em> enumeration. </td></tr>
 262   </table>
 263 </dl>
 264     </td>
 265   </tr>
 266 </table>
 267 <a class="anchor" name="076b35153202b948820538a2d00136e3"></a><!-- doxytag: member="VISU::Mesh::GetPresentationType" ref="076b35153202b948820538a2d00136e3" args="()" --><p>
 268 <table class="mdTable" cellpadding="2" cellspacing="0">
 269   <tr>
 270     <td class="mdRow">
 271       <table cellpadding="0" cellspacing="0" border="0">
 272         <tr>
 273           <td class="md" nowrap valign="top">PresentationType VISU.Mesh.GetPresentationType           </td>
 274           <td class="md" valign="top">(&nbsp;</td>
 275           <td class="mdname1" valign="top" nowrap>          </td>
 276           <td class="md" valign="top">&nbsp;)&nbsp;</td>
 277           <td class="md" nowrap></td>
 278         </tr>
 279       </table>
 280     </td>
 281   </tr>
 282 </table>
 283 <table cellspacing="5" cellpadding="0" border="0">
 284   <tr>
 285     <td>
 286       &nbsp;
 287     </td>
 288     <td>
 289
 290 <p>
 291 Gets the type of representation of the mesh. <dl compact><dt><b>Returns:</b></dt><dd>The type of representation of the mesh. </dd></dl>
 292     </td>
 293   </tr>
 294 </table>
 295 <a class="anchor" name="347812588c93643946de30dfc62cf765"></a><!-- doxytag: member="VISU::Mesh::SetOffset" ref="347812588c93643946de30dfc62cf765" args="(in float theDx, in float theDy, in float theDz)" --><p>
 296 <table class="mdTable" cellpadding="2" cellspacing="0">
 297   <tr>
 298     <td class="mdRow">
 299       <table cellpadding="0" cellspacing="0" border="0">
 300         <tr>
 301           <td class="md" nowrap valign="top">void VISU.Prs3d.SetOffset           </td>
 302           <td class="md" valign="top">(&nbsp;</td>
 303           <td class="md" nowrap valign="top">in float&nbsp;</td>
 304           <td class="mdname" nowrap> <em>theDx</em>, </td>
 305         </tr>
 306         <tr>
 307           <td class="md" nowrap align="right"></td>
 308           <td class="md"></td>
 309           <td class="md" nowrap>in float&nbsp;</td>
 310           <td class="mdname" nowrap> <em>theDy</em>, </td>
 311         </tr>
 312         <tr>
 313           <td class="md" nowrap align="right"></td>
 314           <td class="md"></td>
 315           <td class="md" nowrap>in float&nbsp;</td>
 316           <td class="mdname" nowrap> <em>theDz</em></td>
 317         </tr>
 318         <tr>
 319           <td class="md"></td>
 320           <td class="md">)&nbsp;</td>
 321           <td class="md" colspan="2"><code> [inherited]</code></td>
 322         </tr>
 323       </table>
 324     </td>
 325   </tr>
 326 </table>
 327 <table cellspacing="5" cellpadding="0" border="0">
 328   <tr>
 329     <td>
 330       &nbsp;
 331     </td>
 332     <td>
 333
 334 <p>
 335     </td>
 336   </tr>
 337 </table>
 338 <a class="anchor" name="fec212476adf7396e8672ae1c3e7fb78"></a><!-- doxytag: member="VISU::Mesh::GetOffset" ref="fec212476adf7396e8672ae1c3e7fb78" args="(out float theDx, out float theDy, out float theDz)" --><p>
 339 <table class="mdTable" cellpadding="2" cellspacing="0">
 340   <tr>
 341     <td class="mdRow">
 342       <table cellpadding="0" cellspacing="0" border="0">
 343         <tr>
 344           <td class="md" nowrap valign="top">void VISU.Prs3d.GetOffset           </td>
 345           <td class="md" valign="top">(&nbsp;</td>
 346           <td class="md" nowrap valign="top">out float&nbsp;</td>
 347           <td class="mdname" nowrap> <em>theDx</em>, </td>
 348         </tr>
 349         <tr>
 350           <td class="md" nowrap align="right"></td>
 351           <td class="md"></td>
 352           <td class="md" nowrap>out float&nbsp;</td>
 353           <td class="mdname" nowrap> <em>theDy</em>, </td>
 354         </tr>
 355         <tr>
 356           <td class="md" nowrap align="right"></td>
 357           <td class="md"></td>
 358           <td class="md" nowrap>out float&nbsp;</td>
 359           <td class="mdname" nowrap> <em>theDz</em></td>
 360         </tr>
 361         <tr>
 362           <td class="md"></td>
 363           <td class="md">)&nbsp;</td>
 364           <td class="md" colspan="2"><code> [inherited]</code></td>
 365         </tr>
 366       </table>
 367     </td>
 368   </tr>
 369 </table>
 370 <table cellspacing="5" cellpadding="0" border="0">
 371   <tr>
 372     <td>
 373       &nbsp;
 374     </td>
 375     <td>
 376
 377 <p>
 378     </td>
 379   </tr>
 380 </table>
 381 <a class="anchor" name="7d053f4324b26edd325024cd45424f13"></a><!-- doxytag: member="VISU::Mesh::RemoveFromStudy" ref="7d053f4324b26edd325024cd45424f13" args="()" --><p>
 382 <table class="mdTable" cellpadding="2" cellspacing="0">
 383   <tr>
 384     <td class="mdRow">
 385       <table cellpadding="0" cellspacing="0" border="0">
 386         <tr>
 387           <td class="md" nowrap valign="top">void VISU.RemovableObject.RemoveFromStudy           </td>
 388           <td class="md" valign="top">(&nbsp;</td>
 389           <td class="mdname1" valign="top" nowrap>          </td>
 390           <td class="md" valign="top">&nbsp;)&nbsp;</td>
 391           <td class="md" nowrap><code> [inherited]</code></td>
 392         </tr>
 393       </table>
 394     </td>
 395   </tr>
 396 </table>
 397 <table cellspacing="5" cellpadding="0" border="0">
 398   <tr>
 399     <td>
 400       &nbsp;
 401     </td>
 402     <td>
 403
 404 <p>
 405 Remove object from study.     </td>
 406   </tr>
 407 </table>
 408 <a class="anchor" name="5da28cc23f3657dd24a3b8598319c522"></a><!-- doxytag: member="VISU::Mesh::GetID" ref="5da28cc23f3657dd24a3b8598319c522" args="()" --><p>
 409 <table class="mdTable" cellpadding="2" cellspacing="0">
 410   <tr>
 411     <td class="mdRow">
 412       <table cellpadding="0" cellspacing="0" border="0">
 413         <tr>
 414           <td class="md" nowrap valign="top">IdType VISU.Base.GetID           </td>
 415           <td class="md" valign="top">(&nbsp;</td>
 416           <td class="mdname1" valign="top" nowrap>          </td>
 417           <td class="md" valign="top">&nbsp;)&nbsp;</td>
 418           <td class="md" nowrap><code> [inherited]</code></td>
 419         </tr>
 420       </table>
 421     </td>
 422   </tr>
 423 </table>
 424 <table cellspacing="5" cellpadding="0" border="0">
 425   <tr>
 426     <td>
 427       &nbsp;
 428     </td>
 429     <td>
 430
 431 <p>
 432 Returns ID of the object.     </td>
 433   </tr>
 434 </table>
 435 <a class="anchor" name="6f62d77b0451737114b5a10bf23be21e"></a><!-- doxytag: member="VISU::Mesh::GetType" ref="6f62d77b0451737114b5a10bf23be21e" args="()" --><p>
 436 <table class="mdTable" cellpadding="2" cellspacing="0">
 437   <tr>
 438     <td class="mdRow">
 439       <table cellpadding="0" cellspacing="0" border="0">
 440         <tr>
 441           <td class="md" nowrap valign="top">VISUType VISU.Base.GetType           </td>
 442           <td class="md" valign="top">(&nbsp;</td>
 443           <td class="mdname1" valign="top" nowrap>          </td>
 444           <td class="md" valign="top">&nbsp;)&nbsp;</td>
 445           <td class="md" nowrap><code> [inherited]</code></td>
 446         </tr>
 447       </table>
 448     </td>
 449   </tr>
 450 </table>
 451 <table cellspacing="5" cellpadding="0" border="0">
 452   <tr>
 453     <td>
 454       &nbsp;
 455     </td>
 456     <td>
 457
 458 <p>
 459 Returns the type of the presentable object     </td>
 460   </tr>
 461 </table>
 462 </DIV>
 463 </BODY>
 464 </HTML>