Coin Logo http://www.sim.no
http://www.coin3d.org

SoTransform Class Reference
[Nodes]

The SoTransform class is the "all-purpose" transformation node type.

Like SoMatrixTransform, nodes of this type gives the application programmer maximum flexibility when specifying geometry transformations in a scene graph. If you want to set and keep the various components of the transformation matrix in separate entities, this node type is preferable, though. More...

#include <Inventor/nodes/SoTransform.h>

Inheritance diagram for SoTransform:

SoTransformation SoNode SoFieldContainer SoBase SoTransformManip SoCenterballManip SoHandleBoxManip SoJackManip SoTabBoxManip SoTrackballManip SoTransformBoxManip SoTransformerManip

List of all members.

Public Member Functions

virtual SoType getTypeId (void) const
 SoTransform (void)
void pointAt (const SbVec3f &frompoint, const SbVec3f &topoint)
void getScaleSpaceMatrix (SbMatrix &mat, SbMatrix &inv) const
void getRotationSpaceMatrix (SbMatrix &mat, SbMatrix &inv) const
void getTranslationSpaceMatrix (SbMatrix &mat, SbMatrix &inv) const
void multLeft (const SbMatrix &mat)
void multRight (const SbMatrix &mat)
void combineLeft (SoTransformation *nodeonright)
void combineRight (SoTransformation *nodeonleft)
void setMatrix (const SbMatrix &mat)
void recenter (const SbVec3f &newcenter)
virtual void doAction (SoAction *action)
virtual void GLRender (SoGLRenderAction *action)
virtual void callback (SoCallbackAction *action)
virtual void getBoundingBox (SoGetBoundingBoxAction *action)
virtual void getMatrix (SoGetMatrixAction *action)
virtual void pick (SoPickAction *action)
virtual void getPrimitiveCount (SoGetPrimitiveCountAction *action)

Static Public Member Functions

static SoType getClassTypeId (void)
static void initClass (void)

Public Attributes

SoSFVec3f translation
SoSFRotation rotation
SoSFVec3f scaleFactor
SoSFRotation scaleOrientation
SoSFVec3f center

Protected Member Functions

virtual const SoFieldDatagetFieldData (void) const
virtual ~SoTransform ()

Static Protected Member Functions

static const SoFieldData ** getFieldDataPtr (void)


Detailed Description

The SoTransform class is the "all-purpose" transformation node type.

Like SoMatrixTransform, nodes of this type gives the application programmer maximum flexibility when specifying geometry transformations in a scene graph. If you want to set and keep the various components of the transformation matrix in separate entities, this node type is preferable, though.

The order of operations is: first scaling is done, then rotation, then translation.

FILE FORMAT/DEFAULTS:

    Transform {
        translation 0 0 0
        rotation 0 0 1  0
        scaleFactor 1 1 1
        scaleOrientation 0 0 1  0
        center 0 0 0
    }

Constructor & Destructor Documentation

SoTransform::SoTransform ( void   ) 

Constructor.

References center, rotation, scaleFactor, scaleOrientation, and translation.

SoTransform::~SoTransform (  )  [protected, virtual]

Destructor.


Member Function Documentation

SoType SoTransform::getClassTypeId ( void   )  [static]

This static method returns the SoType object associated with objects of this class.

Reimplemented from SoTransformation.

Reimplemented in SoCenterballManip, SoHandleBoxManip, SoJackManip, SoTabBoxManip, SoTrackballManip, SoTransformBoxManip, SoTransformManip, and SoTransformerManip.

Referenced by SoTransformManip::replaceNode().

SoType SoTransform::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
    }
    else if (node->getTypeId().isOfType(SoGroup::getClassTypeId())) {
      SoGroup * group = (SoGroup *)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 SoTransformation.

Reimplemented in SoCenterballManip, SoHandleBoxManip, SoJackManip, SoTabBoxManip, SoTrackballManip, SoTransformBoxManip, SoTransformManip, and SoTransformerManip.

const SoFieldData ** SoTransform::getFieldDataPtr ( void   )  [static, protected]

This API member is considered internal to the library, as it is not likely to be of interest to the application programmer.

Reimplemented from SoTransformation.

Reimplemented in SoCenterballManip, SoHandleBoxManip, SoJackManip, SoTabBoxManip, SoTrackballManip, SoTransformBoxManip, SoTransformManip, and SoTransformerManip.

const SoFieldData * SoTransform::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 SoTransformation.

Reimplemented in SoCenterballManip, SoHandleBoxManip, SoJackManip, SoTabBoxManip, SoTrackballManip, SoTransformBoxManip, SoTransformManip, and SoTransformerManip.

void SoTransform::initClass ( void   )  [static]

Sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system.

Reimplemented from SoTransformation.

Reimplemented in SoCenterballManip, SoHandleBoxManip, SoJackManip, SoTabBoxManip, SoTrackballManip, SoTransformBoxManip, SoTransformManip, and SoTransformerManip.

References SoNode::VRML1.

void SoTransform::pointAt ( const SbVec3f frompoint,
const SbVec3f topoint 
)

Sets the transformation to translate to frompoint, with a rotation so that the (0,0,-1) vector is rotated into the vector from frompoint to topoint.

References center, SbVec3f::normalize(), SoDebugError::postWarning(), rotation, scaleFactor, scaleOrientation, and translation.

void SoTransform::getScaleSpaceMatrix ( SbMatrix mat,
SbMatrix inv 
) const

void SoTransform::getRotationSpaceMatrix ( SbMatrix mat,
SbMatrix inv 
) const

void SoTransform::getTranslationSpaceMatrix ( SbMatrix mat,
SbMatrix inv 
) const

void SoTransform::multLeft ( const SbMatrix mat  ) 

void SoTransform::multRight ( const SbMatrix mat  ) 

void SoTransform::combineLeft ( SoTransformation nodeonright  ) 

Premultiplies this transformation by the transformation in nodeonright.

References SoAction::apply(), SoGetMatrixAction::getMatrix(), and multLeft().

void SoTransform::combineRight ( SoTransformation nodeonleft  ) 

Postmultiplies this transformation by the transformation in nodeonleft.

References SoAction::apply(), SoGetMatrixAction::getMatrix(), and multRight().

void SoTransform::setMatrix ( const SbMatrix mat  ) 

Sets the fields to create a transformation equal to mat.

References center, SbMatrix::getTransform(), SoSFVec3f::getValue(), rotation, scaleFactor, scaleOrientation, and translation.

Referenced by multLeft(), and multRight().

void SoTransform::recenter ( const SbVec3f newcenter  ) 

Sets the center field to newcenter. This might affect one or more of the other fields.

References center, SbMatrix::getTransform(), SoSFRotation::getValue(), SoSFVec3f::getValue(), rotation, scaleFactor, scaleOrientation, SbMatrix::setTransform(), and translation.

void SoTransform::doAction ( SoAction action  )  [virtual]

This function performs the typical operation of a node for any action.

Reimplemented from SoNode.

Reimplemented in SoTransformManip.

References center, SoAction::getState(), SoSFRotation::getValue(), SoSFVec3f::getValue(), rotation, scaleFactor, scaleOrientation, SbMatrix::setTransform(), and translation.

Referenced by callback(), getBoundingBox(), getPrimitiveCount(), GLRender(), and pick().

void SoTransform::GLRender ( SoGLRenderAction action  )  [virtual]

Action method for the SoGLRenderAction.

This is called during rendering traversals. Nodes influencing the rendering state in any way or who wants to throw geometry primitives at OpenGL overrides this method.

Reimplemented from SoNode.

Reimplemented in SoTransformManip.

References doAction().

void SoTransform::callback ( SoCallbackAction action  )  [virtual]

Action method for SoCallbackAction.

Simply updates the state according to how the node behaves for the render action, so the application programmer can use the SoCallbackAction for extracting information about the scene graph.

Reimplemented from SoNode.

Reimplemented in SoTransformManip.

References doAction().

void SoTransform::getBoundingBox ( SoGetBoundingBoxAction action  )  [virtual]

Action method for the SoGetBoundingBoxAction.

Calculates bounding box and center coordinates for node and modifies the values of the action to encompass the bounding box for this node and to shift the center point for the scene more towards the one for this node.

Nodes influencing how geometry nodes calculates their bounding box also overrides this method to change the relevant state variables.

Reimplemented from SoNode.

Reimplemented in SoTransformManip.

References doAction().

void SoTransform::getMatrix ( SoGetMatrixAction action  )  [virtual]

void SoTransform::pick ( SoPickAction action  )  [virtual]

Action method for SoPickAction.

Does common processing for SoPickAction action instances.

Reimplemented from SoNode.

Reimplemented in SoTransformManip.

References doAction().

void SoTransform::getPrimitiveCount ( SoGetPrimitiveCountAction action  )  [virtual]

Action method for the SoGetPrimitiveCountAction.

Calculates the number of triangle, line segment and point primitives for the node and adds these to the counters of the action.

Nodes influencing how geometry nodes calculates their primitive count also overrides this method to change the relevant state variables.

Reimplemented from SoNode.

References doAction().


Member Data Documentation

The rotation part of the transformation.

Note that there is one very common mistake that is easy to make when setting the value of a 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);

Referenced by SoTransformManip::attachSensors(), doAction(), SoTransformManip::fieldSensorCB(), getMatrix(), getRotationSpaceMatrix(), getTranslationSpaceMatrix(), multLeft(), multRight(), pointAt(), recenter(), setMatrix(), SoTransform(), SoTransformManip::transferFieldValues(), and SoTransformManip::valueChangedCB().


The documentation for this class was generated from the following files:

Copyright © 1998-2007 by Systems in Motion AS. All rights reserved.

Generated on Mon Feb 23 16:34:04 2009 for Coin by Doxygen. 1.5.8