<html>
<head>
<title>Cal3D: CalSpringSystem 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>CalSpringSystem Class Reference</h1> </div>
</div>
<div class="contents">
<!-- doxytag: class="CalSpringSystem" -->
<p>The spring system class.
<a href="#_details">More...</a></p>
<p><code>#include <<a class="el" href="springsystem_8h_source.html">springsystem.h</a>></code></p>
<p><a href="classCalSpringSystem-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="classCalSpringSystem.html#a0b716d1ffa2c6afae955e2949bc777f6">CalSpringSystem</a> (<a class="el" href="classCalModel.html">CalModel</a> *pModel)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Constructs the spring system instance. <a href="#a0b716d1ffa2c6afae955e2949bc777f6"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCalSpringSystem.html#a5708f91f7b009325c6465cc72d62d3b0">calculateForces</a> (<a class="el" href="classCalSubmesh.html">CalSubmesh</a> *pSubmesh, float deltaTime)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Calculates the forces on each unbound vertex. <a href="#a5708f91f7b009325c6465cc72d62d3b0"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCalSpringSystem.html#a23866c08780166e0f5af5886dbc4f131">calculateVertices</a> (<a class="el" href="classCalSubmesh.html">CalSubmesh</a> *pSubmesh, float deltaTime)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Calculates the vertices influenced by the spring system instance. <a href="#a23866c08780166e0f5af5886dbc4f131"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCalSpringSystem.html#a187183860d960ffc05b5c82c9a90b245">update</a> (float deltaTime)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Updates all the spring systems in the attached meshes. <a href="#a187183860d960ffc05b5c82c9a90b245"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classCalVector.html">CalVector</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classCalSpringSystem.html#a14e77ee429ae7bfebd56a013e20d0589">getGravityVector</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the gravity vector. <a href="#a14e77ee429ae7bfebd56a013e20d0589"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCalSpringSystem.html#a3d8d612fbec2792d90b034bf0dba5308">setGravityVector</a> (const <a class="el" href="classCalVector.html">CalVector</a> &vGravity)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the gravity vector. <a href="#a3d8d612fbec2792d90b034bf0dba5308"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classCalVector.html">CalVector</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classCalSpringSystem.html#a858d6368eae4144abf1ddfc0f7baf693">getForceVector</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the force vector. <a href="#a858d6368eae4144abf1ddfc0f7baf693"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCalSpringSystem.html#a3f0764a9489eb7df1854c0deed3035c9">setForceVector</a> (const <a class="el" href="classCalVector.html">CalVector</a> &vForce)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the force vector. <a href="#a3f0764a9489eb7df1854c0deed3035c9"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCalSpringSystem.html#af14740bede7a24be92fc399fafe095ae">setCollisionDetection</a> (bool collision)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Enable or disable the collision system. <a href="#af14740bede7a24be92fc399fafe095ae"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>The spring system class. </p>
</div><hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a0b716d1ffa2c6afae955e2949bc777f6"></a><!-- doxytag: member="CalSpringSystem::CalSpringSystem" ref="a0b716d1ffa2c6afae955e2949bc777f6" args="(CalModel *pModel)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">CalSpringSystem::CalSpringSystem </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classCalModel.html">CalModel</a> * </td>
<td class="paramname"><em>pModel</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Constructs the spring system instance. </p>
<p>This function is the default constructor of the spring system instance. </p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a5708f91f7b009325c6465cc72d62d3b0"></a><!-- doxytag: member="CalSpringSystem::calculateForces" ref="a5708f91f7b009325c6465cc72d62d3b0" args="(CalSubmesh *pSubmesh, float deltaTime)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CalSpringSystem::calculateForces </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classCalSubmesh.html">CalSubmesh</a> * </td>
<td class="paramname"><em>pSubmesh</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float </td>
<td class="paramname"><em>deltaTime</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Calculates the forces on each unbound vertex. </p>
<p>This function calculates the forces on each unbound vertex of a specific submesh.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">pSubmesh</td><td>A pointer to the submesh from which the forces should be calculated. </td></tr>
<tr><td class="paramname">deltaTime</td><td>The elapsed time in seconds since the last calculation. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a23866c08780166e0f5af5886dbc4f131"></a><!-- doxytag: member="CalSpringSystem::calculateVertices" ref="a23866c08780166e0f5af5886dbc4f131" args="(CalSubmesh *pSubmesh, float deltaTime)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CalSpringSystem::calculateVertices </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classCalSubmesh.html">CalSubmesh</a> * </td>
<td class="paramname"><em>pSubmesh</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float </td>
<td class="paramname"><em>deltaTime</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Calculates the vertices influenced by the spring system instance. </p>
<p>This function calculates the vertices influenced by the spring system instance.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">pSubmesh</td><td>A pointer to the submesh from which the vertices should be calculated. </td></tr>
<tr><td class="paramname">deltaTime</td><td>The elapsed time in seconds since the last calculation. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a858d6368eae4144abf1ddfc0f7baf693"></a><!-- doxytag: member="CalSpringSystem::getForceVector" ref="a858d6368eae4144abf1ddfc0f7baf693" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classCalVector.html">CalVector</a> & CalSpringSystem::getForceVector </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the force vector. </p>
<p>This function returns the force vector of the spring system instance.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>the force vector as vector. </dd></dl>
</div>
</div>
<a class="anchor" id="a14e77ee429ae7bfebd56a013e20d0589"></a><!-- doxytag: member="CalSpringSystem::getGravityVector" ref="a14e77ee429ae7bfebd56a013e20d0589" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classCalVector.html">CalVector</a> & CalSpringSystem::getGravityVector </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the gravity vector. </p>
<p>This function returns the gravity vector of the spring system instance.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>the gravity vector as vector. </dd></dl>
</div>
</div>
<a class="anchor" id="af14740bede7a24be92fc399fafe095ae"></a><!-- doxytag: member="CalSpringSystem::setCollisionDetection" ref="af14740bede7a24be92fc399fafe095ae" args="(bool collision)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CalSpringSystem::setCollisionDetection </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"><em>collision</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Enable or disable the collision system. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">collision</td><td>true to enable the collision system else false </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a3f0764a9489eb7df1854c0deed3035c9"></a><!-- doxytag: member="CalSpringSystem::setForceVector" ref="a3f0764a9489eb7df1854c0deed3035c9" args="(const CalVector &vForce)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CalSpringSystem::setForceVector </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classCalVector.html">CalVector</a> & </td>
<td class="paramname"><em>vForce</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Sets the force vector. </p>
<p>This function sets the force vector of the spring system instance.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">vForce</td><td>the force vector as vector. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a3d8d612fbec2792d90b034bf0dba5308"></a><!-- doxytag: member="CalSpringSystem::setGravityVector" ref="a3d8d612fbec2792d90b034bf0dba5308" args="(const CalVector &vGravity)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CalSpringSystem::setGravityVector </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classCalVector.html">CalVector</a> & </td>
<td class="paramname"><em>vGravity</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Sets the gravity vector. </p>
<p>This function sets the gravity vector of the spring system instance.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">vGravity</td><td>the gravity vector as vector. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a187183860d960ffc05b5c82c9a90b245"></a><!-- doxytag: member="CalSpringSystem::update" ref="a187183860d960ffc05b5c82c9a90b245" args="(float deltaTime)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CalSpringSystem::update </td>
<td>(</td>
<td class="paramtype">float </td>
<td class="paramname"><em>deltaTime</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Updates all the spring systems in the attached meshes. </p>
<p>This functon updates all the spring systems in the attached meshes. </p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="springsystem_8h_source.html">springsystem.h</a></li>
<li>springsystem.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>
