<html>
<head>
<title>Cal3D: CalHardwareModel Class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head>
<body bgcolor="#ffffff">
<table width="100%" border="0" cellspacing="0" cellpadding="5" align="center">
<tr>
<td class="md" align="center">
<small>
<b>- Cal3D 0.11 API Reference -</b>
</small>
</td>
</tr>
</table>
<br>
<!-- Generated by Doxygen 1.7.3 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="classes.html"><span>Class Index</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>
</div>
<div class="header">
<div class="summary">
<a href="#nested-classes">Classes</a> |
<a href="#pub-methods">Public Member Functions</a> </div>
<div class="headertitle">
<h1>CalHardwareModel Class Reference</h1> </div>
</div>
<div class="contents">
<!-- doxytag: class="CalHardwareModel" -->
<p><a href="classCalHardwareModel-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="nested-classes"></a>
Classes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structCalHardwareModel_1_1CalHardwareMesh.html">CalHardwareMesh</a></td></tr>
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCalHardwareModel.html#a5c3da18d348a850e06449d35e59c156f">CalHardwareModel</a> (<a class="el" href="classCalCoreModel.html">CalCoreModel</a> *pCoreModel)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Constructs the hardware model instance. <a href="#a5c3da18d348a850e06449d35e59c156f"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCalHardwareModel.html#a2c6bb859d2490b7220d2cababeae3874">setVertexBuffer</a> (char *pVertexBuffer, int stride)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the vertex (position) buffer of the hardware model instance. <a href="#a2c6bb859d2490b7220d2cababeae3874"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCalHardwareModel.html#ab014248d56ceb909f9de1a944c7b643d">setIndexBuffer</a> (CalIndex *pIndexBuffer)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the index buffer of the hardware model instance. <a href="#ab014248d56ceb909f9de1a944c7b643d"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCalHardwareModel.html#a3f4ad99cbd709319e742d4c23bf42557">setNormalBuffer</a> (char *pNormalBuffer, int stride)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the normal buffer of the hardware model instance. <a href="#a3f4ad99cbd709319e742d4c23bf42557"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCalHardwareModel.html#a55cd29ac125ffe7af7afc42d58a8c137">setWeightBuffer</a> (char *pWeightBuffer, int stride)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the weight buffer of the hardware model instance. <a href="#a55cd29ac125ffe7af7afc42d58a8c137"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCalHardwareModel.html#afbc90fc914ecc0b67a15506fb6695c55">setMatrixIndexBuffer</a> (char *pMatrixIndexBuffer, int stride)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the matrix index buffer of the hardware model instance. <a href="#afbc90fc914ecc0b67a15506fb6695c55"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCalHardwareModel.html#a9b2a05151e8bed07b4947a3a35352050">setTextureCoordNum</a> (int textureCoordNum)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the number the texture coordinate of the hardware model instance. <a href="#a9b2a05151e8bed07b4947a3a35352050"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCalHardwareModel.html#a23bffd7cec2788d1ea6a11a0c3e49e07">setTextureCoordBuffer</a> (int mapId, char *pTextureCoordBuffer, int stride)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the texture coordinate buffer of the hardware model instance. <a href="#a23bffd7cec2788d1ea6a11a0c3e49e07"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCalHardwareModel.html#a06e45f354c326d0a6c189188632c5325">setTangentSpaceBuffer</a> (int mapId, char *pTangentSpaceBuffer, int stride)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the tangent space buffer of the hardware model instance. <a href="#a06e45f354c326d0a6c189188632c5325"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCalHardwareModel.html#a6575ad80ce670b2b91ef98199e3f65a0">setCoreMeshIds</a> (const std::vector< int > &coreMeshIds)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the list of core mesh ids to use for building the hardware model instance. <a href="#a6575ad80ce670b2b91ef98199e3f65a0"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classCalHardwareModel.html#aa2706b8ec5848f1e0d4b5efbd88a7c8d">load</a> (int baseVertexIndex, int startIndex, int maxBonesPerMesh)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Compute the information needed to use the hardware model . <a href="#aa2706b8ec5848f1e0d4b5efbd88a7c8d"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">std::vector< <a class="el" href="structCalHardwareModel_1_1CalHardwareMesh.html">CalHardwareMesh</a> > & </td><td class="memItemRight" valign="bottom"><a class="el" href="classCalHardwareModel.html#ac63b2a1d511fcdeb30440f4e8eb7cfbc">getVectorHardwareMesh</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the hardware mesh vector. <a href="#ac63b2a1d511fcdeb30440f4e8eb7cfbc"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCalHardwareModel.html#a251561ad021f151b207d5761fef989a9">getAmbientColor</a> (unsigned char *pColorBuffer)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Provides access to the ambient color. <a href="#a251561ad021f151b207d5761fef989a9"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCalHardwareModel.html#a258961a5fb3f503a00d4cd243e0b0449">getDiffuseColor</a> (unsigned char *pColorBuffer)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Provides access to the diffuse color. <a href="#a258961a5fb3f503a00d4cd243e0b0449"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCalHardwareModel.html#ac655e38938a322dd7089af8ae986e84d">getSpecularColor</a> (unsigned char *pColorBuffer)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Provides access to the specular color. <a href="#ac655e38938a322dd7089af8ae986e84d"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classCalQuaternion.html">CalQuaternion</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classCalHardwareModel.html#a9da3df0d44b4969c92536c09d30632cc">getRotationBoneSpace</a> (int boneId, <a class="el" href="classCalSkeleton.html">CalSkeleton</a> *pSkeleton)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the bone space rotation of the bone boneId. <a href="#a9da3df0d44b4969c92536c09d30632cc"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classCalVector.html">CalVector</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classCalHardwareModel.html#a9e9e0d4791ab5de26f43ff7eb513931f">getTranslationBoneSpace</a> (int boneId, <a class="el" href="classCalSkeleton.html">CalSkeleton</a> *pSkeleton)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the bone space translation of the bone boneId. <a href="#a9e9e0d4791ab5de26f43ff7eb513931f"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="classCalHardwareModel.html#a4349d6b42fd316da91c51f99ff80e121">getShininess</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the shininess factor. <a href="#a4349d6b42fd316da91c51f99ff80e121"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classCalHardwareModel.html#a314efb22692293b55cace621486e3b80">getHardwareMeshCount</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the number of hardware meshes. <a href="#a314efb22692293b55cace621486e3b80"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classCalHardwareModel.html#a7b3bfc9bd92a170f727e3c23feba5ccc">getFaceCount</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the number of faces. <a href="#a7b3bfc9bd92a170f727e3c23feba5ccc"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classCalHardwareModel.html#a93f526df9f727224a7a169803bbdc920">getVertexCount</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the number of vertex. <a href="#a93f526df9f727224a7a169803bbdc920"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classCalHardwareModel.html#ac8871e1668c0ff5a3812410e969727da">getBoneCount</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the number of bone. <a href="#ac8871e1668c0ff5a3812410e969727da"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classCalHardwareModel.html#a1067269d36a6fbe2922a18d31c84d397">getBaseVertexIndex</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the base vertex index. <a href="#a1067269d36a6fbe2922a18d31c84d397"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classCalHardwareModel.html#af50c3ae6b5958af41fc147e365cedc91">getStartIndex</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the start index. <a href="#af50c3ae6b5958af41fc147e365cedc91"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classCalHardwareModel.html#ac0fe9acd232dd4a2fc0f4cc75736b03b">getTotalFaceCount</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the number of faces in the hardware model instance. <a href="#ac0fe9acd232dd4a2fc0f4cc75736b03b"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classCalHardwareModel.html#ab644c5bb3b876e10b68a0228b8d22e0f">getTotalVertexCount</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the number of vertices in the hardware model instance. <a href="#ab644c5bb3b876e10b68a0228b8d22e0f"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">Cal::UserData </td><td class="memItemRight" valign="bottom"><a class="el" href="classCalHardwareModel.html#a1c8e4f504ea076a3933142e32746fb5d">getMapUserData</a> (int mapId)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Provides access to a specified map user data. <a href="#a1c8e4f504ea076a3933142e32746fb5d"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classCalHardwareModel.html#a44f85410070583ff0a10f9d5edd26726">selectHardwareMesh</a> (size_t meshId)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Selects a hardware mesh for rendering data queries. <a href="#a44f85410070583ff0a10f9d5edd26726"></a><br/></td></tr>
</table>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a5c3da18d348a850e06449d35e59c156f"></a><!-- doxytag: member="CalHardwareModel::CalHardwareModel" ref="a5c3da18d348a850e06449d35e59c156f" args="(CalCoreModel *pCoreModel)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">CalHardwareModel::CalHardwareModel </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classCalCoreModel.html">CalCoreModel</a> * </td>
<td class="paramname"><em>pCoreModel</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Constructs the hardware model instance. </p>
<p>This function is the default constructor of the hardware model instance. </p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a251561ad021f151b207d5761fef989a9"></a><!-- doxytag: member="CalHardwareModel::getAmbientColor" ref="a251561ad021f151b207d5761fef989a9" args="(unsigned char *pColorBuffer)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CalHardwareModel::getAmbientColor </td>
<td>(</td>
<td class="paramtype">unsigned char * </td>
<td class="paramname"><em>pColorBuffer</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Provides access to the ambient color. </p>
<p>This function returns the ambient color of the material of the selected hardware mesh.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">pColorBuffer</td><td>A pointer to the user-provided buffer where the color data is written to. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a1067269d36a6fbe2922a18d31c84d397"></a><!-- doxytag: member="CalHardwareModel::getBaseVertexIndex" ref="a1067269d36a6fbe2922a18d31c84d397" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int CalHardwareModel::getBaseVertexIndex </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the base vertex index. </p>
<p>This function returns the base vertex index of the selected hardware mesh instance.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>a integer with the base vertex index. </dd></dl>
</div>
</div>
<a class="anchor" id="ac8871e1668c0ff5a3812410e969727da"></a><!-- doxytag: member="CalHardwareModel::getBoneCount" ref="ac8871e1668c0ff5a3812410e969727da" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int CalHardwareModel::getBoneCount </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the number of bone. </p>
<p>This function returns the number of bone in the selected hardware mesh instance.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>The number of bone. </dd></dl>
</div>
</div>
<a class="anchor" id="a258961a5fb3f503a00d4cd243e0b0449"></a><!-- doxytag: member="CalHardwareModel::getDiffuseColor" ref="a258961a5fb3f503a00d4cd243e0b0449" args="(unsigned char *pColorBuffer)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CalHardwareModel::getDiffuseColor </td>
<td>(</td>
<td class="paramtype">unsigned char * </td>
<td class="paramname"><em>pColorBuffer</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Provides access to the diffuse color. </p>
<p>This function returns the diffuse color of the material of the selected hardware mesh.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">pColorBuffer</td><td>A pointer to the user-provided buffer where the color data is written to. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a7b3bfc9bd92a170f727e3c23feba5ccc"></a><!-- doxytag: member="CalHardwareModel::getFaceCount" ref="a7b3bfc9bd92a170f727e3c23feba5ccc" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int CalHardwareModel::getFaceCount </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the number of faces. </p>
<p>This function returns the number of faces in the selected hardware mesh instance.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>The number of faces. </dd></dl>
</div>
</div>
<a class="anchor" id="a314efb22692293b55cace621486e3b80"></a><!-- doxytag: member="CalHardwareModel::getHardwareMeshCount" ref="a314efb22692293b55cace621486e3b80" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int CalHardwareModel::getHardwareMeshCount </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the number of hardware meshes. </p>
<p>This function returns the number of hardware meshes in the hardware model instance.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>The number of hardware meshes. </dd></dl>
</div>
</div>
<a class="anchor" id="a1c8e4f504ea076a3933142e32746fb5d"></a><!-- doxytag: member="CalHardwareModel::getMapUserData" ref="a1c8e4f504ea076a3933142e32746fb5d" args="(int mapId)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Cal::UserData CalHardwareModel::getMapUserData </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>mapId</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Provides access to a specified map user data. </p>
<p>This function returns the user data stored in the specified map of the material of the selected hardware mesh.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">mapId</td><td>The ID of the map.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>One of the following values: <ul>
<li>the user data stored in the specified map </li>
<li><b>0</b> if an error happend </li>
</ul>
</dd></dl>
</div>
</div>
<a class="anchor" id="a9da3df0d44b4969c92536c09d30632cc"></a><!-- doxytag: member="CalHardwareModel::getRotationBoneSpace" ref="a9da3df0d44b4969c92536c09d30632cc" args="(int boneId, CalSkeleton *pSkeleton)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classCalQuaternion.html">CalQuaternion</a> & CalHardwareModel::getRotationBoneSpace </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>boneId</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classCalSkeleton.html">CalSkeleton</a> * </td>
<td class="paramname"><em>pSkeleton</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the bone space rotation of the bone boneId. </p>
<p>This function returns the rotation to bring a point into the bone instance space of the bone boneId of the selected hardware mesh.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">boneId</td><td>A integer with the bone number </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>The rotation to bring a point into bone space. </dd></dl>
</div>
</div>
<a class="anchor" id="a4349d6b42fd316da91c51f99ff80e121"></a><!-- doxytag: member="CalHardwareModel::getShininess" ref="a4349d6b42fd316da91c51f99ff80e121" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">float CalHardwareModel::getShininess </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the shininess factor. </p>
<p>This function returns the shininess factor of the material of the selected hardware mesh..</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>The shininess factor. </dd></dl>
</div>
</div>
<a class="anchor" id="ac655e38938a322dd7089af8ae986e84d"></a><!-- doxytag: member="CalHardwareModel::getSpecularColor" ref="ac655e38938a322dd7089af8ae986e84d" args="(unsigned char *pColorBuffer)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CalHardwareModel::getSpecularColor </td>
<td>(</td>
<td class="paramtype">unsigned char * </td>
<td class="paramname"><em>pColorBuffer</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Provides access to the specular color. </p>
<p>This function returns the specular color of the material of the selected hardware.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">pColorBuffer</td><td>A pointer to the user-provided buffer where the color data is written to. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="af50c3ae6b5958af41fc147e365cedc91"></a><!-- doxytag: member="CalHardwareModel::getStartIndex" ref="af50c3ae6b5958af41fc147e365cedc91" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int CalHardwareModel::getStartIndex </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the start index. </p>
<p>This function returns the start index of the selected hardware mesh instance.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>a integer with the start index. </dd></dl>
</div>
</div>
<a class="anchor" id="ac0fe9acd232dd4a2fc0f4cc75736b03b"></a><!-- doxytag: member="CalHardwareModel::getTotalFaceCount" ref="ac0fe9acd232dd4a2fc0f4cc75736b03b" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int CalHardwareModel::getTotalFaceCount </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the number of faces in the hardware model instance. </p>
<p>This function returns the number of faces in the hardware model instance.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>The number of faces. </dd></dl>
</div>
</div>
<a class="anchor" id="ab644c5bb3b876e10b68a0228b8d22e0f"></a><!-- doxytag: member="CalHardwareModel::getTotalVertexCount" ref="ab644c5bb3b876e10b68a0228b8d22e0f" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int CalHardwareModel::getTotalVertexCount </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the number of vertices in the hardware model instance. </p>
<p>This function returns the number of vertices in the hardware model instance.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>The number of vertices. </dd></dl>
</div>
</div>
<a class="anchor" id="a9e9e0d4791ab5de26f43ff7eb513931f"></a><!-- doxytag: member="CalHardwareModel::getTranslationBoneSpace" ref="a9e9e0d4791ab5de26f43ff7eb513931f" args="(int boneId, CalSkeleton *pSkeleton)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classCalVector.html">CalVector</a> & CalHardwareModel::getTranslationBoneSpace </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>boneId</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classCalSkeleton.html">CalSkeleton</a> * </td>
<td class="paramname"><em>pSkeleton</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the bone space translation of the bone boneId. </p>
<p>This function returns the translation to bring a point into the bone instance space of the bone boneId of the selected hardware mesh.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">boneId</td><td>A integer with the bone number </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>The translation to bring a point into bone space. </dd></dl>
</div>
</div>
<a class="anchor" id="ac63b2a1d511fcdeb30440f4e8eb7cfbc"></a><!-- doxytag: member="CalHardwareModel::getVectorHardwareMesh" ref="ac63b2a1d511fcdeb30440f4e8eb7cfbc" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::vector< <a class="el" href="structCalHardwareModel_1_1CalHardwareMesh.html">CalHardwareModel::CalHardwareMesh</a> > & CalHardwareModel::getVectorHardwareMesh </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the hardware mesh vector. </p>
<p>This function returns the vector that contains all hardware mesh of the core mesh instance.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>A reference to the hardware mesh vector. </dd></dl>
</div>
</div>
<a class="anchor" id="a93f526df9f727224a7a169803bbdc920"></a><!-- doxytag: member="CalHardwareModel::getVertexCount" ref="a93f526df9f727224a7a169803bbdc920" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int CalHardwareModel::getVertexCount </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the number of vertex. </p>
<p>This function returns the number of vertex in the selected hardware mesh instance.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>The number of vertex. </dd></dl>
</div>
</div>
<a class="anchor" id="aa2706b8ec5848f1e0d4b5efbd88a7c8d"></a><!-- doxytag: member="CalHardwareModel::load" ref="aa2706b8ec5848f1e0d4b5efbd88a7c8d" args="(int baseVertexIndex, int startIndex, int maxBonesPerMesh)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool CalHardwareModel::load </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>baseVertexIndex</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>startIndex</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>maxBonesPerMesh</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Compute the information needed to use the hardware model . </p>
<p>This function Compute the information needed to use the hardware model, it fill vertex buffers with the model data</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">baseVertexIndex</td><td>The base vertex Index. </td></tr>
<tr><td class="paramname">startIndex</td><td>The start index. </td></tr>
<tr><td class="paramname">maxBonesPerMesh</td><td>The maximun of bone by hardware mesh</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>One of the following values: <ul>
<li><b>true</b> if succeed </li>
<li><b>false</b> if an error happend </li>
</ul>
</dd></dl>
</div>
</div>
<a class="anchor" id="a44f85410070583ff0a10f9d5edd26726"></a><!-- doxytag: member="CalHardwareModel::selectHardwareMesh" ref="a44f85410070583ff0a10f9d5edd26726" args="(size_t meshId)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool CalHardwareModel::selectHardwareMesh </td>
<td>(</td>
<td class="paramtype">size_t </td>
<td class="paramname"><em>meshId</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Selects a hardware mesh for rendering data queries. </p>
<p>This function selects a hardware mesh for further rendering data queries.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">meshId</td><td>The ID of the hardware mesh that should be used for further rendering data queries.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>One of the following values: <ul>
<li><b>true</b> if successful </li>
<li><b>false</b> if an error happend </li>
</ul>
</dd></dl>
</div>
</div>
<a class="anchor" id="a6575ad80ce670b2b91ef98199e3f65a0"></a><!-- doxytag: member="CalHardwareModel::setCoreMeshIds" ref="a6575ad80ce670b2b91ef98199e3f65a0" args="(const std::vector< int > &coreMeshIds)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CalHardwareModel::setCoreMeshIds </td>
<td>(</td>
<td class="paramtype">const std::vector< int > & </td>
<td class="paramname"><em>coreMeshIds</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set the list of core mesh ids to use for building the hardware model instance. </p>
<p>setCoreMeshIds must be called before the load method otherwise it will have no effect. If setCoreMeshIds is not called, the hardware model instance will use all the core mesh ids from the core model.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">coreMeshIds</td><td>a vector of core mesh ids </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ab014248d56ceb909f9de1a944c7b643d"></a><!-- doxytag: member="CalHardwareModel::setIndexBuffer" ref="ab014248d56ceb909f9de1a944c7b643d" args="(CalIndex *pIndexBuffer)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CalHardwareModel::setIndexBuffer </td>
<td>(</td>
<td class="paramtype">CalIndex * </td>
<td class="paramname"><em>pIndexBuffer</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set the index buffer of the hardware model instance. </p>
<p>This function set the index buffer the hardware model instance.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">pIndexBuffer</td><td>A pointer to the index buffer. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="afbc90fc914ecc0b67a15506fb6695c55"></a><!-- doxytag: member="CalHardwareModel::setMatrixIndexBuffer" ref="afbc90fc914ecc0b67a15506fb6695c55" args="(char *pMatrixIndexBuffer, int stride)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CalHardwareModel::setMatrixIndexBuffer </td>
<td>(</td>
<td class="paramtype">char * </td>
<td class="paramname"><em>pMatrixIndexBuffer</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>stride</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set the matrix index buffer of the hardware model instance. </p>
<p>This function set the matrix index buffer the hardware model instance.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">pMatrixIndexBuffer</td><td>A pointer to the matrix index buffer. </td></tr>
<tr><td class="paramname">stride</td><td>The number of byte to add to find the next element </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a3f4ad99cbd709319e742d4c23bf42557"></a><!-- doxytag: member="CalHardwareModel::setNormalBuffer" ref="a3f4ad99cbd709319e742d4c23bf42557" args="(char *pNormalBuffer, int stride)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CalHardwareModel::setNormalBuffer </td>
<td>(</td>
<td class="paramtype">char * </td>
<td class="paramname"><em>pNormalBuffer</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>stride</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set the normal buffer of the hardware model instance. </p>
<p>This function set the normal buffer the hardware model instance.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">pNormalBuffer</td><td>A pointer to the normal buffer. </td></tr>
<tr><td class="paramname">stride</td><td>The number of byte to add to find the next element </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a06e45f354c326d0a6c189188632c5325"></a><!-- doxytag: member="CalHardwareModel::setTangentSpaceBuffer" ref="a06e45f354c326d0a6c189188632c5325" args="(int mapId, char *pTangentSpaceBuffer, int stride)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CalHardwareModel::setTangentSpaceBuffer </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>mapId</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char * </td>
<td class="paramname"><em>pTangentSpaceBuffer</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>stride</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set the tangent space buffer of the hardware model instance. </p>
<p>This function set the tangent space buffer the hardware model instance.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">mapId</td><td>A integer to the texture stage </td></tr>
<tr><td class="paramname">pTangentSpaceBuffer</td><td>A pointer to the tangent space buffer. </td></tr>
<tr><td class="paramname">stride</td><td>The number of byte to add to find the next element </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a23bffd7cec2788d1ea6a11a0c3e49e07"></a><!-- doxytag: member="CalHardwareModel::setTextureCoordBuffer" ref="a23bffd7cec2788d1ea6a11a0c3e49e07" args="(int mapId, char *pTextureCoordBuffer, int stride)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CalHardwareModel::setTextureCoordBuffer </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>mapId</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char * </td>
<td class="paramname"><em>pTextureCoordBuffer</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>stride</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set the texture coordinate buffer of the hardware model instance. </p>
<p>This function set the texture coordinate buffer the hardware model instance.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">mapId</td><td>A integer to the texture stage </td></tr>
<tr><td class="paramname">pTextureCoordBuffer</td><td>A pointer to the texture coord buffer. </td></tr>
<tr><td class="paramname">stride</td><td>The number of byte to add to find the next element </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a9b2a05151e8bed07b4947a3a35352050"></a><!-- doxytag: member="CalHardwareModel::setTextureCoordNum" ref="a9b2a05151e8bed07b4947a3a35352050" args="(int textureCoordNum)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CalHardwareModel::setTextureCoordNum </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>textureCoordNum</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set the number the texture coordinate of the hardware model instance. </p>
<p>This function set the number the texture coordinate the hardware model instance.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">textureCoordNum</td><td>A integer with the number the texture coordinate. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a2c6bb859d2490b7220d2cababeae3874"></a><!-- doxytag: member="CalHardwareModel::setVertexBuffer" ref="a2c6bb859d2490b7220d2cababeae3874" args="(char *pVertexBuffer, int stride)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CalHardwareModel::setVertexBuffer </td>
<td>(</td>
<td class="paramtype">char * </td>
<td class="paramname"><em>pVertexBuffer</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>stride</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set the vertex (position) buffer of the hardware model instance. </p>
<p>This function set the vertex (position) buffer the hardware model instance.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">pVertexBuffer</td><td>A pointer to the vertex buffer. </td></tr>
<tr><td class="paramname">stride</td><td>The number of byte to add to find the next element </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a55cd29ac125ffe7af7afc42d58a8c137"></a><!-- doxytag: member="CalHardwareModel::setWeightBuffer" ref="a55cd29ac125ffe7af7afc42d58a8c137" args="(char *pWeightBuffer, int stride)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CalHardwareModel::setWeightBuffer </td>
<td>(</td>
<td class="paramtype">char * </td>
<td class="paramname"><em>pWeightBuffer</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>stride</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set the weight buffer of the hardware model instance. </p>
<p>This function set the weight buffer the hardware model instance.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">pWeightBuffer</td><td>A pointer to the weight buffer. </td></tr>
<tr><td class="paramname">stride</td><td>The number of byte to add to find the next element </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="hardwaremodel_8h_source.html">hardwaremodel.h</a></li>
<li>hardwaremodel.cpp</li>
</ul>
</div>
<hr>
<center>
<small>
Generated at Tue Feb 8 2011 08:51:45 by
<a href="http://gna.org/projects/cal3d/">The Cal3D Team</a>
with
<a href="http://www.doxygen.org/index.html">
Doxygen 1.7.3
</a>
</small>
</center>
</body>
</html>
