- All Implemented Interfaces:
- Direct Known Subclasses:
public class SoTransformManip extends SoTransformBase class for all transform nodes with built-in 3D user interfaces.
SoTransformManipis the base class for all
SoTransformnodes 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
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
SoTransformManiputilizes 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.
SoTransformManipsubclass 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 <B> help </B> 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
SoTransformManipfields the manipulator will move the dragger accordingly. You can use this feature to impose constraints 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.
SoTransformManipuses 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, an
SoTransformManipwill 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
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
SoPathwill end at the manipulator. (See the Actions section of this reference page for a complete description of when the dragger is traversed).
You can get this dragger 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.
translation 0 0 0 rotation 0 0 1 0 scaleFactor 1 1 1 scaleOrientation 0 0 1 0 center 0 0 0
First, traverses the dragger the way an
SoGroupwould. All draggers place themselves in space, but leave the current transformation unchanged when finished. Then the
SoTransformManipaccumulates a transformation into the current transformation just like its base class,
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.
Constructors Constructor Description
All Methods Instance Methods Concrete Methods Modifier and Type Method Description
getDragger()Returns the dragger being used by this manipulator.
replaceManip(SoPath p, SoTransform newOne)Replaces the tail of the path, which must be this manipulator, with the given
replaceNode(SoPath p)Replaces the tail of the path with this manipulator.
Methods inherited from class com.openinventor.inventor.nodes.SoTransform
combineLeft, combineRight, getRotationSpaceMatrix, getScaleSpaceMatrix, getTranslationSpaceMatrix, multLeft, multRight, pointAt, recenter, setMatrix
Methods inherited from class com.openinventor.inventor.nodes.SoNode
affectsState, callback, copy, copy, distribute, doAction, getAlternateRep, getBoundingBox, getByName, getMatrix, getPrimitiveCount, getRenderEngineMode, getRenderUnitID, GLRender, GLRenderBelowPath, GLRenderInPath, GLRenderOffPath, grabEventsCleanup, grabEventsSetup, handleEvent, isBoundingBoxIgnoring, isOverride, pick, rayPick, search, setOverride, touch, write
Methods inherited from class com.openinventor.inventor.fields.SoFieldContainer
copyFieldValues, copyFieldValues, enableNotify, fieldsAreEqual, get, getAllFields, getEventIn, getEventOut, getField, getFieldName, hasDefaultValues, isNotifyEnabled, set, setToDefaults
Methods inherited from class com.openinventor.inventor.misc.SoBase
dispose, getName, isDisposable, isSynchronizable, setName, setSynchronizable
public boolean replaceManip(SoPath p, SoTransform newOne)Replaces the tail of the path, which must be this manipulator, with the given
SoTransformnode. 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 make any changes to field connections. The calling process is thus responsible for keeping track of its own nodes and field connections.
public boolean replaceNode(SoPath p)Replaces the tail of the path with this manipulator. The tail of the path must be an
SoTransformnode (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 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.