Open Inventor Reference
SoTransformManip Class Reference

Base class for all transform Nodes with built-in 3D user interfaces. More...

#include <Inventor/manips/SoTransformManip.h>

Inheritance diagram for SoTransformManip:
SoTransform SoTransformation SoNode SoFieldContainer SoBase SoCenterballManip SoHandleBoxManip SoJackManip SoTabBoxManip SoTrackballManip SoTransformBoxManip SoTransformerManip

Public Member Functions

 SoTransformManip ()
 Constructor.
 
SoDraggergetDragger ()
 Returns a pointer to the dragger being used by this manipulator.
 
bool replaceNode (SoPath *p)
 Replaces the tail of the path with this manipulator.
 
bool replaceManip (SoPath *p, SoTransform *newOne) const
 Replaces the tail of the path, which must be this manipulator, with the given SoTransform node.
 
virtual void doAction (SoAction *action)
 These functions implement all actions for nodekits.
 
virtual void callback (SoCallbackAction *action)
 
virtual void GLRender (SoGLRenderAction *action)
 These virtual functions implement all of the actions for nodes, Most of the default implementations do nothing.
 
virtual void getBoundingBox (SoGetBoundingBoxAction *action)
 
virtual void getMatrix (SoGetMatrixAction *action)
 
virtual void handleEvent (SoHandleEventAction *action)
 
virtual void pick (SoPickAction *action)
 
virtual void search (SoSearchAction *action)
 
virtual SoChildListgetChildren () const
 Returns pointer to children, or NULL if none.
 
- Public Member Functions inherited from SoTransform
 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
 These return composite matrices that transform from object space to each of the spaces after the scale, rotation, or translation.
 
void getRotationSpaceMatrix (SbMatrix &mat, SbMatrix &inv) const
 These return composite matrices that transform from object space to each of the spaces after the scale, rotation, or translation.
 
void getTranslationSpaceMatrix (SbMatrix &mat, SbMatrix &inv) const
 These return composite matrices that transform from object space to each of the spaces after the scale, rotation, or translation.
 
void multLeft (const SbMatrix &mat)
 These are convenience functions that combine the effects of a matrix transformation into the current transformation stored in this node.
 
void multRight (const SbMatrix &mat)
 These are convenience functions that combine the effects of a matrix transformation into the current transformation stored in this node.
 
void combineLeft (SoTransformation *nodeOnLeft)
 These are convenience functions that combine the effects of another transformation node into the current transformation stored in this node.
 
void combineRight (SoTransformation *nodeOnRight)
 These are convenience functions that combine 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
void setOverride (bool state)
 Turns override flag on or off.
 
bool isOverride () const
 Returns the state of the override flag.
 
SoNodecopy (bool copyConnections=FALSE) const
 Creates and returns an exact copy of the node.
 
virtual bool affectsState () const
 Returns TRUE if a node has an effect on the state during traversal.
 
virtual void doAction (SoAction *action)
 This method performs the "typical" operation of a node for any action.
 
virtual void GLRender (SoGLRenderAction *action)
 These virtual functions implement all of the actions for nodes, Most of the default implementations do nothing.
 
virtual void callback (SoCallbackAction *action)
 
virtual void getBoundingBox (SoGetBoundingBoxAction *action)
 
virtual void getMatrix (SoGetMatrixAction *action)
 
virtual void handleEvent (SoHandleEventAction *action)
 
virtual void pick (SoPickAction *action)
 
virtual void rayPick (SoRayPickAction *action)
 
virtual void search (SoSearchAction *action)
 
virtual void write (SoWriteAction *action)
 
virtual void GLRenderBelowPath (SoGLRenderAction *action)
 These methods make render traversal faster by implementing different rendering paths corresponding to different action path codes.
 
virtual void GLRenderInPath (SoGLRenderAction *action)
 
virtual void GLRenderOffPath (SoGLRenderAction *action)
 
virtual void grabEventsSetup ()
 These virtual functions are called when a node gains or loses status as "grabber" of events (see HandleEventAction::setGrabber()).
 
virtual void grabEventsCleanup ()
 
virtual void startNotify ()
 Initiates notification from an instance.
 
virtual void notify (SoNotList *list)
 Propagates modification notification through an instance.
 
SbNodeIdType getNodeId () const
 Returns the unique id for a node.
 
virtual SoChildListgetChildren () const
 Returns pointer to children, or NULL if none.
 
virtual void writeInstance (SoOutput *out)
 Writes instance to SoOutput. (Used for either stage of writing.)
 
virtual SoNodeaddToCopyDict () const
 Recursively adds this node and all nodes under it to the copy dictionary.
 
virtual void copyContents (const SoFieldContainer *fromFC, bool copyConnections)
 Copies the contents of the given node into this instance.
 
virtual SoFieldContainercopyThroughConnection () const
 Copies an instance that is encountered through a field connection.
 
- Public Member Functions inherited from SoFieldContainer
void setToDefaults ()
 Sets all fields in this object to their default values.
 
bool hasDefaultValues () const
 Returns TRUE if all of the object's fields have their default values.
 
bool fieldsAreEqual (const SoFieldContainer *fc) const
 Returns TRUE if this object's fields are exactly equal to fc's fields.
 
void copyFieldValues (const SoFieldContainer *fc, bool copyConnections=FALSE)
 Copies the contents of fc's fields into this object's fields.
 
bool 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 Inventor file format.
 
void get (SbString &fieldDataString)
 Returns the values of the fields of this object in the Inventor ASCII file format in the given string.
 
virtual int getFields (SoFieldList &list) const
 Appends pointers to all of this object's fields to resultList, and returns the number of fields appended.
 
virtual SoFieldgetField (const SbName &fieldName) const
 Returns a pointer to the field with the given name.
 
bool getFieldName (const SoField *field, SbName &fieldName) const
 Returns the name of the given field in the fieldName argument.
 
bool enableNotify (bool flag)
 Notification at this Field Container is enabled (if flag == TRUE) or disabled (if flag == FALSE).
 
bool isNotifyEnabled () const
 Notification is the process of telling interested objects that this object has changed.
 
bool set (const char *fieldDataString, SoInput *dictIn)
 Sets one or more fields in this object to the values specified in the given string, which should be a string in the Inventor file format.
 
void get (SbString &fieldDataString, SoOutput *dictOut)
 Returns the values of the fields of this object in the Inventor ASCII file format in the given string.
 
virtual void notify (SoNotList *)
 Propagates modification notification through an instance.
 
virtual void addWriteReference (SoOutput *out, bool isFromField=FALSE)
 Adds a reference to the instance when writing.
 
virtual void writeInstance (SoOutput *out)
 Writes instance to SoOutput. (Used only for last stage of writing)
 
bool getIsBuiltIn () const
 Returns whether or not instance is considered 'built-in' to the library.
 
virtual const SoFieldDatagetFieldData () const
 Returns an SoFieldData structure for the node.
 
virtual void copyContents (const SoFieldContainer *fromFC, bool copyConnections)
 Copies the contents of the given node into this instance.
 
virtual SoFieldContainercopyThroughConnection () const
 During a copy operation, this copies an instance that is encountered through a field connection.
 
void addManagedSensor (SoSensor *sensor)
 Adds a sensor which is managed by the field container.
 
- Public Member Functions inherited from SoBase
void ref () const
 Adds and removes a reference to an instance.
 
void unref () const
 
void unrefNoDelete () const
 
void touch ()
 Marks an instance as modified, simulating a change to it.
 
virtual SoType getTypeId () const =0
 Returns the type identifier for a specific instance.
 
bool isOfType (SoType type) const
 Returns TRUE if this object is of the type specified in type or is derived from that type.
 
virtual SbName getName () const
 Returns the name of an instance.
 
virtual void setName (const SbName &name)
 Sets the name of an instance.
 
virtual void startNotify ()
 Initiates notification from an instance.
 
virtual void notify (SoNotList *list)
 Propagates modification notification through an instance.
 
void addAuditor (void *auditor, SoNotRec::Type type)
 Adds/removes an auditor to/from list.
 
void removeAuditor (void *auditor, SoNotRec::Type type)
 
const SoAuditorListgetAuditors ()
 Returns auditor list– used by SoField and SoEngineOutput to trace forward connections.
 
int getRefCount () const
 Returns current reference count.
 
virtual void addWriteReference (SoOutput *out, bool isFromField=FALSE)
 Adds a reference to the instance when writing.
 
bool shouldWrite ()
 Returns TRUE if the instance should be written, based on the write-reference info already accumulated.
 

Static Public Member Functions

static void initClass ()
 initialize the class
 
- Static Public Member Functions inherited from SoTransform
static void initClass ()
 
- Static Public Member Functions inherited from SoTransformation
static void initClass ()
 
- Static Public Member Functions inherited from SoNode
static SoType getClassTypeId ()
 Returns type identifier for the SoNode class.
 
static SoNodegetByName (const SbName &name)
 Returns the last node given the specified name.
 
static int getByName (const SbName &name, SoNodeList &list)
 Returns the number of nodes with the given name, and adds to list pointers to those nodes.
 
static void initClass ()
 Initializes base node class.
 
static void initClasses ()
 Initialize ALL Inventor node classes.
 
static SbNodeIdType getNextNodeId ()
 Returns the next available unique id.
 
static int getActionMethodIndex (SoType t)
 Returns the index of this node in the action/method table, given its type.
 
- Static Public Member Functions inherited from SoFieldContainer
static SoType getClassTypeId ()
 Returns the type of this class.
 
static void initClass ()
 Setup type information.
 
static void initCopyDict ()
 During a copy operation, copies of nodes and engines are stored in a dictionary, keyed by the original node or engine pointer, so that copies can be re-used.
 
static void addCopy (const SoFieldContainer *orig, const SoFieldContainer *copy)
 Adds an instance to the dictionary.
 
static SoFieldContainercheckCopy (const SoFieldContainer *orig)
 If a copy of the given instance is in the dictionary, this returns it.
 
static SoFieldContainerfindCopy (const SoFieldContainer *orig, bool copyConnections)
 If a copy of the given instance is not in the dictionary, this returns NULL.
 
static void copyDone ()
 Cleans up the dictionary when done.
 
- Static Public Member Functions inherited from SoBase
static SoType getClassTypeId ()
 Returns type identifier for this class.
 
static void initClass ()
 Setup type information.
 
static void incrementCurrentWriteCounter ()
 Increments the current write counter at the start of a write operation.
 
static void decrementCurrentWriteCounter ()
 Decrements the current write counter after a write operation, in some rare cases.
 
static void addName (SoBase *, const char *)
 Internal methods used to maintain the global name dictionary.
 
static void removeName (SoBase *, const char *)
 
static SoBasegetNamedBase (const SbName &, SoType)
 Helper routines used to get stuff out of nameDict.
 
static int getNamedBases (const SbName &, SoBaseList &, SoType)
 
static bool read (SoInput *in, SoBase *&base, SoType expectedType)
 Reads one instance of some subclass of SoBase.
 
static void setInstancePrefix (const SbString &c)
 This defaults to "+" and is used when naming nodes that are DEF's and USE'd.
 

Protected Member Functions

virtual void copyContents (const SoFieldContainer *fromFC, bool copyConnections)
 Redefines this to also copy the dragger.
 
virtual void setDragger (SoDragger *newDragger)
 
virtual ~SoTransformManip ()
 
- Protected Member Functions inherited from SoTransform
virtual ~SoTransform ()
 
- Protected Member Functions inherited from SoTransformation
 SoTransformation ()
 Constructor - protected since this is abstract.
 
virtual ~SoTransformation ()
 
- Protected Member Functions inherited from SoNode
 SoNode ()
 Constructor, destructor.
 
virtual ~SoNode ()
 
- Protected Member Functions inherited from SoFieldContainer
 SoFieldContainer ()
 
 ~SoFieldContainer ()
 
virtual bool readInstance (SoInput *in, unsigned short flags)
 Reads stuff into instance. Returns FALSE on error.
 
- Protected Member Functions inherited from SoBase
 SoBase ()
 Constructor is protected - this is an abstract class.
 
virtual ~SoBase ()
 Virtual destructor so that subclasses are deleted properly.
 
virtual void destroy ()
 Actually deletes an instance.
 
bool hasMultipleWriteRefs () const
 Returns TRUE if the instance has multiple write references.
 
bool writeHeader (SoOutput *out, bool isGroup, bool isEngine) const
 Writes a header (name, open brace) or footer (close brace) to file defined by SoOutput.
 
void writeFooter (SoOutput *out) const
 
virtual const char * getFileFormatName () const
 Unknown nodes and engines write a different name for themselves than their typeId; this virtual method lets them do that (by default the typeId name is returned)
 
virtual bool readInstance (SoInput *in, unsigned short flags)=0
 Reads stuff into instance of subclass.
 

Static Protected Member Functions

static void transferFieldValues (const SoTransform *from, SoTransform *to)
 
static void valueChangedCB (void *, SoDragger *)
 
static void fieldSensorCB (void *, SoSensor *)
 
- Static Protected Member Functions inherited from SoNode
static const SoFieldData ** getFieldDataPtr ()
 This is used by the field-inheritence mechanism, hidden in the SoSubNode macros.
 
- Static Protected Member Functions inherited from SoBase
static uint32_t getCurrentWriteCounter ()
 Returns current write counter.
 

Protected Attributes

SoFieldSensorrotateFieldSensor
 
SoFieldSensortranslFieldSensor
 
SoFieldSensorscaleFieldSensor
 
SoFieldSensorcenterFieldSensor
 
SoFieldSensorscaleOrientFieldSensor
 
SoChildListchildren
 
- Protected Attributes inherited from SoNode
SbNodeIdType uniqueId
 Unique id for this node.
 
- Protected Attributes inherited from SoFieldContainer
bool isBuiltIn
 Is the subclass a built-in Inventor subclass or an extender subclass? This is used to determine whether to read/write field type information.
 

Additional Inherited Members

- Public Types inherited from SoNode
enum  Stage { FIRST_INSTANCE , PROTO_INSTANCE , OTHER_INSTANCE }
 
- Public Attributes inherited from SoTransform
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.
 
- Static Public Attributes inherited from SoBase
static bool traceRefs
 Turns on/off reference count tracing (for debugging)
 
- Protected Types inherited from SoBase
enum  BaseFlags { IS_ENGINE = 1 , IS_GROUP = 2 }
 This set of enums is used when reading and writing the base. More...
 
- Static Protected Attributes inherited from SoNode
static SbNodeIdType nextUniqueId
 Next available unique id.
 
static int nextActionMethodIndex
 Next index into the action method table.
 

Detailed Description

SoTransformManip is the base class for all SoTransform nodes that have a built-in 3D user interface. Since it is derived from SoTransform, any changes to its fields result in the rotation, scaling, and/or translation of nodes that follow it in the scene graph.

Typically, you will want to replace a regular SoTransform with an SoTransformManip (as when the user selects an object to be moved), or vice versa (as when the object is deselected, and the motion interface should go away). Use the replaceNode() method to insert a manipulator into a scene graph, and the replaceManip() method to remove it when done.

Every subclass of SoTransformManip utilizes a dragger of some sort to provide a 3D interface. (This class does not have dragger; but all the subclasses do.) However a manipulator differs from a dragger; it influences other objects in the scene because, as an SoTransform, it alters the state. The fields values and movement of a dragger, on the other hand, affect only the dragger itself.

Each SoTransformManip subclass utilizes its dragger by adding it as a hidden child. When an action is applied to the manipulator, such as rendering or handling events, the manipulator first traverses the dragger, and then the manipulator adds its transformation matrix to the state. When you click-drag-release over the manipulator, it passes these events down to the dragger, which moves as a result ("I can't <em>help</em> it, I'm a dragger!").

The manipulator maintains consistency between the fields of the dragger and its own fields. Let's say you use the mouse to rotate the dragger. Callbacks insure that the rotation field of the manipulator will change by the same amount, resulting in the rotation of nodes which follow in the scene graph. Similarly, if you set any of the SoTransformManip fields the manipulator will move the dragger accordingly. You can use this feature to impose contraints on a manipulator: If the user moves the manipulator so that a field value becomes too large, you can set the field back to your desired maximum, and the whole thing will move back to where you specified.

Since each SoTransformManip uses a dragger to provide its interface, you will generally be told to look at the dragger's reference page for details of how it moves and what the different parts are for. The interface for the dragger and the manipulator will always be exactly the same. Usually, a SoTransformManip will surround the objects that it influences (i.e., those that move along with it).
This is because the manipulator turns on the surroundScale part of its dragger; so the dragger geometry expands to envelope the other objects (see the reference page for SoSurroundScale).

Because the dragger is a hidden child, you can see the dragger on screen and interact with it, but the dragger does not show up when you write the manipulator to file. Also, any SoPath will end at the manipulator. (See the Actions section of this reference page for a complete description of when the dragger is traversed).

If you want to get a pointer to the dragger you can get it from the manipulator using the getDragger() method. You will need to do this if you want to change the geometry of a manipulator, since the geometry actually belongs to the dragger.

Action Behavior
SoGLRenderAction, SoCallbackAction, SoGetBoundingBoxAction, SoGetMatrixAction, SoHandleEventAction, SoRayPickAction
First, traverses the dragger the way an SoGroup would. All draggers place themselves in space, but leave the current transformation unchanged when finished. Then the SoTransformManip accumulates a transformation into the current transformation just like its base class, SoTransform.
SoSearchAction
Searches just like an SoTransform. Does not search the dragger, which is a hidden child.
SoWriteAction
Writes out just like an SoTransform. Does not write the dragger, which is a hidden child. If you really need to write valuable information about the dragger, such as customized geometry, you can retrieve the dragger with the getDragger() method and then write it out separately.
See Also
SoDragger, SoTransform, SoCenterballManip, SoHandleBoxManip, SoJackManip, SoSurroundScale, SoTabBoxManip, SoTrackballManip, SoTransformBoxManip, SoTransformerManip

Definition at line 163 of file SoTransformManip.h.

Constructor & Destructor Documentation

◆ SoTransformManip()

SoTransformManip::SoTransformManip ( )

◆ ~SoTransformManip()

virtual SoTransformManip::~SoTransformManip ( )
protectedvirtual

Member Function Documentation

◆ callback()

virtual void SoTransformManip::callback ( SoCallbackAction action)
virtual

Reimplemented from SoTransform.

◆ copyContents()

virtual void SoTransformManip::copyContents ( const SoFieldContainer fromFC,
bool  copyConnections 
)
protectedvirtual

Reimplemented from SoNode.

◆ doAction()

virtual void SoTransformManip::doAction ( SoAction action)
virtual

They first traverse the children, then use the SoTransform version of the actions. They traverse first so that the transform will affect objects which follow it in the tree, but not the dragger-child.

Reimplemented from SoTransform.

◆ fieldSensorCB()

static void SoTransformManip::fieldSensorCB ( void *  ,
SoSensor  
)
staticprotected

◆ getBoundingBox()

virtual void SoTransformManip::getBoundingBox ( SoGetBoundingBoxAction action)
virtual

Reimplemented from SoTransform.

◆ getChildren()

virtual SoChildList * SoTransformManip::getChildren ( ) const
virtual

Reimplemented from SoNode.

◆ getDragger()

SoDragger * SoTransformManip::getDragger ( )

Given this pointer, you can customize the dragger just like you would any other dragger. You can change geometry using the setPart() method, or add callbacks using the methods found in the SoDragger reference page.

◆ getMatrix()

virtual void SoTransformManip::getMatrix ( SoGetMatrixAction action)
virtual

Reimplemented from SoTransform.

◆ GLRender()

virtual void SoTransformManip::GLRender ( SoGLRenderAction action)
virtual

Reimplemented from SoTransform.

◆ handleEvent()

virtual void SoTransformManip::handleEvent ( SoHandleEventAction action)
virtual

Reimplemented from SoNode.

◆ initClass()

static void SoTransformManip::initClass ( )
static

◆ pick()

virtual void SoTransformManip::pick ( SoPickAction action)
virtual

Reimplemented from SoTransform.

◆ replaceManip()

bool SoTransformManip::replaceManip ( SoPath p,
SoTransform newOne 
) const

If the path has a nodekit, this will try to use setPart() to insert the new node. Otherwise, the manipulator requires that the next to last node in the path chain be a group.

The field values from the manipulator will be copied to the transform node, and the manipulator will be replaced.

The manipulator will not call ref() or unref() on the node which is replacing it, nor will it make any changes to field connections. The calling process is thus responsible for keeping track of its own nodes and field connections.

◆ replaceNode()

bool SoTransformManip::replaceNode ( SoPath p)

The tail of the path must be an SoTransform node (or subclass thereof). If the path has a nodekit, this will try to use setPart() to insert the manipulator. Otherwise, the manipulator requires that the next to last node in the path chain be a group.

The field values from the transform node will be copied to this manipulator, and the transform will be replaced.

The manipulator will not call ref() on the node it is replacing. The old node will disappear if it has no references other than from the input path p and its parent, since this manipulator will be replacing it in both of those places. Nor will the manipulator make any changes to field connections of the old node.
The calling process is thus responsible for keeping track of its own nodes and field connections.

◆ search()

virtual void SoTransformManip::search ( SoSearchAction action)
virtual

Reimplemented from SoNode.

◆ setDragger()

virtual void SoTransformManip::setDragger ( SoDragger newDragger)
protectedvirtual

Reimplemented in SoCenterballManip.

◆ transferFieldValues()

static void SoTransformManip::transferFieldValues ( const SoTransform from,
SoTransform to 
)
staticprotected

◆ valueChangedCB()

static void SoTransformManip::valueChangedCB ( void *  ,
SoDragger  
)
staticprotected

Member Data Documentation

◆ centerFieldSensor

SoFieldSensor* SoTransformManip::centerFieldSensor
protected

Definition at line 255 of file SoTransformManip.h.

◆ children

SoChildList* SoTransformManip::children
protected

Definition at line 261 of file SoTransformManip.h.

◆ rotateFieldSensor

SoFieldSensor* SoTransformManip::rotateFieldSensor
protected

Definition at line 252 of file SoTransformManip.h.

◆ scaleFieldSensor

SoFieldSensor* SoTransformManip::scaleFieldSensor
protected

Definition at line 254 of file SoTransformManip.h.

◆ scaleOrientFieldSensor

SoFieldSensor* SoTransformManip::scaleOrientFieldSensor
protected

Definition at line 256 of file SoTransformManip.h.

◆ translFieldSensor

SoFieldSensor* SoTransformManip::translFieldSensor
protected

Definition at line 253 of file SoTransformManip.h.


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