diff options
Diffstat (limited to 'docs/doxygen/nel/a03204.html')
| -rw-r--r-- | docs/doxygen/nel/a03204.html | 268 |
1 files changed, 268 insertions, 0 deletions
diff --git a/docs/doxygen/nel/a03204.html b/docs/doxygen/nel/a03204.html new file mode 100644 index 00000000..49366820 --- /dev/null +++ b/docs/doxygen/nel/a03204.html @@ -0,0 +1,268 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>NeL: NL3D::CPSFluidFrictionFunctor class Reference</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body> +<!-- Generated by Doxygen 1.3.6 --> +<div class="qindex"> <form class="search" action="search.php" method="get"> +<a class="qindex" href="main.html">Main Page</a> | <a class="qindex" href="namespaces.html">Namespace List</a> | <a class="qindex" href="hierarchy.html">Class Hierarchy</a> | <a class="qindex" href="classes.html">Alphabetical List</a> | <a class="qindex" href="annotated.html">Data Structures</a> | <a class="qindex" href="files.html">File List</a> | <a class="qindex" href="namespacemembers.html">Namespace Members</a> | <a class="qindex" href="functions.html">Data Fields</a> | <a class="qindex" href="globals.html">Globals</a> | <a class="qindex" href="pages.html">Related Pages</a> | <span class="search"><u>S</u>earch for <input class="search" type="text" name="query" value="" size="20" accesskey="s"/></span></form></div> +<h1>NL3D::CPSFluidFrictionFunctor Class Reference</h1><code>#include <<a class="el" href="a06240.html">ps_force.h</a>></code> +<p> +<hr><a name="_details"></a><h2>Detailed Description</h2> +a fluid friction functor, it is used by the fluid friction class +<p> + +<p> +Definition at line <a class="el" href="a06240.html#l00496">496</a> of file <a class="el" href="a06240.html">ps_force.h</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="a03204.html#NL3D_1_1CPSFluidFrictionFunctora0">CPSFluidFrictionFunctor</a> ()</td></tr> + +<tr><td class="memItemLeft" nowrap align=right valign=top>float </td><td class="memItemRight" valign=bottom><a class="el" href="a03204.html#NL3D_1_1CPSFluidFrictionFunctora1">getK</a> (void) const </td></tr> + +<tr><td class="memItemLeft" nowrap align=right valign=top>void </td><td class="memItemRight" valign=bottom><a class="el" href="a03204.html#NL3D_1_1CPSFluidFrictionFunctora2">operator()</a> (const <a class="el" href="a03128.html">NLMISC::CVector</a> &pos, <a class="el" href="a03128.html">NLMISC::CVector</a> &speed, float invMass, <a class="el" href="a05363.html#a366">TAnimationTime</a> ellapsedTime)</td></tr> + +<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void </td><td class="memItemRight" valign=bottom><a class="el" href="a03204.html#NL3D_1_1CPSFluidFrictionFunctora3">serial</a> (<a class="el" href="a02270.html">NLMISC::IStream</a> &f) throw (NLMISC::EStream)</td></tr> + +<tr><td class="memItemLeft" nowrap align=right valign=top>void </td><td class="memItemRight" valign=bottom><a class="el" href="a03204.html#NL3D_1_1CPSFluidFrictionFunctora4">setK</a> (float coeff)</td></tr> + +<tr><td colspan=2><br><h2>Protected Attributes</h2></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>float </td><td class="memItemRight" valign=bottom><a class="el" href="a03204.html#NL3D_1_1CPSFluidFrictionFunctorp0">_K</a></td></tr> + +</table> +<hr><h2>Constructor & Destructor Documentation</h2> +<a class="anchor" name="NL3D_1_1CPSFluidFrictionFunctora0" doxytag="NL3D::CPSFluidFrictionFunctor::CPSFluidFrictionFunctor" ></a><p> +<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> NL3D::CPSFluidFrictionFunctor::CPSFluidFrictionFunctor </td> + <td class="md" valign="top">( </td> + <td class="mdname1" valign="top" nowrap> </td> + <td class="md" valign="top"> ) </td> + <td class="md" nowrap><code> [inline]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> + +<p> +Definition at line <a class="el" href="a06240.html#l00499">499</a> of file <a class="el" href="a06240.html">ps_force.h</a>. +<p> +<div class="fragment"><pre>00499 : <a class="code" href="a03204.html#NL3D_1_1CPSFluidFrictionFunctorp0">_K</a>(1.f) +00500 { +00501 } +</pre></div> </td> + </tr> +</table> +<hr><h2>Member Function Documentation</h2> +<a class="anchor" name="NL3D_1_1CPSFluidFrictionFunctora1" doxytag="NL3D::CPSFluidFrictionFunctor::getK" ></a><p> +<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> float NL3D::CPSFluidFrictionFunctor::getK </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">void </td> + <td class="mdname1" valign="top" nowrap> </td> + <td class="md" valign="top"> ) </td> + <td class="md" nowrap> const<code> [inline]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> + +<p> +Definition at line <a class="el" href="a06240.html#l00518">518</a> of file <a class="el" href="a06240.html">ps_force.h</a>. +<p> +<div class="fragment"><pre>00518 { <span class="keywordflow">return</span> <a class="code" href="a03204.html#NL3D_1_1CPSFluidFrictionFunctorp0">_K</a>; } +</pre></div> </td> + </tr> +</table> +<a class="anchor" name="NL3D_1_1CPSFluidFrictionFunctora2" doxytag="NL3D::CPSFluidFrictionFunctor::operator()" ></a><p> +<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> void NL3D::CPSFluidFrictionFunctor::operator() </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">const <a class="el" href="a03128.html">NLMISC::CVector</a> & </td> + <td class="mdname" nowrap> <em>pos</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td></td> + <td class="md" nowrap><a class="el" href="a03128.html">NLMISC::CVector</a> & </td> + <td class="mdname" nowrap> <em>speed</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td></td> + <td class="md" nowrap>float </td> + <td class="mdname" nowrap> <em>invMass</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td></td> + <td class="md" nowrap><a class="el" href="a05363.html#a366">TAnimationTime</a> </td> + <td class="mdname" nowrap> <em>ellapsedTime</em></td> + </tr> + <tr> + <td></td> + <td class="md">) </td> + <td class="md" colspan="2"><code> [inline]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> + +<p> +Definition at line <a class="el" href="a06240.html#l00506">506</a> of file <a class="el" href="a06240.html">ps_force.h</a>. +<p> +References <a class="el" href="a05454.html#l00044">NL3D::TAnimationTime</a>. +<p> +<div class="fragment"><pre>00507 { +00508 speed -= (ellapsedTime * <a class="code" href="a03204.html#NL3D_1_1CPSFluidFrictionFunctorp0">_K</a> * invMass * speed); +00509 } +</pre></div> </td> + </tr> +</table> +<a class="anchor" name="NL3D_1_1CPSFluidFrictionFunctora3" doxytag="NL3D::CPSFluidFrictionFunctor::serial" ></a><p> +<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> virtual void NL3D::CPSFluidFrictionFunctor::serial </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="a02270.html">NLMISC::IStream</a> & </td> + <td class="mdname1" valign="top" nowrap> <em>f</em> </td> + <td class="md" valign="top"> ) </td> + <td class="md" nowrap> throw (<a class="el" href="a03781.html">NLMISC::EStream</a>)<code> [inline, virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> + +<p> +Definition at line <a class="el" href="a06240.html#l00511">511</a> of file <a class="el" href="a06240.html">ps_force.h</a>. +<p> +<div class="fragment"><pre>00512 { +00513 f.<a class="code" href="a02270.html#NLMISC_1_1IStreamz2035_8">serialVersion</a>(1); +00514 <span class="comment">// we don't save intensity info : it is saved by the owning object (and set before each use of this functor)</span> +00515 } +</pre></div> </td> + </tr> +</table> +<a class="anchor" name="NL3D_1_1CPSFluidFrictionFunctora4" doxytag="NL3D::CPSFluidFrictionFunctor::setK" ></a><p> +<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> void NL3D::CPSFluidFrictionFunctor::setK </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">float </td> + <td class="mdname1" valign="top" nowrap> <em>coeff</em> </td> + <td class="md" valign="top"> ) </td> + <td class="md" nowrap><code> [inline]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> + +<p> +Definition at line <a class="el" href="a06240.html#l00521">521</a> of file <a class="el" href="a06240.html">ps_force.h</a>. +<p> +Referenced by <a class="el" href="a06240.html#l00544">NL3D::CPSFluidFriction::setupFunctor()</a>. +<p> +<div class="fragment"><pre>00521 { <a class="code" href="a03204.html#NL3D_1_1CPSFluidFrictionFunctorp0">_K</a> = coeff; } +</pre></div> </td> + </tr> +</table> +<hr><h2>Field Documentation</h2> +<a class="anchor" name="NL3D_1_1CPSFluidFrictionFunctorp0" doxytag="NL3D::CPSFluidFrictionFunctor::_K" ></a><p> +<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> float <a class="el" href="a03204.html#NL3D_1_1CPSFluidFrictionFunctorp0">NL3D::CPSFluidFrictionFunctor::_K</a><code> [protected]</code> + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> + +<p> +Definition at line <a class="el" href="a06240.html#l00524">524</a> of file <a class="el" href="a06240.html">ps_force.h</a>. </td> + </tr> +</table> +<hr>The documentation for this class was generated from the following file:<ul> +<li><a class="el" href="a06240.html">ps_force.h</a></ul> +<hr size="1"><address style="align: right;"><small>Generated on Tue Mar 16 07:14:15 2004 for NeL by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.png" alt="doxygen" align="middle" border=0 > +</a>1.3.6 </small></address> +</body> +</html> |