Click or drag to resize
SoTabPlaneDragger Class

Object you can translate or scale within a plane by dragging with the mouse.

Inheritance Hierarchy

Namespace: OIV.Inventor.Draggers
Assembly: OIV.Inventor (in OIV.Inventor.dll) Version: 2024.1.1.0 (2024.1.1)
Syntax
public class SoTabPlaneDragger : SoDragger

The SoTabPlaneDragger type exposes the following members.

Constructors
  NameDescription
Public methodSoTabPlaneDragger

Constructor.

Top
Methods
  NameDescription
Public methodAdjustScaleTabSize

Causes the scale tab sizes to be adjusted so that they remain a near constant screen space size.

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 methodShowCornerScales

show or hide corners

Public methodShowEdgeScales

show or hide edges

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

Specifies the line width for the outline box.

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 propertyresizeHandles

If set to true, handles will be resized automatically when the view matrix (camera) changes.

Public propertyscaleFactor

Scale factor affecting the dragger.

Public propertyscaleUniform

If set to true, scaling will always be uniform.

Public propertytabPixelSize

Specifies the size of the green tabs in pixels.

Public propertytranslation

Position of the dragger.

Public propertytwoSidedLighting

If set to true, OpenGL two sided lighting will be enabled.

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.SoTabPlaneDragger is a dragger which allows the user to interactively translate and scale in a plane. It looks like a square white outline with smaller green squares (or tabs ) set in the corners and along the center of each edge.

Dragging a corner tab scales the dragger in 2D by scaling about the opposite corner. Holding the SHIFT key while while dragging a corner tab forces uniform scaling.

Dragging an edge tab performs 1D scaling about the opposite edge.

Uniform scaling can also be forced by setting the OIV.Inventor.Draggers.SoTabPlaneDragger.scaleUniform field to true.

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.

The dragger tries to keep the small tabs a constant size in screen space. Before version 7.0, this adjustment was only done when a drag operation started and ended, or when the OIV.Inventor.Draggers.SoTabPlaneDragger.AdjustScaleTabSize() method was called. Now as long as the OIV.Inventor.Draggers.SoTabPlaneDragger.resizeHandles field is set to true (the default), the tab size is automatically recalculated whenever the view matrix changes (normally because the camera position or orientation changed).

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.

When the translator part drags, the dragger updates its OIV.Inventor.Draggers.SoTabPlaneDragger.translation field. The various scaling parts cause changes to both the OIV.Inventor.Draggers.SoTabPlaneDragger.scaleFactor and OIV.Inventor.Draggers.SoTabPlaneDragger.translation field, since scaling about a point other than the center adds translation to the center of the dragger. If you set the field, the dragger will move accordingly. You can also connect fields of other nodes or engines from this one to make them follow the dragger's motion.

You can not change the shape used to draw the tabs. This part is kept privately and may not be changed; the coordinates for the tabs are edited during OIV.Inventor.Draggers.SoTabPlaneDragger.AdjustScaleTabSize().

The OIV.Inventor.Draggers.SoTabPlaneDragger class does contain three other parts you can change: tabPlaneTranslator , tabPlaneScaleTabMaterial and tabPlaneScaleTabHints .

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/tabPlaneDragger.iv into your own directory, editing the file, and then setting the environment variable SO_DRAGGER_DIR to be a path to that directory.

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

TabPlaneDragger {
boundingBoxCaching AUTO
renderCulling AUTO
pickCulling AUTO
isActive false
resizeHandles true
translation 0 0 0
scaleFactor 1 1 1
scaleUniform false
twoSidedLighting false
lineWidth 1
tabPixelSize 8
callbackList NULL
translator <tabPlaneTranslator resource>
scaleTabMaterial <tabPlaneScaleTabMaterial resource>
scaleTabHints <tabPlaneScaleTabHints resource>
}

DRAGGER RESOURCES

Resource: tabPlaneTranslator
Part: translator
Appearance: Outline of a Square. The region within it is pickable
Description: Begins translation within the plane
Resource: tabPlaneScaleTabMaterial
Part: scaleTabMaterial
Appearance: Green - half diffuse, half emissive.
Description: Used as material for scaling tabs.
Resource: tabPlaneScaleTabHints
Part: scaleTabHints
Appearance: shapeHints node:COUNTERCLOCKWISE/SOLID/CONVEX
Description: Property for the tab nodes.

CATALOG PARTS

All Parts
Part NamePart TypeDefault TypeNULL Default
callbackList NodeKitListPart yes
translator Separator yes
scaleTabMaterial Material yes
scaleTabHints ShapeHints yes
translatorDrawStyle DrawStyle no
translatorMaterial Material no

Extra Information for List Parts from Above Table
Part NameContainer TypePossible Types
callbackList Separator Callback, EventCallback

See Also