NAME

       SoRotor -

       The SoRotor class is a node used to animate rotations.

       Insert this node in your hierarchy to apply a continuous rotation to some geometry. Since
       this node inherits the SoRotation node, rotation is restricted around the axis specified
       in the rotation field.

SYNOPSIS

       #include <Inventor/nodes/SoRotor.h>

       Inherits SoRotation.

   Public Member Functions
       virtual SoType getTypeId (void) const
           Returns the type identification of an object derived from a class inheriting SoBase.
           This is used for run-time type checking and 'downward' casting.
       SoRotor (void)

   Static Public Member Functions
       static SoType getClassTypeId (void)
       static void initClass (void)

   Public Attributes
       SoSFFloat speed
       SoSFBool on

   Protected Member Functions
       virtual const SoFieldData * getFieldData (void) const
       virtual ~SoRotor ()

   Static Protected Member Functions
       static const SoFieldData ** getFieldDataPtr (void)

   Additional Inherited Members

Detailed Description

       The SoRotor class is a node used to animate rotations.

       Insert this node in your hierarchy to apply a continuous rotation to some geometry. Since
       this node inherits the SoRotation node, rotation is restricted around the axis specified
       in the rotation field.

       The angle value of the SoRotation::rotation field (inherited by this node) gives the
       rotation direction. If the value is larger than 0.0, the rotation will be done in the
       counterclockwise direction, if it is negative the rotation will be done in the clockwise
       direction.

       Do not set the rotation value to exactly 0.0, as rotations are internally handled as
       quaternions, and when converting from an angle and a rotation value to a quaternion
       representation, the information about the angle 'gets lost' if there is no actual
       rotation.

       Note also that the rotation will start at the given angle value.

       FILE FORMAT/DEFAULTS:

       Rotor {
           rotation 0 0 1  0
           speed 1
           on TRUE
       }

Constructor & Destructor Documentation

   SoRotor::SoRotor (void)
       Constructor.

   SoRotor::~SoRotor () [protected],  [virtual]
       Destructor.

Member Function Documentation

   SoType SoRotor::getTypeId (void) const [virtual]
       Returns the type identification of an object derived from a class inheriting SoBase. This
       is used for run-time type checking and 'downward' casting. Usage example:

       void foo(SoNode * node)
       {
         if (node->getTypeId() == SoFile::getClassTypeId()) {
           SoFile * filenode = (SoFile *)node;  // safe downward cast, knows the type
         }
       }

       For application programmers wanting to extend the library with new nodes, engines,
       nodekits, draggers or others: this method needs to be overridden in all subclasses. This
       is typically done as part of setting up the full type system for extension classes, which
       is usually accomplished by using the pre-defined macros available through for instance
       Inventor/nodes/SoSubNode.h (SO_NODE_INIT_CLASS and SO_NODE_CONSTRUCTOR for node classes),
       Inventor/engines/SoSubEngine.h (for engine classes) and so on.

       For more information on writing Coin extensions, see the class documentation of the
       toplevel superclasses for the various class groups.

       Reimplemented from SoRotation.

   const SoFieldData * SoRotor::getFieldData (void) const [protected],  [virtual]
       Returns a pointer to the class-wide field data storage object for this instance. If no
       fields are present, returns NULL.

       Reimplemented from SoRotation.

Member Data Documentation

   SoSFFloat SoRotor::speed
       Specifies the speed of rotation, in revolutions per second. Defaults to 1.0.

   SoSFBool SoRotor::on
       Enable/disable rotation. Default enabled.

Author

       Generated automatically by Doxygen for Coin from the source code.