SoComposeRotation(3)

NAME
SoComposeRotation - The SoComposeRotation class is used to compose rotations from angle and axis.

Simple usage example:

SYNOPSIS

#include <Inventor/engines/SoCompose.h>

Inherits SoEngine.

  Public Member Functions
virtual SoType getTypeId (void) const
virtual const SoFieldData * getFieldData (void) const
virtual const SoEngineOutputData * getOutputData (void) const

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

  Public Attributes
SoMFVec3f axis
SoMFFloat angle
SoEngineOutput rotation

  Static Protected Member Functions
static const SoFieldData ** getInputDataPtr (void)
static const SoEngineOutputData ** getOutputDataPtr (void)

  Additional Inherited Members

Detailed Description

The SoComposeRotation class is used to compose rotations from angle and axis.

Simple usage example:

#Inventor V2.1 ascii
Separator {
   Transform {
      rotation =
      ComposeRotation { axis 0 1 0  angle =
         ElapsedTime { }.timeOut
      }.rotation
   }
   Cube { }
}

Member Function Documentation

  SoType SoComposeRotation::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.

Implements SoBase.

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

Reimplemented from SoFieldContainer.

  const SoEngineOutputData * SoComposeRotation::getOutputData (void) const [virtual]
This API member is considered internal to the library, as it is not likely to be of interest to the application programmer.

Implements SoEngine.

Member Data Documentation

  SoMFVec3f SoComposeRotation::axis
Set of axis vectors for the output rotations. Default value is (0.0f, 0.0f, 1.0f).

  SoMFFloat SoComposeRotation::angle
Set of scalar rotation values for the output rotations. Default value is 0.0.

  SoEngineOutput SoComposeRotation::rotation
(SoMFRotation) Rotations generated from the angle and axis input fields.

Author

Generated automatically by Doxygen for Coin from the source code.