SoResetTransform Class Reference

Node that resets the current transformation to identity. More...

#include <Inventor/nodes/SoResetTransform.h>

Inheritance diagram for SoResetTransform:

Public Types
enum	ResetType {   TRANSFORM = 0x01 ,   BBOX = 0x02 }
	Reset Type enumeration values; defines which things get reset. More...

Public Member Functions
virtual SoType	getTypeId () const
	Returns the type identifier for this specific instance.
	SoResetTransform ()
	Creates a reset transformation node with default settings.
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
SoSFBitMask	whatToReset
	Specifies which items to reset when the node is traversed.

Detailed Description

Node that resets the current transformation to identity.

This node resets the current transformation to identity. It can be used to apply an absolute world space transformation afterwards, such as translating to a specific point from within a hierarchy. An SoResetTransform node should probably be used under an SoSeparator or SoTransformSeparator so it won't change transformations for the rest of the scene graph. An SoResetTransform node can also be used to reset the current bounding box to empty during traversal of an SoGetBoundingBoxAction, if the whatToReset field has the BBOX bit set.

CAUTION: Picking on a shape below an SoResetTransform may fail if bounding box caching is enabled (default). Bounding box caching is set using SoSeparator.

Clipping and culling anomalies may also occur.

FILE FORMAT/DEFAULT

ResetTransform {

whatToReset

TRANSFORM

}

ACTION BEHAVIOR

SoGLRenderAction, SoCallbackAction, SoRayPickAction
If specified, resets current transformation matrix to identity. Sets: SoModelMatrixElement, SoUnitsElement

SoGetBoundingBoxAction
If specified, resets current transformation matrix to identity and current computed bounding box to be empty. Sets: SoBBoxModelMatrixElement

SoGetMatrixAction
Returns identity matrix.

SEE ALSO

SoTransform

Definition at line 116 of file SoResetTransform.h.

Member Enumeration Documentation

ResetType

enum SoResetTransform::ResetType

Reset Type enumeration values; defines which things get reset.

Enumerator
TRANSFORM	Reset the current transformation to identity.
BBOX	Reset the bounding box to empty.

Definition at line 123 of file SoResetTransform.h.

Constructor & Destructor Documentation

SoResetTransform()

SoResetTransform::SoResetTransform

(

)

Creates a reset transformation node with default settings.

Member Function Documentation

getClassTypeId()

static SoType SoResetTransform::getClassTypeId ( )

static

Returns the type identifier for this class.

getTypeId()

virtual SoType SoResetTransform::getTypeId ( ) const

virtual

Returns the type identifier for this specific instance.

Reimplemented from SoTransformation.

Member Data Documentation

whatToReset

SoSFBitMask SoResetTransform::whatToReset

Specifies which items to reset when the node is traversed.

Use enum ResetType. Default is TRANSFORM.

Definition at line 139 of file SoResetTransform.h.

---

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

• Inventor/nodes/SoResetTransform.h