aboutsummaryrefslogtreecommitdiff
path: root/docs/doxygen/nel/classNL3D_1_1CPSMagneticForce.html
diff options
context:
space:
mode:
Diffstat (limited to 'docs/doxygen/nel/classNL3D_1_1CPSMagneticForce.html')
-rw-r--r--docs/doxygen/nel/classNL3D_1_1CPSMagneticForce.html246
1 files changed, 246 insertions, 0 deletions
diff --git a/docs/doxygen/nel/classNL3D_1_1CPSMagneticForce.html b/docs/doxygen/nel/classNL3D_1_1CPSMagneticForce.html
new file mode 100644
index 00000000..325e4aca
--- /dev/null
+++ b/docs/doxygen/nel/classNL3D_1_1CPSMagneticForce.html
@@ -0,0 +1,246 @@
+<!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>&nbsp;<A CLASS=uplinks HREF=http://www.nevrax.org><b>Home</B></FONT></A>&nbsp;&nbsp;&nbsp;</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>&nbsp;<A CLASS=uplinks HREF=http://www.nevrax.com><b>nevrax.com</B></FONT></A>&nbsp;&nbsp;&nbsp;</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>
+&nbsp;
+
+<!-- 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>&nbsp;</td>
+</tr></table>
+<!-- Generated by Doxygen 1.2.14 -->
+<center>
+<a class="qindex" href="index.html">Main Page</a> &nbsp; <a class="qindex" href="namespaces.html">Namespace List</a> &nbsp; <a class="qindex" href="hierarchy.html">Class Hierarchy</a> &nbsp; <a class="qindex" href="classes.html">Alphabetical List</a> &nbsp; <a class="qindex" href="annotated.html">Compound List</a> &nbsp; <a class="qindex" href="files.html">File List</a> &nbsp; <a class="qindex" href="namespacemembers.html">Namespace Members</a> &nbsp; <a class="qindex" href="functions.html">Compound Members</a> &nbsp; <a class="qindex" href="globals.html">File Members</a> &nbsp; <a class="qindex" href="pages.html">Related Pages</a> &nbsp; <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> &nbsp; </center>
+<hr><h1>NL3D::CPSMagneticForce Class Reference</h1>a magnetic field that has the given direction.
+<a href="#_details">More...</a>
+<p>
+<code>#include &lt;<a class="el" href="ps__force_8h-source.html">ps_force.h</a>&gt;</code>
+<p>
+<p>Inheritance diagram for NL3D::CPSMagneticForce:
+<p><center><img src="classNL3D_1_1CPSMagneticForce.gif" usemap="#NL3D::CPSMagneticForce_map" border="0"></center>
+<map name="NL3D::CPSMagneticForce_map">
+<area href="classNL3D_1_1CPSDirectionnalForce.html" alt="NL3D::CPSDirectionnalForce" shape="rect" coords="215,336,420,360">
+<area href="classNL3D_1_1CPSForceIntensityHelper.html" alt="NL3D::CPSForceIntensityHelper" shape="rect" coords="107,280,312,304">
+<area href="classNL3D_1_1CPSDirection.html" alt="NL3D::CPSDirection" shape="rect" coords="322,280,527,304">
+<area href="classNL3D_1_1CPSForce.html" alt="NL3D::CPSForce" shape="rect" coords="0,224,205,248">
+<area href="classNL3D_1_1CPSForceIntensity.html" alt="NL3D::CPSForceIntensity" shape="rect" coords="215,224,420,248">
+<area href="classNL3D_1_1CPSTargetLocatedBindable.html" alt="NL3D::CPSTargetLocatedBindable" shape="rect" coords="0,168,205,192">
+<area href="classNL3D_1_1CPSLocatedBindable.html" alt="NL3D::CPSLocatedBindable" shape="rect" coords="0,112,205,136">
+<area href="classNLMISC_1_1IStreamable.html" alt="NLMISC::IStreamable" shape="rect" coords="0,56,205,80">
+<area href="classNLMISC_1_1IClassable.html" alt="NLMISC::IClassable" shape="rect" coords="0,0,205,24">
+</map>
+<a href="classNL3D_1_1CPSMagneticForce-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>&nbsp;</td><td valign=bottom><a class="el" href="classNL3D_1_1CPSMagneticForce.html#a0">CPSMagneticForce</a> (float i=1.f)</td></tr>
+<tr><td nowrap align=right valign=top>virtual void&nbsp;</td><td valign=bottom><a class="el" href="classNL3D_1_1CPSMagneticForce.html#a1">performDynamic</a> (<a class="el" href="namespaceNL3D.html#a1">TAnimationTime</a> ellapsedTime)</td></tr>
+<tr><td>&nbsp;</td><td><font size=-1><em>Compute the force on the targets.</em> <a href="#a1">More...</a><em></em></font><br><br></td></tr>
+<tr><td nowrap align=right valign=top>virtual void&nbsp;</td><td valign=bottom><a class="el" href="classNL3D_1_1CPSMagneticForce.html#a2">serial</a> (<a class="el" href="classNLMISC_1_1IStream.html">NLMISC::IStream</a> &amp;f) throw (NLMISC::EStream)</td></tr>
+<tr><td>&nbsp;</td><td><font size=-1><em>a magnetic field that has the given direction.</em> <a href="#a2">More...</a><em></em></font><br><br></td></tr>
+<tr><td nowrap align=right valign=top>&nbsp;</td><td valign=bottom><a class="el" href="classNL3D_1_1CPSMagneticForce.html#a3">NLMISC_DECLARE_CLASS</a> (CPSMagneticForce)</td></tr>
+</table>
+<hr><a name="_details"></a><h2>Detailed Description</h2>
+a magnetic field that has the given direction.
+<p>
+
+<p>
+Definition at line <a class="el" href="ps__force_8h-source.html#l00803">803</a> of file <a class="el" href="ps__force_8h-source.html">ps_force.h</a>.<hr><h2>Constructor &amp; Destructor Documentation</h2>
+<a name="a0" doxytag="NL3D::CPSMagneticForce::CPSMagneticForce"></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"> NL3D::CPSMagneticForce::CPSMagneticForce </td>
+ <td class="md" valign="top">(&nbsp;</td>
+ <td class="md" nowrap valign="top">float&nbsp;</td>
+ <td class="mdname1" valign="top" nowrap>&nbsp; <em>i</em> = 1.f </td>
+ <td class="md" valign="top">)&nbsp;</td>
+ <td class="md" nowrap><code> [inline]</code></td>
+ </tr>
+
+ </table>
+ </td>
+ </tr>
+</table>
+<table cellspacing=5 cellpadding=0 border=0>
+ <tr>
+ <td>
+ &nbsp;
+ </td>
+ <td>
+
+<p>
+
+<p>
+Definition at line <a class="el" href="ps__force_8h-source.html#l00806">806</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#l00984">NL3D::CPSLocatedBindable::_Name</a>, and <a class="el" href="ps__force_8h-source.html#l00361">NL3D::CPSDirectionnalForce::CPSDirectionnalForce</a>. </td>
+ </tr>
+</table>
+<hr><h2>Member Function Documentation</h2>
+<a name="a3" doxytag="NL3D::CPSMagneticForce::NLMISC_DECLARE_CLASS"></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"> NL3D::CPSMagneticForce::NLMISC_DECLARE_CLASS </td>
+ <td class="md" valign="top">(&nbsp;</td>
+ <td class="md" nowrap valign="top">CPSMagneticForce&nbsp;</td>
+ <td class="mdname1" valign="top" nowrap>&nbsp; </td>
+ <td class="md" valign="top">)&nbsp;</td>
+ <td class="md" nowrap></td>
+ </tr>
+
+ </table>
+ </td>
+ </tr>
+</table>
+<table cellspacing=5 cellpadding=0 border=0>
+ <tr>
+ <td>
+ &nbsp;
+ </td>
+ <td>
+
+<p>
+
+<p>
+Reimplemented from <a class="el" href="classNL3D_1_1CPSDirectionnalForce.html#a4">NL3D::CPSDirectionnalForce</a>. </td>
+ </tr>
+</table>
+<a name="a1" doxytag="NL3D::CPSMagneticForce::performDynamic"></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::CPSMagneticForce::performDynamic </td>
+ <td class="md" valign="top">(&nbsp;</td>
+ <td class="md" nowrap valign="top"><a class="el" href="namespaceNL3D.html#a1">TAnimationTime</a>&nbsp;</td>
+ <td class="mdname1" valign="top" nowrap>&nbsp; <em>ellapsedTime</em> </td>
+ <td class="md" valign="top">)&nbsp;</td>
+ <td class="md" nowrap><code> [virtual]</code></td>
+ </tr>
+
+ </table>
+ </td>
+ </tr>
+</table>
+<table cellspacing=5 cellpadding=0 border=0>
+ <tr>
+ <td>
+ &nbsp;
+ </td>
+ <td>
+
+<p>
+Compute the force on the targets.
+<p>
+
+<p>
+Reimplemented from <a class="el" href="classNL3D_1_1CPSDirectionnalForce.html#a0">NL3D::CPSDirectionnalForce</a>.
+<p>
+Definition at line <a class="el" href="ps__force_8cpp-source.html#l00990">990</a> of file <a class="el" href="ps__force_8cpp-source.html">ps_force.cpp</a>.
+<p>
+References <a class="el" href="ps__force_8h-source.html#l00388">NL3D::CPSDirectionnalForce::_Dir</a>, <a class="el" href="ps__force_8h-source.html#l00197">NL3D::CPSForceIntensity::_IntensityScheme</a>, <a class="el" href="ps__force_8h-source.html#l00196">NL3D::CPSForceIntensity::_K</a>, <a class="el" href="ps__located_8h-source.html#l00979">NL3D::CPSLocatedBindable::_Owner</a>, <a class="el" href="ps__located_8h-source.html#l01070">NL3D::CPSTargetLocatedBindable::_Targets</a>, and <a class="el" href="animation__time_8h-source.html#l00044">NL3D::TAnimationTime</a>. </td>
+ </tr>
+</table>
+<a name="a2" doxytag="NL3D::CPSMagneticForce::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::CPSMagneticForce::serial </td>
+ <td class="md" valign="top">(&nbsp;</td>
+ <td class="md" nowrap valign="top"><a class="el" href="classNLMISC_1_1IStream.html">NLMISC::IStream</a> &amp;&nbsp;</td>
+ <td class="mdname1" valign="top" nowrap>&nbsp; <em>f</em> </td>
+ <td class="md" valign="top">)&nbsp;</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>
+ &nbsp;
+ </td>
+ <td>
+
+<p>
+a magnetic field that has the given direction.
+<p>
+
+<p>
+Reimplemented from <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#l00984">984</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>&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; </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>