[Orxonox-commit 2980] r7678 - code/trunk/src/modules/objects

[dafrick at orxonox.net]

Author: dafrick
Date: 2010-11-26 13:40:00 +0100 (Fri, 26 Nov 2010)
New Revision: 7678

Modified:
   code/trunk/src/modules/objects/ForceField.h
Log:
Adding documentation for invertedSphere ForceField.


Modified: code/trunk/src/modules/objects/ForceField.h
===================================================================
--- code/trunk/src/modules/objects/ForceField.h	2010-11-26 12:25:56 UTC (rev 7677)
+++ code/trunk/src/modules/objects/ForceField.h	2010-11-26 12:40:00 UTC (rev 7678)
@@ -60,7 +60,7 @@
 
     /**
     @brief
-        Implements a force field, that applies a force to any @ref orxonox::MoblieEnity "MobileEntity" that enters its range.
+        Implements a force field, that applies a force to any @ref orxonox::MobileEntity "MobileEntity" that enters its range.
 
         The following parameters can be set to specify the behavior of the ForceField.
         - @b velocity The amount of force the ForceField excerts. Default is 100.
@@ -70,7 +70,7 @@
             - <em>tube</em> A ForceField which exerts force only in the direction it is oriented. The force is only exerted on objects that are in a tube of length <em>length</em> and diameter <em>diameter</em> (with rounded start and end faces, so in fact the <em>length</em> parameter specifies a ball with <code>origin + length/2</code> as the center and <code>length/2</code> as the radius). The magintude of the force is proportional to the <em>velocity</em>, being highest when an object is in the middle of the tube (radius-wise), linearly decreasing with greater radii and finally reaching zero, when the object is <code>diameter/2</code> away from the orientation vector.
             - <em>sphere</em> A Force Field which exerts force radially away from itself, with the greatest magnitude (proportional to <em>velocity</em>) being in the origin of the ForceField, linearly decreasing with respect to the distance to the origin and finally reaching zero at distance <code>diameter/2</code>.
             Default is <em>tube</em>.
-            - <em>invertedSphere</em> 
+            - <em>invertedSphere</em> A ForceField which excerts force radially towards itself, with the highest force at the boundary of the sphere, linear decreasing until reaching a distance of <code>radius-length</code> from the origin, where the force reaches zero.
 
     @author
         Aurelian Jaggi