<!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: iInstancingMeshState 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 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 Pages</span></a></li> </ul> </div> <div class="tabs"> <ul> <li><a href="classes.html"><span>Alphabetical List</span></a></li> <li><a href="annotated.html"><span>Class List</span></a></li> <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li> <li><a href="functions.html"><span>Class Members</span></a></li> </ul> </div> <h1>iInstancingMeshState Struct Reference<br> <small> [<a class="el" href="group__meshplugins.html">Mesh plugins</a>]</small> </h1><!-- doxytag: class="iInstancingMeshState" --><!-- doxytag: inherits="iInstancingMeshCommonState" -->This interface describes the API for the instancing mesh object. <a href="#_details">More...</a> <p> <code>#include <<a class="el" href="instmesh_8h-source.html">imesh/instmesh.h</a>></code> <p> <div class="dynheader"> Inheritance diagram for iInstancingMeshState:</div> <div class="dynsection"> <p><center><img src="structiInstancingMeshState__inherit__graph.png" border="0" usemap="#iInstancingMeshState__inherit__map" alt="Inheritance graph"></center> <map name="iInstancingMeshState__inherit__map"> <area shape="rect" href="structiInstancingMeshCommonState.html" title="The common interface between instancing meshes and factories." alt="" coords="5,84,227,111"><area shape="rect" href="structiBase.html" title="This is the basic interface: all other interfaces should be derived from this one..." alt="" coords="88,7,144,33"></map> <center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div> <p> <a href="structiInstancingMeshState-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 size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structiInstancingMeshState.html#0565d911c52394e164e10298cf3e5ad2">AddInstance</a> (const <a class="el" href="classcsReversibleTransform.html">csReversibleTransform</a> &trans)=0</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Add an instance. <a href="#0565d911c52394e164e10298cf3e5ad2"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual const <br> <a class="el" href="classcsReversibleTransform.html">csReversibleTransform</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="structiInstancingMeshState.html#1e1171aacef77e8b38f9fdeb1435a437">GetInstanceTransform</a> (size_t id)=0</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Get instance transform. <a href="#1e1171aacef77e8b38f9fdeb1435a437"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="structiInstancingMeshState.html#432ee51fb3d8d7efa5b4a95c78925f07">MoveInstance</a> (size_t id, const <a class="el" href="classcsReversibleTransform.html">csReversibleTransform</a> &trans)=0</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Move an instance. <a href="#432ee51fb3d8d7efa5b4a95c78925f07"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="structiInstancingMeshState.html#d2417028da5733f5fe9a7ec76d9a92a0">RemoveAllInstances</a> ()=0</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Remove all instances. <a href="#d2417028da5733f5fe9a7ec76d9a92a0"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="structiInstancingMeshState.html#dbd53ab85e5af4ffe20f7284acb3e183">RemoveInstance</a> (size_t id)=0</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Remove an instance. <a href="#dbd53ab85e5af4ffe20f7284acb3e183"></a><br></td></tr> </table> <hr><a name="_details"></a><h2>Detailed Description</h2> This interface describes the API for the instancing mesh object. <p> Main creators of instances implementing this interface:<ul> <li>Instmesh mesh object plugin (crystalspace.mesh.object.instmesh)</li><li><a class="el" href="structiMeshObjectFactory.html#82872458683c8e520026e59111f249ce" title="Create an instance of iMeshObject.">iMeshObjectFactory::NewInstance()</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="structiMeshWrapper.html#941b6ca24a1560e9c7d54b317c743316" title="Get the iMeshObject.">iMeshWrapper::GetMeshObject()</a></li></ul> <p> Main users of this interface:<ul> <li>Instmesh Loader plugin (crystalspace.mesh.loader.instmesh) </li></ul> <p>Definition at line <a class="el" href="instmesh_8h-source.html#l00098">98</a> of file <a class="el" href="instmesh_8h-source.html">instmesh.h</a>.</p> <hr><h2>Member Function Documentation</h2> <a class="anchor" name="0565d911c52394e164e10298cf3e5ad2"></a><!-- doxytag: member="iInstancingMeshState::AddInstance" ref="0565d911c52394e164e10298cf3e5ad2" args="(const csReversibleTransform &trans)=0" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual size_t iInstancingMeshState::AddInstance </td> <td>(</td> <td class="paramtype">const <a class="el" href="classcsReversibleTransform.html">csReversibleTransform</a> & </td> <td class="paramname"> <em>trans</em> </td> <td> ) </td> <td width="100%"><code> [pure virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Add an instance. <p> Returns an ID to identify that instance. </div> </div><p> <a class="anchor" name="1e1171aacef77e8b38f9fdeb1435a437"></a><!-- doxytag: member="iInstancingMeshState::GetInstanceTransform" ref="1e1171aacef77e8b38f9fdeb1435a437" args="(size_t id)=0" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual const <a class="el" href="classcsReversibleTransform.html">csReversibleTransform</a>& iInstancingMeshState::GetInstanceTransform </td> <td>(</td> <td class="paramtype">size_t </td> <td class="paramname"> <em>id</em> </td> <td> ) </td> <td width="100%"><code> [pure virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Get instance transform. <p> </div> </div><p> <a class="anchor" name="432ee51fb3d8d7efa5b4a95c78925f07"></a><!-- doxytag: member="iInstancingMeshState::MoveInstance" ref="432ee51fb3d8d7efa5b4a95c78925f07" args="(size_t id, const csReversibleTransform &trans)=0" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual void iInstancingMeshState::MoveInstance </td> <td>(</td> <td class="paramtype">size_t </td> <td class="paramname"> <em>id</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const <a class="el" href="classcsReversibleTransform.html">csReversibleTransform</a> & </td> <td class="paramname"> <em>trans</em></td><td> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td><td width="100%"><code> [pure virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Move an instance. <p> </div> </div><p> <a class="anchor" name="d2417028da5733f5fe9a7ec76d9a92a0"></a><!-- doxytag: member="iInstancingMeshState::RemoveAllInstances" ref="d2417028da5733f5fe9a7ec76d9a92a0" args="()=0" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual void iInstancingMeshState::RemoveAllInstances </td> <td>(</td> <td class="paramname"> </td> <td> ) </td> <td width="100%"><code> [pure virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Remove all instances. <p> </div> </div><p> <a class="anchor" name="dbd53ab85e5af4ffe20f7284acb3e183"></a><!-- doxytag: member="iInstancingMeshState::RemoveInstance" ref="dbd53ab85e5af4ffe20f7284acb3e183" args="(size_t id)=0" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual void iInstancingMeshState::RemoveInstance </td> <td>(</td> <td class="paramtype">size_t </td> <td class="paramname"> <em>id</em> </td> <td> ) </td> <td width="100%"><code> [pure virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Remove an instance. <p> </div> </div><p> <hr>The documentation for this struct was generated from the following file:<ul> <li>imesh/<a class="el" href="instmesh_8h-source.html">instmesh.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>