Coin Logo Coin3D is Free Software,
published under the BSD 3-clause license.
https://coin3d.github.io
https://www.kongsberg.com/en/kogt/
SoTransformManip Class Reference

The SoTransformManip class is used to manipulate transformations. 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

virtual SoType getTypeId (void) const
 Returns the type identification of an object derived from a class inheriting SoBase. This is used for runtime type checking and "downward" casting. More...
 
 SoTransformManip (void)
 
SoDraggergetDragger (void)
 
SbBool replaceNode (SoPath *p)
 
SbBool replaceManip (SoPath *p, SoTransform *newone) const
 
virtual void doAction (SoAction *action)
 
virtual void callback (SoCallbackAction *action)
 
virtual void GLRender (SoGLRenderAction *action)
 
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 (void) const
 
- Public Member Functions inherited from SoTransform
 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 getPrimitiveCount (SoGetPrimitiveCountAction *action)
 
- Public Member Functions inherited from SoNode
void setOverride (const SbBool state)
 
SbBool isOverride (void) const
 
void setNodeType (const NodeType type)
 
NodeType getNodeType (void) const
 
virtual SoNodecopy (SbBool copyconnections=FALSE) const
 
virtual SbBool affectsState (void) const
 
virtual void GLRenderBelowPath (SoGLRenderAction *action)
 
virtual void GLRenderInPath (SoGLRenderAction *action)
 
virtual void GLRenderOffPath (SoGLRenderAction *action)
 
virtual void rayPick (SoRayPickAction *action)
 
virtual void write (SoWriteAction *action)
 
virtual void audioRender (SoAudioRenderAction *action)
 
virtual void grabEventsSetup (void)
 
virtual void grabEventsCleanup (void)
 
virtual void startNotify (void)
 
virtual void notify (SoNotList *l)
 
SbUniqueId getNodeId (void) const
 
virtual void writeInstance (SoOutput *out)
 
virtual SoNodeaddToCopyDict (void) const
 
virtual SoFieldContainercopyThroughConnection (void) const
 
- Public Member Functions inherited from SoFieldContainer
void setToDefaults (void)
 
SbBool hasDefaultValues (void) const
 
SbBool fieldsAreEqual (const SoFieldContainer *container) const
 
void copyFieldValues (const SoFieldContainer *container, SbBool copyconnections=FALSE)
 
SbBool set (const char *const fielddata)
 
void get (SbString &fielddata)
 
virtual int getFields (SoFieldList &l) const
 
virtual int getAllFields (SoFieldList &l) const
 
virtual SoFieldgetField (const SbName &name) const
 
virtual SoFieldgetEventIn (const SbName &name) const
 
virtual SoFieldgetEventOut (const SbName &name) const
 
SbBool getFieldName (const SoField *const field, SbName &name) const
 
SbBool enableNotify (const SbBool flag)
 
SbBool isNotifyEnabled (void) const
 
SbBool set (const char *fielddata, SoInput *input)
 
void get (SbString &fielddata, SoOutput *out)
 
virtual SbBool validateNewFieldValue (SoField *field, void *newval)
 
virtual void addWriteReference (SoOutput *out, SbBool isfromfield=FALSE)
 
SbBool getIsBuiltIn (void) const
 
virtual void getFieldsMemorySize (size_t &managed, size_t &unmanaged) const
 
void setUserData (void *userdata) const
 
void * getUserData (void) const
 
- Public Member Functions inherited from SoBase
void ref (void) const
 
void unref (void) const
 
void unrefNoDelete (void) const
 
int32_t getRefCount (void) const
 
void touch (void)
 
SbBool isOfType (SoType type) const
 Returns TRUE if the type of this object is either of the same type or inherited from type. More...
 
virtual SbName getName (void) const
 
virtual void setName (const SbName &newname)
 
void addAuditor (void *const auditor, const SoNotRec::Type type)
 
void removeAuditor (void *const auditor, const SoNotRec::Type type)
 
const SoAuditorListgetAuditors (void) const
 
SbBool shouldWrite (void)
 
void assertAlive (void) const
 

Static Public Member Functions

static SoType getClassTypeId (void)
 
static void initClass (void)
 
- Static Public Member Functions inherited from SoTransform
static SoType getClassTypeId (void)
 
static void initClass (void)
 
- Static Public Member Functions inherited from SoTransformation
static SoType getClassTypeId (void)
 
static void initClass (void)
 
- Static Public Member Functions inherited from SoNode
static uint32_t getCompatibilityTypes (const SoType &nodetype)
 
static SoType getClassTypeId (void)
 
static SoNodegetByName (const SbName &name)
 
static int getByName (const SbName &name, SoNodeList &l)
 
static void initClass (void)
 
static void initClasses (void)
 
static SbUniqueId getNextNodeId (void)
 
static int getActionMethodIndex (const SoType type)
 
static void getBoundingBoxS (SoAction *action, SoNode *node)
 
static void GLRenderS (SoAction *action, SoNode *node)
 
static void callbackS (SoAction *action, SoNode *node)
 
static void getMatrixS (SoAction *action, SoNode *node)
 
static void handleEventS (SoAction *action, SoNode *node)
 
static void pickS (SoAction *action, SoNode *node)
 
static void rayPickS (SoAction *action, SoNode *node)
 
static void searchS (SoAction *action, SoNode *node)
 
static void writeS (SoAction *action, SoNode *node)
 
static void audioRenderS (SoAction *action, SoNode *node)
 
static void getPrimitiveCountS (SoAction *action, SoNode *node)
 
- Static Public Member Functions inherited from SoFieldContainer
static void initClass (void)
 
static SoType getClassTypeId (void)
 
static void cleanupClass (void)
 
static void initCopyDict (void)
 
static void addCopy (const SoFieldContainer *orig, const SoFieldContainer *copy)
 
static SoFieldContainercheckCopy (const SoFieldContainer *orig)
 
static SoFieldContainerfindCopy (const SoFieldContainer *orig, const SbBool copyconnections)
 
static void copyDone (void)
 
- Static Public Member Functions inherited from SoBase
static void initClass (void)
 Sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system.
 
static SoType getClassTypeId (void)
 This static method returns the SoType object associated with objects of this class.
 
static void addName (SoBase *const base, const char *const name)
 
static void removeName (SoBase *const base, const char *const name)
 
static void incrementCurrentWriteCounter (void)
 
static void decrementCurrentWriteCounter (void)
 
static SoBasegetNamedBase (const SbName &name, SoType type)
 
static int getNamedBases (const SbName &name, SoBaseList &baselist, SoType type)
 
static SbBool read (SoInput *input, SoBase *&base, SoType expectedtype)
 
static void setInstancePrefix (const SbString &c)
 
static void setTraceRefs (SbBool trace)
 
static SbBool getTraceRefs (void)
 
static SbBool connectRoute (SoInput *input, const SbName &fromnodename, const SbName &fromfieldname, const SbName &tonodename, const SbName &tofieldname)
 
static SbBool readRoute (SoInput *input)
 

Protected Member Functions

virtual const SoFieldDatagetFieldData (void) const
 
virtual ~SoTransformManip (void)
 
void setDragger (SoDragger *newdragger)
 
virtual void copyContents (const SoFieldContainer *fromfc, SbBool copyconnections)
 
void attachSensors (const SbBool onoff)
 
- Protected Member Functions inherited from SoTransform
virtual ~SoTransform ()
 
- Protected Member Functions inherited from SoTransformation
 SoTransformation (void)
 
virtual ~SoTransformation ()
 
- Protected Member Functions inherited from SoNode
 SoNode (void)
 
virtual ~SoNode ()
 
virtual SbBool readInstance (SoInput *in, unsigned short flags)
 
- Protected Member Functions inherited from SoFieldContainer
 SoFieldContainer (void)
 
virtual ~SoFieldContainer ()
 
- Protected Member Functions inherited from SoBase
 SoBase (void)
 
virtual ~SoBase ()
 
virtual void destroy (void)
 
SbBool hasMultipleWriteRefs (void) const
 
SbBool writeHeader (SoOutput *out, SbBool isgroup, SbBool isengine) const
 
void writeFooter (SoOutput *out) const
 
virtual const char * getFileFormatName (void) const
 
virtual SoNotRec createNotRec (void)
 

Static Protected Member Functions

static const SoFieldData ** getFieldDataPtr (void)
 
static void transferFieldValues (const SoTransform *from, SoTransform *to)
 
static void valueChangedCB (void *f, SoDragger *d)
 
static void fieldSensorCB (void *f, SoSensor *d)
 
- Static Protected Member Functions inherited from SoTransform
static const SoFieldData ** getFieldDataPtr (void)
 
- Static Protected Member Functions inherited from SoTransformation
static const SoFieldData ** getFieldDataPtr (void)
 
- Static Protected Member Functions inherited from SoNode
static const SoFieldData ** getFieldDataPtr (void)
 
static void setNextActionMethodIndex (int index)
 
static int getNextActionMethodIndex (void)
 
static void incNextActionMethodIndex (void)
 
static void setCompatibilityTypes (const SoType &nodetype, const uint32_t bitmask)
 
- Static Protected Member Functions inherited from SoBase
static uint32_t getCurrentWriteCounter (void)
 
static void staticDataLock (void)
 
static void staticDataUnlock (void)
 

Protected Attributes

SoFieldSensorrotateFieldSensor
 
SoFieldSensortranslFieldSensor
 
SoFieldSensorscaleFieldSensor
 
SoFieldSensorcenterFieldSensor
 
SoFieldSensorscaleOrientFieldSensor
 
SoChildListchildren
 
- Protected Attributes inherited from SoNode
SbUniqueId uniqueId
 
- Protected Attributes inherited from SoFieldContainer
SbBool isBuiltIn
 

Additional Inherited Members

- Public Types inherited from SoNode
enum  NodeType {
  INVENTOR = 0x0000, VRML1 = 0x0001, VRML2 = 0x0002, INVENTOR_1 = 0x0004,
  INVENTOR_2_0 = 0x0008, INVENTOR_2_1 = 0x0010, INVENTOR_2_5 = 0x0020, INVENTOR_2_6 = 0x0040,
  COIN_1_0 = 0x0080, COIN_2_0 = 0x0100, EXTENSION = 0x0200, COIN_2_2 = 0x0400,
  COIN_2_3 = 0x0800, COIN_2_4 = 0x1000, INVENTOR_5_0 = 0x2000, COIN_2_5 = 0x4000,
  COIN_3_0 = 0x8000, INVENTOR_6_0 = 0x10000, COIN_4_0 = 0x20000
}
 
- Public Attributes inherited from SoTransform
SoSFVec3f translation
 
SoSFRotation rotation
 
SoSFVec3f scaleFactor
 
SoSFRotation scaleOrientation
 
SoSFVec3f center
 
- Protected Types inherited from SoBase
enum  BaseFlags { IS_ENGINE = 0x01, IS_GROUP = 0x02 }
 
- Static Protected Attributes inherited from SoNode
static SbUniqueId nextUniqueId = 1
 
static int nextActionMethodIndex = 0
 

Detailed Description

The SoTransformManip class is used to manipulate transformations.

A manipulator is used by replacing the node you want to edit in the graph with the manipulator. Draggers are used to manipulate the node. When manipulation is finished, the node is put back into the graph, replacing the manipulator.

The SoTransformManip class is an abstract class which should not be used directly – use one of its subclasses.

Constructor & Destructor Documentation

◆ SoTransformManip()

SoTransformManip::SoTransformManip ( void  )

The constructor.

◆ ~SoTransformManip()

SoTransformManip::~SoTransformManip ( void  )
protectedvirtual

The destructor.

Member Function Documentation

◆ getTypeId()

SoType SoTransformManip::getTypeId ( void  ) const
virtual

Returns the type identification of an object derived from a class inheriting SoBase. This is used for runtime 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 predefined 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 top level superclasses for the various class groups.

Reimplemented from SoTransform.

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

◆ getFieldData()

const SoFieldData * SoTransformManip::getFieldData ( void  ) const
protectedvirtual

Returns a pointer to the class-wide field data storage object for this instance. If no fields are present, returns NULL.

Reimplemented from SoTransform.

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

◆ getDragger()

SoDragger * SoTransformManip::getDragger ( void  )

Returns the dragger used by this manipulator.

◆ replaceNode()

SbBool SoTransformManip::replaceNode ( SoPath path)

Replaces a node at the tail of path with this manipulator. The node must be an instance of a node class derived from SoTransform.

The manipulator will when inserted automatically copy the field data from the node, to make it initially affect the state in the same way as the node.

Returns TRUE if successful, and FALSE if the given node could not be replaced with the manipulator. The operation will for instance fail if the tail node of the given path is not of SoTransform type, or for any other condition where it is not possible to replace the node with this manipulator.

◆ replaceManip()

SbBool SoTransformManip::replaceManip ( SoPath path,
SoTransform newone 
) const

Replaces this manipulator from the position specified by path with newnode. If newnode is NULL, an SoTransform will be created for you.

◆ doAction()

void SoTransformManip::doAction ( SoAction action)
virtual

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

Reimplemented from SoTransform.

◆ callback()

void SoTransformManip::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 SoTransform.

◆ GLRender()

void SoTransformManip::GLRender ( SoGLRenderAction action)
virtual

Action method for the SoGLRenderAction.

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

Reimplemented from SoTransform.

◆ getBoundingBox()

void SoTransformManip::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 calculate their bounding box also override this method to change the relevant state variables.

Reimplemented from SoTransform.

◆ getMatrix()

void SoTransformManip::getMatrix ( SoGetMatrixAction action)
virtual

Action method for SoGetMatrixAction.

Updates action by accumulating with the transformation matrix of this node (if any).

Reimplemented from SoTransform.

◆ handleEvent()

void SoTransformManip::handleEvent ( SoHandleEventAction action)
virtual

Action method for SoHandleEventAction.

Inspects the event data from action, and processes it if it is something which this node should react to.

Nodes influencing relevant state variables for how event handling is done also override this method.

Reimplemented from SoNode.

◆ pick()

void SoTransformManip::pick ( SoPickAction action)
virtual

Action method for SoPickAction.

Does common processing for SoPickAction action instances.

Reimplemented from SoTransform.

◆ search()

void SoTransformManip::search ( SoSearchAction action)
virtual

Action method for SoSearchAction.

Compares the search criteria from the action to see if this node is a match. Searching is done by matching up all criteria set up in the SoSearchAction – if any of the requested criteria is a miss, the search is not deemed successful for the node.

See also
SoSearchAction

Reimplemented from SoNode.

◆ getChildren()

SoChildList * SoTransformManip::getChildren ( void  ) const
virtual

Returns the children of this node. This node only has the dragger as a child.

Reimplemented from SoNode.

◆ setDragger()

void SoTransformManip::setDragger ( SoDragger newdragger)
protected

Sets up the dragger instance to be controlled by this manipulator.

◆ copyContents()

void SoTransformManip::copyContents ( const SoFieldContainer from,
SbBool  copyconnections 
)
protectedvirtual

Makes a deep copy of all data of from into this instance, except external scene graph references if copyconnections is FALSE.

This is the method that should be overridden by extension node / engine / dragger / whatever subclasses which need to account for internal data that are not handled automatically.

For copying nodes from application code, you should not invoke this function directly, but rather call the SoNode::copy() function:

SoNode * mynewnode = templatenode->copy();

The same also goes for engines.

Make sure that when you override the copyContents() method in your extension class that you also make it call upwards to its parent superclass in the inheritance hierarchy, as copyContents() in for instance SoNode and SoFieldContainer does important work. It should go something like this:

void
MyCoinExtensionNode::copyContents(const SoFieldContainer * from,
SbBool copyconnections)
{
// let parent superclasses do their thing (copy fields, copy
// instance name, etc.)
SoNode::copyContents(from, copyconnections);
// [..then copy internal data..]
}

Reimplemented from SoNode.

◆ transferFieldValues()

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

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

Copies field values from one node to the other.

◆ valueChangedCB()

void SoTransformManip::valueChangedCB ( void *  m,
SoDragger dragger 
)
staticprotected

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

Callback to update field values when motion matrix changes.

◆ fieldSensorCB()

void SoTransformManip::fieldSensorCB ( void *  m,
SoSensor d 
)
staticprotected

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

Callback to update motion matrix when a field is modified.

◆ attachSensors()

void SoTransformManip::attachSensors ( const SbBool  onoff)
protected

Can be used by subclasses to attach/detach field sensors.

Member Data Documentation

◆ rotateFieldSensor

SoFieldSensor * SoTransformManip::rotateFieldSensor
protected

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

◆ translFieldSensor

SoFieldSensor * SoTransformManip::translFieldSensor
protected

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

◆ scaleFieldSensor

SoFieldSensor * SoTransformManip::scaleFieldSensor
protected

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

◆ centerFieldSensor

SoFieldSensor * SoTransformManip::centerFieldSensor
protected

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

◆ scaleOrientFieldSensor

SoFieldSensor * SoTransformManip::scaleOrientFieldSensor
protected

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

◆ children

SoChildList * SoTransformManip::children
protected

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


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