<html>
<head>
<title>Cal3D: CalCoreBone 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="#pub-methods">Public Member Functions</a> </div>
<div class="headertitle">
<h1>CalCoreBone Class Reference</h1> </div>
</div>
<div class="contents">
<!-- doxytag: class="CalCoreBone" -->
<p><a href="classCalCoreBone-members.html">List of all members.</a></p>
<table class="memberdecls">
<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="classCalCoreBone.html#aafb96f134d1f5ec206f5983328e3a961">CalCoreBone</a> (const std::string &name)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Constructs the core bone instance. <a href="#aafb96f134d1f5ec206f5983328e3a961"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classCalCoreBone.html#a41181d947320da1602039f189c5a5d67">addChildId</a> (int childId)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Adds a child ID. <a href="#a41181d947320da1602039f189c5a5d67"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCalCoreBone.html#a846cf7e6403e7acdf63b25bb52361aa9">calculateState</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Calculates the current state. <a href="#a846cf7e6403e7acdf63b25bb52361aa9"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">std::list< int > & </td><td class="memItemRight" valign="bottom"><a class="el" href="classCalCoreBone.html#aa6b99a54a556eee1d905da4cd776375a">getListChildId</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the child ID list. <a href="#aa6b99a54a556eee1d905da4cd776375a"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const std::string & </td><td class="memItemRight" valign="bottom"><a class="el" href="classCalCoreBone.html#aaca6df7aadf6d02a349ccf3cac406cfe">getName</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the name. <a href="#aaca6df7aadf6d02a349ccf3cac406cfe"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classCalCoreBone.html#ad93b4a81816bc21db8d9b32b3dd55b5c">getParentId</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the parent ID. <a href="#ad93b4a81816bc21db8d9b32b3dd55b5c"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classCalCoreSkeleton.html">CalCoreSkeleton</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classCalCoreBone.html#af17a13069ed0bb148a5d5cae98734660">getCoreSkeleton</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Provides access to the core skeleton. <a href="#af17a13069ed0bb148a5d5cae98734660"></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="classCalCoreBone.html#a8c2edeb543ce170d365ca14214b0d18a">getRotation</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the rotation. <a href="#a8c2edeb543ce170d365ca14214b0d18a"></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="classCalCoreBone.html#a6f52917d6b906aea25a7f984f2b513a3">getRotationAbsolute</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the absolute rotation. <a href="#a6f52917d6b906aea25a7f984f2b513a3"></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="classCalCoreBone.html#afd94254ddd8a30ad2e9def15876fb102">getRotationBoneSpace</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the bone space rotation. <a href="#afd94254ddd8a30ad2e9def15876fb102"></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="classCalCoreBone.html#a1e7cc175305a4507fe6be00e342e9079">getTranslation</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the translation. <a href="#a1e7cc175305a4507fe6be00e342e9079"></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="classCalCoreBone.html#a5755c5020a5284d56d1b74ada70e8dfd">getTranslationAbsolute</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the absolute translation. <a href="#a5755c5020a5284d56d1b74ada70e8dfd"></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="classCalCoreBone.html#a5abd76565923ec403072006c74062e08">getTranslationBoneSpace</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the bone space translation. <a href="#a5abd76565923ec403072006c74062e08"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">Cal::UserData </td><td class="memItemRight" valign="bottom"><a class="el" href="classCalCoreBone.html#a42d22708d6cca236207d500d92f05def">getUserData</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Provides access to the user data. <a href="#a42d22708d6cca236207d500d92f05def"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCalCoreBone.html#a23af2e80e1abeba11e3b29d27ff1a2cf">setCoreSkeleton</a> (<a class="el" href="classCalCoreSkeleton.html">CalCoreSkeleton</a> *pCoreSkeleton)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the core skeleton. <a href="#a23af2e80e1abeba11e3b29d27ff1a2cf"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCalCoreBone.html#aa960f56320ea54606de911add4e6472c">setParentId</a> (int parentId)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the parent ID. <a href="#aa960f56320ea54606de911add4e6472c"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCalCoreBone.html#a14b736607804ea9a9e779e7640f903e5">setRotation</a> (const <a class="el" href="classCalQuaternion.html">CalQuaternion</a> &rotation)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the rotation. <a href="#a14b736607804ea9a9e779e7640f903e5"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCalCoreBone.html#a7b8532b2d80cfbde1d37d7034c0ed634">setRotationBoneSpace</a> (const <a class="el" href="classCalQuaternion.html">CalQuaternion</a> &rotation)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the bone space rotation. <a href="#a7b8532b2d80cfbde1d37d7034c0ed634"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCalCoreBone.html#a38ec923af7fa52421f1f41e97373dc61">setTranslation</a> (const <a class="el" href="classCalVector.html">CalVector</a> &translation)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the translation. <a href="#a38ec923af7fa52421f1f41e97373dc61"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCalCoreBone.html#aef011a25b49312c480fc76391a6b90ac">setTranslationBoneSpace</a> (const <a class="el" href="classCalVector.html">CalVector</a> &translation)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the bone space translation. <a href="#aef011a25b49312c480fc76391a6b90ac"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCalCoreBone.html#aaeb108e6c76a7ed7758e00be099e9e28">setUserData</a> (Cal::UserData userData)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Stores user data. <a href="#aaeb108e6c76a7ed7758e00be099e9e28"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCalCoreBone.html#a3698ad486eede3e9b441aa37fed72217">calculateBoundingBox</a> (<a class="el" href="classCalCoreModel.html">CalCoreModel</a> *pCoreModel)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Calculates the bounding box. <a href="#a3698ad486eede3e9b441aa37fed72217"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classCalBoundingBox.html">CalBoundingBox</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classCalCoreBone.html#ace82066baf010391e91e7413667158fd">getBoundingBox</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the current bounding box. <a href="#ace82066baf010391e91e7413667158fd"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a32fb0492f07e925c1db87620a0197e60"></a><!-- doxytag: member="CalCoreBone::getBoundingData" ref="a32fb0492f07e925c1db87620a0197e60" args="(int planeId, CalVector &position)" -->
void </td><td class="memItemRight" valign="bottom"><b>getBoundingData</b> (int planeId, <a class="el" href="classCalVector.html">CalVector</a> &position)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a72cdc956a549670086a85104ba3bad74"></a><!-- doxytag: member="CalCoreBone::isBoundingBoxPrecomputed" ref="a72cdc956a549670086a85104ba3bad74" args="()" -->
bool </td><td class="memItemRight" valign="bottom"><b>isBoundingBoxPrecomputed</b> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCalCoreBone.html#a771a8dafd016e04525015679cb4a4623">scale</a> (float factor)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Scale the core bone. <a href="#a771a8dafd016e04525015679cb4a4623"></a><br/></td></tr>
</table>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="aafb96f134d1f5ec206f5983328e3a961"></a><!-- doxytag: member="CalCoreBone::CalCoreBone" ref="aafb96f134d1f5ec206f5983328e3a961" args="(const std::string &name)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">CalCoreBone::CalCoreBone </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>name</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Constructs the core bone instance. </p>
<p>This function is the default constructor of the core bone instance. </p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a41181d947320da1602039f189c5a5d67"></a><!-- doxytag: member="CalCoreBone::addChildId" ref="a41181d947320da1602039f189c5a5d67" args="(int childId)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool CalCoreBone::addChildId </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>childId</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Adds a child ID. </p>
<p>This function adds a core bone ID to the child ID list of the core bone instance.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">childId</td><td>The ID of the core bone ID that shoud be added to the child ID list.</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="a3698ad486eede3e9b441aa37fed72217"></a><!-- doxytag: member="CalCoreBone::calculateBoundingBox" ref="a3698ad486eede3e9b441aa37fed72217" args="(CalCoreModel *pCoreModel)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CalCoreBone::calculateBoundingBox </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>Calculates the bounding box. </p>
<p>This function Calculates the bounding box of the core bone instance.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">pCoreModel</td><td>The coreModel (needed for vertices data. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a846cf7e6403e7acdf63b25bb52361aa9"></a><!-- doxytag: member="CalCoreBone::calculateState" ref="a846cf7e6403e7acdf63b25bb52361aa9" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CalCoreBone::calculateState </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Calculates the current state. </p>
<p>This function calculates the current state (absolute translation and rotation) of the core bone instance and all its children. </p>
</div>
</div>
<a class="anchor" id="ace82066baf010391e91e7413667158fd"></a><!-- doxytag: member="CalCoreBone::getBoundingBox" ref="ace82066baf010391e91e7413667158fd" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classCalBoundingBox.html">CalBoundingBox</a> & CalCoreBone::getBoundingBox </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the current bounding box. </p>
<p>This function returns the current bounding box of the core bone instance.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>bounding box. </dd></dl>
</div>
</div>
<a class="anchor" id="af17a13069ed0bb148a5d5cae98734660"></a><!-- doxytag: member="CalCoreBone::getCoreSkeleton" ref="af17a13069ed0bb148a5d5cae98734660" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classCalCoreSkeleton.html">CalCoreSkeleton</a> * CalCoreBone::getCoreSkeleton </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Provides access to the core skeleton. </p>
<p>This function returns the core skeleton.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>One of the following values: <ul>
<li>a pointer to the core skeleton </li>
<li><b>0</b> if an error happend </li>
</ul>
</dd></dl>
</div>
</div>
<a class="anchor" id="aa6b99a54a556eee1d905da4cd776375a"></a><!-- doxytag: member="CalCoreBone::getListChildId" ref="aa6b99a54a556eee1d905da4cd776375a" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::list< int > & CalCoreBone::getListChildId </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the child ID list. </p>
<p>This function returns the list that contains all child IDs of the core bone instance.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>A reference to the child ID list. </dd></dl>
</div>
</div>
<a class="anchor" id="aaca6df7aadf6d02a349ccf3cac406cfe"></a><!-- doxytag: member="CalCoreBone::getName" ref="aaca6df7aadf6d02a349ccf3cac406cfe" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const std::string & CalCoreBone::getName </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the name. </p>
<p>This function returns the name of the core bone instance.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>The name as string. </dd></dl>
</div>
</div>
<a class="anchor" id="ad93b4a81816bc21db8d9b32b3dd55b5c"></a><!-- doxytag: member="CalCoreBone::getParentId" ref="ad93b4a81816bc21db8d9b32b3dd55b5c" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int CalCoreBone::getParentId </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the parent ID. </p>
<p>This function returns the parent ID of the core bone instance.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>One of the following values: <ul>
<li>the <b>ID</b> of the parent </li>
<li><b>-1</b> if the core bone instance is a root core bone </li>
</ul>
</dd></dl>
</div>
</div>
<a class="anchor" id="a8c2edeb543ce170d365ca14214b0d18a"></a><!-- doxytag: member="CalCoreBone::getRotation" ref="a8c2edeb543ce170d365ca14214b0d18a" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classCalQuaternion.html">CalQuaternion</a> & CalCoreBone::getRotation </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the rotation. </p>
<p>This function returns the relative rotation of the core bone instance.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>The relative rotation to the parent as quaternion. </dd></dl>
</div>
</div>
<a class="anchor" id="a6f52917d6b906aea25a7f984f2b513a3"></a><!-- doxytag: member="CalCoreBone::getRotationAbsolute" ref="a6f52917d6b906aea25a7f984f2b513a3" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classCalQuaternion.html">CalQuaternion</a> & CalCoreBone::getRotationAbsolute </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the absolute rotation. </p>
<p>This function returns the absolute rotation of the core bone instance.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>The absolute rotation to the parent as quaternion. </dd></dl>
</div>
</div>
<a class="anchor" id="afd94254ddd8a30ad2e9def15876fb102"></a><!-- doxytag: member="CalCoreBone::getRotationBoneSpace" ref="afd94254ddd8a30ad2e9def15876fb102" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classCalQuaternion.html">CalQuaternion</a> & CalCoreBone::getRotationBoneSpace </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the bone space rotation. </p>
<p>This function returns the rotation to bring a point into the core bone instance space.</p>
<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="a1e7cc175305a4507fe6be00e342e9079"></a><!-- doxytag: member="CalCoreBone::getTranslation" ref="a1e7cc175305a4507fe6be00e342e9079" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classCalVector.html">CalVector</a> & CalCoreBone::getTranslation </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the translation. </p>
<p>This function returns the relative translation of the core bone instance.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>The relative translation to the parent as quaternion. </dd></dl>
</div>
</div>
<a class="anchor" id="a5755c5020a5284d56d1b74ada70e8dfd"></a><!-- doxytag: member="CalCoreBone::getTranslationAbsolute" ref="a5755c5020a5284d56d1b74ada70e8dfd" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classCalVector.html">CalVector</a> & CalCoreBone::getTranslationAbsolute </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the absolute translation. </p>
<p>This function returns the absolute translation of the core bone instance.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>The absolute translation to the parent as quaternion. </dd></dl>
</div>
</div>
<a class="anchor" id="a5abd76565923ec403072006c74062e08"></a><!-- doxytag: member="CalCoreBone::getTranslationBoneSpace" ref="a5abd76565923ec403072006c74062e08" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classCalVector.html">CalVector</a> & CalCoreBone::getTranslationBoneSpace </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the bone space translation. </p>
<p>This function returns the translation to bring a point into the core bone instance space.</p>
<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="a42d22708d6cca236207d500d92f05def"></a><!-- doxytag: member="CalCoreBone::getUserData" ref="a42d22708d6cca236207d500d92f05def" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Cal::UserData CalCoreBone::getUserData </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Provides access to the user data. </p>
<p>This function returns the user data stored in the core bone instance.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>The user data stored in the core bone instance. </dd></dl>
</div>
</div>
<a class="anchor" id="a771a8dafd016e04525015679cb4a4623"></a><!-- doxytag: member="CalCoreBone::scale" ref="a771a8dafd016e04525015679cb4a4623" args="(float factor)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CalCoreBone::scale </td>
<td>(</td>
<td class="paramtype">float </td>
<td class="paramname"><em>factor</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Scale the core bone. </p>
<p>This function rescale all the data that are in the core bone instance and in his childs.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">factor</td><td>A float with the scale factor </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a23af2e80e1abeba11e3b29d27ff1a2cf"></a><!-- doxytag: member="CalCoreBone::setCoreSkeleton" ref="a23af2e80e1abeba11e3b29d27ff1a2cf" args="(CalCoreSkeleton *pCoreSkeleton)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CalCoreBone::setCoreSkeleton </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classCalCoreSkeleton.html">CalCoreSkeleton</a> * </td>
<td class="paramname"><em>pCoreSkeleton</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Sets the core skeleton. </p>
<p>This function sets the core skeleton to which the core bone instance is attached to.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">pCoreSkeleton</td><td>The core skeleton to which the core bone instance should be attached to. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="aa960f56320ea54606de911add4e6472c"></a><!-- doxytag: member="CalCoreBone::setParentId" ref="aa960f56320ea54606de911add4e6472c" args="(int parentId)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CalCoreBone::setParentId </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>parentId</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Sets the parent ID. </p>
<p>This function sets the parent ID of the core bone instance.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">parentId</td><td>The ID of the parent that should be set. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a14b736607804ea9a9e779e7640f903e5"></a><!-- doxytag: member="CalCoreBone::setRotation" ref="a14b736607804ea9a9e779e7640f903e5" args="(const CalQuaternion &rotation)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CalCoreBone::setRotation </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classCalQuaternion.html">CalQuaternion</a> & </td>
<td class="paramname"><em>rotation</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Sets the rotation. </p>
<p>This function sets the relative rotation of the core bone instance.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">rotation</td><td>The relative rotation to the parent as quaternion. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a7b8532b2d80cfbde1d37d7034c0ed634"></a><!-- doxytag: member="CalCoreBone::setRotationBoneSpace" ref="a7b8532b2d80cfbde1d37d7034c0ed634" args="(const CalQuaternion &rotation)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CalCoreBone::setRotationBoneSpace </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classCalQuaternion.html">CalQuaternion</a> & </td>
<td class="paramname"><em>rotation</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Sets the bone space rotation. </p>
<p>This function sets the rotation that brings a point into the core bone instance space.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">rotation</td><td>The rotation that brings a point into bone space. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a38ec923af7fa52421f1f41e97373dc61"></a><!-- doxytag: member="CalCoreBone::setTranslation" ref="a38ec923af7fa52421f1f41e97373dc61" args="(const CalVector &translation)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CalCoreBone::setTranslation </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classCalVector.html">CalVector</a> & </td>
<td class="paramname"><em>translation</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Sets the translation. </p>
<p>This function sets the relative translation of the core bone instance.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">translation</td><td>The relative translation to the parent as vector. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="aef011a25b49312c480fc76391a6b90ac"></a><!-- doxytag: member="CalCoreBone::setTranslationBoneSpace" ref="aef011a25b49312c480fc76391a6b90ac" args="(const CalVector &translation)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CalCoreBone::setTranslationBoneSpace </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classCalVector.html">CalVector</a> & </td>
<td class="paramname"><em>translation</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Sets the bone space translation. </p>
<p>This function sets the translation that brings a point into the core bone instance space.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">translation</td><td>The translation that brings a point into bone space. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="aaeb108e6c76a7ed7758e00be099e9e28"></a><!-- doxytag: member="CalCoreBone::setUserData" ref="aaeb108e6c76a7ed7758e00be099e9e28" args="(Cal::UserData userData)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CalCoreBone::setUserData </td>
<td>(</td>
<td class="paramtype">Cal::UserData </td>
<td class="paramname"><em>userData</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Stores user data. </p>
<p>This function stores user data in the core bone instance.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">userData</td><td>The user data that should be stored. </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="corebone_8h_source.html">corebone.h</a></li>
<li>corebone.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>
