Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

Changeset 7678 for code/trunk


Ignore:
Timestamp:
Nov 26, 2010, 1:40:00 PM (14 years ago)
Author:
dafrick
Message:

Adding documentation for invertedSphere ForceField.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • code/trunk/src/modules/objects/ForceField.h

    r7677 r7678  
    6161    /**
    6262    @brief
    63         Implements a force field, that applies a force to any @ref orxonox::MoblieEnity "MobileEntity" that enters its range.
     63        Implements a force field, that applies a force to any @ref orxonox::MobileEntity "MobileEntity" that enters its range.
    6464
    6565        The following parameters can be set to specify the behavior of the ForceField.
     
    7171            - <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>.
    7272            Default is <em>tube</em>.
    73             - <em>invertedSphere</em>
     73            - <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.
    7474
    7575    @author
Note: See TracChangeset for help on using the changeset viewer.