SoTransformManip(3IV)NAMESoTransformManip (SoXfManip) - base class for all transform Nodes with
built-in 3D user interfaces
INHERITS FROM
SoBase > SoFieldContainer > SoNode > SoTransformation > SoTransform >
SoTransformManipSYNOPSIS
#include <Inventor_c/manips/SoTransformManip.h>
typedef SoTransformManip SoXfManip
Fields from class SoTransform:
SoSFVec3f translation
SoSFRotation rotation
SoSFVec3f scaleFactor
SoSFRotation scaleOrientation
SoSFVec3f center
Functions from class SoTransformManip:
SoTransformManip * SoXfManipCreate()
SoDragger * SoXfManipGetDrag(SoXfManip *this)
SbBool SoXfManipReplaceNode(SoXfManip *this, SoPath *p )
SbBool SoXfManipReplaceManip(const SoXfManip *this, SoPath
*p, SoTransform *newOne )
SoType SoXfManipGetClassTypeId()
Functions from class SoTransform:
void SoXfManipPtAt(SoXfManip *this, const SbVec3f
*fromPoint, const SbVec3f *toPoint)
void SoXfManipGetScaleSpaceMx(const SoXfManip *this,
SbMatrix *mat, SbMatrix *inv)
void SoXfManipGetRotSpaceMx(const SoXfManip *this,
SbMatrix *mat, SbMatrix *inv)
void SoXfManipGetXlateSpaceMx(const SoXfManip *this,
SbMatrix *mat, SbMatrix *inv)
void SoXfManipMultLeft(SoXfManip *this, const SbMatrix
*mat)
void SoXfManipMultRight(SoXfManip *this, const SbMatrix
*mat)
void SoXfManipCombineLeft(SoXfManip *this,
SoTransformation *nodeOnRight)
void SoXfManipCombineRight(SoXfManip *this,
SoTransformation *nodeOnLeft)
void SoXfManipSetMx(SoXfManip *this, const SbMatrix *mat)
void SoXfManipRecenter(SoXfManip *this, const SbVec3f
*newCenter)
Page 1SoTransformManip(3IV)
Functions from class SoNode:
void SoXfManipSetOverride(SoXfManip *this, SbBool state)
SbBool SoXfManipIsOverride(const SoXfManip *this)
SoNode * SoXfManipCopy(const SoXfManip *this, SbBool
copyConnections = FALSE)
SbBool SoXfManipAffectsState(const SoXfManip *this)
SoNode * SoXfManipGetByName(const char *name)
int SoXfManipGetByNameList(const char *name, SoNodeList
*list)
Functions from class SoFieldContainer:
void SoXfManipSetToDflts(SoXfManip *this)
SbBool SoXfManipHasDfltVals(const SoXfManip *this)
SbBool SoXfManipFldsAreEq(const SoXfManip *this, const
SoFieldContainer *fc)
void SoXfManipCopyFieldVals(SoXfManip *this, const
SoFieldContainer *fc, SbBool copyConnections =
FALSE)
SbBool SoXfManipSet(SoXfManip *this, const char
*fieldDataString)
void SoXfManipGet(SoXfManip *this, SbString
*fieldDataString)
int SoXfManipGetFields(const SoXfManip *this, SoFieldList
*resultList)
SoField * SoXfManipGetField(const SoXfManip *this, const char
*fieldName)
SbBool SoXfManipGetFieldName(const SoXfManip *this, const
SoField *field, SbName *fieldName)
SbBool SoXfManipIsNotifyEnabled(const SoXfManip *this)
SbBool SoXfManipEnableNotify(SoXfManip *this, SbBool flag)
Functions from class SoBase:
void SoXfManipRef(SoXfManip *this)
void SoXfManipUnref(const SoXfManip *this)
void SoXfManipUnrefNoDelete(const SoXfManip *this)
void SoXfManipTouch(SoXfManip *this)
SoType SoXfManipGetTypeId(const SoXfManip *this)
SbBool SoXfManipIsOfType(const SoXfManip *this, SoType type)
void SoXfManipSetName(SoXfManip *this, const char *name)
SbName SoXfManipGetName(const SoXfManip *this)
DESCRIPTIONSoTransformManip 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
Page 2SoTransformManip(3IV)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 SoXfManipReplaceNode() function to insert a
manipulator into a scene graph, and the SoXfManipReplaceManip() function
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 help 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 SoXfManipGetDragger() 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.
Page 3SoTransformManip(3IV)FUNCTIONSSoTransformManip * SoXfManipCreate()
Constructor.
SoDragger * SoXfManipGetDrag(SoXfManip *this)
Returns a pointer to the dragger being used by this manipulator.
Given this pointer, you can customize the dragger just like you
would any other dragger. You can change geometry using the
SoDragSetPart() method, or add callbacks using the methods found in
the SoDragger reference page.
SbBool SoXfManipReplaceNode(SoXfManip *this, SoPath *p )
Replaces the tail of the path with this manipulator. The tail of the
path must be an SoTransform node (or subclass thereof). If the path
has a nodekit, this will try to use SoBaseKitSetPart() 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 SoXfRef() 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.
SbBool SoXfManipReplaceManip(const SoXfManip *this, SoPath
*p, SoTransform *newOne )
Replaces the tail of the path, which must be this manipulator, with
the given SoTransform node. If the path has a nodekit, this will try
to use SoBaseKitSetPart() 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 SoXfRef() or SoXfUnref() 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.
SoType SoXfManipGetClassTypeId()
Returns type identifier for this class.
ACTION BEHAVIOR
SoGLRenderAction, SoCallbackAction, SoGetBoundingBoxAction,
SoGetMatrixAction, SoHandleEventAction, SoRayPickAction
Page 4SoTransformManip(3IV)
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 SoXfManipGetDragger() method and then
write it out separately.
FILE FORMAT/DEFAULTS
TransformManip {
translation 0 0 0
rotation 0 0 1 0
scaleFactor 1 1 1
scaleOrientation 0 0 1 0
center 0 0 0
}
SEE ALSO
SoDragger, SoTransform, SoCenterballManip, SoHandleBoxManip, SoJackManip,
SoSurroundScale, SoTabBoxManip, SoTrackballManip, SoTransformBoxManip,
SoTransformerManip
Page 5
