Sophie

Sophie

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

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: iProtoFactoryState 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>iProtoFactoryState Struct Reference<br>
<small>
[<a class="el" href="group__meshplugins.html">Mesh plugins</a>]</small>
</h1><!-- doxytag: class="iProtoFactoryState" --><!-- doxytag: inherits="iBase" -->The proto mesh is a demonstration or tutorial mesh.  
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="protomesh_8h-source.html">imesh/protomesh.h</a>&gt;</code>
<p>
<div class="dynheader">
Inheritance diagram for iProtoFactoryState:</div>
<div class="dynsection">
<p><center><img src="structiProtoFactoryState__inherit__graph.png" border="0" usemap="#iProtoFactoryState__inherit__map" alt="Inheritance graph"></center>
<map name="iProtoFactoryState__inherit__map">
<area shape="rect" href="structiBase.html" title="This is the basic interface: all other interfaces should be derived from this one..." alt="" coords="49,7,105,33"></map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>

<p>
<a href="structiProtoFactoryState-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="classcsColor.html">csColor</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structiProtoFactoryState.html#e36d4f06fc8810931ce0adfb2576c603">GetColors</a> ()=0</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the array of colors.  <a href="#e36d4f06fc8810931ce0adfb2576c603"></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="structiProtoFactoryState.html#0e0ff825a1a5f4b122c93d8e29e07f15">GetNormals</a> ()=0</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the array of normals.  <a href="#0e0ff825a1a5f4b122c93d8e29e07f15"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="classcsVector2.html">csVector2</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structiProtoFactoryState.html#89e1f1cc0e07a50adc9701e5475d34df">GetTexels</a> ()=0</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the array of texels.  <a href="#89e1f1cc0e07a50adc9701e5475d34df"></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="structiProtoFactoryState.html#ea954902c8918ee045e2efe08033bcfb">GetTriangles</a> ()=0</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the array of triangles.  <a href="#ea954902c8918ee045e2efe08033bcfb"></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="structiProtoFactoryState.html#e2954a348061341402aab60054c6c39c">GetVertices</a> ()=0</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the array of vertices.  <a href="#e2954a348061341402aab60054c6c39c"></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="structiProtoFactoryState.html#f8b5ad3159c6be368d73b4a33ad8c4c3">Invalidate</a> ()=0</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">After making a significant change to the vertices or triangles you probably want to let this object recalculate the bounding boxes and such.  <a href="#f8b5ad3159c6be368d73b4a33ad8c4c3"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
The proto mesh is a demonstration or tutorial mesh. 
<p>
It is very simple and really unusable in games but it is a very good start to make a new mesh object.<p>
The proto mesh supports:<ul>
<li>Primitive geometry (8 vertices, 12 triangles, just enough for a box).</li><li>Setting of base color and per vertex color.</li><li>Setting of vertices, texels, and normals.</li><li>Material per mesh object.</li><li>Sharing geometry in the factory.</li><li>Collision detection.</li><li>Direct creation of render buffers.</li><li>Delayed creation of render buffers.</li></ul>
<p>
The general API for the proto factory. Here you define the actual geometry which is shared between all proto mesh instances.<p>
Main creators of instances implementing this interface:<ul>
<li>Protomesh mesh object plugin (crystalspace.mesh.object.protomesh)</li><li><a class="el" href="structiMeshObjectType.html#3d291b628b55f77343dfbc948ee757a0" title="Create an instance of iMeshObjectFactory.">iMeshObjectType::NewFactory()</a></li></ul>
<p>
Main ways to get pointers to this interface:<ul>
<li><a class="el" href="group__scf.html#g2e8cf383ca5045f2b0c05374ff0107c3" title="Helper function around iBase::QueryInterface.">scfQueryInterface()</a> on <a class="el" href="structiMeshFactoryWrapper.html#f21ca8291b566e9cf3722ea3067b5c5e" title="Get the iMeshObjectFactory.">iMeshFactoryWrapper::GetMeshObjectFactory()</a></li></ul>
<p>
Main users of this interface:<ul>
<li>Protomesh Factory Loader plugin (crystalspace.mesh.loader.factory.protomesh) </li></ul>

<p>Definition at line <a class="el" href="protomesh_8h-source.html#l00068">68</a> of file <a class="el" href="protomesh_8h-source.html">protomesh.h</a>.</p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="e36d4f06fc8810931ce0adfb2576c603"></a><!-- doxytag: member="iProtoFactoryState::GetColors" ref="e36d4f06fc8810931ce0adfb2576c603" args="()=0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual <a class="el" href="classcsColor.html">csColor</a>* iProtoFactoryState::GetColors           </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 array of colors. 
<p>
It is legal to modify the colors in this array. The number of colors in this array is guaranteed to be equal to 8. 
</div>
</div><p>
<a class="anchor" name="0e0ff825a1a5f4b122c93d8e29e07f15"></a><!-- doxytag: member="iProtoFactoryState::GetNormals" ref="0e0ff825a1a5f4b122c93d8e29e07f15" args="()=0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual <a class="el" href="classcsVector3.html">csVector3</a>* iProtoFactoryState::GetNormals           </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 array of normals. 
<p>
It is legal to modify the normals in this array. The number of normals in this array is guaranteed to be equal to 8. 
</div>
</div><p>
<a class="anchor" name="89e1f1cc0e07a50adc9701e5475d34df"></a><!-- doxytag: member="iProtoFactoryState::GetTexels" ref="89e1f1cc0e07a50adc9701e5475d34df" args="()=0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual <a class="el" href="classcsVector2.html">csVector2</a>* iProtoFactoryState::GetTexels           </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 array of texels. 
<p>
It is legal to modify the texels in this array. The number of texels in this array is guaranteed to be equal to 8. 
</div>
</div><p>
<a class="anchor" name="ea954902c8918ee045e2efe08033bcfb"></a><!-- doxytag: member="iProtoFactoryState::GetTriangles" ref="ea954902c8918ee045e2efe08033bcfb" args="()=0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual <a class="el" href="structcsTriangle.html">csTriangle</a>* iProtoFactoryState::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 array of triangles. 
<p>
It is legal to modify the triangles in this array. The number of triangles in this array is guaranteed to be equal to 12. 
</div>
</div><p>
<a class="anchor" name="e2954a348061341402aab60054c6c39c"></a><!-- doxytag: member="iProtoFactoryState::GetVertices" ref="e2954a348061341402aab60054c6c39c" args="()=0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual <a class="el" href="classcsVector3.html">csVector3</a>* iProtoFactoryState::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 array of vertices. 
<p>
It is legal to modify the vertices in this array. The number of vertices in this array is guaranteed to be equal to 8. 
</div>
</div><p>
<a class="anchor" name="f8b5ad3159c6be368d73b4a33ad8c4c3"></a><!-- doxytag: member="iProtoFactoryState::Invalidate" ref="f8b5ad3159c6be368d73b4a33ad8c4c3" args="()=0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual void iProtoFactoryState::Invalidate           </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>
After making a significant change to the vertices or triangles you probably want to let this object recalculate the bounding boxes and such. 
<p>
This function will invalidate the internal data structures so that they are recomputed. 
</div>
</div><p>
<hr>The documentation for this struct was generated from the following file:<ul>
<li>imesh/<a class="el" href="protomesh_8h-source.html">protomesh.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>