Man Linux: Main Page and Category List

NAME

       SoSFRotation -

       The SoSFRotation class is a container for an SbRotation.

       This field is used where nodes, engines or other field containers needs
       to store a single rotation definition.

SYNOPSIS

       #include <Inventor/fields/SoSFRotation.h>

       Inherits SoSField.

   Public Member Functions
       virtual SoType getTypeId (void) const
       virtual void copyFrom (const SoField &field)
       const SoSFRotation & operator= (const SoSFRotation &field)
       virtual SbBool isSame (const SoField &field) const
       PRIVATE_SFIELD_IO_HEADER ()
       const SbRotation & getValue (void) const
       void setValue (const SbRotation &newvalue)
       const SbRotation & operator= (const SbRotation &newvalue)
       int operator== (const SoSFRotation &field) const
       int operator!= (const SoSFRotation &field) const
       void getValue (SbVec3f &axis, float &angle) const
       void setValue (const float q0, const float q1, const float q2, const
           float q3)
       void setValue (const float q[4])
       void setValue (const SbVec3f &axis, const float angle)

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

   Protected Attributes
       SbRotation value

Detailed Description

       The SoSFRotation class is a container for an SbRotation.

       This field is used where nodes, engines or other field containers needs
       to store a single rotation definition.

       Fields of this type stores their value to file as a rotation axis
       vector plus a rotation angle: ’axis0 axis1 axis2 angle’.

       Note that there is one very common mistake that is easy to make when
       setting the value of an SoSFRotation field, and that is to
       inadvertently use the wrong SbRotation constructor. This example should
       clarify the problem:

         mytransformnode->rotation.setValue(0, 0, 1, 1.5707963f);

       The programmer clearly tries to set a PI/2 rotation around the Z axis,
       but this will fail, as the SbRotation constructor invoked above is the
       one that takes as arguments the 4 floats of a quaternion. What the
       programmer almost certainly wanted to do was to use the SbRotation
       constructor that takes a rotation vector and a rotation angle, which is
       invoked like this:

         mytransformnode->rotation.setValue(SbVec3f(0, 0, 1), 1.5707963f);

       See also:
           SoMFRotation

Member Function Documentation

   static SoType SoSFRotation::getClassTypeId (void) [static] Returns a unique
       type identifier for this field class.
       See also:
           getTypeId(), SoType

       Reimplemented from SoSField.

   virtual SoType SoSFRotation::getTypeId (void) const [virtual] Returns the
       type identification instance which uniquely identifies the Coin field
       class the object belongs to.
       See also:
           getClassTypeId(), SoType

       Implements SoField.

   virtual void SoSFRotation::copyFrom (const SoField & f) [virtual] Copy
       value(s) from f into this field. f must be of the same type as this
       field.
       Implements SoField.

   virtual SbBool SoSFRotation::isSame (const SoField & f) const [virtual]
       Check for equal type and value(s).
       Implements SoField.

   void SoSFRotation::initClass (void) [static] Internal method called upon
       initialization of the library (from SoDB::init()) to set up the type
       system.
       Reimplemented from SoSField.

   void SoSFRotation::getValue (SbVec3f & axis, float & angle) const Return
       value of rotation as an axis and an angle around this axis.
   void SoSFRotation::setValue (const float q0, const float q1, const float
       q2, const float q3) Set the rotation from a set of quaternion values.
   void SoSFRotation::setValue (const float q[4]) Set the rotation from a set
       of quaternion values.
   void SoSFRotation::setValue (const SbVec3f & axis, const float angle) Set
       the rotation from an axis and an angle around this axis.

Author

       Generated automatically by Doxygen for Coin from the source code.