| SoJackDragger Class |
Jack-shaped object you rotate, translate, or scale by dragging with the mouse.
Inheritance HierarchyOIV.InventorSoNetBase
OIV.InventorSoDisposable
OIV.Inventor.MiscSoBase
OIV.Inventor.FieldsSoFieldContainer
OIV.Inventor.NodesSoNode
OIV.Inventor.NodekitsSoBaseKit
OIV.Inventor.NodekitsSoInteractionKit
OIV.Inventor.DraggersSoDragger
OIV.Inventor.DraggersSoJackDragger
Namespace: OIV.Inventor.Draggers
Assembly: OIV.Inventor (in OIV.Inventor.dll) Version: 2023.1.3.0 (2023.1.3)
SyntaxThe SoJackDragger type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | SoJackDragger | Constructor. |
Methods| 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.) |
Properties| 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.) |
Events| Name | Description | |
|---|---|---|
 | FinishDragging | (Inherited from SoDragger.) |
| MouseMove | (Inherited from SoDragger.) |
| StartDragging | (Inherited from SoDragger.) |
| ValueChanged | (Inherited from SoDragger.) |
RemarksOIV.Inventor.Draggers.SoJackDragger is a composite dragger in the shape of a jack from the children's game jacks. Three lines along the x, y, and z axes form the central star shape, which you can drag with the mouse to rotate the jack. Dragging any of the small cubes mounted at the end of the axes will scale the jack uniformly in all 3 dimensions. At the core of the jack is an OIV.Inventor.Draggers.SoDragPointDragger for translating the jack.
Each of these shapes is a different dragger with the default geometry changed. All of them are parts of the jack dragger, which keeps them moving together. The star is an OIV.Inventor.Draggers.SoRotateSphericalDragger, and dragging it updates the OIV.Inventor.Draggers.SoJackDragger.rotation field of the jack dragger. The small cubes are an OIV.Inventor.Draggers.SoScaleUniformDragger, tied to the OIV.Inventor.Draggers.SoJackDragger.scaleFactor field. The position of the OIV.Inventor.Draggers.SoDragPointDragger is given by the OIV.Inventor.Draggers.SoJackDragger.translation field. 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.SoJackManip, 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.SoJackManip 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.SoJackDragger 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/jackDragger.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 |
 |  |
FILE FORMAT/DEFAULT
JackDragger {
| 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 { } |
| rotator | RotateSphericalDragger { } |
| translator | DragPointDragger { } |
| rotator.rotator | <jackRotatorRotator resource> |
| rotator.rotatorActive | <jackRotatorRotatorActive resource> |
| rotator.feedback | <jackRotatorFeedback resource> |
| rotator.feedbackActive | <jackRotatorFeedbackActive resource> |
| scaler.scaler | <jackScalerScaler resource> |
| scaler.scalerActive | <jackScalerScalerActive resource> |
| scaler.feedback | <jackScalerFeedback resource> |
| scaler.feedbackActive | <jackScalerFeedbackActive resource> |
| translator.xTranslator.translator | <jackTranslatorLineTranslator resource> |
| translator.yTranslator.translator | <jackTranslatorLineTranslator resource> |
| translator.zTranslator.translator | <jackTranslatorLineTranslator resource> |
| translator.xTranslator.translatorActive | <jackTranslatorLineTranslatorActive resource> |
| translator.yTranslator.translatorActive | <jackTranslatorLineTranslatorActive resource> |
| translator.zTranslator.translatorActive | <jackTranslatorLineTranslatorActive resource> |
| translator.yzTranslator.translator | <jackTranslatorPlaneTranslator resource> |
| translator.xzTranslator.translator | <jackTranslatorPlaneTranslator resource> |
| translator.xyTranslator.translator | <jackTranslatorPlaneTranslator resource> |
| translator.yzTranslator.translatorActive | <jackTranslatorPlaneTranslatorActive resource> |
| translator.xzTranslator.translatorActive | <jackTranslatorPlaneTranslatorActive resource> |
| translator.xyTranslator.translatorActive | <jackTranslatorPlaneTranslatorActive resource> |
| xFeedback | <jackTranslatorXFeedback resource> |
| yFeedback | <jackTranslatorYFeedback resource> |
| zFeedback | <jackTranslatorZFeedback resource> |
| yzFeedback | <jackTranslatorYZFeedback resource> |
| xzFeedback | <jackTranslatorXZFeedback resource> |
| xyFeedback | <jackTranslatorXYFeedback resource> |
DRAGGER RESOURCES
| Resource: | jackRotatorRotator | |
| Part: | rotator.rotator | |
| Appearance: | The 'star' of the jack. Set of 3 white axes (lines) | |
| Description: | Picking star begins rotational dragging of the jackDragger. | |
| Resource: | jackRotatorRotatorActive | |
| Part: | rotator.rotatorActive | |
| Appearance: | Yellow version of the rotator.rotator part. | |
| Description: | Displayed while the jackDragger is being rotated | |
| Resource: | jackRotatorFeedback | |
| Part: | rotator.feedback | |
| Appearance: | Empty separator | |
| Description: | Removes any feedback geometry created in the constructor of the OIV.Inventor.Draggers.SoRotateSphericalDragger. | |
| Resource: | jackRotatorFeedbackActive | |
| Part: | rotator.feedbackActive | |
| Appearance: | Empty separator | |
| Description: | Removes any feedbackActive geometry created in the constructor of the OIV.Inventor.Draggers.SoRotateSphericalDragger. | |
| Resource: | jackScalerScaler | |
| Part: | scaler.scaler | |
| Appearance: | Six small white cubes, the tips of the rotator star | |
| Description: | Picking this initiates uniform 3D scaling of the dragger. | |
| Resource: | jackScalerScalerActive | |
| Part: | scaler.scalerActive | |
| Appearance: | Yellow version of the scaler.scaler resource. | |
| Description: | Displayed while the dragger is being scaled. | |
| Resource: | jackScalerFeedback | |
| Part: | scaler.feedback | |
| Appearance: | Empty separator | |
| Description: | Removes any feedback geometry created in the constructor of the OIV.Inventor.Draggers.SoScaleUniformDragger. | |
| Resource: | jackScalerFeedbackActive | |
| Part: | scaler.feedbackActive | |
| Appearance: | Empty separator | |
| Description: | Removes any feedbackActive geometry created in the constructor of the OIV.Inventor.Draggers.SoScaleUniformDragger. | |
| Resource: | jackTranslatorLineTranslator | |
| Parts: | translator.xTranslator.translator<BR> translator.yTranslator.translator<BR> translator.zTranslator.translator | |
| Appearance: | Skinny white cylinder aligned with axes of motion | |
| Description: | Picking these parts initiates dragging in the x, y, and z linear draggers respectively. | |
| Resource: | jackTranslatorLineTranslatorActive | |
| Parts: | translator.xTranslator.translatorActive<BR> translator.yTranslator.translatorActive<BR> translator.zTranslator.translatorActive | |
| Appearance: | Skinny yellow cylinder aligned with axes of motion | |
| Description: | Shown during linear dragging in the x, y, and z directions respectively. | |
| Resource: | jackTranslatorPlaneTranslator | |
| Parts: | translator.yzTranslator.translator<BR> translator.xzTranslator.translator<BR> translator.xyTranslator.translator | |
| Appearance: | White flattened cube, drawn in wireframe | |
| Description: | Picking these parts initiates dragging by the yz, xz, and xy planar draggers respectively. | |
| Resource: | jackTranslatorPlaneTranslatorActive | |
| Parts: | translator.yzTranslator.translatorActive<BR> translator.xzTranslator.translatorActive<BR> translator.xyTranslator.translatorActive | |
| Appearance: | Yellow flattened cube, drawn in wireframe | |
| Description: | Shown during planar dragging in the yz, xz, and xy planes respectively. | |
| Resource: | jackTranslatorXFeedback | |
| Part: | xFeedback | |
| Appearance: | Double-headed purple arrow | |
| Description: | Feedback for motion in x direction | |
| Resource: | jackTranslatorYFeedback | |
| Part: | yFeedback | |
| Appearance: | Double-headed purple arrow | |
| Description: | Feedback for motion in y direction | |
| Resource: | jackTranslatorZFeedback | |
| Part: | zFeedback | |
| Appearance: | Double-headed purple arrow | |
| Description: | Feedback for motion in z direction | |
| Resource: | jackTranslatorYZFeedback | |
| Part: | yzFeedback | |
| Appearance: | Semi-transparent green square in yz plane | |
| Description: | Feedback for motion in yz plane | |
| Resource: | jackTranslatorXZFeedback | |
| Part: | xzFeedback | |
| Appearance: | Semi-transparent green square in yz plane | |
| Description: | Feedback for motion in xz plane | |
| Resource: | jackTranslatorXYFeedback | |
| Part: | xyFeedback | |
| Appearance: | Semi-transparent green square in yz plane | |
| Description: | Feedback for motion in xy plane |
CATALOG PARTS
All Parts
| Part Name | Part Type | Default Type | NULL Default |
| callbackList | NodeKitListPart | yes | |
| surroundScale | SurroundScale | yes | |
| antiSquish | AntiSquish | no | |
| scaler | ScaleUniformDragger | yes | |
| rotator | RotateSphericalDragger | yes | |
| translator | DragPointDragger | yes |
Extra Information for List Parts from Above Table
| Part Name | Container Type | Possible Types |
| callbackList | Separator | Callback, EventCallback |
See Also