diff options
Diffstat (limited to 'docs/doxygen/nel/classNL3D_1_1CPSForceIntensityHelper.html')
| -rw-r--r-- | docs/doxygen/nel/classNL3D_1_1CPSForceIntensityHelper.html | 320 |
1 files changed, 320 insertions, 0 deletions
diff --git a/docs/doxygen/nel/classNL3D_1_1CPSForceIntensityHelper.html b/docs/doxygen/nel/classNL3D_1_1CPSForceIntensityHelper.html new file mode 100644 index 00000000..40a869f2 --- /dev/null +++ b/docs/doxygen/nel/classNL3D_1_1CPSForceIntensityHelper.html @@ -0,0 +1,320 @@ +<!doctype html public "-//W3C//DTD HTML 4.0 Transitional//EN" "http://www.w3.org/TR/REC-html40/loose.dtd"> +<HTML> +<HEAD> + <TITLE>nevrax.org : docs</TITLE> + <LINK REL=stylesheet TYPE="text/css" HREF="http://www.nevrax.org/inc/css/nevrax.css"> + <link href="doxygen.css" rel="stylesheet" type="text/css"> +</HEAD> +<BODY MARGINHEIGHT="0" MARGINWIDTH="0"> + +<!-- uplinks --> +<TABLE CELLSPACING=0 CELLPADDING=0 BORDER=0> + <TR> + <TD WIDTH=16><IMG SRC="http://www.nevrax.org/inc/img/pixel.gif" WIDTH="16" HEIGHT="16" BORDER=0 ALT=""></TD> + <TD WIDTH=140 BGCOLOR=#dddddd><IMG SRC="http://www.nevrax.org/inc/img/pixel.gif" WIDTH="140" HEIGHT="16" BORDER=0 ALT=""></TD> + <TD WIDTH=16><IMG SRC="http://www.nevrax.org/inc/img/pixel.gif" WIDTH="16" HEIGHT="16" BORDER=0 ALT=""></TD> + <TD><IMG width=6 height=14 SRC="http://www.nevrax.org/inc/img/reddots.gif" ALT="#" VSPACE=2 HSPACE=2 BORDER=0 ></TD><TD VALIGN=middle> <A CLASS=uplinks HREF=http://www.nevrax.org><b>Home</B></FONT></A> </TD> + <TD><IMG width=6 height=14 SRC="http://www.nevrax.org/inc/img/reddots.gif" ALT="#" VSPACE=2 HSPACE=2 BORDER=0 ></TD><TD VALIGN=middle> <A CLASS=uplinks HREF=http://www.nevrax.com><b>nevrax.com</B></FONT></A> </TD> + </TR> +</TABLE> + +<!-- banner Nevrax --> +<TABLE CELLSPACING=0 CELLPADDING=0 BORDER=0 WIDTH=100%> + <TR><TD BGCOLOR="#000000" BACKGROUND="http://www.nevrax.org/inc/img/black_banner.jpg"><A HREF="http://www.nevrax.org"><IMG SRC="http://www.nevrax.org/inc/img/nevrax.gif" WIDTH="170" HEIGHT="45" BORDER=0 ALT="Nevrax" ></A></TD></TR> +</TABLE> + +<!-- main table --> +<TABLE CELLSPACING=0 CELLPADDING=0 BORDER=0 height=100%> + <TR> + <TD WIDTH=16><IMG SRC="http://www.nevrax.org/inc/img/pixel.gif" WIDTH="16" HEIGHT="10" BORDER=0 ALT=""></TD> + <TD WIDTH=140 BGCOLOR=#dddddd VALIGN=TOP ALIGN=middle><IMG SRC="http://www.nevrax.org/inc/img/pixel.gif" WIDTH="140" HEIGHT="10" BORDER=0 ALT=""> + + <!------ Begin Box ------> + <TABLE BORDER=0 CELLSPACING=0 CELLPADDING=0 BGCOLOR=black><TR><TD><TABLE border=0 cellspacing=2 cellpadding=0 width=120><tr><TD ALIGN=middle bgcolor=black> + <FONT COLOR=white FACE="sans-serif"><B>Nevrax.org</B></FONT></TD></TR><tr><td colspan=2 bgcolor=#FFFFFF> + <TABLE cellspacing=0 cellpadding=1 border=0> + <tr><td ALIGN=middle><a class='linkbox' href="http://www.nevrax.org/news/" TITLE="Rubrique news"><img width=13 height=15 hspace=5 border=0 src=http://www.nevrax.org/inc/img/picto-news.gif ALT=#></A></td><td><a class='linkbox' href="http://www.nevrax.org/news/" TITLE="News">News</a></td></tr> + <tr><td ALIGN=middle><a class='linkbox' href="http://www.nevrax.org/mail/" TITLE="Rubrique mail"><img width=15 height=11 hspace=5 border=0 src=http://www.nevrax.org/inc/img/picto-mail.gif ALT=#></A></td><td><a class='linkbox' href="http://www.nevrax.org/mail/" TITLE="Mailing list archive">Mailing-list</a></td></tr> + <tr><td ALIGN=middle><a class='linkbox' href="http://www.nevrax.org/docs/" TITLE="Rubrique docs"><img width=14 height=16 hspace=5 border=0 src=http://www.nevrax.org/inc/img/picto-docs.gif ALT=#></A></td><td><a class='linkbox' href="http://www.nevrax.org/docs/" TITLE="Documentation">Documentation</a></td></tr> + <tr><td ALIGN=middle><a class='linkbox' href="http://www.nevrax.org/cvs/" TITLE="Rubrique cvs"><img width=13 height=17 hspace=5 border=0 src=http://www.nevrax.org/inc/img/picto-cvs.gif ALT=#></A></td><td><a class='linkbox' href="http://www.nevrax.org/cvs/" TITLE="CVS Web">CVS</a></td></tr> + <tr><td ALIGN=middle><a class='linkbox' href="http://www.nevrax.org/bugs/" TITLE="Rubrique bugs"><img width=20 height=16 hspace=5 border=0 src=http://www.nevrax.org/inc/img/picto-bugs.gif ALT=#></A></td><td><a class='linkbox' href="http://www.nevrax.org/bugs/" TITLE="Bugtracking">Bugs</a></td></tr> + <tr><td ALIGN=middle><a class='linkbox' href="http://www.nevrax.org/GPL.php3" TITLE="Rubrique license"><img width=18 height=12 hspace=5 border=0 src=http://www.nevrax.org/inc/img/picto-gpl.gif ALT=#></A></td><td><a class='linkbox' href="http://www.nevrax.org/GPL.php3" TITLE="License">License</a></td></tr> + </TABLE> + </TD></TR></TABLE></TD></TR></TABLE> + <!------ End Box ------> + + </TD> + <TD WIDTH=15><IMG SRC="http://www.nevrax.org/inc/img/pixel.gif" WIDTH="16" HEIGHT="16" BORDER=0 ALT=""></TD> + <TD ALIGN=left valign=top><IMG SRC="http://www.nevrax.org/inc/img/pixel.gif" WIDTH="140" HEIGHT="10" BORDER=0 ALT=""> + +<!-- title --> +<TABLE background="http://www.nevrax.org/inc/img/redline.gif" CELLSPACING=0 CELLPADDING=0 BORDER=0 width=100%><tr><td> +<A HREF="http://www.nevrax.org/docs/"><img src="http://www.nevrax.org/inc/img/t_docs.gif" ALT="Docs" HEIGHT=20 BORDER=0></A> +</td><td><IMG SRC="http://www.nevrax.org/inc/img/pixel.gif" WIDTH="1" HEIGHT="1" BORDER=0 ALT=""> +</td></tr></table> + + +<!-- block --> +<TABLE bgcolor="#dddddd" CELLSPACING=0 CELLPADDING=0 BORDER=0 width=100%><tr><td width=1% valign=middle><img width=6 height=14 hspace=2 vspace=2 src="http://www.nevrax.org/inc/img/reddots.gif"></TD> + <TD><B>Documentation</B></TD> + <TD ALIGN=RIGHT> </td> +</tr></table> +<!-- Generated by Doxygen 1.2.14 --> +<center> +<a class="qindex" href="index.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">Compound List</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">Compound Members</a> <a class="qindex" href="globals.html">File Members</a> <a class="qindex" href="pages.html">Related Pages</a> <a class="qindexRef" doxygen="_cgi:http://www.nevrax.org/cgi-bin/nel-search.cgi" href="http://www.nevrax.org/cgi-bin/nel-search.cgi">Search</a> </center> +<hr><h1>NL3D::CPSForceIntensityHelper Class Reference</h1>this class defines the newElement, deleteElement, and resize method of a class that derives from <a class="el" href="classNL3D_1_1CPSForceIntensity.html">CPSForceIntensity</a> And that don't add per paerticle attribute. +<a href="#_details">More...</a> +<p> +<code>#include <<a class="el" href="ps__force_8h-source.html">ps_force.h</a>></code> +<p> +<p>Inheritance diagram for NL3D::CPSForceIntensityHelper: +<p><center><img src="classNL3D_1_1CPSForceIntensityHelper.gif" usemap="#NL3D::CPSForceIntensityHelper_map" border="0"></center> +<map name="NL3D::CPSForceIntensityHelper_map"> +<area href="classNL3D_1_1CPSForce.html" alt="NL3D::CPSForce" shape="rect" coords="430,224,635,248"> +<area href="classNL3D_1_1CPSForceIntensity.html" alt="NL3D::CPSForceIntensity" shape="rect" coords="645,224,850,248"> +<area href="classNL3D_1_1CPSTargetLocatedBindable.html" alt="NL3D::CPSTargetLocatedBindable" shape="rect" coords="430,168,635,192"> +<area href="classNL3D_1_1CPSLocatedBindable.html" alt="NL3D::CPSLocatedBindable" shape="rect" coords="430,112,635,136"> +<area href="classNLMISC_1_1IStreamable.html" alt="NLMISC::IStreamable" shape="rect" coords="430,56,635,80"> +<area href="classNLMISC_1_1IClassable.html" alt="NLMISC::IClassable" shape="rect" coords="430,0,635,24"> +<area href="classNL3D_1_1CPSBrownianForce.html" alt="NL3D::CPSBrownianForce" shape="rect" coords="0,336,205,360"> +<area href="classNL3D_1_1CPSCentralGravity.html" alt="NL3D::CPSCentralGravity" shape="rect" coords="215,336,420,360"> +<area href="classNL3D_1_1CPSCylindricVortex.html" alt="NL3D::CPSCylindricVortex" shape="rect" coords="430,336,635,360"> +<area href="classNL3D_1_1CPSDirectionnalForce.html" alt="NL3D::CPSDirectionnalForce" shape="rect" coords="645,336,850,360"> +<area href="classNL3D_1_1CPSGravity.html" alt="NL3D::CPSGravity" shape="rect" coords="860,336,1065,360"> +<area href="classNL3D_1_1CPSSpring.html" alt="NL3D::CPSSpring" shape="rect" coords="1075,336,1280,360"> +<area href="classNL3D_1_1CPSMagneticForce.html" alt="NL3D::CPSMagneticForce" shape="rect" coords="645,392,850,416"> +</map> +<a href="classNL3D_1_1CPSForceIntensityHelper-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0> +<tr><td colspan=2><br><h2>Public Methods</h2></td></tr> +<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classNL3D_1_1CPSForceIntensityHelper.html#a0">serial</a> (<a class="el" href="classNLMISC_1_1IStream.html">NLMISC::IStream</a> &f) throw (NLMISC::EStream)</td></tr> +<tr><td> </td><td><font size=-1><em>Serial the force definition. MUST be called by deriver during their serialisation.</em> <a href="#a0">More...</a><em></em></font><br><br></td></tr> +<tr><td colspan=2><br><h2>Protected Methods</h2></td></tr> +<tr><td nowrap align=right valign=top>virtual <a class="el" href="classNL3D_1_1CPSLocated.html">CPSLocated</a> * </td><td valign=bottom><a class="el" href="classNL3D_1_1CPSForceIntensityHelper.html#b0">getForceIntensityOwner</a> (void)</td></tr> +<tr><td> </td><td><font size=-1><em>deriver must return the located that own them here.</em> <a href="#b0">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="classNL3D_1_1CPSForceIntensityHelper.html#b1">newElement</a> (<a class="el" href="classNL3D_1_1CPSLocated.html">CPSLocated</a> *emitterLocated, <a class="el" href="memory__common_8h.html#a11">uint32</a> emitterIndex)</td></tr> +<tr><td> </td><td><font size=-1><em>Generate a new element for this bindable.</em> <a href="#b1">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="classNL3D_1_1CPSForceIntensityHelper.html#b2">deleteElement</a> (<a class="el" href="memory__common_8h.html#a11">uint32</a> <a class="el" href="driver__opengl__extension__def_8h.html#a358">index</a>)</td></tr> +<tr><td> </td><td><font size=-1><em>Delete an element given its index Attributes of the located that hold this bindable are still accessible for of the index given index out of range -> nl_assert.</em> <a href="#b2">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="classNL3D_1_1CPSForceIntensityHelper.html#b3">resize</a> (<a class="el" href="memory__common_8h.html#a11">uint32</a> <a class="el" href="cf__lexical_8cpp.html#a94">size</a>)</td></tr> +<tr><td> </td><td><font size=-1><em>Resize the bindable attributes containers DERIVERS SHOULD CALL THEIR PARENT VERSION should not be called directly.</em> <a href="#b3">More...</a><em></em></font><br><br></td></tr> +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +this class defines the newElement, deleteElement, and resize method of a class that derives from <a class="el" href="classNL3D_1_1CPSForceIntensity.html">CPSForceIntensity</a> And that don't add per paerticle attribute. +<p> + +<p> +Definition at line <a class="el" href="ps__force_8h-source.html#l00218">218</a> of file <a class="el" href="ps__force_8h-source.html">ps_force.h</a>.<hr><h2>Member Function Documentation</h2> +<a name="b2" doxytag="NL3D::CPSForceIntensityHelper::deleteElement"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> virtual void NL3D::CPSForceIntensityHelper::deleteElement </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="memory__common_8h.html#a11">uint32</a> </td> + <td class="mdname1" valign="top" nowrap> <em>index</em> </td> + <td class="md" valign="top">) </td> + <td class="md" nowrap><code> [inline, protected, virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Delete an element given its index Attributes of the located that hold this bindable are still accessible for of the index given index out of range -> nl_assert. +<p> + +<p> +Implements <a class="el" href="classNL3D_1_1CPSForce.html#b5">NL3D::CPSForce</a>. +<p> +Reimplemented in <a class="el" href="classNL3D_1_1CPSBrownianForce.html#b2">NL3D::CPSBrownianForce</a>. +<p> +Definition at line <a class="el" href="ps__force_8h-source.html#l00226">226</a> of file <a class="el" href="ps__force_8h-source.html">ps_force.h</a>. +<p> +References <a class="el" href="ps__force_8h-source.html#l00203">NL3D::CPSForceIntensity::deleteForceIntensityElement</a>, and <a class="el" href="driver__opengl__extension__def_8h-source.html#l00222">index</a>. </td> + </tr> +</table> +<a name="b0" doxytag="NL3D::CPSForceIntensityHelper::getForceIntensityOwner"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> virtual <a class="el" href="classNL3D_1_1CPSLocated.html">CPSLocated</a>* NL3D::CPSForceIntensityHelper::getForceIntensityOwner </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><code> [inline, protected, virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +deriver must return the located that own them here. +<p> + +<p> +Implements <a class="el" href="classNL3D_1_1CPSForceIntensity.html#b0">NL3D::CPSForceIntensity</a>. +<p> +Reimplemented in <a class="el" href="classNL3D_1_1CPSBrownianForce.html#b0">NL3D::CPSBrownianForce</a>. +<p> +Definition at line <a class="el" href="ps__force_8h-source.html#l00224">224</a> of file <a class="el" href="ps__force_8h-source.html">ps_force.h</a>. +<p> +References <a class="el" href="ps__located_8h-source.html#l00979">NL3D::CPSLocatedBindable::_Owner</a>, and <a class="el" href="ps__force_8h-source.html#l00127">NL3D::CPSForce::CPSLocated</a>. </td> + </tr> +</table> +<a name="b1" doxytag="NL3D::CPSForceIntensityHelper::newElement"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> virtual void NL3D::CPSForceIntensityHelper::newElement </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="classNL3D_1_1CPSLocated.html">CPSLocated</a> * </td> + <td class="mdname" nowrap> <em>emitterLocated</em>, </td> + </tr> + <tr> + <td></td> + <td></td> + <td class="md" nowrap><a class="el" href="memory__common_8h.html#a11">uint32</a> </td> + <td class="mdname" nowrap> <em>emitterIndex</em></td> + </tr> + <tr> + <td></td> + <td class="md">) </td> + <td class="md" colspan="2"><code> [inline, protected, virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Generate a new element for this bindable. +<p> +They are generated according to the propertie of the class +<p> +Implements <a class="el" href="classNL3D_1_1CPSForce.html#b4">NL3D::CPSForce</a>. +<p> +Reimplemented in <a class="el" href="classNL3D_1_1CPSBrownianForce.html#b1">NL3D::CPSBrownianForce</a>. +<p> +Definition at line <a class="el" href="ps__force_8h-source.html#l00225">225</a> of file <a class="el" href="ps__force_8h-source.html">ps_force.h</a>. +<p> +References <a class="el" href="ps__force_8h-source.html#l00127">NL3D::CPSForce::CPSLocated</a>, and <a class="el" href="ps__force_8h-source.html#l00199">NL3D::CPSForceIntensity::newForceIntensityElement</a>. </td> + </tr> +</table> +<a name="b3" doxytag="NL3D::CPSForceIntensityHelper::resize"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> virtual void NL3D::CPSForceIntensityHelper::resize </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="memory__common_8h.html#a11">uint32</a> </td> + <td class="mdname1" valign="top" nowrap> <em>size</em> </td> + <td class="md" valign="top">) </td> + <td class="md" nowrap><code> [inline, protected, virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Resize the bindable attributes containers DERIVERS SHOULD CALL THEIR PARENT VERSION should not be called directly. +<p> +Call CPSLOcated::resize instead +<p> +Implements <a class="el" href="classNL3D_1_1CPSForce.html#b6">NL3D::CPSForce</a>. +<p> +Reimplemented in <a class="el" href="classNL3D_1_1CPSBrownianForce.html#b3">NL3D::CPSBrownianForce</a>. +<p> +Definition at line <a class="el" href="ps__force_8h-source.html#l00227">227</a> of file <a class="el" href="ps__force_8h-source.html">ps_force.h</a>. +<p> +References <a class="el" href="ps__force_8h-source.html#l00207">NL3D::CPSForceIntensity::resizeForceIntensity</a>. </td> + </tr> +</table> +<a name="a0" doxytag="NL3D::CPSForceIntensityHelper::serial"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> void NL3D::CPSForceIntensityHelper::serial </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="classNLMISC_1_1IStream.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="structNLMISC_1_1EStream.html">NLMISC::EStream</a>)<code> [virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Serial the force definition. MUST be called by deriver during their serialisation. +<p> + +<p> +Reimplemented from <a class="el" href="classNL3D_1_1CPSForce.html#a7">NL3D::CPSForce</a>. +<p> +Reimplemented in <a class="el" href="classNL3D_1_1CPSDirectionnalForce.html#a3">NL3D::CPSDirectionnalForce</a>. +<p> +Definition at line <a class="el" href="ps__force_8cpp-source.html#l00231">231</a> of file <a class="el" href="ps__force_8cpp-source.html">ps_force.cpp</a>. </td> + </tr> +</table> +<hr>The documentation for this class was generated from the following files:<ul> +<li><a class="el" href="ps__force_8h-source.html">ps_force.h</a><li><a class="el" href="ps__force_8cpp-source.html">ps_force.cpp</a></ul> + + +<!-- footer --> +<BR><FONT Size=+5> </FONT> +</TD> +<TD WIDTH=15><IMG SRC=http://www.nevrax.org/inc/img/pixel.gif WIDTH=15 HEIGHT=15 BORDER=0 ALT=""></TD> +</TR> +</TABLE> +</BODY> +</HTML> |