Changeset 7678 for code/trunk/src/modules/objects

Timestamp:

Nov 26, 2010, 1:40:00 PM (14 years ago)

Author:

dafrick

Message:

Adding documentation for invertedSphere ForceField.

File:

• code/trunk/src/modules/objects/ForceField.h (modified) (2 diffs)

code/trunk/src/modules/objects/ForceField.h

@@ -61 +61 @@
     /**
     @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.
@@ -71 +71 @@
             - <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