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

Public Member Functions | Static Public Member Functions | Protected Member Functions | Static Protected Member Functions | Protected Attributes
SoTransformManip Class Reference

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 to manipulate the node. When manipulation is finished, the node is put back into the graph, replacing the manipulator. More...

#include <Inventor/manips/SoTransformManip.h>

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

List of all members.

Public Member Functions

virtual SoType getTypeId (void) const
 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)

Static Public Member Functions

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

Protected Member Functions

virtual const SoFieldDatagetFieldData (void) const
 ~SoTransformManip ()
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)
 ~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

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)

Protected Attributes

SoFieldSensorrotateFieldSensor
SoFieldSensortranslFieldSensor
SoFieldSensorscaleFieldSensor
SoFieldSensorcenterFieldSensor
SoFieldSensorscaleOrientFieldSensor
SoChildListchildren

Additional Inherited Members

- Public Attributes inherited from SoTransform
SoSFVec3f translation
SoSFRotation rotation
SoSFVec3f scaleFactor
SoSFRotation scaleOrientation
SoSFVec3f center

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 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 it's subclasses.


Constructor & Destructor Documentation

SoTransformManip::SoTransformManip ( void  )
SoTransformManip::~SoTransformManip ( )
protected

Member Function Documentation

SoType SoTransformManip::getClassTypeId ( void  )
static

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

Reimplemented from SoTransform.

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

Referenced by copyContents(), doAction(), SoIntersectionDetectionAction::isTypeEnabled(), and transferFieldValues().

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

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

Referenced by doAction().

const SoFieldData ** SoTransformManip::getFieldDataPtr ( void  )
staticprotected

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

Reimplemented from SoTransform.

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

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 SoTransformerManip, SoCenterballManip, SoHandleBoxManip, SoJackManip, SoTabBoxManip, SoTrackballManip, and SoTransformBoxManip.

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

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

Referenced by SoInteraction::init().

SoDragger * SoTransformManip::getDragger ( void  )
SbBool SoTransformManip::replaceNode ( SoPath path)

Replaces a node at the tail end 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.

References attachSensors(), fieldSensorCB(), SoGroup::getClassTypeId(), SoTransform::getClassTypeId(), SoBaseKit::getClassTypeId(), SoFullPath::getLength(), SoType::getName(), SoFullPath::getNodeFromTail(), SoBaseKit::getPart(), SoBaseKit::getPartString(), SbName::getString(), SoFullPath::getTail(), SoPath::getTail(), SoBase::getTypeId(), SoBase::isOfType(), SoDebugError::post(), SoBase::ref(), SoBaseKit::setPart(), transferFieldValues(), and SoBase::unrefNoDelete().

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.

void SoTransformManip::doAction ( SoAction action)
virtual

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

Reimplemented from SoTransform.

References children, getClassTypeId(), SoAction::getPathCode(), getTypeId(), SoDebugError::postWarning(), SoChildList::traverse(), and SoChildList::traverseInPath().

Referenced by callback(), GLRender(), handleEvent(), pick(), and search().

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.

References doAction().

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 who wants to throw geometry primitives at OpenGL overrides this method.

Reimplemented from SoTransform.

References doAction().

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 calculates their bounding box also overrides this method to change the relevant state variables.

Reimplemented from SoTransform.

References children, SoGetBoundingBoxAction::getCenter(), SbPList::getLength(), SoAction::getPathCode(), SoGetBoundingBoxAction::isCenterSet(), SoGetBoundingBoxAction::resetCenter(), SoGetBoundingBoxAction::setCenter(), and SoChildList::traverse().

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.

References children, SoAction::getPathCode(), SoChildList::traverse(), and SoChildList::traverseInPath().

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 overrides this method.

Reimplemented from SoNode.

References doAction().

void SoTransformManip::pick ( SoPickAction action)
virtual

Action method for SoPickAction.

Does common processing for SoPickAction action instances.

Reimplemented from SoTransform.

References doAction().

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.

References doAction(), SoSearchAction::isFound(), and SoNode::search().

SoChildList * SoTransformManip::getChildren ( void  ) const
virtual

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

Reimplemented from SoNode.

References children.

void SoTransformManip::setDragger ( SoDragger newdragger)
protected
void SoTransformManip::copyContents ( const SoFieldContainer from,
SbBool  copyconnections 
)
protectedvirtual

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

This is the protected method that should be overridden by extension node / engine / dragger / whatever subclasses which needs 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 it's parent superclass in the inheritance hierarchy, as copyContents() in for instance SoNode and SoFieldContainer does important work. It should go something like this:

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

Reimplemented from SoNode.

References SoNode::copyContents(), getClassTypeId(), SoBase::isOfType(), and setDragger().

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.

References attachSensors(), SoTransform::center, fieldSensorCB(), getClassTypeId(), SoBase::isOfType(), SoTransform::rotation, SoTransform::scaleFactor, SoTransform::scaleOrientation, and SoTransform::translation.

Referenced by replaceNode().

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.

Reimplemented in SoCenterballManip.

References attachSensors(), SoTransform::center, SoSFVec3f::getClassTypeId(), SoFieldContainer::getField(), SoDragger::getMotionMatrix(), SbMatrix::getTransform(), SbVec3f::getValue(), SoField::isOfType(), SoTransform::rotation, SoTransform::scaleFactor, SoTransform::scaleOrientation, and SoTransform::translation.

Referenced by setDragger(), and SoCenterballManip::valueChangedCB().

void SoTransformManip::fieldSensorCB ( void *  m,
SoSensor d 
)
staticprotected
void SoTransformManip::attachSensors ( const SbBool  onoff)
protected

Member Data Documentation

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.

Referenced by attachSensors(), SoTransformManip(), and ~SoTransformManip().

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.

Referenced by attachSensors(), SoTransformManip(), and ~SoTransformManip().

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.

Referenced by attachSensors(), SoTransformManip(), and ~SoTransformManip().

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.

Referenced by attachSensors(), SoTransformManip(), and ~SoTransformManip().

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.

Referenced by attachSensors(), SoTransformManip(), and ~SoTransformManip().

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.

Referenced by doAction(), getBoundingBox(), getChildren(), getDragger(), getMatrix(), setDragger(), SoTransformManip(), and ~SoTransformManip().


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

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

Generated on Wed Jul 25 2012 for Coin by Doxygen. 1.8.1.1