SoTransformBoxDragger Class |
Box-like object you scale, rotate, and translate by dragging with the mouse.
Namespace: OIV.Inventor.Draggers
The SoTransformBoxDragger type exposes the following members.
Name | Description | |
---|---|---|
SoTransformBoxDragger | Constructor. |
Name | Description | |
---|---|---|
AffectsState | Returns true if a node has an effect on the state during traversal. | |
Callback | (Inherited from SoBaseKit.) | |
ClearOtherEventCallbacks | (Inherited from SoDragger.) | |
Copy | Calls Copy(false). (Inherited from SoNode.) | |
Copy(Boolean) | Creates and returns an exact copy of the node. | |
CopyFieldValues(SoFieldContainer) | Calls CopyFieldValues(fc, false). (Inherited from SoFieldContainer.) | |
CopyFieldValues(SoFieldContainer, Boolean) | Copies the contents of fc's fields into this object's fields. | |
CreatePathToPart(String, Boolean) | Calls CreatePathToPart(partName, makeIfNeeded, (OIV.Inventor.SoPath ^)nullptr). (Inherited from SoBaseKit.) | |
CreatePathToPart(String, Boolean, SoPath) | Returns a path that begins at this nodekit and ends at partName. | |
CreatePathToThis | (Inherited from SoDragger.) | |
Dispose |
Releases all resources used by SoDisposable.
(Inherited from SoDisposable.) | |
Distribute | (Inherited from SoNode.) | |
DoAction | (Inherited from SoBaseKit.) | |
EnableNotify | Notification at this Field Container is enabled (if flag == true) or disabled (if flag == false). | |
EnableValueChangedEvent | You can temporarily disable a dragger's valueChangedCallbacks. | |
Equals | Determines whether the specified Object is equal to the current Object. (Inherited from Object.) | |
FieldsAreEqual | Returns true if this object's fields are exactly equal to fc's fields. | |
Get | Returns the values of the fields of this object in the Open Inventor ASCII file format in the given string. | |
GetAllFields | Returns a list of fields, including the eventIn's and eventOut's. | |
GetAlternateRep | This method is called by actions to allow the node to provide an "alternate representation" when appropriate (typically depending on the action type). | |
GetBoundingBox | (Inherited from SoBaseKit.) | |
GetClassNodekitCatalog | Returns the OIV.Inventor.Nodekits.SoNodekitCatalog for this class. | |
GetEvent | (Inherited from SoDragger.) | |
GetEventIn | Returns a the eventIn with the given name. | |
GetEventOut | Returns the eventOut with the given name. | |
GetField | Returns a the field of this object whose name is fieldName. | |
GetFieldName | Returns the name of the given field in the fieldName argument. | |
GetFields | Appends references to all of this object's fields to resultList, and returns the number of fields appended. | |
GetHandleEventAction | (Inherited from SoDragger.) | |
GetHashCode |
Overrides GetHashCode().
(Inherited from SoNetBase.) | |
GetLocalStartingPoint | (Inherited from SoDragger.) | |
GetLocalToWorldMatrix | Calls GetLocalToWorldMatrix((OIV.Inventor.Actions.SoAction ^)nullptr). (Inherited from SoDragger.) | |
GetLocalToWorldMatrix(SoAction) | (Inherited from SoDragger.) | |
GetMatrix | (Inherited from SoBaseKit.) | |
GetMinGesture | Gets the number of pixels of movement required to initiate a constraint gesture. | |
GetMinGestureFloat | Float version of OIV.Inventor.Draggers.SoDragger.GetMinGesture(). | |
GetMotionMatrix | Get the motion matrix. | |
GetName | Returns the name of an instance. | |
GetNodekitCatalog | Returns the OIV.Inventor.Nodekits.SoNodekitCatalog for this instance of OIV.Inventor.Nodekits.SoBaseKit. | |
GetPart | Searches the nodekit catalog (and those of all nested nodekits) for the part named partName. | |
GetPartString | Given a node or a path to a node, checks if the part exists in the nodekit, in a nested nodekit, or an element of a list part. | |
GetPartToLocalMatrix | (Inherited from SoDragger.) | |
GetPickPath | (Inherited from SoDragger.) | |
GetPrimitiveCount | (Inherited from SoBaseKit.) | |
GetRenderEngineMode | Returns the supported Render engine mode. | |
GetRenderUnitID | (Inherited from SoNode.) | |
GetStartMotionMatrix | (Inherited from SoDragger.) | |
GetStringName | (Inherited from SoBase.) | |
GetSurrogatePartPickedName | (Inherited from SoDragger.) | |
GetSurrogatePartPickedOwner | (Inherited from SoDragger.) | |
GetSurrogatePartPickedPath | (Inherited from SoDragger.) | |
GetTrackerDirectMode | Get the current tracker direct mode for this dragger. | |
GetType | Gets the Type of the current instance. (Inherited from Object.) | |
GetViewportIsEnabled | (Inherited from SoBaseKit.) | |
GetViewportOrigin | (Inherited from SoBaseKit.) | |
GetViewportRegion | Obsolete. (Inherited from SoDragger.) | |
GetViewportSize | (Inherited from SoBaseKit.) | |
GetViewVolume | Obsolete. Dragger must not store information related to viewer settings. | |
GetWorldStartingPoint | (Inherited from SoDragger.) | |
GetWorldToLocalMatrix | Calls GetWorldToLocalMatrix((OIV.Inventor.Actions.SoAction ^)nullptr). (Inherited from SoDragger.) | |
GetWorldToLocalMatrix(SoAction) | (Inherited from SoDragger.) | |
GLRender | (Inherited from SoBaseKit.) | |
GLRenderBelowPath | (Inherited from SoNode.) | |
GLRenderInPath | (Inherited from SoNode.) | |
GLRenderOffPath | (Inherited from SoNode.) | |
GrabEventsCleanup | (Inherited from SoNode.) | |
GrabEventsSetup | (Inherited from SoNode.) | |
HandleEvent | (Inherited from SoBaseKit.) | |
HasDefaultValues | Returns true if all of the object's fields have their default values. | |
InvokeValueChanged | (Inherited from SoDragger.) | |
IsBoundingBoxIgnoring | Returns true if bounding box computation should be ignored during OIV.Inventor.Actions.SoGetBoundingBoxAction traversal. | |
IsNotifyEnabled | Notification is the process of telling interested objects that this object has changed. | |
IsOverride | Returns the state of the override flag. | |
IsPathSurrogateInMySubgraph(SoPath) | (Inherited from SoInteractionKit.) | |
IsPathSurrogateInMySubgraph(SoPath, SoPath, String, SoPath) | Calls IsPathSurrogateInMySubgraph(pathToCheck, pathToOwner, surrogateNameInOwner, surrogatePathInOwner, true). (Inherited from SoInteractionKit.) | |
IsPathSurrogateInMySubgraph(SoPath, SoPath, String, SoPath, Boolean) | (Inherited from SoInteractionKit.) | |
IsSynchronizable | Gets the ScaleViz synchronizable state of this object. | |
IsTrackerDirectMode | (Inherited from SoDragger.) | |
Pick | (Inherited from SoNode.) | |
RayPick | (Inherited from SoBaseKit.) | |
RegisterChildDragger | (Inherited from SoDragger.) | |
RegisterChildDraggerMovingIndependently | (Inherited from SoDragger.) | |
SaveStartParameters | (Inherited from SoDragger.) | |
Search | (Inherited from SoBaseKit.) | |
Set(String) | This function allows field values of parts (nodes) to be set in several different parts simultaneously. | |
Set(String, String) | This function allows field values of parts (nodes) to be set. | |
SetHandleEventAction | (Inherited from SoDragger.) | |
SetMinGesture(Int32) | Sets the number of pixels of movement required to initiate a constraint gesture. | |
SetMinGesture(Single) | Float version of OIV.Inventor.Draggers.SoDragger.SetMinGesture(System.Int32). | |
SetMotionMatrix | Set the motion matrix. | |
SetName | (Inherited from SoBase.) | |
SetOverride | Turns the override flag on or off. | |
SetPart | Inserts the given node (not a copy) as the new part specified by partName. | |
SetPartAsDefault(String, SoNode) | Calls SetPartAsDefault(partName, newNode, true). (Inherited from SoInteractionKit.) | |
SetPartAsDefault(String, String) | Calls SetPartAsDefault(partName, newNodeName, true). (Inherited from SoInteractionKit.) | |
SetPartAsDefault(String, SoNode, Boolean) | (Inherited from SoInteractionKit.) | |
SetPartAsDefault(String, String, Boolean) | (Inherited from SoInteractionKit.) | |
SetPartAsPath | Sets any public part in the interaction kit as a "surrogate" path instead. | |
SetStartingPoint(SbVec3f) | (Inherited from SoDragger.) | |
SetStartingPoint(SoPickedPoint) | (Inherited from SoDragger.) | |
SetSynchronizable | Sets this to be a ScaleViz synchronizable object. | |
SetTempPathToThis | (Inherited from SoDragger.) | |
SetToDefaults | Sets all fields in this object to their default values. | |
SetTrackerDirectMode | Calls SetTrackerDirectMode(OIV.Inventor.Draggers.SoDragger.TrackerDirectModes( .SoDragger.DEFAULT )). (Inherited from SoDragger.) | |
SetTrackerDirectMode(SoDraggerTrackerDirectModes) | Sets the tracker direct mode for this dragger (see description above). | |
SetViewportRegion | Obsolete. (Inherited from SoDragger.) | |
SetViewVolume | Obsolete. (Inherited from SoDragger.) | |
ToString |
Converts this SoBase structure to a human readable string.
(Inherited from SoBase.) | |
Touch | Marks an instance as modified, simulating a change to it. | |
TransformMatrixLocalToWorld | (Inherited from SoDragger.) | |
TransformMatrixToLocalSpace | (Inherited from SoDragger.) | |
TransformMatrixWorldToLocal | (Inherited from SoDragger.) | |
UnregisterChildDragger | (Inherited from SoDragger.) | |
UnregisterChildDraggerMovingIndependently | (Inherited from SoDragger.) | |
WorkFieldsIntoTransform | (Inherited from SoDragger.) | |
Write | (Inherited from SoBaseKit.) |
Name | Description | |
---|---|---|
boundingBoxCaching | (Inherited from SoInteractionKit.) | |
boundingBoxIgnoring | Whether to ignore this node during bounding box traversal. | |
enableCallbacks | If set to false, motion, start and finish callbacks are disabled. | |
isActive | true when mouse is down and dragging, else false. | |
IsDisposable | ISafeDisposable interface implementation.
(Inherited from SoDisposable.) | |
pickCulling | Set pick caching mode. | |
renderCaching | Obsolete. Set render caching mode. | |
renderCulling | Set render culling mode. | |
rotation | Orientation of the dragger. | |
scaleFactor | Scale of the dragger. | |
translation | Position of the dragger. | |
UserData |
Gets or sets the user data to be contained by the field container.
(Inherited from SoFieldContainer.) |
Name | Description | |
---|---|---|
FinishDragging | (Inherited from SoDragger.) | |
MouseMove | (Inherited from SoDragger.) | |
StartDragging | (Inherited from SoDragger.) | |
ValueChanged | (Inherited from SoDragger.) |
OIV.Inventor.Draggers.SoTransformBoxDragger is a composite dragger shaped like a box with small cubes at the corners. Click and drag any of these cubes to scale the box uniformly. Drag any edge of the box to rotate the whole dragger about its center, along an axis parallel to that edge. Pick any face of the box for 2D translation in the plane of that face.
Although the box looks just about like a wireframe cube, it is composed of many different simple draggers arranged in a composite assembly. When one part is dragged, the transformBox makes sure they all move together. Each of the parts of the box is a different dragger with the default geometry changed. The faces of the box are SoTranslate2Draggers, the edges are SoRotateCylindricalDraggers, and the cubes are an OIV.Inventor.Draggers.SoScaleUniformDragger. Drag them and the dragger will update its OIV.Inventor.Draggers.SoTransformBoxDragger.translation, OIV.Inventor.Draggers.SoTransformBoxDragger.rotation and OIV.Inventor.Draggers.SoTransformBoxDragger.scaleFactor fields to reflect the changes. As with all draggers, if you change the fields the dragger will move to match the new settings.
Remember: This is not an OIV.Inventor.Nodes.SoTransform ! . If you want to move other objects with this dragger, you can either:
Use an OIV.Inventor.Manips.SoTransformBoxManip, which is subclassed from OIV.Inventor.Nodes.SoTransform. It creates one of these draggers and uses it as the interface to change its fields. (see the OIV.Inventor.Manips.SoTransformBoxManip reference page).
Use field-to-field connections to connect the fields of this dragger to those of any OIV.Inventor.Nodes.SoTransformation node.
You can change the parts in any instance of this dragger using OIV.Inventor.Nodekits.SoBaseKit.SetPart(System.String, OIV.Inventor.Nodes.SoNode). The default part geometries are defined as resources for this OIV.Inventor.Draggers.SoTransformBoxDragger class. They are detailed in the Dragger Resources section of the online reference page for this class. You can make your program use different default resources for the parts by copying the file $OIVHOME/data/draggerDefaults/transformBoxDragger.iv into your own directory, editing the file, and then setting the environment variable SO_DRAGGER_DIR to be a path to that directory.
This dragger has both a default and a WYSIWYG version:
Default Dragger | WYSIWYG Dragger |
TransformBoxDragger {
boundingBoxCaching | AUTO |
renderCulling | AUTO |
pickCulling | AUTO |
isActive | false |
rotation | 0 0 1 0 |
translation | 0 0 0 |
scaleFactor | 1 1 1 |
callbackList | NULL |
surroundScale | NULL |
antiSquish | AntiSquish { |
sizing BIGGEST_DIMENSION | |
} | |
scaler | ScaleUniformDragger { |
rotator1 | RotateCylindricalDragger { |
rotator2 | RotateCylindricalDragger { |
rotator3 | RotateCylindricalDragger { |
translator1 | Translate2Dragger { |
} | |
translator2 | Translate2Dragger { |
} | |
translator3 | Translate2Dragger { |
} | |
translator4 | Translate2Dragger { |
} | |
translator5 | Translate2Dragger { |
} | |
translator6 | Translate2Dragger { |
} | |
scaler.scaler | <transformBoxScalerScaler resource> |
scaler.scalerActive | <transformBoxScalerScalerActive resource> |
scaler.feedback | <transformBoxScalerFeedback resource> |
scaler.feedbackActive | <transformBoxScalerFeedbackActive resource> |
rotator1.rotator | <transformBoxRotatorRotator resource> |
rotator2.rotator | <transformBoxRotatorRotator resource> |
rotator3.rotator | <transformBoxRotatorRotator resource> |
rotator1.rotatorActive | <transformBoxRotatorRotatorActive resource> |
rotator2.rotatorActive | <transformBoxRotatorRotatorActive resource> |
rotator3.rotatorActive | <transformBoxRotatorRotatorActive resource> |
rotator1.feedback | <transformBoxRotatorFeedback resource> |
rotator2.feedback | <transformBoxRotatorFeedback resource> |
rotator3.feedback | <transformBoxRotatorFeedback resource> |
rotator1.feedbackActive | <transformBoxRotatorFeedbackActive resource> |
rotator2.feedbackActive | <transformBoxRotatorFeedbackActive resource> |
rotator3.feedbackActive | <transformBoxRotatorFeedbackActive resource> |
translator1.translator | <transformBoxTranslatorTranslator resource> |
translator2.translator | <transformBoxTranslatorTranslator resource> |
translator3.translator | <transformBoxTranslatorTranslator resource> |
translator4.translator | <transformBoxTranslatorTranslator resource> |
translator5.translator | <transformBoxTranslatorTranslator resource> |
translator6.translator | <transformBoxTranslatorTranslator resource> |
translator1.translatorActive | <transformBoxTranslatorTranslatorActive resource> |
translator2.translatorActive | <transformBoxTranslatorTranslatorActive resource> |
translator3.translatorActive | <transformBoxTranslatorTranslatorActive resource> |
translator4.translatorActive | <transformBoxTranslatorTranslatorActive resource> |
translator5.translatorActive | <transformBoxTranslatorTranslatorActive resource> |
translator6.translatorActive | <transformBoxTranslatorTranslatorActive resource> |
translator1.xAxisFeedback | <transformBoxTranslatorXAxisFeedback resource> |
translator2.xAxisFeedback | <transformBoxTranslatorXAxisFeedback resource> |
translator3.xAxisFeedback | <transformBoxTranslatorXAxisFeedback resource> |
translator4.xAxisFeedback | <transformBoxTranslatorXAxisFeedback resource> |
translator5.xAxisFeedback | <transformBoxTranslatorXAxisFeedback resource> |
translator6.xAxisFeedback | <transformBoxTranslatorXAxisFeedback resource> |
translator1.yAxisFeedback | <transformBoxTranslatorYAxisFeedback resource> |
translator2.yAxisFeedback | <transformBoxTranslatorYAxisFeedback resource> |
translator3.yAxisFeedback | <transformBoxTranslatorYAxisFeedback resource> |
translator4.yAxisFeedback | <transformBoxTranslatorYAxisFeedback resource> |
translator5.yAxisFeedback | <transformBoxTranslatorYAxisFeedback resource> |
translator6.yAxisFeedback | <transformBoxTranslatorYAxisFeedback resource> |
Resource: | transformBoxScalerScaler | |
Part: | scaler.scaler | |
Appearance: | Eight small white cubes at the corners of the box | |
Description: | Picking this initiates uniform 3D scaling of the dragger. | |
Resource: | transformBoxScalerScalerActive | |
Part: | scaler.scalerActive | |
Appearance: | Yellow version of the regular scaler part | |
Description: | Displayed while the dragger is being scaled. | |
Resource: | transformBoxScalerFeedback | |
Part: | scaler.feedback | |
Appearance: | Empty separator | |
Description: | Removes any feedback geometry created in the constructor of the OIV.Inventor.Draggers.SoScaleUniformDragger. | |
Resource: | transformBoxScalerFeedbackActive | |
Part: | scaler.feedbackActive | |
Appearance: | Empty separator | |
Description: | Removes any feedbackActive geometry created in the constructor of the OIV.Inventor.Draggers.SoScaleUniformDragger. | |
Resource: | transformBoxRotatorRotator | |
Parts: | rotator1.rotator<BR> rotator2.rotator<BR> rotator3.rotator | |
Appearance: | Four white lines along the edges of the box | |
Description: | Picking this begins rotational dragging. In each of the three rotateCylindrical draggers, the lines of the rotator part are oriented parallel to the axis of rotation. | |
Resource: | transformBoxRotatorRotatorActive | |
Parts: | rotator1.rotatorActive<BR> rotator2.rotatorActive<BR> rotator3.rotatorActive | |
Appearance: | Four yellow lines along the edges of the box | |
Description: | Displayed while the dragger is being rotated | |
Resource: | transformBoxRotatorFeedback | |
Parts: | rotator1.feedback<BR> rotator2.feedback<BR> rotator3.feedback | |
Appearance: | Empty separator | |
Description: | Removes any feedback geometry created in the constructor of the OIV.Inventor.Draggers.SoRotateCylindricalDragger. | |
Resource: | transformBoxRotatorFeedbackActive | |
Parts: | rotator1.feedbackActive<BR> rotator2.feedbackActive<BR> rotator3.feedbackActive | |
Appearance: | Thin purple line through center of box | |
Description: | Displayed to show axis of rotation during rotational dragging. | |
Resource: | transformBoxTranslatorTranslator | |
Parts: | translator1.translator<BR> translator2.translator<BR> translator3.translator<BR> translator4.translator<BR> translator5.translator<BR> translator6.translator | |
Appearance: | Invisible but pickable square surface | |
Description: | Picking these begins 2-D translational dragging within the plane of one of the sides of the box. The invisible squares of the six translate2Draggers are arranged to form the sides of the box.The squares are easy to discern, although rendered as invisible; they are bounded by the lines of the rotational dragger parts. | |
Resource: | transformBoxTranslatorTranslatorActive | |
Parts: | translator1.translatorActive<BR> translator2.translatorActive<BR> translator3.translatorActive<BR> translator4.translatorActive<BR> translator5.translatorActive<BR> translator6.translatorActive | |
Appearance: | Invisible square surface | |
Description: | Shown during 2-D translational dragging. | |
Resource: | transformBoxTranslatorXAxisFeedback | |
Parts: | translator1.xAxisFeedback<BR> translator2.xAxisFeedback<BR> translator3.xAxisFeedback<BR> translator4.xAxisFeedback<BR> translator5.xAxisFeedback<BR> translator6.xAxisFeedback | |
Appearance: | Short thin purple line | |
Description: | Only shown if dragger is moving and the axis is a permissable direction of motion. When pressing <shift>, motion is constrained, and this is displayed only if the primary motion is in the X direction. | |
Resource: | transformBoxTranslatorYAxisFeedback | |
Parts: | translator1.yAxisFeedback<BR> translator2.yAxisFeedback<BR> translator3.yAxisFeedback<BR> translator4.yAxisFeedback<BR> translator5.yAxisFeedback<BR> translator6.yAxisFeedback | |
Appearance: | Short thin purple line | |
Description: | Only shown if dragger is moving and the axis is a permissable direction of motion. When pressing <shift>, motion is constrained, and this is displayed only if the primary motion is in the Y direction. |
All Parts
Part Name | Part Type | Default Type | NULL Default |
callbackList | NodeKitListPart | yes | |
surroundScale | SurroundScale | yes | |
antiSquish | AntiSquish | no | |
scaler | ScaleUniformDragger | yes | |
rotator1 | RotateCylindricalDragger | yes | |
rotator2 | RotateCylindricalDragger | yes | |
rotator3 | RotateCylindricalDragger | yes | |
translator1 | Translate2Dragger | yes | |
translator2 | Translate2Dragger | yes | |
translator3 | Translate2Dragger | yes | |
translator4 | Translate2Dragger | yes | |
translator5 | Translate2Dragger | yes | |
translator6 | Translate2Dragger | yes |
Extra Information for List Parts from Above Table
Part Name | Container Type | Possible Types |
callbackList | Separator | Callback, EventCallback |