.TH "SoDragger" 3 "Fri Sep 6 2024 15:32:06" "Version 4.0.3" "Coin" \" -*- nroff -*- .ad l .nh .SH NAME SoDragger \- The \fBSoDragger\fP class is the base class for all draggers\&. .SH SYNOPSIS .br .PP .PP \fR#include \fP .PP Inherits \fBSoInteractionKit\fP\&. .PP Inherited by \fBSoCenterballDragger\fP, \fBSoDirectionalLightDragger\fP, \fBSoDragPointDragger\fP, \fBSoHandleBoxDragger\fP, \fBSoJackDragger\fP, \fBSoPointLightDragger\fP, \fBSoRotateCylindricalDragger\fP, \fBSoRotateDiscDragger\fP, \fBSoRotateSphericalDragger\fP, \fBSoScale1Dragger\fP, \fBSoScale2Dragger\fP, \fBSoScale2UniformDragger\fP, \fBSoScaleUniformDragger\fP, \fBSoSpotLightDragger\fP, \fBSoTabBoxDragger\fP, \fBSoTabPlaneDragger\fP, \fBSoTrackballDragger\fP, \fBSoTransformBoxDragger\fP, \fBSoTransformerDragger\fP, \fBSoTranslate1Dragger\fP, and \fBSoTranslate2Dragger\fP\&. .SS "Public Types" .in +1c .ti -1c .RI "enum \fBProjectorFrontSetting\fP { \fBFRONT\fP, \fBBACK\fP, \fBUSE_PICK\fP }" .br .in -1c Public Types inherited from \fBSoInteractionKit\fP .in +1c .ti -1c .RI "enum \fBCacheEnabled\fP { \fBOFF\fP, \fBON\fP, \fBAUTO\fP }" .br .in -1c Public Types inherited from \fBSoNode\fP .in +1c .ti -1c .RI "enum \fBNodeType\fP { \fBINVENTOR\fP = 0x0000, \fBVRML1\fP = 0x0001, \fBVRML2\fP = 0x0002, \fBINVENTOR_1\fP = 0x0004, \fBINVENTOR_2_0\fP = 0x0008, \fBINVENTOR_2_1\fP = 0x0010, \fBINVENTOR_2_5\fP = 0x0020, \fBINVENTOR_2_6\fP = 0x0040, \fBCOIN_1_0\fP = 0x0080, \fBCOIN_2_0\fP = 0x0100, \fBEXTENSION\fP = 0x0200, \fBCOIN_2_2\fP = 0x0400, \fBCOIN_2_3\fP = 0x0800, \fBCOIN_2_4\fP = 0x1000, \fBINVENTOR_5_0\fP = 0x2000, \fBCOIN_2_5\fP = 0x4000, \fBCOIN_3_0\fP = 0x8000, \fBINVENTOR_6_0\fP = 0x10000, \fBCOIN_4_0\fP = 0x20000 }" .br .in -1c .SS "Public Member Functions" .in +1c .ti -1c .RI "virtual \fBSoType\fP \fBgetTypeId\fP (void) const" .br .ti -1c .RI "virtual const \fBSoNodekitCatalog\fP * \fBgetNodekitCatalog\fP (void) const" .br .ti -1c .RI "virtual void \fBcallback\fP (\fBSoCallbackAction\fP *action)" .br .ti -1c .RI "virtual void \fBGLRender\fP (\fBSoGLRenderAction\fP *action)" .br .ti -1c .RI "virtual void \fBgetMatrix\fP (\fBSoGetMatrixAction\fP *action)" .br .ti -1c .RI "virtual void \fBrayPick\fP (\fBSoRayPickAction\fP *action)" .br .ti -1c .RI "virtual void \fBsearch\fP (\fBSoSearchAction\fP *action)" .br .ti -1c .RI "virtual void \fBwrite\fP (\fBSoWriteAction\fP *action)" .br .ti -1c .RI "virtual void \fBgetPrimitiveCount\fP (\fBSoGetPrimitiveCountAction\fP *action)" .br .ti -1c .RI "void \fBsetProjectorEpsilon\fP (const float epsilon)" .br .ti -1c .RI "float \fBgetProjectorEpsilon\fP (void) const" .br .ti -1c .RI "void \fBaddStartCallback\fP (SoDraggerCB *func, void *data=NULL)" .br .ti -1c .RI "void \fBremoveStartCallback\fP (SoDraggerCB *func, void *data=NULL)" .br .ti -1c .RI "void \fBaddMotionCallback\fP (SoDraggerCB *func, void *data=NULL)" .br .ti -1c .RI "void \fBremoveMotionCallback\fP (SoDraggerCB *func, void *data=NULL)" .br .ti -1c .RI "void \fBaddFinishCallback\fP (SoDraggerCB *func, void *data=NULL)" .br .ti -1c .RI "void \fBremoveFinishCallback\fP (SoDraggerCB *func, void *data=NULL)" .br .ti -1c .RI "void \fBaddValueChangedCallback\fP (SoDraggerCB *func, void *data=NULL)" .br .ti -1c .RI "void \fBremoveValueChangedCallback\fP (SoDraggerCB *func, void *data=NULL)" .br .ti -1c .RI "void \fBsetMinGesture\fP (int pixels)" .br .ti -1c .RI "int \fBgetMinGesture\fP (void) const" .br .ti -1c .RI "SbBool \fBenableValueChangedCallbacks\fP (SbBool newval)" .br .ti -1c .RI "const \fBSbMatrix\fP & \fBgetMotionMatrix\fP (void)" .br .ti -1c .RI "void \fBaddOtherEventCallback\fP (SoDraggerCB *func, void *data=NULL)" .br .ti -1c .RI "void \fBremoveOtherEventCallback\fP (SoDraggerCB *func, void *data=NULL)" .br .ti -1c .RI "void \fBregisterChildDragger\fP (\fBSoDragger\fP *child)" .br .ti -1c .RI "void \fBunregisterChildDragger\fP (\fBSoDragger\fP *child)" .br .ti -1c .RI "void \fBregisterChildDraggerMovingIndependently\fP (\fBSoDragger\fP *child)" .br .ti -1c .RI "void \fBunregisterChildDraggerMovingIndependently\fP (\fBSoDragger\fP *child)" .br .ti -1c .RI "\fBSbMatrix\fP \fBgetLocalToWorldMatrix\fP (void)" .br .ti -1c .RI "\fBSbMatrix\fP \fBgetWorldToLocalMatrix\fP (void)" .br .ti -1c .RI "\fBSbVec3f\fP \fBgetLocalStartingPoint\fP (void)" .br .ti -1c .RI "\fBSbVec3f\fP \fBgetWorldStartingPoint\fP (void)" .br .ti -1c .RI "void \fBgetPartToLocalMatrix\fP (const \fBSbName\fP &partname, \fBSbMatrix\fP &parttolocalmatrix, \fBSbMatrix\fP &localtopartmatrix)" .br .ti -1c .RI "void \fBtransformMatrixLocalToWorld\fP (const \fBSbMatrix\fP &frommatrix, \fBSbMatrix\fP &tomatrix)" .br .ti -1c .RI "void \fBtransformMatrixWorldToLocal\fP (const \fBSbMatrix\fP &frommatrix, \fBSbMatrix\fP &tomatrix)" .br .ti -1c .RI "void \fBtransformMatrixToLocalSpace\fP (const \fBSbMatrix\fP &frommatrix, \fBSbMatrix\fP &tomatrix, const \fBSbName\fP &fromspacepartname)" .br .ti -1c .RI "virtual void \fBsetMotionMatrix\fP (const \fBSbMatrix\fP &newmatrix)" .br .ti -1c .RI "void \fBvalueChanged\fP (void)" .br .ti -1c .RI "const \fBSbMatrix\fP & \fBgetStartMotionMatrix\fP (void)" .br .ti -1c .RI "virtual void \fBsaveStartParameters\fP (void)" .br .ti -1c .RI "const \fBSoPath\fP * \fBgetPickPath\fP (void) const" .br .ti -1c .RI "const \fBSoEvent\fP * \fBgetEvent\fP (void) const" .br .ti -1c .RI "\fBSoPath\fP * \fBcreatePathToThis\fP (void)" .br .ti -1c .RI "const \fBSoPath\fP * \fBgetSurrogatePartPickedOwner\fP (void) const" .br .ti -1c .RI "const \fBSbName\fP & \fBgetSurrogatePartPickedName\fP (void) const" .br .ti -1c .RI "const \fBSoPath\fP * \fBgetSurrogatePartPickedPath\fP (void) const" .br .ti -1c .RI "void \fBsetStartingPoint\fP (const \fBSoPickedPoint\fP *newpoint)" .br .ti -1c .RI "void \fBsetStartingPoint\fP (const \fBSbVec3f\fP &newpoint)" .br .ti -1c .RI "const \fBSbViewVolume\fP & \fBgetViewVolume\fP (void)" .br .ti -1c .RI "void \fBsetViewVolume\fP (const \fBSbViewVolume\fP &vol)" .br .ti -1c .RI "const \fBSbViewportRegion\fP & \fBgetViewportRegion\fP (void)" .br .ti -1c .RI "void \fBsetViewportRegion\fP (const \fBSbViewportRegion\fP ®)" .br .ti -1c .RI "\fBSoHandleEventAction\fP * \fBgetHandleEventAction\fP (void) const" .br .ti -1c .RI "void \fBsetHandleEventAction\fP (\fBSoHandleEventAction\fP *newAction)" .br .ti -1c .RI "void \fBsetTempPathToThis\fP (const \fBSoPath\fP *somethingclose)" .br .ti -1c .RI "virtual void \fBgrabEventsSetup\fP (void)" .br .ti -1c .RI "virtual void \fBgrabEventsCleanup\fP (void)" .br .ti -1c .RI "void \fBworkFieldsIntoTransform\fP (\fBSbMatrix\fP &mtx)" .br .ti -1c .RI "void \fBsetFrontOnProjector\fP (\fBProjectorFrontSetting\fP newval)" .br .ti -1c .RI "\fBProjectorFrontSetting\fP \fBgetFrontOnProjector\fP (void) const" .br .in -1c Public Member Functions inherited from \fBSoInteractionKit\fP .in +1c .ti -1c .RI "\fBSoInteractionKit\fP (void)" .br .ti -1c .RI "virtual SbBool \fBsetPartAsPath\fP (const \fBSbName\fP &partname, \fBSoPath\fP *path)" .br .ti -1c .RI "virtual SbBool \fBsetPartAsDefault\fP (const \fBSbName\fP &partname, \fBSoNode\fP *node, SbBool onlyifdefault=TRUE)" .br .ti -1c .RI "virtual SbBool \fBsetPartAsDefault\fP (const \fBSbName\fP &partname, const \fBSbName\fP &nodename, SbBool onlyifdefault=TRUE)" .br .ti -1c .RI "SbBool \fBisPathSurrogateInMySubgraph\fP (const \fBSoPath\fP *path, \fBSoPath\fP *&pathToOwner, \fBSbName\fP &surrogatename, \fBSoPath\fP *&surrogatepath, SbBool fillargs=TRUE)" .br .ti -1c .RI "SbBool \fBisPathSurrogateInMySubgraph\fP (const \fBSoPath\fP *path)" .br .ti -1c .RI "virtual SbBool \fBsetPart\fP (const \fBSbName\fP &partname, \fBSoNode\fP *from)" .br .in -1c Public Member Functions inherited from \fBSoBaseKit\fP .in +1c .ti -1c .RI "\fBSoBaseKit\fP (void)" .br .ti -1c .RI "virtual \fBSoNode\fP * \fBgetPart\fP (const \fBSbName\fP &partname, SbBool makeifneeded)" .br .ti -1c .RI "\fBSbString\fP \fBgetPartString\fP (const \fBSoBase\fP *part)" .br .ti -1c .RI "virtual \fBSoNodeKitPath\fP * \fBcreatePathToPart\fP (const \fBSbName\fP &partname, SbBool makeifneeded, const \fBSoPath\fP *pathtoextend=NULL)" .br .ti -1c .RI "SbBool \fBset\fP (const char *namevaluepairliststring)" .br .ti -1c .RI "SbBool \fBset\fP (const char *partnamestring, const char *parameterstring)" .br .ti -1c .RI "virtual void \fBdoAction\fP (\fBSoAction\fP *action)" .br .ti -1c .RI "virtual \fBSoChildList\fP * \fBgetChildren\fP (void) const" .br .ti -1c .RI "void \fBprintDiagram\fP (void)" .br .ti -1c .RI "void \fBprintSubDiagram\fP (const \fBSbName\fP &rootname, int level)" .br .ti -1c .RI "void \fBprintTable\fP (void)" .br .ti -1c .RI "virtual void \fBaddWriteReference\fP (\fBSoOutput\fP *out, SbBool isfromfield=FALSE)" .br .ti -1c .RI "SbBool \fBforceChildDrivenWriteRefs\fP (\fBSoOutput\fP *out)" .br .in -1c Public Member Functions inherited from \fBSoNode\fP .in +1c .ti -1c .RI "void \fBsetOverride\fP (const SbBool state)" .br .ti -1c .RI "SbBool \fBisOverride\fP (void) const" .br .ti -1c .RI "void \fBsetNodeType\fP (const \fBNodeType\fP type)" .br .ti -1c .RI "\fBNodeType\fP \fBgetNodeType\fP (void) const" .br .ti -1c .RI "virtual \fBSoNode\fP * \fBcopy\fP (SbBool copyconnections=FALSE) const" .br .ti -1c .RI "virtual SbBool \fBaffectsState\fP (void) const" .br .ti -1c .RI "virtual void \fBGLRenderBelowPath\fP (\fBSoGLRenderAction\fP *action)" .br .ti -1c .RI "virtual void \fBGLRenderInPath\fP (\fBSoGLRenderAction\fP *action)" .br .ti -1c .RI "virtual void \fBGLRenderOffPath\fP (\fBSoGLRenderAction\fP *action)" .br .ti -1c .RI "virtual void \fBpick\fP (\fBSoPickAction\fP *action)" .br .ti -1c .RI "virtual void \fBaudioRender\fP (\fBSoAudioRenderAction\fP *action)" .br .ti -1c .RI "virtual void \fBstartNotify\fP (void)" .br .ti -1c .RI "virtual void \fBnotify\fP (\fBSoNotList\fP *l)" .br .ti -1c .RI "SbUniqueId \fBgetNodeId\fP (void) const" .br .ti -1c .RI "virtual void \fBwriteInstance\fP (\fBSoOutput\fP *out)" .br .ti -1c .RI "virtual \fBSoFieldContainer\fP * \fBcopyThroughConnection\fP (void) const" .br .in -1c Public Member Functions inherited from \fBSoFieldContainer\fP .in +1c .ti -1c .RI "void \fBsetToDefaults\fP (void)" .br .ti -1c .RI "SbBool \fBhasDefaultValues\fP (void) const" .br .ti -1c .RI "SbBool \fBfieldsAreEqual\fP (const \fBSoFieldContainer\fP *container) const" .br .ti -1c .RI "void \fBcopyFieldValues\fP (const \fBSoFieldContainer\fP *container, SbBool copyconnections=FALSE)" .br .ti -1c .RI "SbBool \fBset\fP (const char *const fielddata)" .br .ti -1c .RI "void \fBget\fP (\fBSbString\fP &fielddata)" .br .ti -1c .RI "virtual int \fBgetFields\fP (\fBSoFieldList\fP &l) const" .br .ti -1c .RI "virtual int \fBgetAllFields\fP (\fBSoFieldList\fP &l) const" .br .ti -1c .RI "virtual \fBSoField\fP * \fBgetField\fP (const \fBSbName\fP &name) const" .br .ti -1c .RI "virtual \fBSoField\fP * \fBgetEventIn\fP (const \fBSbName\fP &name) const" .br .ti -1c .RI "virtual \fBSoField\fP * \fBgetEventOut\fP (const \fBSbName\fP &name) const" .br .ti -1c .RI "SbBool \fBgetFieldName\fP (const \fBSoField\fP *const field, \fBSbName\fP &name) const" .br .ti -1c .RI "SbBool \fBenableNotify\fP (const SbBool flag)" .br .ti -1c .RI "SbBool \fBisNotifyEnabled\fP (void) const" .br .ti -1c .RI "SbBool \fBset\fP (const char *fielddata, \fBSoInput\fP *input)" .br .ti -1c .RI "void \fBget\fP (\fBSbString\fP &fielddata, \fBSoOutput\fP *out)" .br .ti -1c .RI "virtual SbBool \fBvalidateNewFieldValue\fP (\fBSoField\fP *field, void *newval)" .br .ti -1c .RI "SbBool \fBgetIsBuiltIn\fP (void) const" .br .ti -1c .RI "virtual void \fBgetFieldsMemorySize\fP (size_t &managed, size_t &unmanaged) const" .br .ti -1c .RI "void \fBsetUserData\fP (void *userdata) const" .br .ti -1c .RI "void * \fBgetUserData\fP (void) const" .br .in -1c Public Member Functions inherited from \fBSoBase\fP .in +1c .ti -1c .RI "void \fBref\fP (void) const" .br .ti -1c .RI "void \fBunref\fP (void) const" .br .ti -1c .RI "void \fBunrefNoDelete\fP (void) const" .br .ti -1c .RI "int32_t \fBgetRefCount\fP (void) const" .br .ti -1c .RI "void \fBtouch\fP (void)" .br .ti -1c .RI "SbBool \fBisOfType\fP (\fBSoType\fP type) const" .br .RI "Returns \fRTRUE\fP if the type of this object is either of the same type or inherited from \fItype\fP\&. " .ti -1c .RI "virtual \fBSbName\fP \fBgetName\fP (void) const" .br .ti -1c .RI "virtual void \fBsetName\fP (const \fBSbName\fP &newname)" .br .ti -1c .RI "void \fBaddAuditor\fP (void *const auditor, const \fBSoNotRec::Type\fP type)" .br .ti -1c .RI "void \fBremoveAuditor\fP (void *const auditor, const \fBSoNotRec::Type\fP type)" .br .ti -1c .RI "const \fBSoAuditorList\fP & \fBgetAuditors\fP (void) const" .br .ti -1c .RI "SbBool \fBshouldWrite\fP (void)" .br .ti -1c .RI "void \fBassertAlive\fP (void) const" .br .in -1c .SS "Static Public Member Functions" .in +1c .ti -1c .RI "static \fBSoType\fP \fBgetClassTypeId\fP (void)" .br .ti -1c .RI "static const \fBSoNodekitCatalog\fP * \fBgetClassNodekitCatalog\fP (void)" .br .ti -1c .RI "static void \fBsetMinScale\fP (float newminscale)" .br .ti -1c .RI "static float \fBgetMinScale\fP (void)" .br .ti -1c .RI "static void \fBworkValuesIntoTransform\fP (\fBSbMatrix\fP &mtx, const \fBSbVec3f\fP *translationptr, const \fBSbRotation\fP *rotationptr, const \fBSbVec3f\fP *scalefactorptr, const \fBSbRotation\fP *scaleorientationptr, const \fBSbVec3f\fP *centerptr)" .br .ti -1c .RI "static void \fBgetTransformFast\fP (\fBSbMatrix\fP &mtx, \fBSbVec3f\fP &translation, \fBSbRotation\fP &rotation, \fBSbVec3f\fP &scalefactor, \fBSbRotation\fP &scaleorientation, const \fBSbVec3f\fP ¢er)" .br .ti -1c .RI "static void \fBgetTransformFast\fP (\fBSbMatrix\fP &mtx, \fBSbVec3f\fP &translation, \fBSbRotation\fP &rotation, \fBSbVec3f\fP &scalefactor, \fBSbRotation\fP &scaleorientation)" .br .ti -1c .RI "static \fBSbMatrix\fP \fBappendTranslation\fP (const \fBSbMatrix\fP &mtx, const \fBSbVec3f\fP &translation, const \fBSbMatrix\fP *conversion=NULL)" .br .ti -1c .RI "static \fBSbMatrix\fP \fBappendScale\fP (const \fBSbMatrix\fP &mtx, const \fBSbVec3f\fP &scale, const \fBSbVec3f\fP &scalecenter, const \fBSbMatrix\fP *conversion=NULL)" .br .ti -1c .RI "static \fBSbMatrix\fP \fBappendRotation\fP (const \fBSbMatrix\fP &mtx, const \fBSbRotation\fP &rot, const \fBSbVec3f\fP &rotcenter, const \fBSbMatrix\fP *conversion=NULL)" .br .ti -1c .RI "static void \fBinitClass\fP (void)" .br .ti -1c .RI "static void \fBinitClasses\fP (void)" .br .in -1c Static Public Member Functions inherited from \fBSoInteractionKit\fP .in +1c .ti -1c .RI "static \fBSoType\fP \fBgetClassTypeId\fP (void)" .br .ti -1c .RI "static const \fBSoNodekitCatalog\fP * \fBgetClassNodekitCatalog\fP (void)" .br .ti -1c .RI "static void \fBinitClass\fP (void)" .br .RI "Sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system\&. " .ti -1c .RI "static void \fBsetSwitchValue\fP (\fBSoNode\fP *node, const int newVal)" .br .in -1c Static Public Member Functions inherited from \fBSoBaseKit\fP .in +1c .ti -1c .RI "static \fBSoType\fP \fBgetClassTypeId\fP (void)" .br .ti -1c .RI "static void \fBinitClass\fP (void)" .br .ti -1c .RI "static const \fBSoNodekitCatalog\fP * \fBgetClassNodekitCatalog\fP (void)" .br .ti -1c .RI "static SbBool \fBisSearchingChildren\fP (void)" .br .ti -1c .RI "static void \fBsetSearchingChildren\fP (const SbBool newval)" .br .in -1c Static Public Member Functions inherited from \fBSoNode\fP .in +1c .ti -1c .RI "static uint32_t \fBgetCompatibilityTypes\fP (const \fBSoType\fP &nodetype)" .br .ti -1c .RI "static \fBSoType\fP \fBgetClassTypeId\fP (void)" .br .ti -1c .RI "static \fBSoNode\fP * \fBgetByName\fP (const \fBSbName\fP &name)" .br .ti -1c .RI "static int \fBgetByName\fP (const \fBSbName\fP &name, \fBSoNodeList\fP &l)" .br .ti -1c .RI "static void \fBinitClass\fP (void)" .br .RI "Sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system\&. " .ti -1c .RI "static void \fBinitClasses\fP (void)" .br .ti -1c .RI "static SbUniqueId \fBgetNextNodeId\fP (void)" .br .ti -1c .RI "static int \fBgetActionMethodIndex\fP (const \fBSoType\fP type)" .br .ti -1c .RI "static void \fBgetBoundingBoxS\fP (\fBSoAction\fP *action, \fBSoNode\fP *node)" .br .ti -1c .RI "static void \fBGLRenderS\fP (\fBSoAction\fP *action, \fBSoNode\fP *node)" .br .ti -1c .RI "static void \fBcallbackS\fP (\fBSoAction\fP *action, \fBSoNode\fP *node)" .br .ti -1c .RI "static void \fBgetMatrixS\fP (\fBSoAction\fP *action, \fBSoNode\fP *node)" .br .ti -1c .RI "static void \fBhandleEventS\fP (\fBSoAction\fP *action, \fBSoNode\fP *node)" .br .ti -1c .RI "static void \fBpickS\fP (\fBSoAction\fP *action, \fBSoNode\fP *node)" .br .ti -1c .RI "static void \fBrayPickS\fP (\fBSoAction\fP *action, \fBSoNode\fP *node)" .br .ti -1c .RI "static void \fBsearchS\fP (\fBSoAction\fP *action, \fBSoNode\fP *node)" .br .ti -1c .RI "static void \fBwriteS\fP (\fBSoAction\fP *action, \fBSoNode\fP *node)" .br .ti -1c .RI "static void \fBaudioRenderS\fP (\fBSoAction\fP *action, \fBSoNode\fP *node)" .br .ti -1c .RI "static void \fBgetPrimitiveCountS\fP (\fBSoAction\fP *action, \fBSoNode\fP *node)" .br .in -1c Static Public Member Functions inherited from \fBSoFieldContainer\fP .in +1c .ti -1c .RI "static void \fBinitClass\fP (void)" .br .RI "Sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system\&. " .ti -1c .RI "static \fBSoType\fP \fBgetClassTypeId\fP (void)" .br .RI "This static method returns the \fBSoType\fP object associated with objects of this class\&. " .ti -1c .RI "static void \fBcleanupClass\fP (void)" .br .ti -1c .RI "static void \fBinitCopyDict\fP (void)" .br .ti -1c .RI "static void \fBaddCopy\fP (const \fBSoFieldContainer\fP *orig, const \fBSoFieldContainer\fP *copy)" .br .ti -1c .RI "static \fBSoFieldContainer\fP * \fBcheckCopy\fP (const \fBSoFieldContainer\fP *orig)" .br .ti -1c .RI "static \fBSoFieldContainer\fP * \fBfindCopy\fP (const \fBSoFieldContainer\fP *orig, const SbBool copyconnections)" .br .ti -1c .RI "static void \fBcopyDone\fP (void)" .br .in -1c Static Public Member Functions inherited from \fBSoBase\fP .in +1c .ti -1c .RI "static void \fBinitClass\fP (void)" .br .RI "Sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system\&. " .ti -1c .RI "static \fBSoType\fP \fBgetClassTypeId\fP (void)" .br .RI "This static method returns the \fBSoType\fP object associated with objects of this class\&. " .ti -1c .RI "static void \fBaddName\fP (\fBSoBase\fP *const base, const char *const name)" .br .ti -1c .RI "static void \fBremoveName\fP (\fBSoBase\fP *const base, const char *const name)" .br .ti -1c .RI "static void \fBincrementCurrentWriteCounter\fP (void)" .br .ti -1c .RI "static void \fBdecrementCurrentWriteCounter\fP (void)" .br .ti -1c .RI "static \fBSoBase\fP * \fBgetNamedBase\fP (const \fBSbName\fP &name, \fBSoType\fP type)" .br .ti -1c .RI "static int \fBgetNamedBases\fP (const \fBSbName\fP &name, \fBSoBaseList\fP &baselist, \fBSoType\fP type)" .br .ti -1c .RI "static SbBool \fBread\fP (\fBSoInput\fP *input, \fBSoBase\fP *&base, \fBSoType\fP expectedtype)" .br .ti -1c .RI "static void \fBsetInstancePrefix\fP (const \fBSbString\fP &c)" .br .ti -1c .RI "static void \fBsetTraceRefs\fP (SbBool trace)" .br .ti -1c .RI "static SbBool \fBgetTraceRefs\fP (void)" .br .ti -1c .RI "static SbBool \fBconnectRoute\fP (\fBSoInput\fP *input, const \fBSbName\fP &fromnodename, const \fBSbName\fP &fromfieldname, const \fBSbName\fP &tonodename, const \fBSbName\fP &tofieldname)" .br .ti -1c .RI "static SbBool \fBreadRoute\fP (\fBSoInput\fP *input)" .br .in -1c .SS "Public Attributes" .in +1c .ti -1c .RI "\fBSoSFBool\fP \fBisActive\fP" .br .in -1c Public Attributes inherited from \fBSoInteractionKit\fP .in +1c .ti -1c .RI "\fBSoSFEnum\fP \fBrenderCaching\fP" .br .ti -1c .RI "\fBSoSFEnum\fP \fBboundingBoxCaching\fP" .br .ti -1c .RI "\fBSoSFEnum\fP \fBrenderCulling\fP" .br .ti -1c .RI "\fBSoSFEnum\fP \fBpickCulling\fP" .br .in -1c Public Attributes inherited from \fBSoBase\fP .SS "Protected Member Functions" .in +1c .ti -1c .RI "virtual const \fBSoFieldData\fP * \fBgetFieldData\fP (void) const" .br .ti -1c .RI "\fBSoDragger\fP (void)" .br .ti -1c .RI "virtual \fB~SoDragger\fP (void)" .br .ti -1c .RI "\fBSbVec2f\fP \fBgetNormalizedLocaterPosition\fP (void)" .br .ti -1c .RI "\fBSbVec2s\fP \fBgetLocaterPosition\fP (void)" .br .ti -1c .RI "\fBSbVec2s\fP \fBgetStartLocaterPosition\fP (void) const" .br .ti -1c .RI "void \fBsetStartLocaterPosition\fP (\fBSbVec2s\fP p)" .br .ti -1c .RI "SbBool \fBisAdequateConstraintMotion\fP (void)" .br .ti -1c .RI "virtual SbBool \fBshouldGrabBasedOnSurrogate\fP (const \fBSoPath\fP *pickpath, const \fBSoPath\fP *surrogatepath)" .br .ti -1c .RI "void \fBsetCameraInfo\fP (\fBSoAction\fP *action)" .br .ti -1c .RI "virtual void \fBhandleEvent\fP (\fBSoHandleEventAction\fP *ha)" .br .ti -1c .RI "void \fBtransferMotion\fP (\fBSoDragger\fP *child)" .br .ti -1c .RI "void \fBsetIgnoreInBbox\fP (SbBool newval)" .br .ti -1c .RI "SbBool \fBisIgnoreInBbox\fP (void)" .br .ti -1c .RI "virtual void \fBgetBoundingBox\fP (\fBSoGetBoundingBoxAction\fP *action)" .br .ti -1c .RI "void \fBsetActiveChildDragger\fP (\fBSoDragger\fP *newchilddragger)" .br .ti -1c .RI "\fBSoDragger\fP * \fBgetActiveChildDragger\fP (void) const" .br .ti -1c .RI "virtual void \fBsetDefaultOnNonWritingFields\fP (void)" .br .ti -1c .RI "void \fBupdateDraggerCache\fP (const \fBSoPath\fP *path)" .br .ti -1c .RI "virtual const \fBSoPickedPoint\fP * \fBgetPickedPointForStart\fP (\fBSoHandleEventAction\fP *action)" .br .in -1c Protected Member Functions inherited from \fBSoInteractionKit\fP .in +1c .ti -1c .RI "virtual \fB~SoInteractionKit\fP ()" .br .ti -1c .RI "virtual void \fBcopyContents\fP (const \fBSoFieldContainer\fP *fromFC, SbBool copyConnections)" .br .ti -1c .RI "virtual SbBool \fBsetPart\fP (const int partNum, \fBSoNode\fP *node)" .br .ti -1c .RI "virtual SbBool \fBreadInstance\fP (\fBSoInput\fP *in, unsigned short flags)" .br .ti -1c .RI "virtual SbBool \fBsetAnyPartAsDefault\fP (const \fBSbName\fP &partname, \fBSoNode\fP *node, SbBool anypart=TRUE, SbBool onlyifdefault=TRUE)" .br .ti -1c .RI "virtual SbBool \fBsetAnyPartAsDefault\fP (const \fBSbName\fP &partname, const \fBSbName\fP &nodename, SbBool anypart=TRUE, SbBool onlyifdefault=TRUE)" .br .ti -1c .RI "SbBool \fBsetAnySurrogatePath\fP (const \fBSbName\fP &name, \fBSoPath\fP *path, SbBool leafcheck=FALSE, SbBool publiccheck=FALSE)" .br .ti -1c .RI "virtual SbBool \fBsetUpConnections\fP (SbBool onoff, SbBool doitalways=FALSE)" .br .ti -1c .RI "void \fBconnectSeparatorFields\fP (\fBSoSeparator\fP *dest, SbBool onOff)" .br .in -1c Protected Member Functions inherited from \fBSoBaseKit\fP .in +1c .ti -1c .RI "virtual \fB~SoBaseKit\fP ()" .br .ti -1c .RI "virtual \fBSoNode\fP * \fBaddToCopyDict\fP (void) const" .br .ti -1c .RI "\fBSoGroup\fP * \fBgetContainerNode\fP (const \fBSbName\fP &listname, SbBool makeifneeded=TRUE)" .br .ti -1c .RI "virtual \fBSoNode\fP * \fBgetAnyPart\fP (const \fBSbName\fP &partname, SbBool makeifneeded, SbBool leafcheck=FALSE, SbBool publiccheck=FALSE)" .br .ti -1c .RI "virtual \fBSoNodeKitPath\fP * \fBcreatePathToAnyPart\fP (const \fBSbName\fP &partname, SbBool makeifneeded, SbBool leafcheck=FALSE, SbBool publiccheck=FALSE, const \fBSoPath\fP *pathtoextend=NULL)" .br .ti -1c .RI "virtual SbBool \fBsetAnyPart\fP (const \fBSbName\fP &partname, \fBSoNode\fP *from, SbBool anypart=TRUE)" .br .ti -1c .RI "void \fBcreateNodekitPartsList\fP (void)" .br .ti -1c .RI "void \fBcreateFieldList\fP (void)" .br .ti -1c .RI "virtual void \fBcreateDefaultParts\fP (void)" .br .ti -1c .RI "const SoNodekitParts * \fBgetNodekitPartsList\fP (void) const" .br .ti -1c .RI "const \fBSbList\fP< \fBSoSFNode\fP * > & \fBgetCatalogInstances\fP (void) const" .br .ti -1c .RI "void \fBcatalogError\fP (void)" .br .ti -1c .RI "void \fBcountMyFields\fP (\fBSoOutput\fP *out)" .br .in -1c Protected Member Functions inherited from \fBSoNode\fP .in +1c .ti -1c .RI "\fBSoNode\fP (void)" .br .ti -1c .RI "virtual \fB~SoNode\fP ()" .br .in -1c Protected Member Functions inherited from \fBSoFieldContainer\fP .in +1c .ti -1c .RI "\fBSoFieldContainer\fP (void)" .br .ti -1c .RI "virtual \fB~SoFieldContainer\fP ()" .br .in -1c Protected Member Functions inherited from \fBSoBase\fP .in +1c .ti -1c .RI "\fBSoBase\fP (void)" .br .ti -1c .RI "virtual \fB~SoBase\fP ()" .br .ti -1c .RI "virtual void \fBdestroy\fP (void)" .br .ti -1c .RI "SbBool \fBhasMultipleWriteRefs\fP (void) const" .br .ti -1c .RI "SbBool \fBwriteHeader\fP (\fBSoOutput\fP *out, SbBool isgroup, SbBool isengine) const" .br .ti -1c .RI "void \fBwriteFooter\fP (\fBSoOutput\fP *out) const" .br .ti -1c .RI "virtual const char * \fBgetFileFormatName\fP (void) const" .br .ti -1c .RI "virtual \fBSoNotRec\fP \fBcreateNotRec\fP (void)" .br .in -1c .SS "Static Protected Member Functions" .in +1c .ti -1c .RI "static const \fBSoFieldData\fP ** \fBgetFieldDataPtr\fP (void)" .br .ti -1c .RI "static const \fBSoNodekitCatalog\fP ** \fBgetClassNodekitCatalogPtr\fP (void)" .br .ti -1c .RI "static void \fBchildTransferMotionAndValueChangedCB\fP (void *, \fBSoDragger\fP *)" .br .ti -1c .RI "static void \fBchildValueChangedCB\fP (void *, \fBSoDragger\fP *)" .br .ti -1c .RI "static void \fBchildStartCB\fP (void *, \fBSoDragger\fP *)" .br .ti -1c .RI "static void \fBchildMotionCB\fP (void *, \fBSoDragger\fP *)" .br .ti -1c .RI "static void \fBchildFinishCB\fP (void *, \fBSoDragger\fP *)" .br .ti -1c .RI "static void \fBchildOtherEventCB\fP (void *, \fBSoDragger\fP *)" .br .in -1c Static Protected Member Functions inherited from \fBSoInteractionKit\fP .in +1c .ti -1c .RI "static const \fBSoFieldData\fP ** \fBgetFieldDataPtr\fP (void)" .br .ti -1c .RI "static const \fBSoNodekitCatalog\fP ** \fBgetClassNodekitCatalogPtr\fP (void)" .br .ti -1c .RI "static void \fBreadDefaultParts\fP (const char *fileName, const char defaultBuffer[], int defBufSize)" .br .ti -1c .RI "static void \fBfieldSensorCB\fP (void *, \fBSoSensor\fP *)" .br .in -1c Static Protected Member Functions inherited from \fBSoBaseKit\fP .in +1c .ti -1c .RI "static const \fBSoFieldData\fP ** \fBgetFieldDataPtr\fP (void)" .br .ti -1c .RI "static const \fBSoNodekitCatalog\fP ** \fBgetClassNodekitCatalogPtr\fP (void)" .br .in -1c Static Protected Member Functions inherited from \fBSoNode\fP .in +1c .ti -1c .RI "static const \fBSoFieldData\fP ** \fBgetFieldDataPtr\fP (void)" .br .ti -1c .RI "static void \fBsetNextActionMethodIndex\fP (int index)" .br .ti -1c .RI "static int \fBgetNextActionMethodIndex\fP (void)" .br .ti -1c .RI "static void \fBincNextActionMethodIndex\fP (void)" .br .ti -1c .RI "static void \fBsetCompatibilityTypes\fP (const \fBSoType\fP &nodetype, const uint32_t bitmask)" .br .in -1c Static Protected Member Functions inherited from \fBSoBase\fP .in +1c .ti -1c .RI "static uint32_t \fBgetCurrentWriteCounter\fP (void)" .br .ti -1c .RI "static void \fBstaticDataLock\fP (void)" .br .ti -1c .RI "static void \fBstaticDataUnlock\fP (void)" .br .in -1c .SS "Protected Attributes" .in +1c .ti -1c .RI "\fBSoSFNode\fP \fBmotionMatrix\fP" .br .in -1c Protected Attributes inherited from \fBSoInteractionKit\fP .in +1c .ti -1c .RI "\fBSoSFNode\fP \fBgeomSeparator\fP" .br .ti -1c .RI "\fBSoSFNode\fP \fBtopSeparator\fP" .br .ti -1c .RI "\fBSoFieldSensor\fP * \fBfieldSensor\fP" .br .ti -1c .RI "\fBSoSeparator\fP * \fBoldTopSep\fP" .br .in -1c Protected Attributes inherited from \fBSoBaseKit\fP .in +1c .ti -1c .RI "\fBSoSFNode\fP \fBcallbackList\fP" .br .ti -1c .RI "\fBSoChildList\fP * \fBchildren\fP" .br .ti -1c .RI "SbBool \fBconnectionsSetUp\fP" .br .in -1c Protected Attributes inherited from \fBSoNode\fP .in +1c .ti -1c .RI "SbUniqueId \fBuniqueId\fP" .br .in -1c Protected Attributes inherited from \fBSoFieldContainer\fP .in +1c .ti -1c .RI "SbBool \fBisBuiltIn\fP" .br .in -1c .SS "Additional Inherited Members" Protected Types inherited from \fBSoBase\fP .in +1c .ti -1c .RI "enum \fBBaseFlags\fP { \fBIS_ENGINE\fP = 0x01, \fBIS_GROUP\fP = 0x02 }" .br .in -1c Static Protected Attributes inherited from \fBSoNode\fP .in +1c .ti -1c .RI "static SbUniqueId \fBnextUniqueId\fP = 1" .br .ti -1c .RI "static int \fBnextActionMethodIndex\fP = 0" .br .in -1c .SH "Detailed Description" .PP The \fBSoDragger\fP class is the base class for all draggers\&. Draggers is a mechanism used for letting the end-users of your application code interact with elements in 3D, by scaling, rotating or translating geometry or other instances in the scene (like cameras or light sources)\&. .PP For a very thorough introduction and tutorial to the dragger classes and general concepts, we advise you to consult The Inventor Mentor, ISBN 0-201-62495-8, chapter 15\&. .PP This is the common superclass for all dragger classes\&. .PP It holds the current motion matrix, and offers lots of convenience methods to build from for its subclasses -- that is, the non-abstract dragger classes to use as nodes in your scene graph\&. .PP The motion matrix is used to modify the model matrix during traversal, and this is a common dragger mechanism -- all draggers should update this during dragging\&. .PP A number of the Coin dragger classes have built-in convenience wrapper classes, called \fImanipulators\fP\&. See for instance the \fBSoTrackballDragger\fP / \fBSoTrackballManip\fP pair\&. .PP The matching manipulator class for any dragger class has basically two convenient additions to the functionality of the standalone dragger: 1) it makes swapping the dragger in and out of the scene graph very straightforward (something which is often done for draggers in 3D user interfaces), 2) it wraps up the dragger with \fBSoSurroundScale\fP and \fBSoAntiSquish\fP nodes where applicable, so the dragger geometry automatically scales up or down to match the geometry it influences\&. .PP This last functionality can also be duplicated in a rather straightforward manner outside of the context of a manipulator, as can be seen from the usage example in the \fBSoSurroundScale\fP class documentation\&. .PP The appearance of draggers can be modified by either using the \fBSoDragger::setPart()\fP method (see usage example below) or by setting up external Inventor-format files which the geometry parts are read from\&. The latter method can be done by setting the environment variable \fRSO_DRAGGER_DIR\fP to point to a directory with replacement geometry files\&. The name of the new files and the name of the nodes / sub-graphs with the replacement geometries must follow a rigid scheme\&. We advise you to look at the Coin source code directory Coin/data/draggerDefaults/ to see how the replacement geometry files should be named\&. Setting \fRSO_DRAGGER_DIR\fP to this directory and modifying the files there provides a convenient way to play around with new dragger geometry arrangements\&. .PP As mentioned above, \fBSoDragger::setPart()\fP can be used to modify the appearance of a dragger by changing its default geometry\&. One common technique is for instance to take advantage of this to use only \fIparts\fP of a dragger, by replacing / disabling the geometry that you don't want the end-user to interact with\&. The following code example shows how to remove the translation functionality of the \fBSoTransformBoxDragger\fP: .PP .PP .nf #include #include #include #include int main(int argc, char ** argv) { QWidget * window = SoQt::init(argv[0]); SoTransformBoxDragger * dragger = new SoTransformBoxDragger; SbString str; for (int i = 1; i <= 6; i++) { str\&.sprintf("translator%d\&.translator", i); dragger\->setPart(str\&.getString(), new SoSeparator); } SoQtExaminerViewer * viewer = new SoQtExaminerViewer(window); viewer\->setSceneGraph(dragger); viewer\->show(); SoQt::show(window); SoQt::mainLoop(); delete viewer; return 0; } .fi .PP .PP Draggers are also node kits, and below is the catalog structure for this top-level dragger class\&. .PP Nodekit structure (new entries versus parent class marked with arrow prefix): .PP .PP .nf CLASS SoDragger -->'this' 'callbackList' 'topSeparator' --> 'motionMatrix' 'geomSeparator' .fi .PP .PP (See \fBSoBaseKit::printDiagram()\fP for information about the output formatting\&.) .PP Detailed information on catalog parts: .PP .PP .nf CLASS SoDragger PVT 'this', SoDragger --- 'callbackList', SoNodeKitListPart [ SoCallback, SoEventCallback ] PVT 'topSeparator', SoSeparator --- PVT 'motionMatrix', SoMatrixTransform --- PVT 'geomSeparator', SoSeparator --- .fi .PP .PP (See \fBSoBaseKit::printTable()\fP for information about the output formatting\&.) .SH "Member Enumeration Documentation" .PP .SS "enum \fBSoDragger::ProjectorFrontSetting\fP" Holds various settings for projectors, which might affect cylindrical and spherical based draggers\&. Specifies whether dragging should be based on the front or back of the sphere / cylinder, or if the picked point should be used to decide this\&. .PP \fBEnumerator\fP .in +1c .TP \f(BIFRONT \fP Always use front of projector\&. .TP \f(BIBACK \fP Always use back of projector\&. .TP \f(BIUSE_PICK \fP Use picked point to decide front or back of projector\&. .SH "Constructor & Destructor Documentation" .PP .SS "SoDragger::SoDragger (void )\fR [protected]\fP" A protected constructor for this abstract superclass for all Coin draggers\&. .SS "SoDragger::~SoDragger (void )\fR [protected]\fP, \fR [virtual]\fP" Virtual protected destructor\&. .SH "Member Function Documentation" .PP .SS "\fBSoType\fP SoDragger::getClassTypeId (void )\fR [static]\fP" This static method returns the \fBSoType\fP object associated with objects of this class\&. .br .SS "\fBSoType\fP SoDragger::getTypeId (void ) const\fR [virtual]\fP" Returns the type identification of an object derived from a class inheriting \fBSoBase\fP\&. This is used for runtime type checking and 'downward' casting\&. .br .PP Reimplemented from \fBSoInteractionKit\fP\&. .PP Reimplemented in \fBSoCenterballDragger\fP, \fBSoDirectionalLightDragger\fP, \fBSoDragPointDragger\fP, \fBSoHandleBoxDragger\fP, \fBSoJackDragger\fP, \fBSoPointLightDragger\fP, \fBSoRotateCylindricalDragger\fP, \fBSoRotateDiscDragger\fP, \fBSoRotateSphericalDragger\fP, \fBSoScale1Dragger\fP, \fBSoScale2Dragger\fP, \fBSoScale2UniformDragger\fP, \fBSoScaleUniformDragger\fP, \fBSoSpotLightDragger\fP, \fBSoTabBoxDragger\fP, \fBSoTabPlaneDragger\fP, \fBSoTrackballDragger\fP, \fBSoTransformBoxDragger\fP, \fBSoTransformerDragger\fP, \fBSoTranslate1Dragger\fP, and \fBSoTranslate2Dragger\fP\&. .SS "const \fBSoFieldData\fP ** SoDragger::getFieldDataPtr (void )\fR [static]\fP, \fR [protected]\fP" \fIThis API member is considered internal to the library, as it is not likely to be of interest to the application programmer\&.\fP .br .br Returns the \fBSoFieldData\fP class which holds information about fields in this node\&. .br .SS "const \fBSoFieldData\fP * SoDragger::getFieldData (void ) const\fR [protected]\fP, \fR [virtual]\fP" Returns a pointer to the class-wide field data storage object for this instance\&. If no fields are present, returns \fRNULL\fP\&. .PP Reimplemented from \fBSoInteractionKit\fP\&. .PP Reimplemented in \fBSoCenterballDragger\fP, \fBSoDirectionalLightDragger\fP, \fBSoDragPointDragger\fP, \fBSoHandleBoxDragger\fP, \fBSoJackDragger\fP, \fBSoPointLightDragger\fP, \fBSoRotateCylindricalDragger\fP, \fBSoRotateDiscDragger\fP, \fBSoRotateSphericalDragger\fP, \fBSoScale1Dragger\fP, \fBSoScale2Dragger\fP, \fBSoScale2UniformDragger\fP, \fBSoScaleUniformDragger\fP, \fBSoSpotLightDragger\fP, \fBSoTabBoxDragger\fP, \fBSoTabPlaneDragger\fP, \fBSoTrackballDragger\fP, \fBSoTransformBoxDragger\fP, \fBSoTransformerDragger\fP, \fBSoTranslate1Dragger\fP, and \fBSoTranslate2Dragger\fP\&. .SS "const \fBSoNodekitCatalog\fP * SoDragger::getClassNodekitCatalog (void )\fR [static]\fP" Returns the nodekit catalog which defines the layout of this class' kit\&. .br .SS "const \fBSoNodekitCatalog\fP * SoDragger::getNodekitCatalog (void ) const\fR [virtual]\fP" Returns the nodekit catalog which defines the layout of this class' kit\&. .br .PP Reimplemented from \fBSoInteractionKit\fP\&. .PP Reimplemented in \fBSoCenterballDragger\fP, \fBSoDirectionalLightDragger\fP, \fBSoDragPointDragger\fP, \fBSoHandleBoxDragger\fP, \fBSoJackDragger\fP, \fBSoPointLightDragger\fP, \fBSoRotateCylindricalDragger\fP, \fBSoRotateDiscDragger\fP, \fBSoRotateSphericalDragger\fP, \fBSoScale1Dragger\fP, \fBSoScale2Dragger\fP, \fBSoScale2UniformDragger\fP, \fBSoScaleUniformDragger\fP, \fBSoSpotLightDragger\fP, \fBSoTabBoxDragger\fP, \fBSoTabPlaneDragger\fP, \fBSoTrackballDragger\fP, \fBSoTransformBoxDragger\fP, \fBSoTransformerDragger\fP, \fBSoTranslate1Dragger\fP, and \fBSoTranslate2Dragger\fP\&. .SS "const \fBSoNodekitCatalog\fP ** SoDragger::getClassNodekitCatalogPtr (void )\fR [static]\fP, \fR [protected]\fP" Returns the pointer to the pointer of the nodekit catalog for this class\&. .br .SS "void SoDragger::callback (\fBSoCallbackAction\fP * action)\fR [virtual]\fP" Action method for \fBSoCallbackAction\fP\&. .PP Simply updates the state according to how the node behaves for the render action, so the application programmer can use the \fBSoCallbackAction\fP for extracting information about the scene graph\&. .PP Reimplemented from \fBSoBaseKit\fP\&. .SS "void SoDragger::GLRender (\fBSoGLRenderAction\fP * action)\fR [virtual]\fP" Action method for the \fBSoGLRenderAction\fP\&. .PP This is called during rendering traversals\&. Nodes influencing the rendering state in any way or want to throw geometry primitives at OpenGL override this method\&. .PP Reimplemented from \fBSoBaseKit\fP\&. .PP Reimplemented in \fBSoTabPlaneDragger\fP\&. .SS "void SoDragger::getMatrix (\fBSoGetMatrixAction\fP * action)\fR [virtual]\fP" Action method for \fBSoGetMatrixAction\fP\&. .PP Updates \fIaction\fP by accumulating with the transformation matrix of this node (if any)\&. .PP Reimplemented from \fBSoBaseKit\fP\&. .PP Reimplemented in \fBSoCenterballDragger\fP\&. .SS "void SoDragger::rayPick (\fBSoRayPickAction\fP * action)\fR [virtual]\fP" Action method for \fBSoRayPickAction\fP\&. .PP Checks the ray specification of the \fIaction\fP and tests for intersection with the data of the node\&. .PP Nodes influencing relevant state variables for how picking is done also override this method\&. .PP Reimplemented from \fBSoBaseKit\fP\&. .SS "void SoDragger::search (\fBSoSearchAction\fP * action)\fR [virtual]\fP" Action method for \fBSoSearchAction\fP\&. .PP Compares the search criteria from the \fIaction\fP to see if this node is a match\&. Searching is done by matching up \fIall\fP criteria set up in the \fBSoSearchAction\fP -- if \fIany\fP of the requested criteria is a miss, the search is not deemed successful for the node\&. .PP \fBSee also\fP .RS 4 \fBSoSearchAction\fP .RE .PP .PP Reimplemented from \fBSoBaseKit\fP\&. .SS "void SoDragger::write (\fBSoWriteAction\fP * action)\fR [virtual]\fP" Action method for \fBSoWriteAction\fP\&. .PP Writes out a node object, and any connected nodes, engines etc, if necessary\&. .PP Reimplemented from \fBSoBaseKit\fP\&. .SS "void SoDragger::getPrimitiveCount (\fBSoGetPrimitiveCountAction\fP * action)\fR [virtual]\fP" Action method for the \fBSoGetPrimitiveCountAction\fP\&. .PP Calculates the number of triangle, line segment and point primitives for the node and adds these to the counters of the \fIaction\fP\&. .PP Nodes influencing how geometry nodes calculate their primitive count also override this method to change the relevant state variables\&. .PP Reimplemented from \fBSoBaseKit\fP\&. .SS "void SoDragger::setProjectorEpsilon (const float epsilon)" Sets the epsilon used for restricting the draggers when the intersection line is almost parallel with the projector direction\&. .PP For line projectors this is based on the dot product between the picking ray and the projector line\&. For plane projector, the dot product between the plane normal and the picking ray is used\&. .PP Default value is 0\&.0\&. .PP \fBSince\fP .RS 4 Coin 3\&.0 .RE .PP .SS "void SoDragger::addStartCallback (SoDraggerCB * func, void * data = \fRNULL\fP)" Adds a callback which is called at the start of a drag, after the mouse button 1 is pressed, and dragger is picked\&. .SS "void SoDragger::removeStartCallback (SoDraggerCB * func, void * data = \fRNULL\fP)" Removes a previously registered start callback\&. .PP \fBSee also\fP .RS 4 \fBaddStartCallback()\fP .RE .PP .SS "void SoDragger::addMotionCallback (SoDraggerCB * func, void * data = \fRNULL\fP)" Adds a callback which is called for each mouse movement during dragging\&. .SS "void SoDragger::removeMotionCallback (SoDraggerCB * func, void * data = \fRNULL\fP)" Removes a previously registered motion callback\&. .PP \fBSee also\fP .RS 4 \fBaddMotionCallback()\fP .RE .PP .SS "void SoDragger::addFinishCallback (SoDraggerCB * func, void * data = \fRNULL\fP)" Adds a callback which is called after dragging is finished\&. .SS "void SoDragger::removeFinishCallback (SoDraggerCB * func, void * data = \fRNULL\fP)" Removes a finish callback\&. .PP \fBSee also\fP .RS 4 \fBaddFinishCallback()\fP .RE .PP .SS "void SoDragger::addValueChangedCallback (SoDraggerCB * func, void * data = \fRNULL\fP)" Adds a callback which is called after a dragger has changed a field\&. It is not called if the \fBSoDragger::isActive\fP field is changed\&. .PP \fBSee also\fP .RS 4 enableValueChangedCallback() .RE .PP .SS "void SoDragger::removeValueChangedCallback (SoDraggerCB * func, void * data = \fRNULL\fP)" Removes a value changed callback\&. .PP \fBSee also\fP .RS 4 \fBaddValueChangedCallback()\fP .RE .PP .SS "void SoDragger::setMinGesture (int pixels)" Sets the number of pixel movement needed to trigger a constraint gesture\&. Default is 8 pixels\&. .SS "int SoDragger::getMinGesture (void ) const" Returns the gesture pixels threshold value\&. .PP \fBSee also\fP .RS 4 \fBsetMinGesture()\fP .RE .PP .SS "SbBool SoDragger::enableValueChangedCallbacks (SbBool val)" Enable or disable 'value changed' callbacks\&. .PP \fBSee also\fP .RS 4 \fBaddValueChangedCallback()\fP .RE .PP .SS "const \fBSbMatrix\fP & SoDragger::getMotionMatrix (void )" Returns the motion matrix for this dragger\&. .SS "void SoDragger::addOtherEventCallback (SoDraggerCB * func, void * data = \fRNULL\fP)" Adds an event callback for events other then drag events\&. As soon as dragging starts, the dragger grabs all events (until mouse button is released)\&. This method can be used to handle other events during dragging\&. .SS "void SoDragger::removeOtherEventCallback (SoDraggerCB * func, void * data = \fRNULL\fP)" Removes a other event callback\&. .PP \fBSee also\fP .RS 4 \fBaddOtherEventCallback()\fP .RE .PP .SS "void SoDragger::registerChildDragger (\fBSoDragger\fP * child)" Should be called by compound draggers to register child draggers\&. .SS "void SoDragger::unregisterChildDragger (\fBSoDragger\fP * child)" Should be called by compound draggers to unregister child draggers\&. .SS "void SoDragger::registerChildDraggerMovingIndependently (\fBSoDragger\fP * child)" Should be called by compound draggers to register child draggers that should move independently of their parent\&. .SS "void SoDragger::unregisterChildDraggerMovingIndependently (\fBSoDragger\fP * child)" Should be called by compound draggers to unregister child draggers\&. .PP \fBSee also\fP .RS 4 \fBregisterChildDraggerMovingIndependently()\fP .RE .PP .SS "\fBSbMatrix\fP SoDragger::getLocalToWorldMatrix (void )" Returns a matrix that converts from local to world space\&. .SS "\fBSbMatrix\fP SoDragger::getWorldToLocalMatrix (void )" Returns a matrix that converts from world to local space\&. .SS "\fBSbVec3f\fP SoDragger::getLocalStartingPoint (void )" Returns the drag starting point in the local coordinate system\&. .SS "\fBSbVec3f\fP SoDragger::getWorldStartingPoint (void )" Returns the drag starting point in the world coordinate system\&. .SS "void SoDragger::getPartToLocalMatrix (const \fBSbName\fP & partname, \fBSbMatrix\fP & parttolocalmatrix, \fBSbMatrix\fP & localtopartmatrix)" Returns matrices that will convert between local space and the space in which \fIpartname\fP lies in\&. .SS "void SoDragger::transformMatrixLocalToWorld (const \fBSbMatrix\fP & frommatrix, \fBSbMatrix\fP & tomatrix)" Convenience method that transforms the local \fIfrommatrix\fP to a world coordinate systems matrix\&. .SS "void SoDragger::transformMatrixWorldToLocal (const \fBSbMatrix\fP & frommatrix, \fBSbMatrix\fP & tomatrix)" Convenience method that transforms the world \fIfrommatrix\fP to a local coordinate systems matrix\&. .SS "void SoDragger::transformMatrixToLocalSpace (const \fBSbMatrix\fP & frommatrix, \fBSbMatrix\fP & tomatrix, const \fBSbName\fP & fromspacepartname)" Transforms a matrix that lies in the \fIfrompartname\fP coordinate system into the local coordinate system\&. .SS "void SoDragger::setMotionMatrix (const \fBSbMatrix\fP & matrix)\fR [virtual]\fP" Sets a new current motion matrix for the dragger geometry\&. .PP Triggers value changed callbacks if \fImatrix\fP is not equal to the previous motion matrix\&. .PP Reimplemented in \fBSoTranslate1Dragger\fP, and \fBSoTranslate2Dragger\fP\&. .SS "void SoDragger::valueChanged (void )" Can be called by subclasses to trigger value changed callbacks\&. This might be needed if a field is changed without changing the motion matrix\&. .SS "const \fBSbMatrix\fP & SoDragger::getStartMotionMatrix (void )" Returns the motion matrix as it was when \fBsaveStartParameters()\fP was called\&. .SS "void SoDragger::saveStartParameters (void )\fR [virtual]\fP" This is invoked to save start parameters, to enable draggers to calculate relative motion\&. .PP Default method in superclass \fBSoDragger\fP just saves the motion matrix, but subclasses should overload this method if other data needs to be saved\&. .PP Reimplemented in \fBSoCenterballDragger\fP\&. .SS "const \fBSoPath\fP * SoDragger::getPickPath (void ) const" Returns the picked path\&. .SS "const \fBSoEvent\fP * SoDragger::getEvent (void ) const" Returns the current event\&. .SS "\fBSoPath\fP * SoDragger::createPathToThis (void )" Creates a new path to this dragger\&. Don't forget to \fBref()\fP and \fBunref()\fP since this method creates a fresh copy for you\&. .SS "const \fBSoPath\fP * SoDragger::getSurrogatePartPickedOwner (void ) const" Returns the path to the \fBSoInteractionKit\fP that holds the current surrogate path\&. .SS "const \fBSbName\fP & SoDragger::getSurrogatePartPickedName (void ) const" Returns the name of the path in the \fBSoInteractionKit\fP that holds the current surrogate path\&. .SS "const \fBSoPath\fP * SoDragger::getSurrogatePartPickedPath (void ) const" Returns the current surrogate path\&. .SS "void SoDragger::setStartingPoint (const \fBSoPickedPoint\fP * point)" Sets the staring point for the drag\&. \fIpoint\fP is usually a picked point from a \fBSoRayPickAction\fP\&. .SS "void SoDragger::setStartingPoint (const \fBSbVec3f\fP & point)" Sets the starting point for a drag\&. .SS "const \fBSbViewVolume\fP & SoDragger::getViewVolume (void )" Return the current view volume\&. .SS "void SoDragger::setViewVolume (const \fBSbViewVolume\fP & vv)" Sets the current view volume\&. .SS "const \fBSbViewportRegion\fP & SoDragger::getViewportRegion (void )" Returns the current viewport region\&. .SS "void SoDragger::setViewportRegion (const \fBSbViewportRegion\fP & vp)" Sets the current viewport region\&. .SS "\fBSoHandleEventAction\fP * SoDragger::getHandleEventAction (void ) const" Return the current (most recent) \fBSoHandleEventAction\fP\&. .SS "void SoDragger::setHandleEventAction (\fBSoHandleEventAction\fP * action)" Stores a handle event action\&. .SS "void SoDragger::setTempPathToThis (const \fBSoPath\fP * somethingclose)" This function is part of the original SGI Inventor 2\&.1 API, but has not been implemented in Coin as it looks like a function which should probably have been private in Open Inventor\&. .SS "void SoDragger::grabEventsSetup (void )\fR [virtual]\fP" Called when dragger starts grabbing events (mouse button down)\&. Overload if you need to do something extra in your dragger\&. .PP \fBSee also\fP .RS 4 grabEventCleanup() .RE .PP .PP Reimplemented from \fBSoNode\fP\&. .SS "void SoDragger::grabEventsCleanup (void )\fR [virtual]\fP" Called when dragger stops grabbing events (mouse button up)\&. .PP \fBSee also\fP .RS 4 grabEventSetup() .RE .PP .PP Reimplemented from \fBSoNode\fP\&. .SS "void SoDragger::workFieldsIntoTransform (\fBSbMatrix\fP & matrix)" Examines the fields of the dragger, changes the matrix according to those fields and leaves the rest of the matrix as it was\&. The following field names are supported: translation, scaleFactor, rotation and scaleOrientation\&. .SS "void SoDragger::setFrontOnProjector (\fBProjectorFrontSetting\fP val)" Controls the behaviour of the \fBSbProjector\fP\&. .SS "\fBSoDragger::ProjectorFrontSetting\fP SoDragger::getFrontOnProjector (void ) const" Returns the behaviour of the \fBSbProjector\fP\&. .SS "void SoDragger::setMinScale (float minscalearg)\fR [static]\fP" Sets the minimum scale value all scale factors are clamped against\&. This is used in \fBworkFieldsIntoTransform()\fP\&. The default value is 0\&.01 .SS "float SoDragger::getMinScale (void )\fR [static]\fP" Returns the minimum scale value\&. .PP \fBSee also\fP .RS 4 \fBsetMinScale()\fP .RE .PP .SS "void SoDragger::workValuesIntoTransform (\fBSbMatrix\fP & matrix, const \fBSbVec3f\fP * translationptr, const \fBSbRotation\fP * rotationptr, const \fBSbVec3f\fP * scalefactorptr, const \fBSbRotation\fP * scaleorientationptr, const \fBSbVec3f\fP * centerptr)\fR [static]\fP" Same as above, but pointers to values are supplied\&. If a pointer is \fRNULL\fP, the matrix value for that argument is used when reconstructing the matrix\&. .SS "void SoDragger::getTransformFast (\fBSbMatrix\fP & matrix, \fBSbVec3f\fP & translation, \fBSbRotation\fP & rotation, \fBSbVec3f\fP & scalefactor, \fBSbRotation\fP & scaleorientation, const \fBSbVec3f\fP & center)\fR [static]\fP" Can be used when there is no scaleorientation\&. Faster than \fBSoDragger::workValuesIntoTransform()\fP\&. .SS "void SoDragger::getTransformFast (\fBSbMatrix\fP & matrix, \fBSbVec3f\fP & translation, \fBSbRotation\fP & rotation, \fBSbVec3f\fP & scalefactor, \fBSbRotation\fP & scaleorientation)\fR [static]\fP" This is an overloaded member function, provided for convenience\&. It differs from the above function only in what argument(s) it accepts\&. .SS "\fBSbMatrix\fP SoDragger::appendTranslation (const \fBSbMatrix\fP & matrix, const \fBSbVec3f\fP & translation, const \fBSbMatrix\fP * conversion = \fRNULL\fP)\fR [static]\fP" Returns \fImatrix\fP after \fItranslation\fP has been appended\&. If \fIconversion\fP != \fRNULL\fP it is used to transform \fItranslation\fP into the space \fImatrix\fP is defined\&. .SS "\fBSbMatrix\fP SoDragger::appendScale (const \fBSbMatrix\fP & matrix, const \fBSbVec3f\fP & scale, const \fBSbVec3f\fP & scalecenter, const \fBSbMatrix\fP * conversion = \fRNULL\fP)\fR [static]\fP" Returns \fImatrix\fP after \fIscale\fP and \fIscalecenter\fP have been appended\&. If \fIconversion\fP != \fRNULL\fP it is used to transform scale into the space \fImatrix\fP is defined\&. .SS "\fBSbMatrix\fP SoDragger::appendRotation (const \fBSbMatrix\fP & matrix, const \fBSbRotation\fP & rot, const \fBSbVec3f\fP & rotcenter, const \fBSbMatrix\fP * conversion = \fRNULL\fP)\fR [static]\fP" Appends \fIrot\fP, around \fIrotcenter\fP, to \fImatrix\fP\&. If \fIconversion\fP is != \fRNULL\fP, this is used to move the rotation into that coordinate systems before appending the rotation\&. .SS "void SoDragger::initClass (void )\fR [static]\fP" Initializes type system for this dragger class\&. .PP Application programmers should usually not have to invoke this method, see documentation of \fBSoInteraction::init()\fP\&. .SS "void SoDragger::initClasses (void )\fR [static]\fP" Initializes all built-in draggers\&. .SS "\fBSbVec2f\fP SoDragger::getNormalizedLocaterPosition (void )\fR [protected]\fP" Returns the position of the locater\&. .SS "\fBSbVec2s\fP SoDragger::getLocaterPosition (void )\fR [protected]\fP" This is an overloaded member function, provided for convenience\&. It differs from the above function only in what argument(s) it accepts\&. .SS "\fBSbVec2s\fP SoDragger::getStartLocaterPosition (void ) const\fR [protected]\fP" Returns the position when mouse button 1 was pressed\&. .SS "void SoDragger::setStartLocaterPosition (\fBSbVec2s\fP pos)\fR [protected]\fP" The start locater position is automatically set when mouse button 1 goes down, but subclasses can use this method to reset the value\&. .SS "SbBool SoDragger::isAdequateConstraintMotion (void )\fR [protected]\fP" Checks if the mouse pointer has been moved enough after the end-user hit a constraint mode key (which is typically \fRSHIFT\fP, sometimes also \fRCTRL\fP for the built-in draggers) that we should act upon and decide which direction the constraint should be set to\&. .SS "SbBool SoDragger::shouldGrabBasedOnSurrogate (const \fBSoPath\fP * pickpath, const \fBSoPath\fP * surrogatepath)\fR [protected]\fP, \fR [virtual]\fP" Checks if \fIpickpath\fP contains \fIsurrogatepath\fP and returns \fRTRUE\fP if the tail of \fIsurrogatepath\fP is before any dragger in \fIpickpath\fP\&. .SS "void SoDragger::setCameraInfo (\fBSoAction\fP * action)\fR [protected]\fP" Store data about the current camera in the given action\&. .SS "void SoDragger::handleEvent (\fBSoHandleEventAction\fP * action)\fR [protected]\fP, \fR [virtual]\fP" Action method for \fBSoHandleEventAction\fP\&. .PP Inspects the event data from \fIaction\fP, and processes it if it is something which this node should react to\&. .PP Nodes influencing relevant state variables for how event handling is done also override this method\&. .PP Reimplemented from \fBSoBaseKit\fP\&. .SS "void SoDragger::transferMotion (\fBSoDragger\fP * child)\fR [protected]\fP" \fIThis API member is considered internal to the library, as it is not likely to be of interest to the application programmer\&.\fP .br .br .SS "void SoDragger::setIgnoreInBbox (SbBool val)\fR [protected]\fP" Sets whether dragger geometry should be ignored when calculating bounding box\&. .SS "SbBool SoDragger::isIgnoreInBbox (void )\fR [protected]\fP" Returns whether dragger geometry should be ignored when calculating bounding box\&. .SS "void SoDragger::getBoundingBox (\fBSoGetBoundingBoxAction\fP * action)\fR [protected]\fP, \fR [virtual]\fP" Action method for the \fBSoGetBoundingBoxAction\fP\&. .PP Calculates bounding box and center coordinates for node and modifies the values of the \fIaction\fP to encompass the bounding box for this node and to shift the center point for the scene more towards the one for this node\&. .PP Nodes influencing how geometry nodes calculate their bounding box also override this method to change the relevant state variables\&. .PP Reimplemented from \fBSoBaseKit\fP\&. .PP Reimplemented in \fBSoCenterballDragger\fP\&. .SS "void SoDragger::setActiveChildDragger (\fBSoDragger\fP * childdragger)\fR [protected]\fP" \fIThis API member is considered internal to the library, as it is not likely to be of interest to the application programmer\&.\fP .br .br .SS "\fBSoDragger\fP * SoDragger::getActiveChildDragger (void ) const\fR [protected]\fP" \fIThis API member is considered internal to the library, as it is not likely to be of interest to the application programmer\&.\fP .br .br .SS "void SoDragger::setDefaultOnNonWritingFields (void )\fR [protected]\fP, \fR [virtual]\fP" (Be aware that this method is unlikely to be of interest to the application programmer who does not want to extend the library with new custom nodekits or draggers\&. If you indeed \fIare\fP writing extensions, see the information in the \fBSoBaseKit\fP class documentation\&.) .PP This is a virtual method, and the code in it should call \fBSoField::setDefault()\fP with argument \fRTRUE\fP on part fields that should not be written upon scene graph export operations\&. .PP This is typically done when: .PP .PD 0 .IP "1." 4 field value is \fRNULL\fP and part is \fRNULL\fP by default .PP .IP "2." 4 it is a leaf \fBSoGroup\fP or \fBSoSeparator\fP node with no children .PP .IP "3." 4 it is a leaf listpart with no children and an \fBSoGroup\fP or \fBSoSeparator\fP container .PP .IP "4." 4 it is a non-leaf part and it is of \fBSoGroup\fP type and all fields are at their default values .PP .PP .PP Subclasses should usually override this to do additional settings for new member fields\&. From the subclass, do remember to call 'upwards' to your superclass' \fBsetDefaultOnNonWritingFields()\fP method\&. .PP Reimplemented from \fBSoInteractionKit\fP\&. .PP Reimplemented in \fBSoCenterballDragger\fP, \fBSoDirectionalLightDragger\fP, \fBSoDragPointDragger\fP, \fBSoHandleBoxDragger\fP, \fBSoJackDragger\fP, \fBSoPointLightDragger\fP, \fBSoSpotLightDragger\fP, \fBSoTabBoxDragger\fP, \fBSoTabPlaneDragger\fP, \fBSoTrackballDragger\fP, \fBSoTransformBoxDragger\fP, and \fBSoTransformerDragger\fP\&. .SS "void SoDragger::childTransferMotionAndValueChangedCB (void * data, \fBSoDragger\fP * child)\fR [static]\fP, \fR [protected]\fP" \fIThis API member is considered internal to the library, as it is not likely to be of interest to the application programmer\&.\fP .br .br .SS "void SoDragger::childValueChangedCB (void * data, \fBSoDragger\fP * child)\fR [static]\fP, \fR [protected]\fP" \fIThis API member is considered internal to the library, as it is not likely to be of interest to the application programmer\&.\fP .br .br .SS "void SoDragger::childStartCB (void * data, \fBSoDragger\fP * child)\fR [static]\fP, \fR [protected]\fP" \fIThis API member is considered internal to the library, as it is not likely to be of interest to the application programmer\&.\fP .br .br .SS "void SoDragger::childMotionCB (void * data, \fBSoDragger\fP * child)\fR [static]\fP, \fR [protected]\fP" \fIThis API member is considered internal to the library, as it is not likely to be of interest to the application programmer\&.\fP .br .br .SS "void SoDragger::childFinishCB (void * data, \fBSoDragger\fP * child)\fR [static]\fP, \fR [protected]\fP" \fIThis API member is considered internal to the library, as it is not likely to be of interest to the application programmer\&.\fP .br .br .SS "void SoDragger::childOtherEventCB (void * data, \fBSoDragger\fP * child)\fR [static]\fP, \fR [protected]\fP" \fIThis API member is considered internal to the library, as it is not likely to be of interest to the application programmer\&.\fP .br .br .SS "void SoDragger::updateDraggerCache (const \fBSoPath\fP * path)\fR [protected]\fP" \fIThis API member is considered internal to the library, as it is not likely to be of interest to the application programmer\&.\fP .br .br .SS "const \fBSoPickedPoint\fP * SoDragger::getPickedPointForStart (\fBSoHandleEventAction\fP * action)\fR [protected]\fP, \fR [virtual]\fP" Interaction with the dragger will be started, if the returned picked point belongs to the dragger\&. A derived class can override this method to change the condition when the dragger starts interaction, e\&.g\&. it can return the picked point on the dragger from the picked point list of the action, even if it is covered by other (semi) transparent objects\&. The default implementation returns the foremost picked point from the action\&. This method is not present in Open Inventor\&. .SH "Member Data Documentation" .PP .SS "\fBSoSFBool\fP SoDragger::isActive" Is \fRTRUE\fP whenever the user is interacting with the dragger\&. For compound draggers (draggers consisting of one or more subdraggers), the isActive field is updated only for the active subdragger, not for the compound dragger\&. .SH "Author" .PP Generated automatically by Doxygen for Coin from the source code\&.