Sophie

Sophie

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

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: csTriangleMeshPointer Class 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>csTriangleMeshPointer Class Reference<br>
<small>
[<a class="el" href="group__geom__utils.html">Geometry utilities</a>]</small>
</h1><!-- doxytag: class="csTriangleMeshPointer" --><!-- doxytag: inherits="scfImplementation1&lt; csTriangleMeshPointer, iTriangleMesh &gt;" -->A convenience triangle mesh which takes vertex and triangle pointers from another source.  
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="csgeom_2trimesh_8h-source.html">csgeom/trimesh.h</a>&gt;</code>
<p>
<div class="dynheader">
Inheritance diagram for csTriangleMeshPointer:</div>
<div class="dynsection">
<p><center><img src="classcsTriangleMeshPointer__inherit__graph.png" border="0" usemap="#csTriangleMeshPointer__inherit__map" alt="Inheritance graph"></center>
<map name="csTriangleMeshPointer__inherit__map">
<area shape="rect" href="classscfImplementation1.html" title="scfImplementation1\&lt; csTriangleMeshPointer, iTriangleMesh \&gt;" alt="" coords="72,161,488,188"><area shape="rect" href="classscfImplementation.html" title="scfImplementation\&lt; csTriangleMeshPointer \&gt;" alt="" coords="5,84,320,111"><area shape="rect" href="structiBase.html" title="This is the basic interface: all other interfaces should be derived from this one..." alt="" coords="333,7,389,33"><area shape="rect" href="structiTriangleMesh.html" title="This interface reprents a mesh of triangles." alt="" coords="344,84,451,111"><area shape="rect" href="classCS_1_1Memory_1_1CustomAllocated.html" title="Class that overrides operator new/operator delete/etc." alt="" coords="52,7,273,33"></map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>

<p>
<a href="classcsTriangleMeshPointer-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">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcsTriangleMeshPointer.html#200c5ed1f5303b0343a3bf436ab185ee">csTriangleMeshPointer</a> (<a class="el" href="classcsVector3.html">csVector3</a> *vertices, size_t num_vertices, <a class="el" href="structcsTriangle.html">csTriangle</a> *triangles, size_t num_triangles)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Construct a triangle mesh.  <a href="#200c5ed1f5303b0343a3bf436ab185ee"></a><br></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="classcsTriangleMeshPointer.html#31b84f4b609f4e986bb4f8771bb817ef">GetChangeNumber</a> () const </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="#31b84f4b609f4e986bb4f8771bb817ef"></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="classcsTriangleMeshPointer.html#b7a080de353ead50a5c00dde42d8f96c">GetFlags</a> ()</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get flags for this triangle mesh.  <a href="#b7a080de353ead50a5c00dde42d8f96c"></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="classcsTriangleMeshPointer.html#ec1416178b8474716bd3a8b3d5cced64">GetTriangleCount</a> ()</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the number of triangles for this mesh.  <a href="#ec1416178b8474716bd3a8b3d5cced64"></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="classcsTriangleMeshPointer.html#672095ba463df9bfb2835076eee30609">GetTriangles</a> ()</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the triangle table for this mesh.  <a href="#672095ba463df9bfb2835076eee30609"></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="classcsTriangleMeshPointer.html#341762f8f2dd5b2f48c28716eef78b99">GetVertexCount</a> ()</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the number of vertices for this mesh.  <a href="#341762f8f2dd5b2f48c28716eef78b99"></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="classcsTriangleMeshPointer.html#0d02af4de2c3b18984df35c3022fcd04">GetVertices</a> ()</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the pointer to the array of vertices.  <a href="#0d02af4de2c3b18984df35c3022fcd04"></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="classcsTriangleMeshPointer.html#ab0d92ac481db4b857798f63d05162a8">Lock</a> ()</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Lock the triangle mesh.  <a href="#ab0d92ac481db4b857798f63d05162a8"></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="classcsTriangleMeshPointer.html#1d6ca3e6fc4271ce54cd02d5b9fde080">Unlock</a> ()</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Unlock the triangle mesh.  <a href="#1d6ca3e6fc4271ce54cd02d5b9fde080"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="2db866f8fdfa579d89d97bcf956559df"></a><!-- doxytag: member="csTriangleMeshPointer::~csTriangleMeshPointer" ref="2db866f8fdfa579d89d97bcf956559df" args="()" -->
virtual&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcsTriangleMeshPointer.html#2db866f8fdfa579d89d97bcf956559df">~csTriangleMeshPointer</a> ()</td></tr>

</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
A convenience triangle mesh which takes vertex and triangle pointers from another source. 
<p>
Take care of object life time when using this class; i.e. make sure the real owner of the vertex and triangle data is not destroyed at a time when this class is still in use. 
<p>Definition at line <a class="el" href="csgeom_2trimesh_8h-source.html#l00231">231</a> of file <a class="el" href="csgeom_2trimesh_8h-source.html">trimesh.h</a>.</p>
<hr><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" name="200c5ed1f5303b0343a3bf436ab185ee"></a><!-- doxytag: member="csTriangleMeshPointer::csTriangleMeshPointer" ref="200c5ed1f5303b0343a3bf436ab185ee" args="(csVector3 *vertices, size_t num_vertices, csTriangle *triangles, size_t num_triangles)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">csTriangleMeshPointer::csTriangleMeshPointer           </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="classcsVector3.html">csVector3</a> *&nbsp;</td>
          <td class="paramname"> <em>vertices</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">size_t&nbsp;</td>
          <td class="paramname"> <em>num_vertices</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="structcsTriangle.html">csTriangle</a> *&nbsp;</td>
          <td class="paramname"> <em>triangles</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">size_t&nbsp;</td>
          <td class="paramname"> <em>num_triangles</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td width="100%"><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Construct a triangle mesh. 
<p>

<p>Definition at line <a class="el" href="csgeom_2trimesh_8h-source.html#l00246">246</a> of file <a class="el" href="csgeom_2trimesh_8h-source.html">trimesh.h</a>.</p>

</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="31b84f4b609f4e986bb4f8771bb817ef"></a><!-- doxytag: member="csTriangleMeshPointer::GetChangeNumber" ref="31b84f4b609f4e986bb4f8771bb817ef" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual <a class="el" href="group__util.html#g1134b580f8da4de94ca6b1de4d37975e">uint32</a> csTriangleMeshPointer::GetChangeNumber           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"> const<code> [inline, 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>Implements <a class="el" href="structiTriangleMesh.html#5aa75cea701c74749ade593e05040335">iTriangleMesh</a>.</p>

<p>Definition at line <a class="el" href="csgeom_2trimesh_8h-source.html#l00268">268</a> of file <a class="el" href="csgeom_2trimesh_8h-source.html">trimesh.h</a>.</p>

</div>
</div><p>
<a class="anchor" name="b7a080de353ead50a5c00dde42d8f96c"></a><!-- doxytag: member="csTriangleMeshPointer::GetFlags" ref="b7a080de353ead50a5c00dde42d8f96c" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual <a class="el" href="classcsFlags.html">csFlags</a>&amp; csTriangleMeshPointer::GetFlags           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"><code> [inline, 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>Implements <a class="el" href="structiTriangleMesh.html#5f1a504bbc31e23a72972f4d187e49e5">iTriangleMesh</a>.</p>

<p>Definition at line <a class="el" href="csgeom_2trimesh_8h-source.html#l00267">267</a> of file <a class="el" href="csgeom_2trimesh_8h-source.html">trimesh.h</a>.</p>

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

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

<p>Implements <a class="el" href="structiTriangleMesh.html#c66cc8b64e082f053313438f3e1b01c9">iTriangleMesh</a>.</p>

<p>Definition at line <a class="el" href="csgeom_2trimesh_8h-source.html#l00263">263</a> of file <a class="el" href="csgeom_2trimesh_8h-source.html">trimesh.h</a>.</p>

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

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

<p>Implements <a class="el" href="structiTriangleMesh.html#649c130c81e001ab037ae9587696ef14">iTriangleMesh</a>.</p>

<p>Definition at line <a class="el" href="csgeom_2trimesh_8h-source.html#l00264">264</a> of file <a class="el" href="csgeom_2trimesh_8h-source.html">trimesh.h</a>.</p>

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

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

<p>Implements <a class="el" href="structiTriangleMesh.html#075fe4ad6c26252bad601e84c67fa07d">iTriangleMesh</a>.</p>

<p>Definition at line <a class="el" href="csgeom_2trimesh_8h-source.html#l00261">261</a> of file <a class="el" href="csgeom_2trimesh_8h-source.html">trimesh.h</a>.</p>

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

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

<p>Implements <a class="el" href="structiTriangleMesh.html#1cf785e09ee154c99fbc3f0497d8105c">iTriangleMesh</a>.</p>

<p>Definition at line <a class="el" href="csgeom_2trimesh_8h-source.html#l00262">262</a> of file <a class="el" href="csgeom_2trimesh_8h-source.html">trimesh.h</a>.</p>

</div>
</div><p>
<a class="anchor" name="ab0d92ac481db4b857798f63d05162a8"></a><!-- doxytag: member="csTriangleMeshPointer::Lock" ref="ab0d92ac481db4b857798f63d05162a8" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual void csTriangleMeshPointer::Lock           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"><code> [inline, 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>Implements <a class="el" href="structiTriangleMesh.html#552ceeafa7628a0980cab6075360d292">iTriangleMesh</a>.</p>

<p>Definition at line <a class="el" href="csgeom_2trimesh_8h-source.html#l00265">265</a> of file <a class="el" href="csgeom_2trimesh_8h-source.html">trimesh.h</a>.</p>

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

<p>
Unlock the triangle mesh. 
<p>
This allows clean up again. 
<p>Implements <a class="el" href="structiTriangleMesh.html#16481a9203a043ce02383559bb30eb73">iTriangleMesh</a>.</p>

<p>Definition at line <a class="el" href="csgeom_2trimesh_8h-source.html#l00266">266</a> of file <a class="el" href="csgeom_2trimesh_8h-source.html">trimesh.h</a>.</p>

</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li>csgeom/<a class="el" href="csgeom_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>