![]() |
http://www.sim.no http://www.coin3d.org |
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>
Public Member Functions | |
virtual SoType | getTypeId (void) const |
SoTransformManip (void) | |
SoDragger * | getDragger (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 SoChildList * | getChildren (void) const |
Static Public Member Functions | |
static SoType | getClassTypeId (void) |
static void | initClass (void) |
Protected Member Functions | |
virtual const SoFieldData * | getFieldData (void) const |
~SoTransformManip () | |
void | setDragger (SoDragger *newdragger) |
virtual void | copyContents (const SoFieldContainer *fromfc, SbBool copyconnections) |
void | attachSensors (const SbBool onoff) |
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 | |
SoFieldSensor * | rotateFieldSensor |
SoFieldSensor * | translFieldSensor |
SoFieldSensor * | scaleFieldSensor |
SoFieldSensor * | centerFieldSensor |
SoFieldSensor * | scaleOrientFieldSensor |
SoChildList * | children |
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.
SoTransformManip::SoTransformManip | ( | void | ) |
The constructor.
References attachSensors(), centerFieldSensor, children, fieldSensorCB(), rotateFieldSensor, scaleFieldSensor, scaleOrientFieldSensor, SoDelayQueueSensor::setPriority(), and translFieldSensor.
SoTransformManip::~SoTransformManip | ( | ) | [protected] |
The destructor.
References centerFieldSensor, children, rotateFieldSensor, scaleFieldSensor, scaleOrientFieldSensor, setDragger(), and translFieldSensor.
SoType SoTransformManip::getClassTypeId | ( | void | ) | [static] |
This static method returns the SoType object associated with objects of this class.
Reimplemented from SoTransform.
Reimplemented in SoCenterballManip, SoHandleBoxManip, SoJackManip, SoTabBoxManip, SoTrackballManip, SoTransformBoxManip, and SoTransformerManip.
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 SoCenterballManip, SoHandleBoxManip, SoJackManip, SoTabBoxManip, SoTrackballManip, SoTransformBoxManip, and SoTransformerManip.
Referenced by doAction().
const SoFieldData ** SoTransformManip::getFieldDataPtr | ( | void | ) | [static, protected] |
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 SoCenterballManip, SoHandleBoxManip, SoJackManip, SoTabBoxManip, SoTrackballManip, SoTransformBoxManip, and SoTransformerManip.
const SoFieldData * SoTransformManip::getFieldData | ( | void | ) | const [protected, virtual] |
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.
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 SoCenterballManip, SoHandleBoxManip, SoJackManip, SoTabBoxManip, SoTrackballManip, SoTransformBoxManip, and SoTransformerManip.
Referenced by SoInteraction::init().
SoDragger * SoTransformManip::getDragger | ( | void | ) |
Returns the dragger used by this manipulator.
References children, SoDragger::getClassTypeId(), SbPList::getLength(), SoBase::isOfType(), and SoDebugError::post().
Referenced by fieldSensorCB(), SoTransformerManip::isLocateHighlighting(), setDragger(), SoTransformerManip::setLocateHighlighting(), and SoTransformerManip::unsquishKnobs().
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(), SoBaseKit::getClassTypeId(), SoTransform::getClassTypeId(), SoFullPath::getLength(), SoType::getName(), SoFullPath::getNodeFromTail(), SoBaseKit::getPart(), SoBaseKit::getPartString(), SbName::getString(), SoPath::getTail(), SoFullPath::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.
Reimplemented from SoNode.
References doAction(), SoSearchAction::isFound(), and SoNode::search().
SoChildList * SoTransformManip::getChildren | ( | void | ) | const [virtual] |
void SoTransformManip::setDragger | ( | SoDragger * | newdragger | ) | [protected] |
Sets up the dragger instance to be controlled by this manipulator.
Reimplemented in SoCenterballManip.
References SoDragger::addValueChangedCallback(), SoChildList::append(), children, fieldSensorCB(), getDragger(), SbPList::getLength(), SoChildList::remove(), SoDragger::removeValueChangedCallback(), SoChildList::set(), and valueChangedCB().
Referenced by copyContents(), SoCenterballManip::setDragger(), SoHandleBoxManip::SoHandleBoxManip(), SoJackManip::SoJackManip(), SoTabBoxManip::SoTabBoxManip(), SoTrackballManip::SoTrackballManip(), SoTransformBoxManip::SoTransformBoxManip(), SoTransformerManip::SoTransformerManip(), and ~SoTransformManip().
void SoTransformManip::copyContents | ( | const SoFieldContainer * | from, | |
SbBool | copyconnections | |||
) | [protected, virtual] |
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:
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 MyCoinExtensionNode::copyContents(const SoFieldContainer * from, 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 | |||
) | [static, protected] |
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(), SoSFRotation::getValue(), SoSFVec3f::getValue(), SoBase::isOfType(), SoTransform::rotation, SoTransform::scaleFactor, SoTransform::scaleOrientation, and SoTransform::translation.
Referenced by replaceNode().
void SoTransformManip::valueChangedCB | ( | void * | m, | |
SoDragger * | dragger | |||
) | [static, protected] |
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(), SoSFRotation::getValue(), SbVec3f::getValue(), SoSFVec3f::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 | |||
) | [static, protected] |
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.
Reimplemented in SoCenterballManip.
References SoTransform::center, SoDragger::enableValueChangedCallbacks(), SoSFVec3f::getClassTypeId(), getDragger(), SoFieldContainer::getField(), SoSFRotation::getValue(), SoSFVec3f::getValue(), SoField::isOfType(), SoTransform::rotation, SoTransform::scaleFactor, SoTransform::scaleOrientation, SoDragger::setMotionMatrix(), SbMatrix::setTransform(), SoTransform::translation, and SoDragger::valueChanged().
Referenced by SoCenterballManip::fieldSensorCB(), replaceNode(), setDragger(), SoTransformManip(), and transferFieldValues().
void SoTransformManip::attachSensors | ( | const SbBool | onoff | ) | [protected] |
Can be used by subclasses to attach/detach field sensors.
References SoFieldSensor::attach(), SoTransform::center, centerFieldSensor, SoFieldSensor::detach(), rotateFieldSensor, SoTransform::rotation, SoTransform::scaleFactor, scaleFieldSensor, SoTransform::scaleOrientation, scaleOrientFieldSensor, SoTransform::translation, and translFieldSensor.
Referenced by replaceNode(), SoTransformManip(), transferFieldValues(), and valueChangedCB().
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().
Copyright © 1998-2007 by Systems in Motion AS. All rights reserved.
Generated on Mon Feb 23 16:34:04 2009 for Coin by Doxygen. 1.5.8