| SoDragPointDragger Class |
Object you can translate in 3D 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.DraggersSoDragPointDragger
Namespace: OIV.Inventor.Draggers
Assembly: OIV.Inventor (in OIV.Inventor.dll) Version: 2023.1.3.0 (2023.1.3)
SyntaxThe SoDragPointDragger type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | SoDragPointDragger | 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.) |
| GetJumpLimit | Gets the point at which the feedback axes will jump to a new position. |
| 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.) |
| SetJumpLimit | Sets the point at which the feedback axes will jump to a new position. |
| 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.) |
| ShowDraggerSet | The dragPoint dragger contains three pairs of draggers, each containing a plane dragger and a line dragger (see the Description above). |
| ShowNextDraggerSet | The dragPoint dragger contains three pairs of draggers, each containing a plane dragger and a line dragger (see the Description above). |
| 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. |
| 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.SoDragPointDragger is a compound dragger that translates in all three dimensions when dragged with the mouse.
It is made up of six smaller draggers, which it displays two at a time. Each pair has one plane dragger and one line dragger. The line dragger is oriented perpendicular to the plane, so together the plane/line pair lets you move through all of 3-space.
DragPoint has a total of three such pairs, oriented along the x, y, and z axes of its local space. You can cycle through the three pairs by hitting the <Control> key with the cursor over the dragger. (You need not press the mouse button.) This behavior may be disabled by setting the environment variable OIV_DISABLE_DRAGGER_CTRL_KEY to true (see OIV.Inventor.SoPreferences). An application can cycle through the pairs by calling the showNextDraggerSet method or display a specific pair by calling the showDraggerSet method. The dragger starts with the Y axis (y-line/xz-plane) pair displayed.
The line draggers are SoTranslate1Draggers and the plane draggers are SoTranslate2Draggers. So you can use the <Shift> key to constrain the motion of a plane dragger along one of the two axes within the plane, as described in the SoTranslate2Draggers reference page.
DragPoint adds extra feedback parts to provide a more intuitive idea of where you are placed in three-space. There are three feedback planes and three feedback axes ; each corresponds to one of the plane or line draggers, but spans a much greater distance. When you drag along a line, that line's larger feedback axis is displayed, and remains anchored in space while the dragger slides along it. This helps establish the motion of the dragger relative to the rest of the scene. Similarly, when you drag within a plane, the larger (but transparent) feedback plane establishes a ground plane for you to move upon. The location of the dragger within the plane is pinpointed by two intersecting axes that always cross below the cursor and extend to the edges of the plane. When you move dragPoint to the edge of the feedback plane (or line), the feedback will jump to a new location in that direction, so that the dragger never leaves the feedback behind.
The primary directions of motion are given by the local space of the dragger. Transforms earlier in the scene will affect the dragger, its children, and the orientation of its directions of motion.
This node has a OIV.Inventor.Draggers.SoDragPointDragger.translation field which always reflects its position in local space. Setting the field moves the dragger to that point. You can also connect fields of other nodes or engines from this one to make them follow the dragger's motion.
Although the child draggers each have their own resources defining default part geometries, the dragPoint dragger overrides these with a new set of resources. It also defines resources for the feedback parts that it adds. These are detailed in the Dragger Resources section of the online reference page for this class. You can change the parts in any instance of this dragger using OIV.Inventor.Nodekits.SoBaseKit.SetPart(System.String, OIV.Inventor.Nodes.SoNode).
You can make your program use different default resources for the parts by copying the file $OIVHOME/data/draggerDefaults/dragPointDragger.iv into your own directory, editing the file, and then setting the environment variable SO_DRAGGER_DIR to be a path to that directory.
See OIV.Inventor.Draggers.SoDragger for more information about using and customizing draggers, including code examples, using draggers in an immersive VR environment and using WYSIWYG draggers.
FILE FORMAT/DEFAULT
DragPointDragger {
| boundingBoxCaching | AUTO |
| renderCulling | AUTO |
| pickCulling | AUTO |
| isActive | false |
| translation | 0 0 0 |
| callbackList | NULL |
| xTranslator | Translate1Dragger { |
| } | |
| xyTranslator | Translate2Dragger { |
| } | |
| xzTranslator | Translate2Dragger { |
| } | |
| zTranslator | Translate1Dragger { |
| } | |
| yzTranslator | Translate2Dragger { |
| } | |
| yTranslator | Translate1Dragger { |
| } | |
| xFeedback | <dragPointXFeedback resource> |
| yFeedback | <dragPointYFeedback resource> |
| zFeedback | <dragPointZFeedback resource> |
| yzFeedback | <dragPointYZFeedback resource> |
| xzFeedback | <dragPointXZFeedback resource> |
| xyFeedback | <dragPointXYFeedback resource> |
| xTranslator.translator | <dragPointXTranslatorTranslator resource> |
| xTranslator.translatorActive | <dragPointXTranslatorTranslatorActive resource> |
| yTranslator.translator | <dragPointYTranslatorTranslator resource> |
| yTranslator.translatorActive | <dragPointYTranslatorTranslatorActive resource> |
| zTranslator.translator | <dragPointZTranslatorTranslator resource> |
| zTranslator.translatorActive | <dragPointZTranslatorTranslatorActive resource> |
| yzTranslator.translator | <dragPointYZTranslatorTranslator resource> |
| yzTranslator.translatorActive | <dragPointYZTranslatorTranslatorActive resource> |
| xzTranslator.translator | <dragPointXZTranslatorTranslator resource> |
| xzTranslator.translatorActive | <dragPointXZTranslatorTranslatorActive resource> |
| xyTranslator.translator | <dragPointXYTranslatorTranslator resource> |
| xyTranslator.translatorActive | <dragPointXYTranslatorTranslatorActive resource> |
DRAGGER RESOURCES
| Resource: | dragPointXTranslatorTranslator | |
| Part: | xTranslator.translator | |
| Appearance: | white cylinder with axis aligned in X direction | |
| Description: | picking this initiates linear motion in X direction | |
| Resource: | dragPointXTranslatorTranslatorActive | |
| Part: | xTranslator.translatorActive | |
| Appearance: | yellow cylinder with axis aligned in X direction | |
| Description: | shown when moving in X direction | |
| Resource: | dragPointYTranslatorTranslator | |
| Part: | yTranslator.translator | |
| Appearance: | white cylinder with axis aligned in Y direction | |
| Description: | picking this initiates linear motion in Y direction | |
| Resource: | dragPointYTranslatorTranslatorActive | |
| Part: | yTranslator.translatorActive | |
| Appearance: | yellow cylinder with axis aligned in Y direction | |
| Description: | shown when moving in Y direction | |
| Resource: | dragPointZTranslatorTranslator | |
| Part: | zTranslator.translator | |
| Appearance: | white cylinder with axis aligned in Z direction | |
| Description: | picking this initiates linear motion in Z direction | |
| Resource: | dragPointZTranslatorTranslatorActive | |
| Part: | zTranslator.translatorActive | |
| Appearance: | yellow cylinder with axis aligned in Z direction | |
| Description: | shown when moving in Z direction | |
| Resource: | dragPointYZTranslatorTranslator | |
| Part: | yzTranslator.translator | |
| Appearance: | white flattened cube within the yz plane of motion | |
| Description: | picking this initiates planar motion in yz plane | |
| Resource: | dragPointYZTranslatorTranslatorActive | |
| Part: | yzTranslator.translatorActive | |
| Appearance: | yellow flattened cube within the yz plane of motion | |
| Description: | shown when moving in yz plane | |
| Resource: | dragPointXZTranslatorTranslator | |
| Part: | xzTranslator.translator | |
| Appearance: | white flattened cube within the xz plane of motion | |
| Description: | picking this initiates planar motion in xz plane | |
| Resource: | dragPointXZTranslatorTranslatorActive | |
| Part: | xzTranslator.translatorActive | |
| Appearance: | yellow flattened cube within the xz plane of motion | |
| Description: | shown when moving in xz plane | |
| Resource: | dragPointXYTranslatorTranslator | |
| Part: | xyTranslator.translator | |
| Appearance: | white flattened cube within the xy plane of motion | |
| Description: | picking this initiates planar motion in xy plane | |
| Resource: | dragPointXYTranslatorTranslatorActive | |
| Part: | xyTranslator.translatorActive | |
| Appearance: | yellow flattened cube within the xy plane of motion | |
| Description: | shown when moving in xy plane | |
| Resource: | dragPointXFeedback | |
| Part: | xFeedback | |
| Appearance: | douple-headed purple arrow | |
| Description: | feedback for motion in x direction | |
| Resource: | dragPointYFeedback | |
| Part: | yFeedback | |
| Appearance: | douple-headed purple arrow | |
| Description: | feedback for motion in y direction | |
| Resource: | dragPointZFeedback | |
| Part: | zFeedback | |
| Appearance: | douple-headed purple arrow | |
| Description: | feedback for motion in z direction | |
| Resource: | dragPointYZFeedback | |
| Part: | yzFeedback | |
| Appearance: | semi-transparent green square in yz plane | |
| Description: | feedback for motion in yz plane | |
| Resource: | dragPointXZFeedback | |
| Part: | xzFeedback | |
| Appearance: | semi-transparent green square in yz plane | |
| Description: | feedback for motion in xz plane | |
| Resource: | dragPointXYFeedback | |
| 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 | |
| xTranslator | Translate1Dragger | yes | |
| xyTranslator | Translate2Dragger | yes | |
| xzTranslator | Translate2Dragger | yes | |
| zTranslator | Translate1Dragger | yes | |
| yzTranslator | Translate2Dragger | yes | |
| yTranslator | Translate1Dragger | yes | |
| xFeedback | Separator | yes | |
| yFeedback | Separator | yes | |
| zFeedback | Separator | yes | |
| yzFeedback | Separator | yes | |
| xzFeedback | Separator | yes | |
| xyFeedback | Separator | yes |
Extra Information for List Parts from Above Table
| Part Name | Container Type | Possible Types |
| callbackList | Separator | Callback, EventCallback |
See Also