<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.5.9 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<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 class="tabs">
<ul>
<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="contents">
<h1>CalSpringSystem Class Reference</h1><!-- doxytag: class="CalSpringSystem" -->The spring system class.
<a href="#_details">More...</a>
<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><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"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCalSpringSystem.html#0b716d1ffa2c6afae955e2949bc777f6">CalSpringSystem</a> (CalModel *pModel)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Constructs the spring system instance. <a href="#0b716d1ffa2c6afae955e2949bc777f6"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCalSpringSystem.html#5708f91f7b009325c6465cc72d62d3b0">calculateForces</a> (CalSubmesh *pSubmesh, float deltaTime)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Calculates the forces on each unbound vertex. <a href="#5708f91f7b009325c6465cc72d62d3b0"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCalSpringSystem.html#23866c08780166e0f5af5886dbc4f131">calculateVertices</a> (CalSubmesh *pSubmesh, float deltaTime)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Calculates the vertices influenced by the spring system instance. <a href="#23866c08780166e0f5af5886dbc4f131"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCalSpringSystem.html#187183860d960ffc05b5c82c9a90b245">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="#187183860d960ffc05b5c82c9a90b245"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classCalVector.html">CalVector</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classCalSpringSystem.html#14e77ee429ae7bfebd56a013e20d0589">getGravityVector</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the gravity vector. <a href="#14e77ee429ae7bfebd56a013e20d0589"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCalSpringSystem.html#3d8d612fbec2792d90b034bf0dba5308">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="#3d8d612fbec2792d90b034bf0dba5308"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classCalVector.html">CalVector</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classCalSpringSystem.html#858d6368eae4144abf1ddfc0f7baf693">getForceVector</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the force vector. <a href="#858d6368eae4144abf1ddfc0f7baf693"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCalSpringSystem.html#3f0764a9489eb7df1854c0deed3035c9">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="#3f0764a9489eb7df1854c0deed3035c9"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCalSpringSystem.html#f14740bede7a24be92fc399fafe095ae">setCollisionDetection</a> (bool collision)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Enable or disable the collision system. <a href="#f14740bede7a24be92fc399fafe095ae"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
The spring system class. <hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="0b716d1ffa2c6afae955e2949bc777f6"></a><!-- doxytag: member="CalSpringSystem::CalSpringSystem" ref="0b716d1ffa2c6afae955e2949bc777f6" args="(CalModel *pModel)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">CalSpringSystem::CalSpringSystem </td>
<td>(</td>
<td class="paramtype">CalModel * </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>
This function is the default constructor of the spring system instance.
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="5708f91f7b009325c6465cc72d62d3b0"></a><!-- doxytag: member="CalSpringSystem::calculateForces" ref="5708f91f7b009325c6465cc72d62d3b0" 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">CalSubmesh * </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><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Calculates the forces on each unbound vertex.
<p>
This function calculates the forces on each unbound vertex of a specific submesh.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>pSubmesh</em> </td><td>A pointer to the submesh from which the forces should be calculated. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>deltaTime</em> </td><td>The elapsed time in seconds since the last calculation. </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="23866c08780166e0f5af5886dbc4f131"></a><!-- doxytag: member="CalSpringSystem::calculateVertices" ref="23866c08780166e0f5af5886dbc4f131" 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">CalSubmesh * </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><td> </td>
</tr>
<tr>
<td></td>
<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>
This function calculates the vertices influenced by the spring system instance.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>pSubmesh</em> </td><td>A pointer to the submesh from which the vertices should be calculated. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>deltaTime</em> </td><td>The elapsed time in seconds since the last calculation. </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="858d6368eae4144abf1ddfc0f7baf693"></a><!-- doxytag: member="CalSpringSystem::getForceVector" ref="858d6368eae4144abf1ddfc0f7baf693" 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>
This function returns the force vector of the spring system instance.<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>the force vector as vector. </dd></dl>
</div>
</div><p>
<a class="anchor" name="14e77ee429ae7bfebd56a013e20d0589"></a><!-- doxytag: member="CalSpringSystem::getGravityVector" ref="14e77ee429ae7bfebd56a013e20d0589" 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>
This function returns the gravity vector of the spring system instance.<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>the gravity vector as vector. </dd></dl>
</div>
</div><p>
<a class="anchor" name="f14740bede7a24be92fc399fafe095ae"></a><!-- doxytag: member="CalSpringSystem::setCollisionDetection" ref="f14740bede7a24be92fc399fafe095ae" 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 compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>collision</em> </td><td>true to enable the collision system else false </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="3f0764a9489eb7df1854c0deed3035c9"></a><!-- doxytag: member="CalSpringSystem::setForceVector" ref="3f0764a9489eb7df1854c0deed3035c9" 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>
This function sets the force vector of the spring system instance.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>vForce</em> </td><td>the force vector as vector. </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="3d8d612fbec2792d90b034bf0dba5308"></a><!-- doxytag: member="CalSpringSystem::setGravityVector" ref="3d8d612fbec2792d90b034bf0dba5308" 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>
This function sets the gravity vector of the spring system instance.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>vGravity</em> </td><td>the gravity vector as vector. </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="187183860d960ffc05b5c82c9a90b245"></a><!-- doxytag: member="CalSpringSystem::update" ref="187183860d960ffc05b5c82c9a90b245" 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>
This functon updates all the spring systems in the attached meshes.
</div>
</div><p>
<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>springsystem.cpp</ul>
</div>
<hr>
<center>
<small>
Generated at Fri Jul 24 21:14:57 2009 by
<a href="http://gna.org/projects/cal3d/">The Cal3D Team</a>
with
<a href="http://www.doxygen.org/index.html">
Doxygen 1.5.9
</a>
</small>
</center>
</body>
</html>
