SoMFRotation(3IV)

SoMFRotation (SoMRotation) - Multiple-value field containing any number of SbRotations.

As shipped in IRIX 6.5.22. Added in IRIX 6.5.22.

NAME
     SoMFRotation (SoMRotation) - Multiple-value field containing any number
     of SbRotations.

INHERITS FROM
     SoField > SoMField > SoMFRotation

SYNOPSIS
     #include <Inventor_c/fields/SoMFRotation.h>

     typedef SoMFRotation  SoMRotation

          Functions from class SoMFRotation:

     void                SoMRotationSet1AxisAngle(SoMRotation *this, int
                              index, const SbVec3f *axis, float angle)
     void                SoMRotationSetAxisAngle(SoMRotation *this, const
                              SbVec3f *axis, float angle)
     void                SoMRotationSet1Q_U_A_T(SoMRotation *this, int index,
                              float q0, float q1, float q2, float q3)
     void                SoMRotationSet1Quat(SoMRotation *this, int index,
                              const float q[4])
     void                SoMRotationSetQ_U_A_T(SoMRotation *this, float q0,
                              float q1, float q2, float q3)
     void                SoMRotationSetQuat(SoMRotation *this, float q[4])
     SoType              SoMRotationGetClassTypeId()
     void                SoMRotationGetTypeId(const SoMRotation *this)
     const SbRotation *  SoMRotationGet(const SoMRotation *this, int i)
     const SbRotation *  SoMRotationGetN(const SoMRotation *this, int start)
     int                 SoMRotationFind(SoMRotation *this, const SbRotation *
                              targetValue, SbBool addIfNotFound = FALSE)
     void                SoMRotationSetQuats(SoMRotation *this, int start, int
                              num, const SbRotation *newValues)
     void                SoMRotationSet1(SoMRotation *this, int index, const
                              SbRotation * newValue)
     void                SoMRotationSet(SoMRotation *this, const SbRotation *
                              newValue)
     int                 SoMRotationIsEq(const SoMRotation *this, const
                              SoMFRotation *f)
     int                 SoMRotationIsNEq(const SoMRotation *this, const
                              SoMFRotation *f)
     SbRotation *        SoMRotationStartEdit(SoMRotation *this)
     void                SoMRotationFinishEdit(SoMRotation *this)

          Functions from class SoMField:

     int                 SoMRotationGetNum(const SoMRotation *this)
     void                SoMRotationSetNum(SoMRotation *this, int num)
     void                SoMRotationDel(SoMRotation *this, int start, int num
                              = -1)
     void                SoMRotationInsertSpace(SoMRotation *this, int start,
                              int num)
     void                SoMRotationGet1(SoMRotation *this, int index,
                              SbString *valueString)

          Functions from class SoField:

     void                SoMRotationSetIgnored(SoMRotation *this, SbBool
                              ignore)
     SbBool              SoMRotationIsIgnored(const SoMRotation *this)
     SbBool              SoMRotationIsDflt(const SoMRotation *this)
     SbBool              SoMRotationIsOfType(const SoMRotation *this, SoType
                              type)
     SbBool              SoMRotationSetFromStr(SoMRotation *this, const char
                              *valueString)
     void                SoMRotationGetIntoStr(SoMRotation *this, SbString
                              *valueString)
     void                SoMRotationTouch(SoMRotation *this)
     SbBool              SoMRotationConnFromField(SoMRotation *this, SoField
                              *fromField)
     SbBool              SoMRotationConnFrom(SoMRotation *this, SoEngineOutput
                              *fromEngine)
     void                SoMRotationDisconn(SoMRotation *this)
     SbBool              SoMRotationIsConn(const SoMRotation *this)
     SbBool              SoMRotationIsConnFromField(const SoMRotation *this)
     SbBool              SoMRotationGetConnField(const SoMRotation *this,
                              SoField **writingField)
     SbBool              SoMRotationIsConnFromEngine(const SoMRotation *this)
     SbBool              SoMRotationGetConnEngine(const SoMRotation *this,
                              SoEngineOutput **engineOutput)
     void                SoMRotationEnableConn(SoMRotation *this, SbBool flag)
     SbBool              SoMRotationIsConnEnabled(const SoMRotation *this)
     int                 SoMRotationGetForwardConn(const SoMRotation *this,
                              SoFieldList *list)
     SoFieldContainer *  SoMRotationGetContainer(const SoMRotation *this)


DESCRIPTION
     multiple-value field that contains any number of SbRotations.

     SoMFRotations are written to file as one or more sets of four floating
     point values. Each set of 4 values is an axis of rotation followed by the
     amount of right-handed rotation about that axis, in radians.

     When more than one value is present, all of the values are enclosed in
     square brackets and separated by commas; for example:

          [ 1 0 0 0, -.707 -.707 0 1.57 ]



FUNCTIONS
     void                SoMRotationSet1AxisAngle(SoMRotation *this, int
                              index, const SbVec3f *axis, float angle)
          Sets the index'th value to the given axis/angle.

     void                SoMRotationSetAxisAngle(SoMRotation *this, const
                              SbVec3f *axis, float angle)
          Makes this field have exactly one value, given by axis and angle.

     void                SoMRotationSet1Q_U_A_T(SoMRotation *this, int index,
                              float q0, float q1, float q2, float q3)
     void                SoMRotationSet1Quat(SoMRotation *this, int index,
                              const float q[4])
          Sets the index'th value to the given quaternion.

     void                SoMRotationSetQ_U_A_T(SoMRotation *this, float q0,
                              float q1, float q2, float q3)
     void                SoMRotationSetQuat(SoMRotation *this, float q[4])
          Makes this field have exactly one value, given by the quaternion.

     SoType              SoMRotationGetClassTypeId()
     void                SoMRotationGetTypeId(const SoMRotation *this)
          Returns the type for this class or a particular object of this
          class.

     const SbRotation *  SoMRotationGet(const SoMRotation *this, int i)
          Returns the i'th value of the field. Indexing past the end of the
          field (passing in i greater than getNum()) will return garbage.

     const SbRotation *  SoMRotationGetN(const SoMRotation *this, int start)
          Returns a pointer into the array of values in the field, starting at
          index start. The values are read-only; see the
          startEditing()/finishEditing() methods for a way of modifying values
          in place.

     int                 SoMRotationFind(SoMRotation *this, const SbRotation *
                              targetValue, SbBool addIfNotFound = FALSE)
          Finds the given value in the array and returns the index of that
          value in the array. If the value is not found, -1 is returned. If
          addIfNotFound is set, then targetValue is added to the end of the
          array (but -1 is still returned).

     void                SoMRotationSetQuats(SoMRotation *this, int start, int
                              num, const SbRotation *newValues)
          Sets num values starting at index start to the values in newValues.
          The array will be automatically be made larger to accomodate the new
          values, if necessary.

     void                SoMRotationSet1(SoMRotation *this, int index, const
                              SbRotation * newValue)
          Sets the index'th value in the array to newValue. The array will be
          automatically expanded, if necessary.

     void                SoMRotationSet(SoMRotation *this, const SbRotation *
                              newValue)
          Sets the first value in the array to newValue, and deletes the
          second and subsequent values.

     int                 SoMRotationIsEq(const SoMRotation *this, const
                              SoMFRotation *f)
     int                 SoMRotationIsNEq(const SoMRotation *this, const
                              SoMFRotation *f)
          Returns TRUE if all of the values of this field equal (do not equal)
          those of the given field. If the fields are different types FALSE
          will always be returned (even if one field is an SoMFFloat with one
          value of 1.0 and the other is an SoMFInt with a value of 1, for
          example).

     SbRotation *        SoMRotationStartEdit(SoMRotation *this)
     void                SoMRotationFinishEdit(SoMRotation *this)
          startEditing() returns a pointer to the internally-maintained array
          that can be modified. The values in the array may be changed, but
          values cannot be added or removed. It is illegal to call any other
          editing methods between StartEdit() and FinishEdit() (e.g. Set1(),
          Set(), etc).

          Fields, engines or sensors connected to this field and sensors are
          not notified that this field has changed until FinishEdit() is
          called. Calling FinishEdit() always sets the IsDflt flag to FALSE
          and informs engines and sensors that the field changed, even if none
          of the values actually were changed.


SEE ALSO
     SbRotation