Click or drag to resize
SoCenterballDragger Class

Striped ball you rotate and re-center by dragging with the mouse.

Inheritance Hierarchy

Namespace: OIV.Inventor.Draggers
Assembly: OIV.Inventor (in OIV.Inventor.dll) Version: 2023.1.3.0 (2023.1.3)
Syntax
public class SoCenterballDragger : SoDragger

The SoCenterballDragger type exposes the following members.

Constructors
  NameDescription
Public methodSoCenterballDragger

Constructor.

Top
Methods
  NameDescription
Public methodAffectsState

Returns true if a node has an effect on the state during traversal.

(Inherited from SoNode.)
Public methodCallback
(Inherited from SoBaseKit.)
Public methodClearOtherEventCallbacks
(Inherited from SoDragger.)
Public methodCopy
Calls Copy(false).
(Inherited from SoNode.)
Public methodCopy(Boolean)

Creates and returns an exact copy of the node.

(Inherited from SoNode.)
Public methodCopyFieldValues(SoFieldContainer)
Calls CopyFieldValues(fc, false).
(Inherited from SoFieldContainer.)
Public methodCopyFieldValues(SoFieldContainer, Boolean)

Copies the contents of fc's fields into this object's fields.

(Inherited from SoFieldContainer.)
Public methodCreatePathToPart(String, Boolean)
Calls CreatePathToPart(partName, makeIfNeeded, (OIV.Inventor.SoPath ^)nullptr).
(Inherited from SoBaseKit.)
Public methodCreatePathToPart(String, Boolean, SoPath)

Returns a path that begins at this nodekit and ends at partName.

(Inherited from SoBaseKit.)
Public methodCreatePathToThis
(Inherited from SoDragger.)
Public methodDispose
Releases all resources used by SoDisposable.
(Inherited from SoDisposable.)
Public methodDistribute
(Inherited from SoNode.)
Public methodDoAction
(Inherited from SoBaseKit.)
Public methodEnableNotify

Notification at this Field Container is enabled (if flag == true) or disabled (if flag == false).

(Inherited from SoFieldContainer.)
Public methodEnableValueChangedEvent

You can temporarily disable a dragger's valueChangedCallbacks.

(Inherited from SoDragger.)
Public methodEquals
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Public methodFieldsAreEqual

Returns true if this object's fields are exactly equal to fc's fields.

(Inherited from SoFieldContainer.)
Public methodGet

Returns the values of the fields of this object in the Open Inventor ASCII file format in the given string.

(Inherited from SoFieldContainer.)
Public methodGetAllFields

Returns a list of fields, including the eventIn's and eventOut's.

(Inherited from SoFieldContainer.)
Public methodGetAlternateRep

This method is called by actions to allow the node to provide an "alternate representation" when appropriate (typically depending on the action type).

(Inherited from SoNode.)
Public methodGetBoundingBox
(Inherited from SoBaseKit.)
Public methodStatic memberGetClassNodekitCatalog

Returns the OIV.Inventor.Nodekits.SoNodekitCatalog for this class.

Public methodGetEvent
(Inherited from SoDragger.)
Public methodGetEventIn

Returns a the eventIn with the given name.

(Inherited from SoFieldContainer.)
Public methodGetEventOut

Returns the eventOut with the given name.

(Inherited from SoFieldContainer.)
Public methodGetField

Returns a the field of this object whose name is fieldName.

(Inherited from SoFieldContainer.)
Public methodGetFieldName

Returns the name of the given field in the fieldName argument.

(Inherited from SoFieldContainer.)
Public methodGetFields

Appends references to all of this object's fields to resultList, and returns the number of fields appended.

(Inherited from SoFieldContainer.)
Public methodGetHandleEventAction
(Inherited from SoDragger.)
Public methodGetHashCode
Overrides GetHashCode().
(Inherited from SoNetBase.)
Public methodGetLocalStartingPoint
(Inherited from SoDragger.)
Public methodGetLocalToWorldMatrix
Calls GetLocalToWorldMatrix((OIV.Inventor.Actions.SoAction ^)nullptr).
(Inherited from SoDragger.)
Public methodGetLocalToWorldMatrix(SoAction)
(Inherited from SoDragger.)
Public methodGetMatrix
(Inherited from SoBaseKit.)
Public methodGetMinGesture

Gets the number of pixels of movement required to initiate a constraint gesture.

(Inherited from SoDragger.)
Public methodGetMinGestureFloat (Inherited from SoDragger.)
Public methodGetMotionMatrix

Get the motion matrix.

(Inherited from SoDragger.)
Public methodGetName

Returns the name of an instance.

(Inherited from SoBase.)
Public methodGetNodekitCatalog (Inherited from SoBaseKit.)
Public methodGetPart

Searches the nodekit catalog (and those of all nested nodekits) for the part named partName.

(Inherited from SoBaseKit.)
Public methodGetPartString

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.

(Inherited from SoBaseKit.)
Public methodGetPartToLocalMatrix
(Inherited from SoDragger.)
Public methodGetPickPath
(Inherited from SoDragger.)
Public methodGetPrimitiveCount
(Inherited from SoBaseKit.)
Public methodGetRenderEngineMode

Returns the supported Render engine mode.

(Inherited from SoNode.)
Public methodGetRenderUnitID
(Inherited from SoNode.)
Public methodGetStartMotionMatrix
(Inherited from SoDragger.)
Public methodGetStringName (Inherited from SoBase.)
Public methodGetSurrogatePartPickedName
(Inherited from SoDragger.)
Public methodGetSurrogatePartPickedOwner
(Inherited from SoDragger.)
Public methodGetSurrogatePartPickedPath
(Inherited from SoDragger.)
Public methodGetTrackerDirectMode

Get the current tracker direct mode for this dragger.

(Inherited from SoDragger.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodGetViewportIsEnabled (Inherited from SoBaseKit.)
Public methodGetViewportOrigin (Inherited from SoBaseKit.)
Public methodGetViewportRegion Obsolete.
(Inherited from SoDragger.)
Public methodGetViewportSize (Inherited from SoBaseKit.)
Public methodGetViewVolume Obsolete.

Dragger must not store information related to viewer settings.

(Inherited from SoDragger.)
Public methodGetWorldStartingPoint
(Inherited from SoDragger.)
Public methodGetWorldToLocalMatrix
Calls GetWorldToLocalMatrix((OIV.Inventor.Actions.SoAction ^)nullptr).
(Inherited from SoDragger.)
Public methodGetWorldToLocalMatrix(SoAction)
(Inherited from SoDragger.)
Public methodGLRender
(Inherited from SoBaseKit.)
Public methodGLRenderBelowPath
(Inherited from SoNode.)
Public methodGLRenderInPath
(Inherited from SoNode.)
Public methodGLRenderOffPath
(Inherited from SoNode.)
Public methodGrabEventsCleanup
(Inherited from SoNode.)
Public methodGrabEventsSetup
(Inherited from SoNode.)
Public methodHandleEvent
(Inherited from SoBaseKit.)
Public methodHasDefaultValues

Returns true if all of the object's fields have their default values.

(Inherited from SoFieldContainer.)
Public methodInvokeValueChanged

(Inherited from SoDragger.)
Public methodIsBoundingBoxIgnoring

Returns true if bounding box computation should be ignored during OIV.Inventor.Actions.SoGetBoundingBoxAction traversal.

(Inherited from SoBaseKit.)
Public methodIsNotifyEnabled

Notification is the process of telling interested objects that this object has changed.

(Inherited from SoFieldContainer.)
Public methodIsOverride

Returns the state of the override flag.

(Inherited from SoNode.)
Public methodIsPathSurrogateInMySubgraph(SoPath)
(Inherited from SoInteractionKit.)
Public methodIsPathSurrogateInMySubgraph(SoPath, SoPath, String, SoPath)
Calls IsPathSurrogateInMySubgraph(pathToCheck, pathToOwner, surrogateNameInOwner, surrogatePathInOwner, true).
(Inherited from SoInteractionKit.)
Public methodIsPathSurrogateInMySubgraph(SoPath, SoPath, String, SoPath, Boolean)
(Inherited from SoInteractionKit.)
Public methodIsSynchronizable

Gets the ScaleViz synchronizable state of this object.

(Inherited from SoBase.)
Public methodIsTrackerDirectMode
(Inherited from SoDragger.)
Public methodPick
(Inherited from SoNode.)
Public methodRayPick
(Inherited from SoBaseKit.)
Public methodRegisterChildDragger
(Inherited from SoDragger.)
Public methodRegisterChildDraggerMovingIndependently
(Inherited from SoDragger.)
Public methodSaveStartParameters
(Inherited from SoDragger.)
Public methodSearch
(Inherited from SoBaseKit.)
Public methodSet(String)

This function allows field values of parts (nodes) to be set in several different parts simultaneously.

(Inherited from SoBaseKit.)
Public methodSet(String, String)

This function allows field values of parts (nodes) to be set.

(Inherited from SoBaseKit.)
Public methodSetHandleEventAction
(Inherited from SoDragger.)
Public methodSetMinGesture(Int32)

Sets the number of pixels of movement required to initiate a constraint gesture.

(Inherited from SoDragger.)
Public methodSetMinGesture(Single) (Inherited from SoDragger.)
Public methodSetMotionMatrix

Set the motion matrix.

(Inherited from SoDragger.)
Public methodSetName (Inherited from SoBase.)
Public methodSetOverride

Turns the override flag on or off.

(Inherited from SoNode.)
Public methodSetPart

Inserts the given node (not a copy) as the new part specified by partName.

(Inherited from SoBaseKit.)
Public methodSetPartAsDefault(String, SoNode)
Calls SetPartAsDefault(partName, newNode, true).
(Inherited from SoInteractionKit.)
Public methodSetPartAsDefault(String, String)
Calls SetPartAsDefault(partName, newNodeName, true).
(Inherited from SoInteractionKit.)
Public methodSetPartAsDefault(String, SoNode, Boolean)
(Inherited from SoInteractionKit.)
Public methodSetPartAsDefault(String, String, Boolean)
(Inherited from SoInteractionKit.)
Public methodSetPartAsPath

Sets any public part in the interaction kit as a "surrogate" path instead.

(Inherited from SoInteractionKit.)
Public methodSetStartingPoint(SbVec3f)
(Inherited from SoDragger.)
Public methodSetStartingPoint(SoPickedPoint)
(Inherited from SoDragger.)
Public methodSetSynchronizable

Sets this to be a ScaleViz synchronizable object.

(Inherited from SoBase.)
Public methodSetTempPathToThis
(Inherited from SoDragger.)
Public methodSetToDefaults

Sets all fields in this object to their default values.

(Inherited from SoFieldContainer.)
Public methodSetTrackerDirectMode
Calls SetTrackerDirectMode(OIV.Inventor.Draggers.SoDragger.TrackerDirectModes( .SoDragger.DEFAULT )).
(Inherited from SoDragger.)
Public methodSetTrackerDirectMode(SoDraggerTrackerDirectModes)

Sets the tracker direct mode for this dragger (see description above).

(Inherited from SoDragger.)
Public methodSetViewportRegion Obsolete.
(Inherited from SoDragger.)
Public methodSetViewVolume Obsolete.
(Inherited from SoDragger.)
Public methodToString
Converts this SoBase structure to a human readable string.
(Inherited from SoBase.)
Public methodTouch

Marks an instance as modified, simulating a change to it.

(Inherited from SoNode.)
Public methodTransformMatrixLocalToWorld
(Inherited from SoDragger.)
Public methodTransformMatrixToLocalSpace
(Inherited from SoDragger.)
Public methodTransformMatrixWorldToLocal
(Inherited from SoDragger.)
Public methodUnregisterChildDragger
(Inherited from SoDragger.)
Public methodUnregisterChildDraggerMovingIndependently
(Inherited from SoDragger.)
Public methodWorkFieldsIntoTransform
(Inherited from SoDragger.)
Public methodWrite
(Inherited from SoBaseKit.)
Top
Properties
  NameDescription
Public propertyboundingBoxCaching
(Inherited from SoInteractionKit.)
Public propertyboundingBoxIgnoring

Whether to ignore this node during bounding box traversal.

(Inherited from SoBaseKit.)
Public propertycenter

Center of rotation and scale of the centerball dragger.

Public propertyenableCallbacks

If set to false, motion, start and finish callbacks are disabled.

(Inherited from SoDragger.)
Public propertyisActive

true when mouse is down and dragging, else false.

(Inherited from SoDragger.)
Public propertyIsDisposable
ISafeDisposable interface implementation.
(Inherited from SoDisposable.)
Public propertypickCulling

Set pick caching mode.

(Inherited from SoInteractionKit.)
Public propertyrenderCaching Obsolete.

Set render caching mode.

(Inherited from SoInteractionKit.)
Public propertyrenderCulling

Set render culling mode.

(Inherited from SoInteractionKit.)
Public propertyrotation

Orientation of the centerball dragger.

Public propertyUserData
Gets or sets the user data to be contained by the field container.
(Inherited from SoFieldContainer.)
Top
Events
  NameDescription
Public eventFinishDragging
(Inherited from SoDragger.)
Public eventMouseMove
(Inherited from SoDragger.)
Public eventStartDragging
(Inherited from SoDragger.)
Public eventValueChanged
(Inherited from SoDragger.)
Top
Remarks

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:

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

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

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>
}

DRAGGER RESOURCES

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.

CATALOG PARTS

All Parts
Part NamePart TypeDefault TypeNULL 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 NameContainer TypePossible Types
callbackList Separator Callback, EventCallback

See Also