Sophie

Sophie

distrib > Mandriva > 2010.0 > i586 > media > contrib-release > by-pkgid > bad97183153701b09df5fae1052b1c30 > files > 3921

crystalspace-doc-1.2.1-5mdv2010.0.i586.rpm

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>Crystal Space 1.2.1: iTriangleMesh Struct Reference (Crystal Space 1.2.1 Public API Reference)</title>
<link href="tabs.css" rel="stylesheet" type="text/css">
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body>
<table border="0" cellpadding="0" cellspacing="0" width="100%" class="head">
 <tr height="59">
  <td class="head" width="202" valign="bottom" style="padding-left:0;"><a href="http://www.crystalspace3d.org/"><img src="csblur.png" width="236" height="59" alt="CrystalSpace" border="0"></a></td>
  <td class="head"><h2>Public API Reference</h2></td>
 </tr>
 <tr height="11">
  <td colspan="2" class="headshadow" valign="top" style="padding-left:0;"><img src="csblurb.png" width="236" height="11" alt="" border="0"></td>
 </tr>
</table>
<div class="content">
<!-- Generated by Doxygen 1.5.3 -->
<div class="tabs">
  <ul>
    <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
    <li><a href="modules.html"><span>Modules</span></a></li>
    <li><a href="namespaces.html"><span>Namespaces</span></a></li>
    <li class="current"><a href="classes.html"><span>Classes</span></a></li>
    <li><a href="files.html"><span>Files</span></a></li>
    <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
  </ul>
</div>
<div class="tabs">
  <ul>
    <li><a href="classes.html"><span>Alphabetical&nbsp;List</span></a></li>
    <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
    <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
    <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
  </ul>
</div>
<h1>iTriangleMesh Struct Reference<br>
<small>
[<a class="el" href="group__geom__utils.html">Geometry utilities</a>]</small>
</h1><!-- doxytag: class="iTriangleMesh" --><!-- doxytag: inherits="iBase" -->This interface reprents a mesh of triangles.  
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="igeom_2trimesh_8h-source.html">igeom/trimesh.h</a>&gt;</code>
<p>
<div class="dynheader">
Inheritance diagram for iTriangleMesh:</div>
<div class="dynsection">
<p><center><img src="structiTriangleMesh__inherit__graph.png" border="0" usemap="#iTriangleMesh__inherit__map" alt="Inheritance graph"></center>
<map name="iTriangleMesh__inherit__map">
<area shape="rect" href="classscfImplementation1.html" title="scfImplementation1\&lt; csTriangleMesh, iTriangleMesh \&gt;" alt="" coords="296,5,664,32"><area shape="rect" href="classscfImplementation1.html" title="scfImplementation1\&lt; csTriangleMeshBox, iTriangleMesh \&gt;" alt="" coords="283,56,677,83"><area shape="rect" href="classscfImplementation1.html" title="scfImplementation1\&lt; csTriangleMeshPointer, iTriangleMesh \&gt;" alt="" coords="272,107,688,133"><area shape="rect" href="classscfImplementation1.html" title="scfImplementation1\&lt; csTriangleMeshPolyMesh, iTriangleMesh \&gt;" alt="" coords="264,157,696,184"><area shape="rect" href="structiBase.html" title="This is the basic interface: all other interfaces should be derived from this one..." alt="" coords="5,81,61,108"><area shape="rect" href="classcsTriangleMesh.html" title="A mesh of triangles." alt="" coords="776,5,893,32"><area shape="rect" href="classcsTriangleMeshBox.html" title="A convenience triangle mesh implementation that represents a cube." alt="" coords="764,56,905,83"><area shape="rect" href="classcsTriangleMeshPointer.html" title="A convenience triangle mesh which takes vertex and triangle pointers from another..." alt="" coords="753,107,916,133"><area shape="rect" href="classcsTriangleMeshPolyMesh.html" title="This triangle mesh is a temporary class that takes a polygon mesh and wraps it so..." alt="" coords="745,157,924,184"></map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>

<p>
<a href="structiTriangleMesh-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="group__util.html#g1134b580f8da4de94ca6b1de4d37975e">uint32</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structiTriangleMesh.html#5aa75cea701c74749ade593e05040335">GetChangeNumber</a> () const =0</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">When this number changes you know the triangle mesh has changed (deformation has occured) since the last time you got another number from this function.  <a href="#5aa75cea701c74749ade593e05040335"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="classcsFlags.html">csFlags</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structiTriangleMesh.html#5f1a504bbc31e23a72972f4d187e49e5">GetFlags</a> ()=0</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get flags for this triangle mesh.  <a href="#5f1a504bbc31e23a72972f4d187e49e5"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual size_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structiTriangleMesh.html#c66cc8b64e082f053313438f3e1b01c9">GetTriangleCount</a> ()=0</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the number of triangles for this mesh.  <a href="#c66cc8b64e082f053313438f3e1b01c9"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="structcsTriangle.html">csTriangle</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structiTriangleMesh.html#649c130c81e001ab037ae9587696ef14">GetTriangles</a> ()=0</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the triangle table for this mesh.  <a href="#649c130c81e001ab037ae9587696ef14"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual size_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structiTriangleMesh.html#075fe4ad6c26252bad601e84c67fa07d">GetVertexCount</a> ()=0</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the number of vertices for this mesh.  <a href="#075fe4ad6c26252bad601e84c67fa07d"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="classcsVector3.html">csVector3</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structiTriangleMesh.html#1cf785e09ee154c99fbc3f0497d8105c">GetVertices</a> ()=0</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the pointer to the array of vertices.  <a href="#1cf785e09ee154c99fbc3f0497d8105c"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structiTriangleMesh.html#552ceeafa7628a0980cab6075360d292">Lock</a> ()=0</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Lock the triangle mesh.  <a href="#552ceeafa7628a0980cab6075360d292"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structiTriangleMesh.html#16481a9203a043ce02383559bb30eb73">Unlock</a> ()=0</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Unlock the triangle mesh.  <a href="#16481a9203a043ce02383559bb30eb73"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
This interface reprents a mesh of triangles. 
<p>
It is useful to communicate geometry information outside of the engine. One place where this will be useful is for communicating geometry information to the collision detection plugin.<br>
 All Crystal Space mesh objects (things, sprites, ...) should implement and/or embed an implementation of this interface.<p>
A triangle mesh has the concept of a vertex buffer and an array of triangles.<p>
Main creators of instances implementing this interface:<ul>
<li>Almost all mesh objects have several implementations of this interface.</li></ul>
<p>
Main ways to get pointers to this interface:<ul>
<li><a class="el" href="structiObjectModel.html#c894706a83d6c33d9a204e0638c63f1c" title="Get a triangle mesh representing the geometry of the object.">iObjectModel::GetTriangleData()</a></li></ul>
<p>
Main users of this interface:<ul>
<li>Collision detection plugins (<a class="el" href="structiCollideSystem.html" title="This is the Collide plug-in.">iCollideSystem</a>)</li><li>Visibility culler plugins (<a class="el" href="structiVisibilityCuller.html" title="This interface represents a visibility culling system.">iVisibilityCuller</a>)</li><li>Shadow stencil plugin </li></ul>

<p>Definition at line <a class="el" href="igeom_2trimesh_8h-source.html#l00112">112</a> of file <a class="el" href="igeom_2trimesh_8h-source.html">trimesh.h</a>.</p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="5aa75cea701c74749ade593e05040335"></a><!-- doxytag: member="iTriangleMesh::GetChangeNumber" ref="5aa75cea701c74749ade593e05040335" args="() const =0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual <a class="el" href="group__util.html#g1134b580f8da4de94ca6b1de4d37975e">uint32</a> iTriangleMesh::GetChangeNumber           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"> const<code> [pure virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
When this number changes you know the triangle mesh has changed (deformation has occured) since the last time you got another number from this function. 
<p>

<p>Implemented in <a class="el" href="classcsTriangleMesh.html#6e6a57cc6ee1fe820913db5ff49a95e2">csTriangleMesh</a>, <a class="el" href="classcsTriangleMeshBox.html#2f3c28510134ee44a3286197501affd0">csTriangleMeshBox</a>, <a class="el" href="classcsTriangleMeshPointer.html#31b84f4b609f4e986bb4f8771bb817ef">csTriangleMeshPointer</a>, and <a class="el" href="classcsTriangleMeshPolyMesh.html#79526feac323af4f647272fd496cec2a">csTriangleMeshPolyMesh</a>.</p>

</div>
</div><p>
<a class="anchor" name="5f1a504bbc31e23a72972f4d187e49e5"></a><!-- doxytag: member="iTriangleMesh::GetFlags" ref="5f1a504bbc31e23a72972f4d187e49e5" args="()=0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual <a class="el" href="classcsFlags.html">csFlags</a>&amp; iTriangleMesh::GetFlags           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"><code> [pure virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Get flags for this triangle mesh. 
<p>
This is zero or a combination of the following flags:<ul>
<li><a class="el" href="group__geom__utils.html#gg68c01102755fc7d1c810bb0b0635fa90e79eee97416d39f451607fc2c94b01dc" title="The object is closed, if set.">CS_TRIMESH_CLOSED</a>: mesh is closed.</li><li><a class="el" href="group__geom__utils.html#gg68c01102755fc7d1c810bb0b0635fa9003fce5c7db65c3182ec683ff006698a3" title="The object is not closed, if set.">CS_TRIMESH_NOTCLOSED</a>: mesh is not closed.</li><li><a class="el" href="group__geom__utils.html#gg68c01102755fc7d1c810bb0b0635fa90eb9ea0bd96761361e39a61c17d65a256" title="The object is convex, if set.">CS_TRIMESH_CONVEX</a>: mesh is convex.</li><li><a class="el" href="group__geom__utils.html#gg68c01102755fc7d1c810bb0b0635fa903d71f9603c9ea6f85b041230d365c984" title="The object is not convex, if set.">CS_TRIMESH_NOTCONVEX</a>: mesh is not convex.</li><li><a class="el" href="group__geom__utils.html#gg68c01102755fc7d1c810bb0b0635fa909c5cd7efda84b38e2bdc0089c8ef74ef" title="Set this flag if the triangle mesh is deformable.">CS_TRIMESH_DEFORMABLE</a>: mesh is deformable.</li></ul>
<p>
Note that if neither <a class="el" href="group__geom__utils.html#gg68c01102755fc7d1c810bb0b0635fa90e79eee97416d39f451607fc2c94b01dc" title="The object is closed, if set.">CS_TRIMESH_CLOSED</a> nor <a class="el" href="group__geom__utils.html#gg68c01102755fc7d1c810bb0b0635fa9003fce5c7db65c3182ec683ff006698a3" title="The object is not closed, if set.">CS_TRIMESH_NOTCLOSED</a> are set then the closed state is not known. Setting both is illegal. Note that if neither <a class="el" href="group__geom__utils.html#gg68c01102755fc7d1c810bb0b0635fa90eb9ea0bd96761361e39a61c17d65a256" title="The object is convex, if set.">CS_TRIMESH_CONVEX</a> nor <a class="el" href="group__geom__utils.html#gg68c01102755fc7d1c810bb0b0635fa903d71f9603c9ea6f85b041230d365c984" title="The object is not convex, if set.">CS_TRIMESH_NOTCONVEX</a> are set then the convex state is not known. Setting both is illegal. 
<p>Implemented in <a class="el" href="classcsTriangleMesh.html#e32e852eedc1ed87a044a4c1f2c60a20">csTriangleMesh</a>, <a class="el" href="classcsTriangleMeshBox.html#abb999713726f0a8af06833cbb652962">csTriangleMeshBox</a>, <a class="el" href="classcsTriangleMeshPointer.html#b7a080de353ead50a5c00dde42d8f96c">csTriangleMeshPointer</a>, and <a class="el" href="classcsTriangleMeshPolyMesh.html#426f98d73254a51faee839596c3cebb7">csTriangleMeshPolyMesh</a>.</p>

</div>
</div><p>
<a class="anchor" name="c66cc8b64e082f053313438f3e1b01c9"></a><!-- doxytag: member="iTriangleMesh::GetTriangleCount" ref="c66cc8b64e082f053313438f3e1b01c9" args="()=0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual size_t iTriangleMesh::GetTriangleCount           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"><code> [pure virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Get the number of triangles for this mesh. 
<p>

<p>Implemented in <a class="el" href="classcsTriangleMesh.html#73f76b647a18a80776dd77a17d49adcb">csTriangleMesh</a>, <a class="el" href="classcsTriangleMeshBox.html#6eeaa1cb49882a3b9bc52a5c110d9d50">csTriangleMeshBox</a>, <a class="el" href="classcsTriangleMeshPointer.html#ec1416178b8474716bd3a8b3d5cced64">csTriangleMeshPointer</a>, and <a class="el" href="classcsTriangleMeshPolyMesh.html#524d241e981449f6dfeff0970af2dafd">csTriangleMeshPolyMesh</a>.</p>

</div>
</div><p>
<a class="anchor" name="649c130c81e001ab037ae9587696ef14"></a><!-- doxytag: member="iTriangleMesh::GetTriangles" ref="649c130c81e001ab037ae9587696ef14" args="()=0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual <a class="el" href="structcsTriangle.html">csTriangle</a>* iTriangleMesh::GetTriangles           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"><code> [pure virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Get the triangle table for this mesh. 
<p>

<p>Implemented in <a class="el" href="classcsTriangleMesh.html#a12969f085d843788f0fc1d27d8311a4">csTriangleMesh</a>, <a class="el" href="classcsTriangleMeshBox.html#59ccbd2d6d1e51fa75bb5d92566c5182">csTriangleMeshBox</a>, <a class="el" href="classcsTriangleMeshPointer.html#672095ba463df9bfb2835076eee30609">csTriangleMeshPointer</a>, and <a class="el" href="classcsTriangleMeshPolyMesh.html#a64f1b4a350829653d5221b5aa0711b3">csTriangleMeshPolyMesh</a>.</p>

</div>
</div><p>
<a class="anchor" name="075fe4ad6c26252bad601e84c67fa07d"></a><!-- doxytag: member="iTriangleMesh::GetVertexCount" ref="075fe4ad6c26252bad601e84c67fa07d" args="()=0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual size_t iTriangleMesh::GetVertexCount           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"><code> [pure virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Get the number of vertices for this mesh. 
<p>

<p>Implemented in <a class="el" href="classcsTriangleMesh.html#df2728d735c06324ac1cf84a4b17cfd1">csTriangleMesh</a>, <a class="el" href="classcsTriangleMeshBox.html#7a6ad0433904e0660b07434a257008b2">csTriangleMeshBox</a>, <a class="el" href="classcsTriangleMeshPointer.html#341762f8f2dd5b2f48c28716eef78b99">csTriangleMeshPointer</a>, and <a class="el" href="classcsTriangleMeshPolyMesh.html#03f12be7fdb520101df5fe8a73a10f94">csTriangleMeshPolyMesh</a>.</p>

</div>
</div><p>
<a class="anchor" name="1cf785e09ee154c99fbc3f0497d8105c"></a><!-- doxytag: member="iTriangleMesh::GetVertices" ref="1cf785e09ee154c99fbc3f0497d8105c" args="()=0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual <a class="el" href="classcsVector3.html">csVector3</a>* iTriangleMesh::GetVertices           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"><code> [pure virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Get the pointer to the array of vertices. 
<p>

<p>Implemented in <a class="el" href="classcsTriangleMesh.html#e9175d90bef11428eef07081885c8e69">csTriangleMesh</a>, <a class="el" href="classcsTriangleMeshBox.html#2dfda51f217994fa05561a6624ceb360">csTriangleMeshBox</a>, <a class="el" href="classcsTriangleMeshPointer.html#0d02af4de2c3b18984df35c3022fcd04">csTriangleMeshPointer</a>, and <a class="el" href="classcsTriangleMeshPolyMesh.html#7a7ea76fbb496d12dcc2e749ee3e7132">csTriangleMeshPolyMesh</a>.</p>

</div>
</div><p>
<a class="anchor" name="552ceeafa7628a0980cab6075360d292"></a><!-- doxytag: member="iTriangleMesh::Lock" ref="552ceeafa7628a0980cab6075360d292" args="()=0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual void iTriangleMesh::Lock           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"><code> [pure virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Lock the triangle mesh. 
<p>
This prevents the triangle data from being cleaned up. 
<p>Implemented in <a class="el" href="classcsTriangleMesh.html#a166091d21245beba50ebb6df7f6a1b5">csTriangleMesh</a>, <a class="el" href="classcsTriangleMeshBox.html#844fa4b35e57c70551f49e500af8b486">csTriangleMeshBox</a>, <a class="el" href="classcsTriangleMeshPointer.html#ab0d92ac481db4b857798f63d05162a8">csTriangleMeshPointer</a>, and <a class="el" href="classcsTriangleMeshPolyMesh.html#3af48e5e45c80ad11126b722e2b278f2">csTriangleMeshPolyMesh</a>.</p>

</div>
</div><p>
<a class="anchor" name="16481a9203a043ce02383559bb30eb73"></a><!-- doxytag: member="iTriangleMesh::Unlock" ref="16481a9203a043ce02383559bb30eb73" args="()=0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual void iTriangleMesh::Unlock           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"><code> [pure virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Unlock the triangle mesh. 
<p>
This allows clean up again. 
<p>Implemented in <a class="el" href="classcsTriangleMesh.html#957f5b45da8955aadc355230eff13bb3">csTriangleMesh</a>, <a class="el" href="classcsTriangleMeshBox.html#7611d2140aec24cac1e163621c7f9d45">csTriangleMeshBox</a>, <a class="el" href="classcsTriangleMeshPointer.html#1d6ca3e6fc4271ce54cd02d5b9fde080">csTriangleMeshPointer</a>, and <a class="el" href="classcsTriangleMeshPolyMesh.html#08ad031f0d3f91efb76fe65f4fc2ffcd">csTriangleMeshPolyMesh</a>.</p>

</div>
</div><p>
<hr>The documentation for this struct was generated from the following file:<ul>
<li>igeom/<a class="el" href="igeom_2trimesh_8h-source.html">trimesh.h</a></ul>
<hr size="1"><address><small>Generated for Crystal Space 1.2.1 by 
<a href="http://www.doxygen.org/index.html">doxygen</a> 1.5.3 
</small></address> </div></body> </html>