| SoRotateCylindricalDragger Class |
Object you rotate along a cylindrical surface 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.DraggersSoRotateCylindricalDragger
Namespace: OIV.Inventor.Draggers
Assembly: OIV.Inventor (in OIV.Inventor.dll) Version: 10.12.3.0 (10.12.3.0)
SyntaxThe SoRotateCylindricalDragger type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | SoRotateCylindricalDragger | 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.) |
| GetProjector | Gets the cylinder projector. |
| 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. |
| SetProjector | Sets a different cylinder projector. |
| 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. |
| 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.SoRotateCylindricalDragger is a simple dragger that rotates about the y axis of its local space. The feel of the rotation is as if you were spinning a cylinder about its axis of rotation. The local space is determined by its location in the scene graph. Transformation nodes placed before it will affect both the dragger and the direction of motion.
This node has a OIV.Inventor.Draggers.SoRotateCylindricalDragger.rotation field which always reflects its orientation in local space. If you set the field, the dragger will rotate accordingly. You can also connect fields of other nodes or engines from this one to make them follow the dragger's orientation.
This dragger contains four parts, rotator , rotatorActive , feedback , and feedbackActive .
Each of these is set by default from a resource described 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/rotateCylindricalDragger.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
RotateCylindricalDragger {
| boundingBoxCaching | AUTO |
| renderCulling | AUTO |
| pickCulling | AUTO |
| isActive | false |
| rotation | 0 0 1 0 |
| callbackList | NULL |
| rotator | <rotateCylindricalRotator resource> |
| rotatorActive | <rotateCylindricalRotatorActive resource> |
| feedback | <rotateCylindricalFeedback resource> |
| feedbackActive | <rotateCylindricalFeedbackActive resource> |
DRAGGER RESOURCES
| Resource: | rotateCylindricalRotator | |
| Part: | rotator | |
| Appearance: | white cylinder (with vertical axis) made of lines | |
| Description: | picking this initiates rotation | |
| Resource: | rotateCylindricalRotatorActive | |
| Part: | rotatorActive | |
| Appearance: | yellow version of rotator | |
| Description: | displayed while in motion instead of the rotator | |
| Resource: | rotateCylindricalFeedback | |
| Part: | feedback | |
| Appearance: | thin purple line along local y-axis | |
| Description: | shows center of rotation when not moving | |
| Resource: | rotateCylindricalFeedbackActive | |
| Part: | feedbackActive | |
| Appearance: | thin, slightly brighter purple line along local y-axis | |
| Description: | shows center of rotation when moving |
CATALOG PARTS
All Parts
| Part Name | Part Type | Default Type | NULL Default |
| callbackList | NodeKitListPart | yes | |
| rotator | Separator | yes | |
| rotatorActive | Separator | yes | |
| feedback | Separator | yes | |
| feedbackActive | Separator | yes |
Extra Information for List Parts from Above Table
| Part Name | Container Type | Possible Types |
| callbackList | Separator | Callback, EventCallback |
See Also