General 3D geometric transformation node. More...

#include <Inventor/nodes/SoTransform.h>

Inheritance diagram for SoTransform:

Public Member Functions
virtual SoType	getTypeId () const
	Returns the type identifier for this specific instance.

	SoTransform ()
	Creates a transformation node with default settings.

void	pointAt (const SbVec3f &fromPoint, const SbVec3f &toPoint)
	Sets the node to translate the origin to the fromPoint and rotate the negative z-axis (0,0,-1) to lie on the vector from fromPoint to toPoint .

void	getScaleSpaceMatrix (SbMatrix &mat, SbMatrix &inv) const
	Returns composite matrix that transforms from object space to scale space (the space after the scale).

void	getRotationSpaceMatrix (SbMatrix &mat, SbMatrix &inv) const
	Returns composite matrix that transforms from object space to rotation space (the space after the scale and rotation).

void	getTranslationSpaceMatrix (SbMatrix &mat, SbMatrix &inv) const
	Returns composite matrix that transforms from object space to translation space (the space after scale, rotation, and translation).

void	multLeft (const SbMatrix &mat)
	Convenience function that combines the effects of a matrix transformation into the current transformation stored in this node.

void	multRight (const SbMatrix &mat)
	Convenience function that combines the effects of a matrix transformation into the current transformation stored in this node.

void	combineLeft (SoTransformation *nodeOnLeft)
	Convenience function that combines the effects of another transformation node into the current transformation stored in this node.

void	combineRight (SoTransformation *nodeOnRight)
	Convenience function that combines the effects of another transformation node into the current transformation stored in this node.

void	setMatrix (const SbMatrix &mat)
	Sets the fields in the node to implement the transformation represented by the given matrix.

void	recenter (const SbVec3f &newCenter)
	Changes the center of the transformation to the given point without affecting the overall effect of the transformation.

Public Member Functions inherited from SoNode
virtual void	setOverride (const SbBool state)
	Turns the override flag on or off.

virtual SbBool	isOverride () const
	Returns the state of the override flag.

virtual SoNode *	copy (SbBool copyConnections=FALSE) const
	Creates and returns an exact copy of the node.

virtual SbBool	affectsState () const
	Returns TRUE if a node has an effect on the state during traversal.

virtual void	touch ()
	Marks an instance as modified, simulating a change to it.

Public Member Functions inherited from SoFieldContainer
void	setToDefaults ()
	Sets all fields in this object to their default values.

SbBool	hasDefaultValues () const
	Returns TRUE if all of the object's fields have their default values.

SbBool	fieldsAreEqual (const SoFieldContainer *fc) const
	Returns TRUE if this object's fields are exactly equal to fc's fields.

void	copyFieldValues (const SoFieldContainer *fc, SbBool copyConnections=FALSE)
	Copies the contents of fc's fields into this object's fields.

SoNONUNICODE SbBool	set (const char *fieldDataString)
	Sets one or more fields in this object to the values specified in the given string, which should be a string in the Open Inventor file format.

SbBool	set (const SbString &fieldDataString)
	Sets one or more fields in this object to the values specified in the given string, which should be a string in the Open Inventor file format.

void	get (SbString &fieldDataString)
	Returns the values of the fields of this object in the Open Inventor ASCII file format in the given string.

virtual int	getFields (SoFieldList &list) const
	Appends references to all of this object's fields to resultList, and returns the number of fields appended.

virtual int	getAllFields (SoFieldList &list) const
	Returns a list of fields, including the eventIn's and eventOut's.

virtual SoField *	getField (const SbName &fieldName) const
	Returns a the field of this object whose name is fieldName.

virtual SoField *	getEventIn (const SbName &fieldName) const
	Returns a the eventIn with the given name.

virtual SoField *	getEventOut (const SbName &fieldName) const
	Returns the eventOut with the given name.

SbBool	getFieldName (const SoField *field, SbName &fieldName) const
	Returns the name of the given field in the fieldName argument.

SbBool	enableNotify (SbBool flag)
	Notification at this Field Container is enabled (if flag == TRUE) or disabled (if flag == FALSE).

SbBool	isNotifyEnabled () const
	Notification is the process of telling interested objects that this object has changed.

virtual void	setUserData (void *data)
	Sets application data.

void *	getUserData (void) const
	Gets user application data.

Public Member Functions inherited from SoBase
virtual SbName	getName () const
	Returns the name of an instance.

virtual void	setName (const SbName &name)
	Sets the name of an instance.

void	setSynchronizable (const bool b)
	Sets this to be a ScaleViz synchronizable object.

bool	isSynchronizable () const
	Gets the ScaleViz synchronizable state of this object.

Public Member Functions inherited from SoRefCounter
void	ref () const
	Adds a reference to an instance.

void	unref () const
	Removes a reference from an instance.

void	unrefNoDelete () const
	unrefNoDelete() should be called when it is desired to decrement the reference count, but not delete the instance if this brings the reference count to zero.

int	getRefCount () const
	Returns current reference count.

void	lock () const
	lock this instance.

void	unlock () const
	unlock this instance.

Public Member Functions inherited from SoTypedObject
SbBool	isOfType (const SoType &type) const
	Returns TRUE if this object is of the type specified in type or is derived from that type.

template<typename TypedObjectClass >
SbBool	isOfType () const
	Returns TRUE if this object is of the type of class TypedObjectClass or is derived from that class.

Static Public Member Functions
static SoType	getClassTypeId ()
	Returns the type identifier for this class.

Static Public Member Functions inherited from SoTransformation
static SoType	getClassTypeId ()
	Returns the type identifier for this class.

Static Public Member Functions inherited from SoNode
static SoType	getClassTypeId ()
	Returns the type identifier for this class.

static SoNode *	getByName (const SbName &name)
	A node's name can be set using SoBase::setName().

static int	getByName (const SbName &name, SoNodeList &list)
	A node's name can be set using SoBase::setName().

Static Public Member Functions inherited from SoFieldContainer
static SoType	getClassTypeId ()
	Returns the type of this class.

Static Public Member Functions inherited from SoBase
static SoType	getClassTypeId ()
	Returns type identifier for this class.

Static Public Member Functions inherited from SoTypedObject
static SoType	getClassTypeId ()
	Returns the type identifier for this class.

Public Attributes
SoSFVec3f	translation
	Translation vector.

SoSFRotation	rotation
	Rotation specification.

SoSFVec3f	scaleFactor
	Scale factors.

SoSFRotation	scaleOrientation
	Rotational orientation for scale.

SoSFVec3f	center
	Origin for scale and rotation.

Detailed Description

General 3D geometric transformation node.

This node defines a geometric 3D transformation consisting of (in order) a (possibly) non-uniform scale about an arbitrary point, a rotation about an arbitrary point and axis, and a translation. (While the transformations can be thought of as being applied in that order, matrices are actually premultiplied in the opposite order. Therefore, the operations are listed in the reverse order throughout this reference page.)

FILE FORMAT/DEFAULT

translation	0 0 0
rotation	0 0 1 0
scaleFactor	1 1 1
scaleOrientation	0 0 1 0
center	0 0 0

ACTION BEHAVIOR

SoGLRenderAction

SoCallbackAction

SoGetBoundingBoxAction

SoRayPickAction

SoModelMatrixElement

SoGetMatrixAction
Returns the matrix corresponding to the total transformation.

Constructor & Destructor Documentation

◆ SoTransform()

SoTransform::SoTransform ( )

Creates a transformation node with default settings.

Member Function Documentation

◆ combineLeft()

void SoTransform::combineLeft ( SoTransformation * nodeOnLeft )

Convenience function that combines the effects of another transformation node into the current transformation stored in this node.

This method premultiplies the transformation.

◆ combineRight()

void SoTransform::combineRight ( SoTransformation * nodeOnRight )

Convenience function that combines the effects of another transformation node into the current transformation stored in this node.

This method postmultiplies the transformation.

◆ getClassTypeId()

static SoType SoTransform::getClassTypeId ( )

static

Returns the type identifier for this class.

◆ getRotationSpaceMatrix()

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

Returns composite matrix that transforms from object space to rotation space (the space after the scale and rotation).

◆ getScaleSpaceMatrix()

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

Returns composite matrix that transforms from object space to scale space (the space after the scale).

◆ getTranslationSpaceMatrix()

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

Returns composite matrix that transforms from object space to translation space (the space after scale, rotation, and translation).

◆ getTypeId()

virtual SoType SoTransform::getTypeId ( ) const

virtual

Returns the type identifier for this specific instance.

Reimplemented from SoTransformation.

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

◆ multLeft()

void SoTransform::multLeft ( const SbMatrix & mat )

Convenience function that combines the effects of a matrix transformation into the current transformation stored in this node.

This method premultiplies the transformation.

◆ multRight()

void SoTransform::multRight ( const SbMatrix & mat )

Convenience function that combines the effects of a matrix transformation into the current transformation stored in this node.

This method postmultiplies the transformation.

◆ pointAt()

void SoTransform::pointAt	(	const SbVec3f &	fromPoint,
		const SbVec3f &	toPoint
	)

Sets the node to translate the origin to the fromPoint and rotate the negative z-axis (0,0,-1) to lie on the vector from fromPoint to toPoint .

This always tries to keep the "up" direction the positive y-axis, unless that is impossible. All current field values in the node are replaced.

◆ recenter()

void SoTransform::recenter ( const SbVec3f & newCenter )

Changes the center of the transformation to the given point without affecting the overall effect of the transformation.

◆ setMatrix()

void SoTransform::setMatrix ( const SbMatrix & mat )

Sets the fields in the node to implement the transformation represented by the given matrix.

Note that invalid matrices (such as singular ones) have undefined results.

Member Data Documentation

◆ center

SoSFVec3f SoTransform::center

Origin for scale and rotation.

Definition at line 141 of file SoTransform.h.

◆ rotation

SoSFRotation SoTransform::rotation

Rotation specification.

Definition at line 126 of file SoTransform.h.

◆ scaleFactor

SoSFVec3f SoTransform::scaleFactor

Scale factors.

Non-positive values may cause undesirable results.

Definition at line 131 of file SoTransform.h.

◆ scaleOrientation

SoSFRotation SoTransform::scaleOrientation

Rotational orientation for scale.

Definition at line 136 of file SoTransform.h.

◆ translation

SoSFVec3f SoTransform::translation

Translation vector.

Definition at line 121 of file SoTransform.h.

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

Inventor/nodes/SoTransform.h

Open Inventor Release 2024.2.1

Public Member Functions

Static Public Member Functions

Public Attributes