SoTrackballDragger Class |
Striped ball you can rotate or scale uniformly by dragging with the mouse.
Namespace: OIV.Inventor.Draggers
The SoTrackballDragger type exposes the following members.
Name | Description | |
---|---|---|
SoTrackballDragger | 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.) | |
IsAnimationEnabled | Returns whether spin animation is enabled. | |
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. | |
SetAnimationEnabled | Enables/disables spin animation. | |
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. | |
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.SoTrackballDragger is a ball wrapped in three circular stripes. The stripes are oriented like wheels that spin around the x, y, and z axes. Drag the stripes to rotate the trackball around those axes. You do not have to hit the lines; pick anywhere within the stripe's outline. To rotate the trackball freely in 3 dimensions, click the area between the stripes and then drag. An invisible but pickable sphere initiates this dragging. If the mouse is still moving when you release it, the trackball will continue to spin.
Press the <Control> key to scale the trackball uniformly instead of rotating. This behavior may be disabled by setting the environment variable OIV_DISABLE_DRAGGER_CTRL_KEY to false (see OIV.Inventor.SoPreferences).
Press the <Shift> key and the user axis appears; this is a draggable axis with an extra stripe around it. Moving the mouse along the surface of the sphere drags the 'pole' of the axis. Release the <Shift> key and the user axis remains; drag the new stripe for constrained rotation around the user axis. To make the user axis disappear, press <Shift> and drag the pole to where two of other stripes intersect. This aligns the user axis with a primary axis, at which point the user axis disappears.
As you drag the trackball, it updates its OIV.Inventor.Draggers.SoTrackballDragger.rotation field, or its OIV.Inventor.Draggers.SoTrackballDragger.scaleFactor field if the <Control> key is down. As with all draggers, if you change the fields the dragger moves in response.
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.SoTrackballManip, which is subclassed from OIV.Inventor.Nodes.SoTransform. The manipulator creates one of these draggers and uses it as the interface to edit the manipulator's fields. (see the OIV.Inventor.Manips.SoTrackballManip 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.SoTrackballDragger 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/trackballDragger.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 |
Unlike most multi-function draggers, OIV.Inventor.Draggers.SoTrackballDragger is not a compound dragger made up of other draggers that perform its smaller tasks. This is not because it was inappropriate, but because the trackball was written before implementation of the methods that take care of synchronizing multiple child draggers. The younger OIV.Inventor.Draggers.SoCenterballDragger is similar in form to the trackball, but the centerball is a compound dragger.
TrackballDragger {
boundingBoxCaching | AUTO |
renderCulling | AUTO |
pickCulling | AUTO |
isActive | false |
rotation | 0 0 1 0 |
scaleFactor | 1 1 1 |
callbackList | NULL |
surroundScale | NULL |
antiSquish | AntiSquish { |
sizing LONGEST_DIAGONAL | |
} | |
rotator | <trackballRotator resource> |
rotatorActive | <trackballRotatorActive resource> |
XRotator | <trackballXRotator resource> |
XRotatorActive | <trackballXRotatorActive resource> |
YRotator | <trackballYRotator resource> |
YRotatorActive | <trackballYRotatorActive resource> |
ZRotator | <trackballZRotator resource> |
ZRotatorActive | <trackballZRotatorActive resource> |
userAxis | <trackballUserAxis resource> |
userAxisActive | <trackballUserAxisActive resource> |
userRotator | <trackballUserRotator resource> |
userRotatorActive | <trackballUserRotatorActive resource> |
Resource: | trackballRotator | |
Part: | rotator | |
Appearance: | Invisible but pickable sphere | |
Description: | Initiates unconstrained 3D rotation. Slightly smaller radius than the stripes, so you must pick between the stripes to use it. | |
Resource: | trackballRotatorActive | |
Part: | rotatorActive | |
Appearance: | Invisible sphere | |
Description: | Displayed during unconstrained 3D rotation. | |
Resource: | trackballXRotator | |
Part: | XRotator | |
Appearance: | White outline of a stripe aligned with the X axis. | |
Description: | Pick this to initiate constrained rotation about the X axis. | |
Resource: | trackballXRotatorActive | |
Part: | XRotatorActive | |
Appearance: | Yellow version of the regular XRotator | |
Description: | Displayed during constrained rotation about the X axis. | |
Resource: | trackballYRotator | |
Part: | YRotator | |
Appearance: | White outline of a stripe aligned with the Y axis. | |
Description: | Pick this to initiate constrained rotation about the Y axis. | |
Resource: | trackballYRotatorActive | |
Part: | YRotatorActive | |
Appearance: | Yellow version of the regular YRotator | |
Description: | Displayed during constrained rotation about the Y axis. | |
Resource: | trackballZRotator | |
Part: | ZRotator | |
Appearance: | White outline of a stripe aligned with the Z axis. | |
Description: | Pick this to initiate constrained rotation about the Z axis. | |
Resource: | trackballZRotatorActive | |
Part: | ZRotatorActive | |
Appearance: | Yellow version of the regular ZRotator | |
Description: | Displayed during constrained rotation about the Z axis. | |
Resource: | trackballUserAxis | |
Part: | userAxis | |
Appearance: | Thin purple line | |
Description: | Displays the user axis. Dragging the userRotator rotates about this line. | |
Resource: | trackballUserAxisActive | |
Part: | userAxisActive | |
Appearance: | Thin purple line | |
Description: | Displays the user axis. Dragging the userRotator rotates about this line. | |
Resource: | trackballUserRotator | |
Part: | userRotator | |
Appearance: | Transparent green stripe circling the user axis. | |
Description: | Pick to initiate constrained rotation about the user axis. | |
Resource: | trackballUserRotatorActive | |
Part: | userRotatorActive | |
Appearance: | Brighter green version of the regular userRotator | |
Description: | Displayed during constrained rotation about the user axis. |
All Parts
Part Name | Part Type | Default Type | NULL Default |
callbackList | NodeKitListPart | yes | |
surroundScale | SurroundScale | yes | |
antiSquish | AntiSquish | no | |
rotator | Separator | yes | |
rotatorActive | Separator | yes | |
XRotator | Separator | yes | |
XRotatorActive | Separator | yes | |
YRotator | Separator | yes | |
YRotatorActive | Separator | yes | |
ZRotator | Separator | yes | |
ZRotatorActive | Separator | yes | |
userAxis | Separator | yes | |
userAxisActive | Separator | yes | |
userRotator | Separator | yes | |
userRotatorActive | Separator | yes |
Extra Information for List Parts from Above Table
Part Name | Container Type | Possible Types |
callbackList | Separator | Callback, EventCallback |