SoCenterballDragger Class |
Striped ball you rotate and re-center by dragging with the mouse.
Namespace: OIV.Inventor.Draggers
The SoCenterballDragger type exposes the following members.
Name | Description | |
---|---|---|
SoCenterballDragger | 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. | |
center | Center of rotation and scale of the centerball dragger. | |
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 centerball 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.SoCenterballDragger is a composite dragger. Its shape is a sphere defined by three intersecting circles. Where the circles intersect (at the ends of the x, y and z axes) there are sets of small green crosshairs. Dragging a pair of crosshairs translates the entire centerball within the plane of the crosshairs. The interface of the sphere and circles is just like OIV.Inventor.Draggers.SoTrackballDragger. Dragging a circle rotates about a constrained axis and dragging the areas between them rotates the sphere freely about the center. An invisible but pickable sphere initiates the free-rotation dragging.
When you drag the crosshairs, the OIV.Inventor.Draggers.SoCenterballDragger.center field is updated; there is no translation field. Dragging other parts of the centerball updates the OIV.Inventor.Draggers.SoCenterballDragger.rotation field. As with all draggers, if you change the fields the dragger moves in response.
The draggers used for the crosshair parts are SoTranslate2Draggers, so pressing the <Shift> key allows you to constrain motion to slide along either the local x axis or y axis of that crosshair. The direction is determined by your initial mouse gesture after pressing the key. Releasing the key removes the constraint.
Remember: This is not an SoTransform! If you want to move other objects with this dragger, you can either:
Use an OIV.Inventor.Manips.SoCenterballManip, 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.SoCenterballManip 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.SoCenterballDragger 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/centerballDragger.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 |
CenterballDragger {
boundingBoxCaching | AUTO |
renderCulling | AUTO |
pickCulling | AUTO |
isActive | false |
rotation | 0 0 1 0 |
center | 0 0 0 |
callbackList | NULL |
translateToCenter | MatrixTransform { |
matrix | |
1 0 0 0 | |
0 1 0 0 | |
0 0 1 0 | |
0 0 0 1 | |
} | |
surroundScale | NULL |
antiSquish | AntiSquish { |
sizing LONGEST_DIAGONAL | |
} | |
lightModel | LightModel { |
model PHONG | |
} | |
XAxis | <centerballXAxis resource> |
YAxis | <centerballYAxis resource> |
ZAxis | <centerballZAxis resource> |
rotator | RotateSphericalDragger { |
} | |
YRotator | RotateCylindricalDragger { |
} | |
ZCenterChanger | Translate2Dragger { |
} | |
ZRotator | RotateCylindricalDragger { |
} | |
YCenterChanger | Translate2Dragger { |
} | |
XCenterChanger | Translate2Dragger { |
} | |
XRotator | RotateCylindricalDragger { |
} | |
rotator.rotator | <centerballRotator resource> |
rotator.rotatorActive | <centerballRotatorActive resource> |
XRotator.rotator | <centerballStripe resource> |
YRotator.rotator | <centerballStripe resource> |
ZRotator.rotator | <centerballStripe resource> |
XRotator.rotatorActive | <centerballStripeActive resource> |
YRotator.rotatorActive | <centerballStripeActive resource> |
ZRotator.rotatorActive | <centerballStripeActive resource> |
XCenterChanger.translator | <centerballCenterChanger resource> |
YCenterChanger.translator | <centerballCenterChanger resource> |
ZCenterChanger.translator | <centerballCenterChanger resource> |
XCenterChanger.translatorActive | <centerballCenterChangerActive resource> |
YCenterChanger.translatorActive | <centerballCenterChangerActive resource> |
ZCenterChanger.translatorActive | <centerballCenterChangerActive resource> |
XCenterChanger.xAxisFeedback | <centerballCenterXAxisFeedback resource> |
YCenterChanger.xAxisFeedback | <centerballCenterXAxisFeedback resource> |
ZCenterChanger.xAxisFeedback | <centerballCenterXAxisFeedback resource> |
XCenterChanger.yAxisFeedback | <centerballCenterYAxisFeedback resource> |
YCenterChanger.yAxisFeedback | <centerballCenterYAxisFeedback resource> |
ZCenterChanger.yAxisFeedback | <centerballCenterYAxisFeedback resource> |
Resource: | centerballRotator | |
Part: | rotator.rotator | |
Appearance: | Invisible but pickable sphere | |
Description: | When picked, initiates free rotation about the center point. Slightly smaller radius than the stripes, so you must pick between the stripes to use it. | |
Resource: | centerballRotatorActive | |
Part: | rotator.rotatorActive | |
Appearance: | Invisible sphere | |
Description: | Displayed during unconstrained 3D rotation instead of centerballRotator. | |
Resource: | centerballStripe | |
Parts: | XRotator.rotator<BR> YRotator.rotator<BR> ZRotator.rotator | |
Appearance: | White circle aligned with rotation axis. | |
Description: | When picked, initiates constrained rotation. Each rotator rotates locally about its Y axis. The centerball contains private transform parts that orient the draggers along three different axes. | |
Resource: | centerballStripeActive | |
Parts: | XRotator.rotatorActive<BR> YRotator.rotatorActive<BR> ZRotator.rotatorActive | |
Appearance: | White circle aligned with the rotation axis. | |
Description: | Displayed during constrained rotation instead of the rotator part. The centerball orients the draggers along three different axes. | |
Resource: | centerballCenterChanger | |
Parts: | XCenterChanger.translator<BR> YCenterChanger.translator<BR> ZCenterChanger.translator | |
Appearance: | Two sets of small green crosshairs, one located at each intersection of axis and ball. | |
Description: | When picked, initiates 2D translation of ball through space. Edits the OIV.Inventor.Draggers.SoCenterballDragger.center field, which becomes center for subsequent rotations. Each translator works locally in its X-Y plane. The centerball containsprivate transform parts that place the draggers along three different axes. | |
Resource: | centerballCenterChangerActive | |
Parts: | XCenterChanger.translatorActive<BR> YCenterChanger.translatorActive<BR> ZCenterChanger.translatorActive | |
Appearance: | Yellow version of centerballCenterChanger. | |
Description: | Displayed during 2D translation instead of regular translator part. The centerball places the draggers along three different axes. | |
Resource: | centerballCenterXAxisFeedback | |
Parts: | XCenterChanger.xAxisFeedback<BR> YCenterChanger.xAxisFeedback<BR> ZCenterChanger.xAxisFeedback | |
Appearance: | Double-headed purple arrows, one located at each intersection of axis and ball. Located atop X axis of crosshair. | |
Description: | Only shown if dragger is moving and the axis is a permitted direction of motion. When pressing <shift>, motion is constrained, and this is displayed only if the primary motion is in the X direction of the child dragger's local space. The centerball places the draggers along three different axes; so not all of these parts aligns with the X axis in centerball space. | |
Resource: | centerballCenterYAxisFeedback | |
Parts: | XCenterChanger.yAxisFeedback<BR> YCenterChanger.yAxisFeedback<BR> ZCenterChanger.yAxisFeedback | |
Appearance: | Double-headed purple arrows, one located at each intersection of axis and ball. Located atop Y axis of crosshair. | |
Description: | Only shown if dragger is moving and the axis is a permitted direction of motion. When pressing <shift>, motion is constrained, and this is displayed only if the primary motion is in the Y direction of the child dragger's local space. The centerball places the draggers along three different axes; so not all of these parts aligns with the Y axis in centerball space. | |
Resource: | centerballXAxis | |
Part: | XAxis | |
Appearance: | Thin yellow line connecting left and right crosshairs. | |
Description: | Feedback shown alone during rotation about X axis; displayed with centerballYAxis and centerballZAxis while center is dragged. | |
Resource: | centerballYAxis | |
Part: | YAxis | |
Appearance: | Thin yellow line connecting lower and upper crosshairs. | |
Description: | Feedback shown alone during rotation about Y axis; displayed with centerballXAxis and centerballZAxis while center is dragged. | |
Resource: | centerballZAxis | |
Part: | ZAxis | |
Appearance: | Thin yellow line connecting near and far crosshairs. | |
Description: | Feedback shown alone during rotation about Z axis; displayed with centerballXAxis and centerballYAxis while center is dragged. |
All Parts
Part Name | Part Type | Default Type | NULL Default |
callbackList | NodeKitListPart | yes | |
translateToCenter | MatrixTransform | yes | |
surroundScale | SurroundScale | yes | |
antiSquish | AntiSquish | no | |
lightModel | LightModel | yes | |
XAxis | Separator | yes | |
YAxis | Separator | yes | |
ZAxis | Separator | yes | |
rotator | RotateSphericalDragger | yes | |
YRotator | RotateCylindricalDragger | yes | |
ZCenterChanger | Translate2Dragger | yes | |
ZRotator | RotateCylindricalDragger | yes | |
YCenterChanger | Translate2Dragger | yes | |
XCenterChanger | Translate2Dragger | yes | |
XRotator | RotateCylindricalDragger | yes |
Extra Information for List Parts from Above Table
Part Name | Container Type | Possible Types |
callbackList | Separator | Callback, EventCallback |