SoTabBoxDragger Class |
Cubic object you can translate and scale by dragging with the mouse.
Namespace: OIV.Inventor.Draggers
The SoTabBoxDragger type exposes the following members.
Name | Description | |
---|---|---|
SoTabBoxDragger | Constructor. |
Name | Description | |
---|---|---|
AdjustScaleTabSize | Causes the scale tab sizes to be re-adjusted on all 6 SoTabPlaneDraggers so that they remain a near constant screen space size. | |
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. | |
enableCallbacks | If set to false, motion, start and finish callbacks are disabled. | |
enableHighlight | Enables highlighting for tabs and faces. | |
highlightColor | Specifies the highlight color. | |
isActive | true when mouse is down and dragging, else false. | |
IsDisposable | ISafeDisposable interface implementation.
(Inherited from SoDisposable.) | |
pickCulling | Set pick caching mode. | |
privateStyle | Controls whether this instance of OIV.Inventor.Draggers.SoTabBoxDragger shares or does not share parts, e.g. | |
renderCaching | Obsolete. Set render caching mode. | |
renderCulling | Set render culling mode. | |
resizeHandles | If set to true, handles will be resized at each camera motion. | |
scaleFactor | Scale of the dragger. | |
tabPixelSize | Specifies the size of the green tabs in pixels. | |
translation | Position 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.SoTabBoxDragger is a composite dragger shaped like a box. Inside it are six SoTabPlaneDraggers which the dragger positions and orients to form a cube. The operations available in an OIV.Inventor.Draggers.SoTabPlaneDragger (translation, 1D scaling and 2D scaling) are available on each face of the cube. Since they each move in their own local space, the dragger may be easily translated or scaled in any direction.
Clicking and dragging a corner tab does a 2D scaling in the plane of the tab by scaling, centered on the opposite corner of that face of the dragger, meaning that the opposite corner is the only corner that won't move. Note: Holding the SHIFT key while dragging a corner tab forces uniform scaling.
Clicking and dragging an edge tab does 1D scaling about the opposite edge of that face.
Clicking and dragging a face does translation within the plane of the face. Although the face of the dragger is invisible (using the default dragger geometry) it is pickable. Note: Holding the SHIFT key while dragging a face forces axis constrained dragging. The drag axis is determined by the initial drag direction.
As a composite dragger, this class makes sure that when one plane is dragged, the entire box moves together.
Each OIV.Inventor.Draggers.SoTabPlaneDragger tries to keep the small tabs a constant size in screen space. Every time a drag begins or ends, the size is automatically recalculated based on the viewing and modeling matrix. When the OIV.Inventor.Draggers.SoTabBoxDragger.resizeHandles field is set to true (the default), the tab size is also recalculated during the render traversal if the view matrix has changed (usually because the camera position and/or orientation changed). The application can also force the tab size to be recomputed by calling the OIV.Inventor.Draggers.SoTabBoxDragger.AdjustScaleTabSize() method.
If the dragger becomes too small in one dimension to contain all three tabs (two corner tabs plus the edge tab), the middle (edge) tab will not be drawn. If the dragger becomes very small (or flat) in one dimension, it may not be possible for the user to resize using the tabs. One solution for this is to provide a "reset dragger" button in the application.
When dragging the translator part, press the <Shift> key and you can constrain motion to either the local x axis or the y axis . The direction is determined by your initial mouse gesture after pressing the key. Releasing the key removes the constraint.
As each sub-dragger is moved, the OIV.Inventor.Draggers.SoTabBoxDragger updates its OIV.Inventor.Draggers.SoTabBoxDragger.scaleFactor and OIV.Inventor.Draggers.SoTabBoxDragger.translation fields. As with all draggers, if you change a field the dragger will move to match the new settings.
Remember: This is not an SoTransform!. If you want to move other objects with this dragger, you can:
Use an OIV.Inventor.Manips.SoTabBoxManip, which is subclassed from OIV.Inventor.Nodes.SoTransform. It creates one of these draggers and uses it as the interface to change its fields.
Use an OIV.LDM.Manips.SoROIManip, which is subclassed from OIV.LDM.Nodes.SoROI, if your goal is to do volume rendering and interact with a region-of-interest. This is commonly used for medical volume data and seismic volume data.
Use field-to-field connections to connect the fields of this dragger to those of any OIV.Inventor.Nodes.SoTransformation node.
Use the standard dragger callbacks, see for example OIV.Inventor.Draggers.SoDragger.ValueChanged().
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.SoTabBoxDragger class. They are detailed below 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/tabBoxDragger.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 |
TabBoxDragger {
boundingBoxCaching | AUTO |
renderCulling | AUTO |
pickCulling | AUTO |
isActive | false |
resizeHandles | true |
translation | 0 0 0 |
scaleFactor | 1 1 1 |
tabPixelSize | 8 |
callbackList | NULL |
surroundScale | NULL |
privateStyle | false |
highlightColor | 1.0 1.0 0.0 |
enableHighlight | true |
tabPlane1 | TabPlaneDragger { |
} | |
tabPlane2 | TabPlaneDragger { |
} | |
tabPlane3 | TabPlaneDragger { |
} | |
tabPlane4 | TabPlaneDragger { |
} | |
tabPlane5 | TabPlaneDragger { |
} | |
tabPlane6 | TabPlaneDragger { |
} | |
boxGeom | <tabBoxBoxGeom resource> |
tabPlane1.translator | <tabBoxTranslator resource> |
tabPlane2.translator | <tabBoxTranslator resource> |
tabPlane3.translator | <tabBoxTranslator resource> |
tabPlane4.translator | <tabBoxTranslator resource> |
tabPlane5.translator | <tabBoxTranslator resource> |
tabPlane6.translator | <tabBoxTranslator resource> |
tabPlane1.scaleTabMaterial | <tabBoxScaleTabMaterial resource> |
tabPlane2.scaleTabMaterial | <tabBoxScaleTabMaterial resource> |
tabPlane3.scaleTabMaterial | <tabBoxScaleTabMaterial resource> |
tabPlane4.scaleTabMaterial | <tabBoxScaleTabMaterial resource> |
tabPlane5.scaleTabMaterial | <tabBoxScaleTabMaterial resource> |
tabPlane6.scaleTabMaterial | <tabBoxScaleTabMaterial resource> |
tabPlane1.scaleTabHints | <tabBoxScaleTabHints resource> |
tabPlane2.scaleTabHints | <tabBoxScaleTabHints resource> |
tabPlane3.scaleTabHints | <tabBoxScaleTabHints resource> |
tabPlane4.scaleTabHints | <tabBoxScaleTabHints resource> |
tabPlane5.scaleTabHints | <tabBoxScaleTabHints resource> |
tabPlane6.scaleTabHints | <tabBoxScaleTabHints resource> |
Resource: | tabBoxTranslator | |
Parts: | tabPlane1.translator<BR> tabPlane2.translator<BR> tabPlane3.translator<BR> tabPlane4.translator<BR> tabPlane5.translator<BR> tabPlane6.translator | |
Appearance: | Outline of a Square. The region within is pickable | |
Description: | Begins translation within the plane. The tabBox places and orients each tabPlane so that these squares form a box. | |
Resource: | tabBoxScaleTabMaterial | |
Parts: | tabPlane1.scaleTabMaterial<BR> tabPlane2.scaleTabMaterial<BR> tabPlane3.scaleTabMaterial<BR> tabPlane4.scaleTabMaterial<BR> tabPlane5.scaleTabMaterial<BR> tabPlane6.scaleTabMaterial | |
Appearance: | Green - half diffuse, half emissive. | |
Description: | Used as material for scaling tabs. | |
Resource: | tabBoxScaleTabHints | |
Parts: | tabPlane1.scaleTabHints<BR> tabPlane2.scaleTabHints<BR> tabPlane3.scaleTabHints<BR> tabPlane4.scaleTabHints<BR> tabPlane5.scaleTabHints<BR> tabPlane6.scaleTabHints | |
Appearance: | shapeHints node:COUNTERCLOCKWISE/SOLID/CONVEX | |
Description: | Property for the tab nodes. | |
Resource: | tabBoxBoxGeom | |
Part: | boxGeom | |
Appearance: | Unpickable gray outline of a box. | |
Description: | Just feedback. |
All Parts
Part Name | Part Type | Default Type | NULL Default |
callbackList | NodeKitListPart | yes | |
surroundScale | SurroundScale | yes | |
tabPlane1 | TabPlaneDragger | yes | |
tabPlane2 | TabPlaneDragger | yes | |
tabPlane3 | TabPlaneDragger | yes | |
tabPlane4 | TabPlaneDragger | yes | |
tabPlane5 | TabPlaneDragger | yes | |
tabPlane6 | TabPlaneDragger | yes | |
boxGeom | Separator | yes |
Extra Information for List Parts from Above Table
Part Name | Container Type | Possible Types |
callbackList | Separator | Callback, EventCallback |