man SoTabPlaneDragger () - object you can translate or scale within a plane by dragging with the mouse
NAME
SoTabPlaneDragger - object you can translate or scale within a plane by dragging with the mouse
INHERITS FROM
SoBase > SoFieldContainer > SoNode > SoBaseKit > SoInteractionKit > SoDragger > SoTabPlaneDragger
SYNOPSIS
#include <Inventor/draggers/SoTabPlaneDragger.h>
Fields from class SoTabPlaneDragger:
c
}
c
}
scaleFactor
c
}
c
}
translation
Fields from class SoDragger:
c
}
c
}
isActive
Fields from class SoInteractionKit:
c
}
c
}
renderCaching
c
}
c
}
boundingBoxCaching
c
}
c
}
renderCulling
c
}
c
}
pickCulling
Parts from class SoBaseKit:
c
}
c
}
callbackList
Methods from class SoTabPlaneDragger:
c
}
c
}
SoTabPlaneDragger()
c
}
c
}
adjustScaleTabSize()
c
}
c
}
getClassNodekitCatalog() const
c
}
c
}
getClassTypeId()
Methods from class SoDragger:
c
}
c
}
addStartCallback(SoDraggerCB *f, void *userData = NULL)
c
}
c
}
removeStartCallback(SoDraggerCB *f, void *userData = NULL)
c
}
c
}
addMotionCallback(SoDraggerCB *f, void *userData = NULL)
c
}
c
}
removeMotionCallback(SoDraggerCB *f, void *userData = NULL)
c
}
c
}
addFinishCallback(SoDraggerCB *f, void *userData = NULL)
c
}
c
}
removeFinishCallback(SoDraggerCB *f, void *userData = NULL)
c
}
c
}
addValueChangedCallback(SoDraggerCB *f, void *userData = NULL)
c
}
c
}
removeValueChangedCallback(SoDraggerCB *f, void *userData = NULL)
c
}
c
}
enableValueChangedCallbacks()
c
}
c
}
setMinGesture(int pixels)
c
}
c
}
getMinGesture() const
c
}
c
}
setMinScale(float newMinScale)
c
}
c
}
getMinScale()
Methods from class SoInteractionKit:
c
}
c
}
setPartAsPath(const SbName &partName, SoPath *surrogatePath )
Methods from class SoBaseKit:
c
}
c
}
getNodekitCatalog() const
c
}
c
}
getPart(const SbName &partName, SbBool makeIfNeeded)
c
}
c
}
getPartString(const SoBase *part)
c
}
c
}
createPathToPart(const SbName &partName, SbBool makeIfNeeded, const SoPath *pathToExtend = NULL)
c
}
c
}
setPart(const SbName &partName, SoNode *newPart)
c
}
c
}
set(char *partName, char *parameters)
c
}
c
}
set(char *nameValuePairs)
c
}
c
}
isSearchingChildren()
c
}
c
}
setSearchingChildren(SbBool newVal)
Methods from class SoNode:
c
}
c
}
setOverride(SbBool state)
c
}
c
}
isOverride() const
c
}
c
}
copy(SbBool copyConnections = FALSE) const
c
}
c
}
affectsState() const
c
}
c
}
getByName(const SbName &name)
c
}
c
}
getByName(const SbName &name, SoNodeList &list)
Methods from class SoFieldContainer:
c
}
c
}
setToDefaults()
c
}
c
}
hasDefaultValues() const
c
}
c
}
fieldsAreEqual(const SoFieldContainer *fc) const
c
}
c
}
copyFieldValues(const SoFieldContainer *fc, SbBool copyConnections = FALSE)
c
}
c
}
get(SbString &fieldDataString)
c
}
c
}
getFields(SoFieldList &resultList) const
c
}
c
}
getField(const SbName &fieldName) const
c
}
c
}
getFieldName(const SoField *field, SbName &fieldName) const
c
}
c
}
isNotifyEnabled() const
c
}
c
}
enableNotify(SbBool flag)
Methods from class SoBase:
c
}
c
}
ref()
c
}
c
}
unref() const
c
}
c
}
unrefNoDelete() const
c
}
c
}
touch()
c
}
c
}
getTypeId() const
c
}
c
}
isOfType(SoType type) const
c
}
c
}
setName(const SbName &name)
c
}
c
}
getName() const
Macros from class SoBaseKit:
SO_GET_PART(kit, partName, partClass)
SO_CHECK_PART(kit, partName, partClass)
DESCRIPTION
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. Dragging an edge tab performs 1D scaling about the opposite edge. The rest of the dragger is invisible but pickable; selecting it initiates translation within the plane. The dragger tries to keep the small tabs a constant size in screen space. Every time a drag begins or ends, the size is recalculated based on the viewing and modeling matrix. 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 translation field. The various scaling parts cause changes to both the scaleFactor and 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 adjustScaleTabSize(). The 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 setPart(). You can make your program use different default resources for the parts by copying the file /usr/share/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.
FIELDS
c
}
c
}
scaleFactor
Scale factor affecting the dragger.
c
}
c
}
translation
Position of the dragger.
METHODS
c
}
c
}
SoTabPlaneDragger()
Constructor.
c
}
c
}
adjustScaleTabSize()
Cause the scale tab sizes to be re-adjusted so that they remain a near constant screen space size. This happens automatically upon dragger finish. Call this to adjust the scale tab sizes at other times,
for instance after the camera has changed in a viewer finish callback.
c
}
c
}
getClassNodekitCatalog() const
Returns an SoNodekitCatalog for this class
c
}
c
}
getClassTypeId()
Returns type identifier for this class.
CATALOG PARTS
box, tab(!); cb s s s lb lb lb lb lb lb lb lb l l l c. All parts !!!NULL by Part Name!Part Type!Default Type!Default
callbackList!NodeKitListPart!--!yes translator!Separator!--!yes scaleTabMaterial!Material!--!yes scaleTabHints!ShapeHints!--!yes
box, tab(!); cb s s lb lb lbw(3) l l l. Extra information for list parts from above table Part Name!Container Type!Permissible Types
callbackList!Separator!T{ Callback, EventCallback T}
DRAGGER RESOURCES
.in 0n+.5i
Resource: tabPlaneTranslator
.in 0n+.5i
Part: translator
Appearance: Outline of a Square. The region within it is pickable
Description: Begins translation within the plane
.in 0n+.5i
Resource: tabPlaneScaleTabMaterial
.in 0n+.5i
Part: scaleTabMaterial
Appearance: Green - half diffuse, half emissive.
Description: Used as material for scaling tabs.
.in 0n+.5i
Resource: tabPlaneScaleTabHints
.in 0n+.5i
Part: scaleTabHints
Appearance: shapeHints node:COUNTERCLOCKWISE/SOLID/CONVEX
Description: Property for the tab nodes.
FILE FORMAT/DEFAULTS
TabPlaneDragger {
renderCaching AUTO
boundingBoxCaching AUTO
renderCulling AUTO
pickCulling AUTO
isActive FALSE
translation 0 0 0
scaleFactor 1 1 1
callbackList NULL
translator <tabPlaneTranslator resource>
scaleTabMaterial <tabPlaneScaleTabMaterial resource>
scaleTabHints <tabPlaneScaleTabHints resource>
}
SEE ALSO
SoInteractionKit, SoDragger, SoCenterballDragger, SoDirectionalLightDragger, SoDragPointDragger, SoHandleBoxDragger, SoJackDragger, SoPointLightDragger, SoRotateCylindricalDragger, SoRotateDiscDragger, SoRotateSphericalDragger, SoScale1Dragger, SoScale2Dragger, SoScale2UniformDragger, SoScaleUniformDragger, SoSpotLightDragger, SoTabBoxDragger, SoTrackballDragger, SoTransformBoxDragger, SoTransformerDragger, SoTranslate1Dragger, SoTranslate2Dragger