SoDragger(3)

📦 version 2.5.0, in fedora 43, fedora 44

💅 SoDragger(3) — Library Functions Manual ✨

✨ NAME ✨

SoDragger is the base class for all draggers. That's it, that's the name. 💖

🌸 SYNOPSIS 🌸

#include <Inventor/draggers/SoDragger.h>

Inherits SoInteractionKit.

Inherited by SoCenterballDragger, SoDirectionalLightDragger,
SoDragPointDragger, SoHandleBoxDragger, SoJackDragger,
SoPointLightDragger, SoRotateCylindricalDragger, SoRotateDiscDragger,
SoRotateSphericalDragger, SoScale1Dragger, SoScale2Dragger,
SoScale2UniformDragger, SoScaleUniformDragger, SoSpotLightDragger,
SoTabBoxDragger, SoTabPlaneDragger, SoTrackballDragger,
SoTransformBoxDragger, SoTransformerDragger, SoTranslate1Dragger, and
SoTranslate2Dragger.

okay so it includes that header, inherits from SoInteractionKit, and the whole dragger family inherits from it. periodt 🌈

🎀 Public Types 🎀

  • enum ProjectorFrontSetting { FRONT, BACK, USE_PICK } — the projector front setting enum, with values FRONT, BACK, and USE_PICK. 💅

💖 Public Types inherited from SoInteractionKit 💖

  • enum CacheEnabled { OFF, ON, AUTO } — cache enabled enum, values OFF, ON, AUTO. ✨

🌈 Public Types inherited from SoNode 🌈

enum NodeType { INVENTOR = 0x0000, VRML1 = 0x0001, VRML2 = 0x0002,
    INVENTOR_1 = 0x0004, INVENTOR_2_0 = 0x0008, INVENTOR_2_1 = 0x0010,
    INVENTOR_2_5 = 0x0020, INVENTOR_2_6 = 0x0040, COIN_1_0 = 0x0080,
    COIN_2_0 = 0x0100, EXTENSION = 0x0200, COIN_2_2 = 0x0400, COIN_2_3 =
    0x0800, COIN_2_4 = 0x1000, INVENTOR_5_0 = 0x2000, COIN_2_5 = 0x4000
    }

these are the node type constants, no cap. 🦋

🔥 Public Member Functions 🔥

here's the full stack, every single one, bestie:

  • virtual SoType getTypeId (void) const
  • virtual const SoNodekitCatalog * getNodekitCatalog (void) const
  • virtual void callback (SoCallbackAction *action)
  • virtual void GLRender (SoGLRenderAction *action)
  • virtual void getMatrix (SoGetMatrixAction *action)
  • virtual void rayPick (SoRayPickAction *action)
  • virtual void search (SoSearchAction *action)
  • virtual void write (SoWriteAction *action)
  • virtual void getPrimitiveCount (SoGetPrimitiveCountAction *action)
  • void addStartCallback (SoDraggerCB *func, void *data=NULL)
  • void removeStartCallback (SoDraggerCB *func, void *data=NULL)
  • void addMotionCallback (SoDraggerCB *func, void *data=NULL)
  • void removeMotionCallback (SoDraggerCB *func, void *data=NULL)
  • void addFinishCallback (SoDraggerCB *func, void *data=NULL)
  • void removeFinishCallback (SoDraggerCB *func, void *data=NULL)
  • void addValueChangedCallback (SoDraggerCB *func, void *data=NULL)
  • void removeValueChangedCallback (SoDraggerCB *func, void *data=NULL)
  • void setMinGesture (int pixels)
  • int getMinGesture (void) const
  • SbBool enableValueChangedCallbacks (SbBool newval)
  • const SbMatrix & getMotionMatrix (void)
  • void addOtherEventCallback (SoDraggerCB *func, void *data=NULL)
  • void removeOtherEventCallback (SoDraggerCB *func, void *data=NULL)
  • void registerChildDragger (SoDragger *child)
  • void unregisterChildDragger (SoDragger *child)
  • void registerChildDraggerMovingIndependently (SoDragger *child)
  • void unregisterChildDraggerMovingIndependently (SoDragger *child)
  • SbMatrix getLocalToWorldMatrix (void)
  • SbMatrix getWorldToLocalMatrix (void)
  • SbVec3f getLocalStartingPoint (void)
  • SbVec3f getWorldStartingPoint (void)
  • void getPartToLocalMatrix (const SbName &partname, SbMatrix &parttolocalmatrix, SbMatrix &localtopartmatrix)
  • void transformMatrixLocalToWorld (const SbMatrix &frommatrix, SbMatrix &tomatrix)
  • void transformMatrixWorldToLocal (const SbMatrix &frommatrix, SbMatrix &tomatrix)
  • void transformMatrixToLocalSpace (const SbMatrix &frommatrix, SbMatrix &tomatrix, const SbName &fromspacepartname)
  • void setMotionMatrix (const SbMatrix &newmatrix)
  • void valueChanged (void)
  • const SbMatrix & getStartMotionMatrix (void)
  • virtual void saveStartParameters (void)
  • const SoPath * getPickPath (void) const
  • const SoEvent * getEvent (void) const
  • SoPath * createPathToThis (void)
  • const SoPath * getSurrogatePartPickedOwner (void) const
  • const SbName & getSurrogatePartPickedName (void) const
  • const SoPath * getSurrogatePartPickedPath (void) const
  • void setStartingPoint (const SoPickedPoint *newpoint)
  • void setStartingPoint (const SbVec3f &newpoint)
  • const SbViewVolume & getViewVolume (void)
  • void setViewVolume (const SbViewVolume &vol)
  • const SbViewportRegion & getViewportRegion (void)
  • void setViewportRegion (const SbViewportRegion &reg)
  • SoHandleEventAction * getHandleEventAction (void) const
  • void setHandleEventAction (SoHandleEventAction *newAction)
  • void setTempPathToThis (const SoPath *somethingclose)
  • virtual void grabEventsSetup (void)
  • virtual void grabEventsCleanup (void)
  • void workFieldsIntoTransform (SbMatrix &mtx)
  • void setFrontOnProjector (ProjectorFrontSetting newval)
  • ProjectorFrontSetting getFrontOnProjector (void) const

💜 Public Member Functions inherited from SoInteractionKit 💜

  • SoInteractionKit (void)
  • virtual SbBool setPartAsPath (const SbName &partname, SoPath *path)
  • virtual SbBool setPartAsDefault (const SbName &partname, SoNode *node, SbBool onlyifdefault=1)
  • virtual SbBool setPartAsDefault (const SbName &partname, const SbName &nodename, SbBool onlyifdefault=1)
  • SbBool isPathSurrogateInMySubgraph (const SoPath *path, SoPath *&pathToOwner, SbName &surrogatename, SoPath *&surrogatepath, SbBool fillargs=1)
  • SbBool isPathSurrogateInMySubgraph (const SoPath *path)
  • virtual SbBool setPart (const SbName &partname, SoNode *from)

💙 Public Member Functions inherited from SoBaseKit 💙

  • SoBaseKit (void)
  • virtual SoNode * getPart (const SbName &partname, SbBool makeifneeded)
  • SbString getPartString (const SoBase *part)
  • virtual SoNodeKitPath * createPathToPart (const SbName &partname, SbBool makeifneeded, const SoPath *pathtoextend=NULL)
  • SbBool set (const char *namevaluepairliststring)
  • SbBool set (const char *partnamestring, const char *parameterstring)
  • virtual void doAction (SoAction *action)
  • virtual SoChildList * getChildren (void) const
  • void printDiagram (void)
  • void printSubDiagram (const SbName &rootname, int level)
  • void printTable (void)
  • virtual void addWriteReference (SoOutput *out, SbBool isfromfield=0)
  • SbBool forceChildDrivenWriteRefs (SoOutput *out)

💚 Public Member Functions inherited from SoNode 💚

  • void setOverride (const SbBool state)
  • SbBool isOverride (void) const
  • void setNodeType (const NodeType type)
  • NodeType getNodeType (void) const
  • virtual SoNode * copy (SbBool copyconnections=0) const
  • virtual SbBool affectsState (void) const
  • virtual void GLRenderBelowPath (SoGLRenderAction *action)
  • virtual void GLRenderInPath (SoGLRenderAction *action)
  • virtual void GLRenderOffPath (SoGLRenderAction *action)
  • virtual void pick (SoPickAction *action)
  • virtual void audioRender (SoAudioRenderAction *action)
  • virtual void startNotify (void)
  • virtual void notify (SoNotList *l)
  • uint32_t getNodeId (void) const
  • virtual void writeInstance (SoOutput *out)
  • virtual SoFieldContainer * copyThroughConnection (void) const

💜 Public Member Functions inherited from SoFieldContainer 💜

  • void setToDefaults (void)
  • SbBool hasDefaultValues (void) const
  • SbBool fieldsAreEqual (const SoFieldContainer *container) const
  • void copyFieldValues (const SoFieldContainer *container, SbBool copyconnections=0)
  • SbBool set (const char *const fielddata)
  • void get (SbString &fielddata)
  • virtual int getFields (SoFieldList &l) const
  • virtual int getAllFields (SoFieldList &l) const
  • virtual SoField * getField (const SbName &name) const
  • virtual SoField * getEventIn (const SbName &name) const
  • virtual SoField * getEventOut (const SbName &name) const
  • SbBool getFieldName (const SoField *const field, SbName &name) const
  • SbBool enableNotify (const SbBool flag)
  • SbBool isNotifyEnabled (void) const
  • SbBool set (const char *fielddata, SoInput *in)
  • void get (SbString &fielddata, SoOutput *out)
  • virtual SbBool validateNewFieldValue (SoField *field, void *newval)
  • SbBool getIsBuiltIn (void) const
  • void setUserData (void *userdata) const
  • void * getUserData (void) const

💙 Public Member Functions inherited from SoBase 💙

  • void ref (void) const
  • void unref (void) const
  • void unrefNoDelete (void) const
  • int32_t getRefCount (void) const
  • void touch (void)
  • SbBool isOfType (SoType type) const
  • virtual SbName getName (void) const
  • virtual void setName (const SbName &newname)
  • void addAuditor (void *const auditor, const SoNotRec::Type type)
  • void removeAuditor (void *const auditor, const SoNotRec::Type type)
  • const SoAuditorList & getAuditors (void) const
  • SbBool shouldWrite (void)
  • void assertAlive (void) const

⭐ Static Public Member Functions ⭐

  • static SoType getClassTypeId (void)
  • static const SoNodekitCatalog * getClassNodekitCatalog (void)
  • static void setMinScale (float newminscale)
  • static float getMinScale (void)
  • static void workValuesIntoTransform (SbMatrix &mtx, const SbVec3f *translationptr, const SbRotation *rotationptr, const SbVec3f *scalefactorptr, const SbRotation *scaleorientationptr, const SbVec3f *centerptr)
  • static void getTransformFast (SbMatrix &mtx, SbVec3f &translation, SbRotation &rotation, SbVec3f &scalefactor, SbRotation &scaleorientation, const SbVec3f &center)
  • static void getTransformFast (SbMatrix &mtx, SbVec3f &translation, SbRotation &rotation, SbVec3f &scalefactor, SbRotation &scaleorientation)
  • static SbMatrix appendTranslation (const SbMatrix &mtx, const SbVec3f &translation, const SbMatrix *conversion=NULL)
  • static SbMatrix appendScale (const SbMatrix &mtx, const SbVec3f &scale, const SbVec3f &scalecenter, const SbMatrix *conversion=NULL)
  • static SbMatrix appendRotation (const SbMatrix &mtx, const SbRotation &rot, const SbVec3f &rotcenter, const SbMatrix *conversion=NULL)
  • static void initClass (void)
  • static void initClasses (void)

💜 Static Public Member Functions inherited from SoInteractionKit 💜

  • static SoType getClassTypeId (void)
  • static const SoNodekitCatalog * getClassNodekitCatalog (void)
  • static void initClass (void)
  • static void setSwitchValue (SoNode *node, const int newVal)

💚 Static Public Member Functions inherited from SoBaseKit 💚

  • static SoType getClassTypeId (void)
  • static void initClass (void)
  • static const SoNodekitCatalog * getClassNodekitCatalog (void)
  • static SbBool isSearchingChildren (void)
  • static void setSearchingChildren (const SbBool newval)
  • static SoNode * typeCheck (const SbName &partname, const SoType &parttype, SoNode *node)

Static Public Member Functions inherited from SoNode 🫶

okay bestie, these are the static public functions SoNode is passing down, and they're literally all here:

  • static uint32_t getCompatibilityTypes (const SoType &nodetype)
  • static SoType getClassTypeId (void)
  • static SoNode * getByName (const SbName &name)
  • static int getByName (const SbName &name, SoNodeList &l)
  • static void initClass (void)
  • static void initClasses (void)
  • static uint32_t getNextNodeId (void)
  • static int getActionMethodIndex (const SoType type)
  • static void getBoundingBoxS (SoAction *action, SoNode *node)
  • static void GLRenderS (SoAction *action, SoNode *node)
  • static void callbackS (SoAction *action, SoNode *node)
  • static void getMatrixS (SoAction *action, SoNode *node)
  • static void handleEventS (SoAction *action, SoNode *node)
  • static void pickS (SoAction *action, SoNode *node)
  • static void rayPickS (SoAction *action, SoNode *node)
  • static void searchS (SoAction *action, SoNode *node)
  • static void writeS (SoAction *action, SoNode *node)
  • static void audioRenderS (SoAction *action, SoNode *node)
  • static void getPrimitiveCountS (SoAction *action, SoNode *node)

Static Public Member Functions inherited from SoFieldContainer 💜

and SoFieldContainer said "here, take these too":

  • static void initClass (void)
  • static SoType getClassTypeId (void)
  • static void initCopyDict (void)
  • static void addCopy (const SoFieldContainer *orig, const SoFieldContainer *copy)
  • static SoFieldContainer * checkCopy (const SoFieldContainer *orig)
  • static SoFieldContainer * findCopy (const SoFieldContainer *orig, const SbBool copyconnections)
  • static void copyDone (void)

Static Public Member Functions inherited from SoBase 🌈

and SoBase is the final boss of inherited static public functions, fr fr:

  • static void initClass (void)
  • static SoType getClassTypeId (void)
  • static void addName (SoBase *const base, const char *const name)
  • static void removeName (SoBase *const base, const char *const name)
  • static void incrementCurrentWriteCounter (void)
  • static void decrementCurrentWriteCounter (void)
  • static SoBase * getNamedBase (const SbName &name, SoType type)
  • static int getNamedBases (const SbName &name, SoBaseList &baselist, SoType type)
  • static SbBool read (SoInput *in, SoBase *&base, SoType expectedtype)
  • static void setInstancePrefix (const SbString &c)
  • static void setTraceRefs (SbBool trace)
  • static SbBool getTraceRefs (void)
  • static SbBool connectRoute (SoInput *in, const SbName &fromnodename, const SbName &fromfieldname, const SbName &tonodename, const SbName &tofieldname)
  • static SbBool readRoute (SoInput *in)

Public Attributes 🎀

the public attribute of SoDragger itself, serving:

  • SoSFBool isActive

Public Attributes inherited from SoInteractionKit ✨

these are the public attributes SoInteractionKit is handing down, no cap:

  • SoSFEnum renderCaching
  • SoSFEnum boundingBoxCaching
  • SoSFEnum renderCulling
  • SoSFEnum pickCulling

Protected Member Functions 🧚

okay so these are SoDragger's own protected member functions, and they are lowkey the whole plot:

  • virtual const SoFieldData * getFieldData (void) const
  • SoDragger (void)
  • virtual ~SoDragger ()
  • SbVec2f getNormalizedLocaterPosition (void)
  • SbVec2s getLocaterPosition (void)
  • SbVec2s getStartLocaterPosition (void) const
  • void setStartLocaterPosition (SbVec2s p)
  • SbBool isAdequateConstraintMotion (void)
  • virtual SbBool shouldGrabBasedOnSurrogate (const SoPath *pickpath, const SoPath *surrogatepath)
  • void setCameraInfo (SoAction *action)
  • virtual void handleEvent (SoHandleEventAction *ha)
  • void transferMotion (SoDragger *child)
  • void setIgnoreInBbox (SbBool newval)
  • SbBool isIgnoreInBbox (void)
  • virtual void getBoundingBox (SoGetBoundingBoxAction *action)
  • void setActiveChildDragger (SoDragger *newchilddragger)
  • SoDragger * getActiveChildDragger (void) const
  • virtual void setDefaultOnNonWritingFields (void)
  • void updateDraggerCache (const SoPath *path)

Protected Member Functions inherited from SoInteractionKit 🍑

and the ones it inherited from SoInteractionKit are giving:

  • virtual ~SoInteractionKit ()
  • virtual void copyContents (const SoFieldContainer *fromFC, SbBool copyConnections)
  • virtual SbBool setPart (const int partNum, SoNode *node)
  • virtual SbBool readInstance (SoInput *in, unsigned short flags)
  • virtual SbBool setAnyPartAsDefault (const SbName &partname, SoNode *node, SbBool anypart=1, SbBool onlyifdefault=1)
  • virtual SbBool setAnyPartAsDefault (const SbName &partname, const SbName &nodename, SbBool anypart=1, SbBool onlyifdefault=1)
  • SbBool setAnySurrogatePath (const SbName &name, SoPath *path, SbBool leafcheck=0, SbBool publiccheck=0)
  • virtual SbBool setUpConnections (SbBool onoff, SbBool doitalways=0)
  • void connectSeparatorFields (SoSeparator *dest, SbBool onOff)

Protected Member Functions inherited from SoBaseKit ⭐

and SoBaseKit's protected member functions are also here, periodt:

  • virtual ~SoBaseKit ()
  • virtual SoNode * addToCopyDict (void) const
  • SoGroup * getContainerNode (const SbName &listname, SbBool makeifneeded=1)
  • virtual SoNode * getAnyPart (const SbName &partname, SbBool makeifneeded, SbBool leafcheck=0, SbBool publiccheck=0)
  • virtual SoNodeKitPath * createPathToAnyPart (const SbName &partname, SbBool makeifneeded, SbBool leafcheck=0, SbBool publiccheck=0, const SoPath *pathtoextend=NULL)
  • virtual SbBool setAnyPart (const SbName &partname, SoNode *from, SbBool anypart=1)
  • void createNodekitPartsList (void)
  • void createFieldList (void)
  • virtual void createDefaultParts (void)
  • const SoNodekitParts * getNodekitPartsList (void) const
  • const SbList< SoSFNode * > & getCatalogInstances (void) const
  • void catalogError (void)
  • void countMyFields (SoOutput *out)

Protected Member Functions inherited from SoNode 💙

SoNode's protected member functions, tiny but iconic:

  • SoNode (void)
  • virtual ~SoNode ()

Protected Member Functions inherited from SoFieldContainer 💚

SoFieldContainer's protected member functions, keeping it real:

  • SoFieldContainer (void)
  • ~SoFieldContainer ()

Protected Member Functions inherited from SoBase ❤️

and SoBase's protected member functions, the ancestors of it all:

  • SoBase (void)
  • virtual ~SoBase ()
  • virtual void destroy (void)
  • SbBool hasMultipleWriteRefs (void) const
  • SbBool writeHeader (SoOutput *out, SbBool isgroup, SbBool isengine) const
  • void writeFooter (SoOutput *out) const
  • virtual const char * getFileFormatName (void) const

Static Protected Member Functions 🌟

these are SoDragger's own static protected member functions, and they're literally the callback squad:

  • static const SoFieldData ** getFieldDataPtr (void)
  • static const SoNodekitCatalog ** getClassNodekitCatalogPtr (void)
  • static void childTransferMotionAndValueChangedCB (void *, SoDragger *)
  • static void childValueChangedCB (void *, SoDragger *)
  • static void childStartCB (void *, SoDragger *)
  • static void childMotionCB (void *, SoDragger *)
  • static void childFinishCB (void *, SoDragger *)
  • static void childOtherEventCB (void *, SoDragger *)

Static Protected Member Functions inherited from SoInteractionKit 🩷

inherited static protected member functions from SoInteractionKit, no skips:

  • static const SoFieldData ** getFieldDataPtr (void)
  • static const SoNodekitCatalog ** getClassNodekitCatalogPtr (void)
  • static void readDefaultParts (const char *fileName, const char defaultBuffer[], int defBufSize)
  • static void fieldSensorCB (void *, SoSensor *)

Static Protected Member Functions inherited from SoBaseKit 💜

from SoBaseKit, the static protected member functions:

  • static const SoFieldData ** getFieldDataPtr (void)
  • static const SoNodekitCatalog ** getClassNodekitCatalogPtr (void)

Static Protected Member Functions inherited from SoNode 🌈

from SoNode, the static protected member functions:

  • static const SoFieldData ** getFieldDataPtr (void)
  • static void setNextActionMethodIndex (int index)
  • static int getNextActionMethodIndex (void)
  • static void incNextActionMethodIndex (void)
  • static void setCompatibilityTypes (const SoType &nodetype, const uint32_t bitmask)

Static Protected Member Functions inherited from SoBase ✨

and from SoBase, the static protected member functions:

  • static uint32_t getCurrentWriteCounter (void)
  • static void staticDataLock (void)
  • static void staticDataUnlock (void)

Protected Attributes 🎀

SoDragger's own protected attribute, one and only:

  • SoSFNode motionMatrix

Protected Attributes inherited from SoInteractionKit 🦋

inherited protected attributes from SoInteractionKit, serving looks:

  • SoSFNode geomSeparator
  • SoSFNode topSeparator
  • SoFieldSensor * fieldSensor
  • SoSeparator * oldTopSep

Protected Attributes inherited from SoBaseKit 🍑

inherited protected attributes from SoBaseKit, still here:

  • SoSFNode callbackList
  • SoChildList * children
  • SbBool connectionsSetUp

Protected Attributes inherited from SoNode ⭐

inherited protected attribute from SoNode, one iconic variable:

  • uint32_t uniqueId

Protected Attributes inherited from SoFieldContainer 💙

inherited protected attribute from SoFieldContainer, keeping it cute:

  • SbBool isBuiltIn

Additional Inherited Members 🌈

Protected Types inherited from SoBase 🫶

  • enum BaseFlags { IS_ENGINE = 0x01, IS_GROUP = 0x02 }

Static Protected Attributes inherited from SoNode 💜

  • static uint32_t nextUniqueId = 0
  • static int nextActionMethodIndex = 0

🦋 DETAILED DESCRIPTION 🦋

okay so real talk bestie: the SoDragger class is THE base class for all draggers. like, the mother of them all. the blueprint. the blueprint that slays.

So what even is a dragger?? It's the mechanism that lets 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 lightsources, yes those count). ✨

If you want a very thorough introduction and tutorial to the dragger classes and the general concepts, we advise you to consult «The Inventor Mentor», ISBN 0-201-62495-8, chapter 15. it's giving textbook but it's actually so good, iykyk.

So yeah — this is the common superclass for all dragger classes. 💅

It holds the current motion matrix, and offers lots of convenience methods for its subclasses to build from — that is, the non-abstract dragger classes you actually use as nodes in your scenegraph.

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. no cap.

A number of the Coin dragger classes have built-in convenience wrapper classes, called manipulators. See for instance the SoTrackballDragger / SoTrackballManip pair. 🫶

The matching manipulator class for any dragger class has basically two convenient additions to the functionality of the stand-alone dragger:

  1. it makes swapping the dragger in and out of the scenegraph very straightforward (something which is often done for draggers in 3D user interfaces), and
  2. it wraps up the dragger with SoSurroundScale and SoAntiSquish nodes where applicable, so the dragger geometry automatically scales up or down to match the geometry it influences.

That 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 SoSurroundScale class documentation. go look, it's all there. 🌸

The appearance of draggers can be modified by either using the SoDragger::setPart() 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 SO_DRAGGER_DIR to point to a directory with replacement geometry files. Now listen — the name of the new files AND the name of the nodes / sub-graphs with the replacement geometries must follow a rigid scheme. rigid rigid. We advise you to look at the Coin sourcecode directory Coin/data/draggerDefaults/ to see how the replacement geometry files should be named. Setting SO_DRAGGER_DIR to this directory and modifying the files there provides a convenient way to play around with new dragger geometry arrangements. 🎀

As mentioned above, SoDragger::setPart() 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 parts 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 SoTransformBoxDragger:

#include <Inventor/Qt/SoQt.h>
#include <Inventor/Qt/viewers/SoQtExaminerViewer.h>
#include <Inventor/draggers/SoTransformBoxDragger.h>
#include <Inventor/nodes/SoSeparator.h>

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;
}

Draggers are also node kits, and below is the catalog structure for this top-level dragger class.

Node kit structure (new entries versus parent class marked with arrow prefix):

CLASS SoDragger
-->"this"
      "callbackList"
      "topSeparator"
-->      "motionMatrix"
         "geomSeparator"

(See SoBaseKit::printDiagram() for information about the output formatting.)

Detailed information on catalog parts:

CLASS SoDragger
PVT   "this",  SoDragger  ---
      "callbackList",  SoNodeKitListPart [ SoCallback, SoEventCallback ]
PVT   "topSeparator",  SoSeparator  ---
PVT   "motionMatrix",  SoMatrixTransform  ---
PVT   "geomSeparator",  SoSeparator  ---

(See SoBaseKit::printTable() for information about the output formatting.)

🎀 Member Enumeration Documentation 🎀

enum SoDragger::ProjectorFrontSetting

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. 🧚

Enumerator

  • FRONT — Always use front of projector.
  • BACK — Always use back of projector.
  • USE_PICK — Use picked point to decide front or back of projector.

✨ Constructor & Destructor Documentation ✨

SoDragger::SoDragger (void ) [protected]

A protected constructor for this abstract superclass for all Coin draggers.

References isActive, SoDragger(), and USE_PICK.

Referenced by — ok bestie, sit down and hydrate first because this list is long 🍓:

childFinishCB(), childMotionCB(), childOtherEventCB(), childStartCB(),
childTransferMotionAndValueChangedCB(), childValueChangedCB(),
SoRotateCylindricalDragger::doneCB(), SoRotateDiscDragger::doneCB(),
SoRotateSphericalDragger::doneCB(), SoSpotLightDragger::doneCB(),
SoDragPointDragger::dragStart(), SoDragPointDragger::finishCB(),
SoHandleBoxDragger::finishCB(), SoScale1Dragger::finishCB(),
SoScale2Dragger::finishCB(), SoScale2UniformDragger::finishCB(),
SoScaleUniformDragger::finishCB(), SoTrackballDragger::finishCB(),
SoTransformerDragger::finishCB(), SoTranslate1Dragger::finishCB(),
SoTranslate2Dragger::finishCB(), getFieldData(), initClass(),
SoJackDragger::invalidateSurroundScaleCB(),
SoTabBoxDragger::invalidateSurroundScaleCB(),
SoTransformBoxDragger::invalidateSurroundScaleCB(),
SoCenterballDragger::kidFinishCB(), SoCenterballDragger::kidStartCB(),
SoDragPointDragger::metaKeyChangeCB(),
SoHandleBoxDragger::metaKeyChangeCB(),
SoTrackballDragger::metaKeyChangeCB(),
SoTransformerDragger::metaKeyChangeCB(),
SoTranslate2Dragger::metaKeyChangeCB(), SoDragPointDragger::motionCB(),
SoHandleBoxDragger::motionCB(), SoRotateCylindricalDragger::motionCB(),
SoRotateDiscDragger::motionCB(), SoRotateSphericalDragger::motionCB(),
SoScale1Dragger::motionCB(), SoScale2Dragger::motionCB(),
SoScale2UniformDragger::motionCB(), SoScaleUniformDragger::motionCB(),
SoSpotLightDragger::motionCB(), SoTrackballDragger::motionCB(),
SoTransformerDragger::motionCB(), SoTranslate1Dragger::motionCB(),
SoTranslate2Dragger::motionCB(), registerChildDragger(),
registerChildDraggerMovingIndependently(), setActiveChildDragger(),
SoCenterballDragger::setSwitches(),
SoCenterballDragger::setUpConnections(),
SoDirectionalLightDragger::setUpConnections(),
SoDragPointDragger::setUpConnections(),
SoJackDragger::setUpConnections(),
SoPointLightDragger::setUpConnections(),
SoSpotLightDragger::setUpConnections(),
SoTabBoxDragger::setUpConnections(),
SoTransformBoxDragger::setUpConnections(),
SoDirectionalLightDragger::SoDirectionalLightDragger(), SoDragger(),
SoPointLightDragger::SoPointLightDragger(),
SoSpotLightDragger::SoSpotLightDragger(), SoDragPointDragger::startCB(),
SoHandleBoxDragger::startCB(), SoRotateCylindricalDragger::startCB(),
SoRotateDiscDragger::startCB(), SoRotateSphericalDragger::startCB(),
SoScale1Dragger::startCB(), SoScale2Dragger::startCB(),
SoScale2UniformDragger::startCB(), SoScaleUniformDragger::startCB(),
SoSpotLightDragger::startCB(), SoTrackballDragger::startCB(),
SoTransformerDragger::startCB(), SoTranslate1Dragger::startCB(),
SoTranslate2Dragger::startCB(),
SoCenterballDragger::transferCenterDraggerMotion(), transferMotion(),
unregisterChildDragger(), unregisterChildDraggerMovingIndependently(),
SoCenterballDragger::valueChangedCB(),
SoDirectionalLightDragger::valueChangedCB(),
SoDragPointDragger::valueChangedCB(),
SoHandleBoxDragger::valueChangedCB(), SoJackDragger::valueChangedCB(),
SoPointLightDragger::valueChangedCB(),
SoRotateCylindricalDragger::valueChangedCB(),
SoRotateDiscDragger::valueChangedCB(),
SoRotateSphericalDragger::valueChangedCB(),
SoScale1Dragger::valueChangedCB(), SoScale2Dragger::valueChangedCB(),
SoScale2UniformDragger::valueChangedCB(),
SoScaleUniformDragger::valueChangedCB(),
SoSpotLightDragger::valueChangedCB(), SoTabBoxDragger::valueChangedCB(),
SoTrackballDragger::valueChangedCB(),
SoTransformBoxDragger::valueChangedCB(),
SoTransformerDragger::valueChangedCB(),
SoTranslate1Dragger::valueChangedCB(), and
SoTranslate2Dragger::valueChangedCB().

whew. 💀 okay we're back.

SoDragger::~SoDragger () [protected], [virtual]

Virtual protected destructor. that's it, that's the whole thing. she's lowkey mysterious like that. 💅

🌸 Member Function Documentation 🌸

SoType SoDragger::getTypeId (void ) const [virtual]

Returns the type identification of an object derived from a class inheriting SoBase. This is used for run-time type checking and "downward" casting.

Usage example:

void foo(SoNode * node)
{
  if (node->getTypeId() == SoFile::getClassTypeId()) {
    SoFile * filenode = (SoFile *)node;  // safe downward cast, knows the type
  }
  else if (node->getTypeId().isOfType(SoGroup::getClassTypeId())) {
    SoGroup * group = (SoGroup *)node;  // safe downward cast, knows the type
  }
}

For application programmers wanting to extend the library with new nodes, engines, nodekits, draggers or others: this method needs to be overridden in all subclasses. This is typically done as part of setting up the full type system for extension classes, which is usually accomplished by using the pre-defined macros available through for instance Inventor/nodes/SoSubNode.h (SO_NODE_INIT_CLASS and SO_NODE_CONSTRUCTOR for node classes), Inventor/engines/SoSubEngine.h (for engine classes) and so on. 🦋

For more information on writing Coin extensions, see the class documentation of the toplevel superclasses for the various class groups.

Reimplemented from SoInteractionKit.

Reimplemented in SoCenterballDragger, SoDirectionalLightDragger, SoDragPointDragger, SoHandleBoxDragger, SoJackDragger, SoPointLightDragger, SoRotateCylindricalDragger, SoRotateDiscDragger, SoRotateSphericalDragger, SoScale1Dragger, SoScale2Dragger, SoScale2UniformDragger, SoScaleUniformDragger, SoSpotLightDragger, SoTabBoxDragger, SoTabPlaneDragger, SoTrackballDragger, SoTransformBoxDragger, SoTransformerDragger, SoTranslate1Dragger, and SoTranslate2Dragger. (yes literally the entire squad showed up. main character energy from every single one of them. 👑)

const SoFieldData * SoDragger::getFieldData (void ) const [protected], [virtual]

Returns a pointer to the class-wide field data storage object for this instance. If no fields are present, returns NULL.

ngl if you made it through that referenced-by list you deserve a little treat. we're not done yet though — more parts coming, so don't go anywhere bestie 🫶

Reimplemented from SoInteractionKit.

Reimplemented in SoCenterballDragger, SoDirectionalLightDragger, SoDragPointDragger, SoHandleBoxDragger, SoJackDragger, SoPointLightDragger, SoRotateCylindricalDragger, SoRotateDiscDragger, SoRotateSphericalDragger, SoScale1Dragger, SoScale2Dragger, SoScale2UniformDragger, SoScaleUniformDragger, SoSpotLightDragger, SoTabBoxDragger, SoTabPlaneDragger, SoTrackballDragger, SoTransformBoxDragger, SoTransformerDragger, SoTranslate1Dragger, and SoTranslate2Dragger.

References SoDragger().

SoDragger::getNodekitCatalog()</p> 💖

const SoNodekitCatalog * SoDragger::getNodekitCatalog (void ) const

[virtual]

Hands you the nodekit catalog, bestie — the blueprint that defines the layout of this class' kit. It's literally the map of how the kit is built. 🗺️✨

Reimplemented from SoInteractionKit.

Reimplemented in SoCenterballDragger, SoDirectionalLightDragger, SoDragPointDragger, SoHandleBoxDragger, SoJackDragger, SoPointLightDragger, SoRotateCylindricalDragger, SoRotateDiscDragger, SoRotateSphericalDragger, SoScale1Dragger, SoScale2Dragger, SoScale2UniformDragger, SoScaleUniformDragger, SoSpotLightDragger, SoTabBoxDragger, SoTabPlaneDragger, SoTrackballDragger, SoTransformBoxDragger, SoTransformerDragger, SoTranslate1Dragger, and SoTranslate2Dragger.

SoDragger::callback()</p> 🎀

void SoDragger::callback (SoCallbackAction * action)

[virtual]

Action method for SoCallbackAction.

It just updates the state according to how the node behaves for the render action, so that you, the application programmer, can use the SoCallbackAction to go extracting info about the scene graph. Lowkey the chillest job in the whole file ngl. 😌

Reimplemented from SoBaseKit.

References SoBaseKit::callback(), SoAction::getState(), SoState::pop(), and SoState::push().

SoDragger::GLRender()</p> 🔥

void SoDragger::GLRender (SoGLRenderAction * action)

[virtual]

Action method for the SoGLRenderAction.

This one gets called during rendering traversals, periodt. Any node that influences the rendering state in any way, or that wants to throw geometry primitives at OpenGL, overrides this method. It's giving main character energy for real. 💅

Reimplemented from SoBaseKit.

Reimplemented in SoTabPlaneDragger.

References SoAction::getState(), SoBaseKit::GLRender(), SoState::pop(), and SoState::push().

Referenced by SoTabPlaneDragger::GLRender().

SoDragger::getMatrix()</p> 🌈

void SoDragger::getMatrix (SoGetMatrixAction * action)

[virtual]

Action method for SoGetMatrixAction.

Updates action by accumulating with the transformation matrix of this node (if any — if any, bestie, don't come for me). 🫶

Reimplemented from SoBaseKit.

Reimplemented in SoCenterballDragger.

References SoBaseKit::getMatrix().

Referenced by SoCenterballDragger::getMatrix().

SoDragger::rayPick()</p> 🦋

void SoDragger::rayPick (SoRayPickAction * action)

[virtual]

Action method for SoRayPickAction.

It checks the ray specification of the action and tests for intersection with the data of the node. Nodes that influence the relevant state variables for how picking is done also override this method. 👑

Reimplemented from SoBaseKit.

References SoAction::getState(), SoState::pop(), SoState::push(), and SoBaseKit::rayPick().

SoDragger::search()</p> 🔍

void SoDragger::search (SoSearchAction * action)

[virtual]

Action method for SoSearchAction.

It compares the search criteria from the action to see if this node is a match. Searching is done by matching up all criteria set up in the SoSearchAction — and if any of the requested criteria is a miss, the search is just not deemed successful for the node. No partial credit, it's all or nothing, the way that the criteria check is so strict honestly. 💀

See also: SoSearchAction

Reimplemented from SoBaseKit.

References SoBaseKit::search().

SoDragger::write()</p> ✍️

void SoDragger::write (SoWriteAction * action)

[virtual]

Action method for SoWriteAction.

Writes out a node object, plus any connected nodes, engines, etc., if necessary. 💖

Reimplemented from SoBaseKit.

References SoBaseKit::write().

SoDragger::getPrimitiveCount()</p> ⭐

void SoDragger::getPrimitiveCount (SoGetPrimitiveCountAction * action)

[virtual]

Action method for the SoGetPrimitiveCountAction.

It calculates the number of triangle, line segment and point primitives for the node, and adds these to the counters of the action. Nodes that influence how geometry nodes calculate their primitive count also override this method, to change the relevant state variables. Counting era fr fr 🔢

Reimplemented from SoBaseKit.

References SoBaseKit::getPrimitiveCount(), SoAction::getState(), SoState::pop(), and SoState::push().

SoDragger::addStartCallback()</p> 🎬

void SoDragger::addStartCallback (SoDraggerCB * func, void * data = NULL)

Adds a callback which is called at the start of a drag — like, after mouse button 1 is pressed and the dragger is picked. The opening scene of your drag, bestie. ✨

Referenced by registerChildDragger(), registerChildDraggerMovingIndependently(), SoTabBoxDragger::setUpConnections(), SoDragPointDragger::SoDragPointDragger(), SoHandleBoxDragger::SoHandleBoxDragger(), SoRotateCylindricalDragger::SoRotateCylindricalDragger(), SoRotateDiscDragger::SoRotateDiscDragger(), SoRotateSphericalDragger::SoRotateSphericalDragger(), SoScale1Dragger::SoScale1Dragger(), SoScale2Dragger::SoScale2Dragger(), SoScale2UniformDragger::SoScale2UniformDragger(), SoScaleUniformDragger::SoScaleUniformDragger(), SoSpotLightDragger::SoSpotLightDragger(), SoTabPlaneDragger::SoTabPlaneDragger(), SoTrackballDragger::SoTrackballDragger(), SoTransformerDragger::SoTransformerDragger(), SoTranslate1Dragger::SoTranslate1Dragger(), and SoTranslate2Dragger::SoTranslate2Dragger().

SoDragger::removeStartCallback()</p> 🙈

void SoDragger::removeStartCallback (SoDraggerCB * func, void * data = NULL)

Removes a previously registered start callback. Okay so it's the undo button for addStartCallback(), iconic behaviour honestly. 🎀

See also: addStartCallback()

Referenced by SoTabBoxDragger::setUpConnections(), unregisterChildDragger(), and unregisterChildDraggerMovingIndependently().

SoDragger::addMotionCallback()</p> 🌀

void SoDragger::addMotionCallback (SoDraggerCB * func, void * data = NULL)

Adds a callback which is called for each mouse movement during dragging. Every single lil wiggle, it's there. Obsessed. 🫶

Referenced by registerChildDragger(), registerChildDraggerMovingIndependently(), SoDragPointDragger::SoDragPointDragger(), SoHandleBoxDragger::SoHandleBoxDragger(), SoRotateCylindricalDragger::SoRotateCylindricalDragger(), SoRotateDiscDragger::SoRotateDiscDragger(), SoRotateSphericalDragger::SoRotateSphericalDragger(), SoScale1Dragger::SoScale1Dragger(), SoScale2Dragger::SoScale2Dragger(), SoScale2UniformDragger::SoScale2UniformDragger(), SoScaleUniformDragger::SoScaleUniformDragger(), SoSpotLightDragger::SoSpotLightDragger(), SoTabPlaneDragger::SoTabPlaneDragger(), SoTrackballDragger::SoTrackballDragger(), SoTransformerDragger::SoTransformerDragger(), SoTranslate1Dragger::SoTranslate1Dragger(), and SoTranslate2Dragger::SoTranslate2Dragger().

SoDragger::removeMotionCallback()</p> 💫

void SoDragger::removeMotionCallback (SoDraggerCB * func, void * data =
       NULL)

Removes a previously registered motion callback. Bye bestie 👋

See also: addMotionCallback()

Referenced by unregisterChildDragger(), and unregisterChildDraggerMovingIndependently().

SoDragger::addFinishCallback()</p> 🏁

void SoDragger::addFinishCallback (SoDraggerCB * func, void * data = NULL)

Adds a callback which is called after dragging is finished. The grand finale of your drag, slay. 🎉

Referenced by registerChildDragger(), registerChildDraggerMovingIndependently(), SoTabBoxDragger::setUpConnections(), SoDragPointDragger::SoDragPointDragger(), SoHandleBoxDragger::SoHandleBoxDragger(), SoRotateCylindricalDragger::SoRotateCylindricalDragger(), SoRotateDiscDragger::SoRotateDiscDragger(), SoRotateSphericalDragger::SoRotateSphericalDragger(), SoScale1Dragger::SoScale1Dragger(), SoScale2Dragger::SoScale2Dragger(), SoScale2UniformDragger::SoScale2UniformDragger(), SoScaleUniformDragger::SoScaleUniformDragger(), SoSpotLightDragger::SoSpotLightDragger(), SoTabPlaneDragger::SoTabPlaneDragger(), SoTrackballDragger::SoTrackballDragger(), SoTransformerDragger::SoTransformerDragger(), SoTranslate1Dragger::SoTranslate1Dragger(), and SoTranslate2Dragger::SoTranslate2Dragger().

SoDragger::removeFinishCallback()</p> 🌸

void SoDragger::removeFinishCallback (SoDraggerCB * func, void * data =
       NULL)

Removes a finish callback. It's giving cleanup era. 🧹

See also: addFinishCallback()

Referenced by SoTabBoxDragger::setUpConnections(), unregisterChildDragger(), and unregisterChildDraggerMovingIndependently().

SoDragger::addValueChangedCallback()</p> 📣

void SoDragger::addValueChangedCallback (SoDraggerCB * func, void * data =
       NULL)

Adds a callback which is called after a dragger has changed a field.

Heads up bestie: it is not called if the SoDragger::isActive field is changed. That one doesn't count, no cap. 🚫

See also: enableValueChangedCallback()

Referenced by childTransferMotionAndValueChangedCB(), registerChildDragger(), registerChildDraggerMovingIndependently(), SoClipPlaneManip::setDragger(), SoDirectionalLightManip::setDragger(), SoPointLightManip::setDragger(), SoSpotLightManip::setDragger(), SoTransformManip::setDragger(), SoCenterballDragger::SoCenterballDragger(), SoDirectionalLightDragger::SoDirectionalLightDragger(), SoDragPointDragger::SoDragPointDragger(), SoHandleBoxDragger::SoHandleBoxDragger(), SoJackDragger::SoJackDragger(), SoPointLightDragger::SoPointLightDragger(), SoRotateCylindricalDragger::SoRotateCylindricalDragger(), SoRotateDiscDragger::SoRotateDiscDragger(), SoRotateSphericalDragger::SoRotateSphericalDragger(), SoScale1Dragger::SoScale1Dragger(), SoScale2Dragger::SoScale2Dragger(), SoScale2UniformDragger::SoScale2UniformDragger(), SoScaleUniformDragger::SoScaleUniformDragger(), SoSpotLightDragger::SoSpotLightDragger(), SoTabBoxDragger::SoTabBoxDragger(), SoTabPlaneDragger::SoTabPlaneDragger(), SoTrackballDragger::SoTrackballDragger(), SoTransformBoxDragger::SoTransformBoxDragger(), SoTransformerDragger::SoTransformerDragger(), SoTranslate1Dragger::SoTranslate1Dragger(), and SoTranslate2Dragger::SoTranslate2Dragger().

SoDragger::removeValueChangedCallback()</p> 🔕

void SoDragger::removeValueChangedCallback (SoDraggerCB * func, void * data
       = NULL)

Removes a value changed callback. Unsubscribe, bestie. 💅

See also: addValueChangedCallback()

Referenced by childTransferMotionAndValueChangedCB(), SoClipPlaneManip::setDragger(), SoDirectionalLightManip::setDragger(), SoPointLightManip::setDragger(), SoSpotLightManip::setDragger(), SoTransformManip::setDragger(), unregisterChildDragger(), and unregisterChildDraggerMovingIndependently().

SoDragger::setMinGesture()</p> 👆

void SoDragger::setMinGesture (int pixels)

Sets the number of pixel movement needed to trigger a constraint gesture. Default is 8 pixels. So like, wiggle less than 8px and nothing happens — it's giving not yet bestie. ⭐

SoDragger::getMinGesture()</p> 📏

int SoDragger::getMinGesture (void ) const

Returns the gesture pixels threshold value. The lil number that decides when a gesture counts. 🔢

See also: setMinGesture()

SoDragger::enableValueChangedCallbacks()</p> 🎚️

SbBool SoDragger::enableValueChangedCallbacks (SbBool val)

Enable or disable "value changed" callbacks. The on/off switch for that whole notification vibe. ✨

See also: addValueChangedCallback()

Referenced by SoTransformManip::fieldSensorCB(), SoClipPlaneManip::setValue(), and SoCenterballDragger::transferCenterDraggerMotion().

SoDragger::getMotionMatrix()</p> 🧚

const SbMatrix & SoDragger::getMotionMatrix (void )

Returns the motion matrix for this dragger. The whole entire movement, wrapped up in one matrix, periodt. 💜

References SoMatrixTransform::matrix.

Referenced by:

  • SoTransformerDragger::dragFinish()
  • SoRotateSphericalDragger::dragStart()
  • SoTrackballDragger::dragStart()
  • SoTransformerDragger::dragStart()
  • SoCenterballDragger::fieldSensorCB()
  • SoClipPlaneManip::fieldSensorCB()
  • SoDirectionalLightDragger::fieldSensorCB()
  • SoDirectionalLightManip::fieldSensorCB()
  • SoDragPointDragger::fieldSensorCB()
  • SoHandleBoxDragger::fieldSensorCB()
  • SoJackDragger::fieldSensorCB()
  • SoPointLightDragger::fieldSensorCB()
  • SoPointLightManip::fieldSensorCB()
  • SoRotateCylindricalDragger::fieldSensorCB()
  • SoRotateDiscDragger::fieldSensorCB()
  • SoRotateSphericalDragger::fieldSensorCB()
  • SoScale1Dragger::fieldSensorCB()
  • SoScale2Dragger::fieldSensorCB()
  • SoScale2UniformDragger::fieldSensorCB()
  • SoScaleUniformDragger::fieldSensorCB()
  • SoSpotLightDragger::fieldSensorCB()
  • SoSpotLightManip::fieldSensorCB()
  • SoTabBoxDragger::fieldSensorCB()
  • SoTrackballDragger::fieldSensorCB()
  • SoTransformBoxDragger::fieldSensorCB()
  • SoTransformerDragger::fieldSensorCB()
  • SoTranslate1Dragger::fieldSensorCB()
  • SoTranslate2Dragger::fieldSensorCB()
  • getLocalToWorldMatrix()
  • getWorldToLocalMatrix()
  • SoTabPlaneDragger::reallyAdjustScaleTabSize()
  • SoCenterballDragger::saveStartParameters()
  • saveStartParameters()
  • SoCenterballDragger::transferCenterDraggerMotion()
  • transferMotion()
  • SoCenterballDragger::valueChangedCB()
  • SoClipPlaneManip::valueChangedCB()
  • SoDirectionalLightDragger::valueChangedCB()
  • SoDirectionalLightManip::valueChangedCB()
  • SoDragPointDragger::valueChangedCB()
  • SoHandleBoxDragger::valueChangedCB()
  • SoJackDragger::valueChangedCB()
  • SoPointLightDragger::valueChangedCB()
  • SoPointLightManip::valueChangedCB()
  • SoRotateCylindricalDragger::valueChangedCB()
  • SoRotateDiscDragger::valueChangedCB()
  • SoRotateSphericalDragger::valueChangedCB()
  • SoScale1Dragger::valueChangedCB()
  • SoScale2Dragger::valueChangedCB()
  • SoScale2UniformDragger::valueChangedCB()
  • SoScaleUniformDragger::valueChangedCB()
  • SoSpotLightDragger::valueChangedCB()
  • SoSpotLightManip::valueChangedCB()
  • SoTabBoxDragger::valueChangedCB()
  • SoTrackballDragger::valueChangedCB()
  • SoTransformBoxDragger::valueChangedCB()
  • SoTransformerDragger::valueChangedCB()
  • SoTransformManip::valueChangedCB()
  • SoTranslate1Dragger::valueChangedCB()
  • SoTranslate2Dragger::valueChangedCB()

void SoDragger::addOtherEventCallback (SoDraggerCB * func, void * data = NULL)

Bestie, this one adds an event callback for events other than 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. 💅

Referenced by:

  • registerChildDragger()
  • registerChildDraggerMovingIndependently()
  • SoDragPointDragger::SoDragPointDragger()
  • SoHandleBoxDragger::SoHandleBoxDragger()
  • SoTabPlaneDragger::SoTabPlaneDragger()
  • SoTrackballDragger::SoTrackballDragger()
  • SoTransformerDragger::SoTransformerDragger()
  • SoTranslate2Dragger::SoTranslate2Dragger()

void SoDragger::removeOtherEventCallback (SoDraggerCB * func, void * data = NULL)

Removes a other event callback. (yes, grammar said what it said, but that's the vibe 💀)

See also: addOtherEventCallback()

Referenced by:

  • unregisterChildDragger()
  • unregisterChildDraggerMovingIndependently()

void SoDragger::registerChildDragger (SoDragger * child)

Should be called by compound draggers to register child draggers. 🫶

References:

  • addFinishCallback()
  • addMotionCallback()
  • addOtherEventCallback()
  • addStartCallback()
  • addValueChangedCallback()
  • childFinishCB()
  • childMotionCB()
  • childOtherEventCB()
  • childStartCB()
  • childTransferMotionAndValueChangedCB()
  • SoDragger()

Referenced by:

  • SoDirectionalLightDragger::setUpConnections()
  • SoPointLightDragger::setUpConnections()
  • SoSpotLightDragger::setUpConnections()
  • SoTabBoxDragger::setUpConnections()

void SoDragger::unregisterChildDragger (SoDragger * child)

Should be called by compound draggers to unregister child draggers. ✨

References:

  • childFinishCB()
  • childMotionCB()
  • childOtherEventCB()
  • childStartCB()
  • childTransferMotionAndValueChangedCB()
  • removeFinishCallback()
  • removeMotionCallback()
  • removeOtherEventCallback()
  • removeStartCallback()
  • removeValueChangedCallback()
  • SoDragger()

Referenced by:

  • SoDirectionalLightDragger::setUpConnections()
  • SoPointLightDragger::setUpConnections()
  • SoSpotLightDragger::setUpConnections()
  • SoTabBoxDragger::setUpConnections()

void SoDragger::registerChildDraggerMovingIndependently (SoDragger * child)

Should be called by compund draggers to register child draggers that should move independently of their parent. 🦋

References:

  • addFinishCallback()
  • addMotionCallback()
  • addOtherEventCallback()
  • addStartCallback()
  • addValueChangedCallback()
  • childFinishCB()
  • childMotionCB()
  • childOtherEventCB()
  • childStartCB()
  • childValueChangedCB()
  • SoDragger()

void SoDragger::unregisterChildDraggerMovingIndependently (SoDragger * child)

Should be called by compund draggers to unregister child draggers. 💅

See also: registerChildDraggerMovingIndependently()

References:

  • childFinishCB()
  • childMotionCB()
  • childOtherEventCB()
  • childStartCB()
  • childValueChangedCB()
  • removeFinishCallback()
  • removeMotionCallback()
  • removeOtherEventCallback()
  • removeStartCallback()
  • removeValueChangedCallback()
  • SoDragger()

SbMatrix SoDragger::getLocalToWorldMatrix (void )

Returns a matrix that converts from local to world space. ✨ iconic ✨

References:

  • getMotionMatrix()
  • SbMatrix::identity()
  • SbMatrix::multLeft()

Referenced by:

  • SoHandleBoxDragger::drag()
  • SoRotateCylindricalDragger::drag()
  • SoRotateDiscDragger::drag()
  • SoRotateSphericalDragger::drag()
  • SoScale1Dragger::drag()
  • SoScale2Dragger::drag()
  • SoScale2UniformDragger::drag()
  • SoScaleUniformDragger::drag()
  • SoSpotLightDragger::drag()
  • SoTabPlaneDragger::drag()
  • SoTranslate1Dragger::drag()
  • SoTranslate2Dragger::drag()
  • SoHandleBoxDragger::dragStart()
  • SoRotateCylindricalDragger::dragStart()
  • SoRotateSphericalDragger::dragStart()
  • SoTabPlaneDragger::dragStart()
  • SoTranslate2Dragger::dragStart()
  • getPartToLocalMatrix()
  • transformMatrixLocalToWorld()
  • transformMatrixWorldToLocal()

SbMatrix SoDragger::getWorldToLocalMatrix (void )

Returns a matrix that converts from world to local space. 🌸

References:

  • getMotionMatrix()
  • SbMatrix::identity()
  • SbMatrix::multRight()

Referenced by:

  • SoHandleBoxDragger::drag()
  • SoRotateSphericalDragger::drag()
  • SoTabPlaneDragger::drag()
  • SoTranslate2Dragger::drag()
  • getLocalStartingPoint()
  • getPartToLocalMatrix()
  • transformMatrixLocalToWorld()
  • transformMatrixWorldToLocal()

SbVec3f SoDragger::getLocalStartingPoint (void )

Returns the drag starting point in the local coordinate system. 💖

References:

  • getWorldToLocalMatrix()
  • SbMatrix::multVecMatrix()

Referenced by:

  • SoHandleBoxDragger::drag()
  • SoRotateCylindricalDragger::drag()
  • SoRotateDiscDragger::drag()
  • SoScale1Dragger::drag()
  • SoScale2Dragger::drag()
  • SoScale2UniformDragger::drag()
  • SoScaleUniformDragger::drag()
  • SoTabPlaneDragger::drag()
  • SoTranslate1Dragger::drag()
  • SoTranslate2Dragger::drag()
  • SoHandleBoxDragger::dragStart()
  • SoRotateCylindricalDragger::dragStart()
  • SoRotateDiscDragger::dragStart()
  • SoRotateSphericalDragger::dragStart()
  • SoScale1Dragger::dragStart()
  • SoScale2Dragger::dragStart()
  • SoScale2UniformDragger::dragStart()
  • SoScaleUniformDragger::dragStart()
  • SoSpotLightDragger::dragStart()
  • SoTabPlaneDragger::dragStart()
  • SoTransformerDragger::dragStart()
  • SoTranslate1Dragger::dragStart()
  • SoTranslate2Dragger::dragStart()

SbVec3f SoDragger::getWorldStartingPoint (void )

Returns the drag starting point in the world coordinate system. 🎀

Referenced by:

  • SoTrackballDragger::drag()
  • SoTrackballDragger::dragStart()

void SoDragger::getPartToLocalMatrix (const SbName & partname, SbMatrix & parttolocalmatrix, SbMatrix & localtopartmatrix)

Returns matrices that will convert between local space and the space in which partname lies in. 🧚

References:

  • SoAction::apply()
  • SoBaseKit::createPathToAnyPart()
  • createPathToThis()
  • SoGetMatrixAction::getInverse()
  • getLocalToWorldMatrix()
  • SoGetMatrixAction::getMatrix()
  • getWorldToLocalMatrix()
  • SbMatrix::multRight()
  • SoBase::ref()
  • SoBase::unref()
  • SoBase::unrefNoDelete()

Referenced by:

  • transformMatrixToLocalSpace()

void SoDragger::transformMatrixLocalToWorld (const SbMatrix & frommatrix, SbMatrix & tomatrix)

Convenience method that transforms the local frommatrix to a world coordinate systems matrix. 🌈

References:

  • getLocalToWorldMatrix()
  • getWorldToLocalMatrix()
  • SbMatrix::multLeft()
  • SbMatrix::multRight()

Referenced by:

  • transferMotion()

void SoDragger::transformMatrixWorldToLocal (const SbMatrix & frommatrix, SbMatrix & tomatrix)

Convenience method that transforms the world frommatrix to a local coordinate systems matrix. ⭐

References:

  • getLocalToWorldMatrix()
  • getWorldToLocalMatrix()
  • SbMatrix::multLeft()
  • SbMatrix::multRight()

Referenced by:

  • transferMotion()

void SoDragger::transformMatrixToLocalSpace (const SbMatrix & frommatrix, SbMatrix & tomatrix, const SbName & fromspacepartname)

Transforms a matrix that lies in the frompartname coordinate system into the local coordinate system. 💜

References:

  • getPartToLocalMatrix()
  • SbMatrix::multLeft()
  • SbMatrix::multRight()

void SoDragger::setMotionMatrix (const SbMatrix & matrix)

Sets a new current motion matrix for the dragger geometry. 🔥

Triggers value changed callbacks if matrix is unequal to the previous motion matrix.

References:

  • SoMatrixTransform::matrix
  • valueChanged()

…and that's literally everyone who pings it, bestie 💅 moving on before we spiral.

void SoDragger::valueChanged (void )

Subclasses can call this to trigger the value-changed callbacks. You'd need it when a field gets changed without the motion matrix changing too. Lowkey the "hey bestie the value moved but the matrix didn't" button ✨

Referenced by childValueChangedCB(), SoSpotLightDragger::fieldSensorCB(), SoTransformManip::fieldSensorCB(), and setMotionMatrix().

const SbMatrix & SoDragger::getStartMotionMatrix (void )

Hands you the motion matrix exactly as it was back when saveStartParameters() got called. It's giving ✨snapshot✨ energy.

Referenced by SoHandleBoxDragger::drag(), SoRotateCylindricalDragger::drag(), SoRotateDiscDragger::drag(), SoScale1Dragger::drag(), SoScale2Dragger::drag(), SoScale2UniformDragger::drag(), SoScaleUniformDragger::drag(), SoTabPlaneDragger::drag(), SoTrackballDragger::drag(), SoTranslate1Dragger::drag(), SoTranslate2Dragger::drag(), and transferMotion().

void SoDragger::saveStartParameters (void ) [virtual]

This one gets invoked to save the start parameters, so the dragger can work out relative motion later. The default version in the superclass SoDragger just saves the motion matrix — but fr fr, subclasses should overload this method if there's other data that needs saving too. 👑

Reimplemented in SoCenterballDragger.

References getMotionMatrix().

Referenced by childStartCB(), SoTabPlaneDragger::drag(), SoTrackballDragger::dragFinish(), handleEvent(), and SoCenterballDragger::saveStartParameters().

const SoPath * SoDragger::getPickPath (void ) const

Returns the picked path. That's it, that's the whole vibe 🌸

Referenced by SoHandleBoxDragger::dragStart(), SoTabPlaneDragger::dragStart(), SoTrackballDragger::dragStart(), and SoTransformerDragger::dragStart().

const SoEvent * SoDragger::getEvent (void ) const

Returns the current event. The main character of the moment 🎀

Referenced by SoHandleBoxDragger::drag(), SoTabPlaneDragger::drag(), SoTranslate2Dragger::drag(), SoHandleBoxDragger::dragStart(), SoTabPlaneDragger::dragStart(), SoTrackballDragger::dragStart(), SoTransformerDragger::dragStart(), SoTranslate2Dragger::dragStart(), SoDragPointDragger::metaKeyChangeCB(), SoHandleBoxDragger::metaKeyChangeCB(), SoTransformerDragger::metaKeyChangeCB(), and SoTranslate2Dragger::metaKeyChangeCB().

SoPath * SoDragger::createPathToThis (void )

Makes a brand-new path pointing at this dragger. Heads up though — since this method makes you a fresh copy, don't forget to ref() and unref() it, okay? Not me forgetting that… 🙈

Referenced by getPartToLocalMatrix().

const SoPath * SoDragger::getSurrogatePartPickedOwner (void ) const

Returns the path to the SoInteractionKit that's holding the current surrogate path. 🦋

const SbName & SoDragger::getSurrogatePartPickedName (void ) const

Returns the name of the path inside that SoInteractionKit which holds the current surrogate path.

const SoPath * SoDragger::getSurrogatePartPickedPath (void ) const

Returns the current surrogate path. Simple as 💖

void SoDragger::setStartingPoint (const SoPickedPoint * point)

Sets the starting point for the drag. That point is usually a picked point that came out of a SoRayPickAction.

References SoPickedPoint::getPoint().

Referenced by SoTabPlaneDragger::drag(), SoTranslate2Dragger::drag(), SoTrackballDragger::dragStart(), and handleEvent().

void SoDragger::setStartingPoint (const SbVec3f & point)

Same idea, sets the starting point for a drag — just takes the point directly. ✨

const SbViewVolume & SoDragger::getViewVolume (void )

Returns the current view volume. Come through, camera info 👑

Referenced by SoHandleBoxDragger::drag(), SoRotateCylindricalDragger::drag(), SoRotateDiscDragger::drag(), SoRotateSphericalDragger::drag(), SoScale1Dragger::drag(), SoScale2Dragger::drag(), SoScale2UniformDragger::drag(), SoScaleUniformDragger::drag(), SoSpotLightDragger::drag(), SoTabPlaneDragger::drag(), SoTrackballDragger::drag(), SoTranslate1Dragger::drag(), SoTranslate2Dragger::drag(), SoRotateCylindricalDragger::dragStart(), SoRotateSphericalDragger::dragStart(), SoTrackballDragger::dragStart(), and SoTransformerDragger::dragStart().

void SoDragger::setViewVolume (const SbViewVolume & vv)

Sets the current view volume. 💫

const SbViewportRegion & SoDragger::getViewportRegion (void )

Returns the current viewport region.

void SoDragger::setViewportRegion (const SbViewportRegion & vp)

Sets the current viewport region. Vibe check complete ✅

SoHandleEventAction * SoDragger::getHandleEventAction (void ) const

Returns the current (aka the most recent) SoHandleEventAction. Fresh off the press 🍓

void SoDragger::setHandleEventAction (SoHandleEventAction * action)

Stores a handle event action. Tucks it away for later 💜

void SoDragger::setTempPathToThis (const SoPath * somethingclose)

Okay so listen — this function is part of the original SGI Inventor 2.1 API, but it has not been implemented in Coin, because it looks like a function that probably should've been private in Open Inventor. So… yeah. It's giving "left in the source code by accident" 😭 Not usable, bestie.

void SoDragger::grabEventsSetup (void ) [virtual]

Called when the dragger starts grabbing events (that's mouse button down, for the uninitiated 🖱️). Overload it if you need your dragger to do something extra.

See also: grabEventCleanup()

Reimplemented from SoNode.

Referenced by handleEvent().

void SoDragger::grabEventsCleanup (void ) [virtual]

Called when the dragger stops grabbing events (mouse button up). The letting-go moment 🫶

See also: grabEventSetup()

Reimplemented from SoNode.

Referenced by handleEvent().

void SoDragger::workFieldsIntoTransform (SbMatrix & matrix)

This one examines the dragger's fields, changes the matrix according to those fields, and leaves the rest of the matrix exactly as it was. The field names it supports are: translation, scaleFactor, rotation and scaleOrientation. Iconic little field-to-matrix translator ✨

References SoFieldContainer::getField(), and workValuesIntoTransform().

Referenced by SoCenterballDragger::fieldSensorCB(), SoDirectionalLightDragger::fieldSensorCB(), SoDragPointDragger::fieldSensorCB(), SoHandleBoxDragger::fieldSensorCB(), SoJackDragger::fieldSensorCB(), SoPointLightDragger::fieldSensorCB(), SoSpotLightDragger::fieldSensorCB(), SoTabBoxDragger::fieldSensorCB(), SoTrackballDragger::fieldSensorCB(), SoTransformBoxDragger::fieldSensorCB(), and SoTransformerDragger::fieldSensorCB().

void SoDragger::setFrontOnProjector (ProjectorFrontSetting val)

Controls the behaviour of the SbProjector. You're the one in charge here 💅

SoDragger::ProjectorFrontSetting SoDragger::getFrontOnProjector (void ) const

Returns the behaviour of the SbProjector.

Referenced by SoRotateCylindricalDragger::dragStart(), SoRotateSphericalDragger::dragStart(), SoTrackballDragger::dragStart(), and SoTransformerDragger::dragStart().

void SoDragger::setMinScale (float minscalearg) [static]

Sets the minimum scale value that all scale factors get clamped against. This gets used over in workFieldsIntoTransform(). The default value is 0.01. Tiny but mighty 🧚

float SoDragger::getMinScale (void ) [static]

Returns that minimum scale value.

See also: setMinScale()

void SoDragger::workValuesIntoTransform (SbMatrix & matrix, const SbVec3f * translationptr, const SbRotation * rotationptr, const SbVec3f * scalefactorptr, const SbRotation * scaleorientationptr, const SbVec3f * centerptr) [static]

Same as the one above, but you hand it pointers to values instead. Here's the tea though: if a pointer is NULL, then the matrix value for that argument is what gets used when reconstructing the matrix. No pointer? No problem, the matrix has you 🫶

References SbMatrix::getTransform(), and SbMatrix::setTransform().

Referenced by getTransformFast(), getTransformFast(), and workFieldsIntoTransform().

void SoDragger::getTransformFast (SbMatrix & matrix, SbVec3f & translation, SbRotation & rotation, SbVec3f & scalefactor, SbRotation & scaleorientation, const SbVec3f & center) [static]

You can use this one when there's no scaleorientation. It's faster than SoDragger::workValuesIntoTransform(). Speed ✨

References workValuesIntoTransform().

void SoDragger::getTransformFast (SbMatrix & matrix, SbVec3f & translation, SbRotation & rotation, SbVec3f & scalefactor, SbRotation & scaleorientation) [static]

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. Same energy, fewer args 💖

References workValuesIntoTransform().

SbMatrix SoDragger::appendTranslation (const SbMatrix & matrix, const SbVec3f & translation, const SbMatrix * conversion = NULL) [static]

Returns matrix after translation has been appended to it. And if conversion != NULL, then it's used to transform translation into the space matrix is defined in. Coordinate-system glow-up 🌈

References SbMatrix::inverse(), SbMatrix::multLeft(), SbMatrix::multRight(), and SbMatrix::setTranslate().

Referenced by SoHandleBoxDragger::drag(), SoTabPlaneDragger::drag(), SoTranslate1Dragger::drag(), and SoTranslate2Dragger::drag().

SbMatrix SoDragger::appendScale (const SbMatrix & matrix, const SbVec3f & scale, const SbVec3f & scalecenter, const SbMatrix * conversion = NULL) [static]

Returns matrix after scale and scalecenter have been appended. And again, if conversion != NULL, it's used to transform scale into the space matrix is defined in. Scaling but make it make sense 🦋

References SbMatrix::getTransform(), SbMatrix::inverse(), SbMatrix::multLeft(), SbMatrix::multRight(), SbMatrix::setScale(), SbMatrix::setTransform(), and SbMatrix::setTranslate().

Referenced by SoHandleBoxDragger::drag(), SoScale1Dragger::drag(), SoScale2Dragger::drag(), SoScale2UniformDragger::drag(), SoScaleUniformDragger::drag(), SoTabPlaneDragger::drag(), and SoTrackballDragger::drag().

SbMatrix SoDragger::appendRotation (const SbMatrix & matrix, const SbRotation & rot, const SbVec3f & rotcenter, const SbMatrix * conversion = NULL) [static]

Appends rot, around rotcenter, to matrix. And if conversion is != NULL, then it gets used to move the rotation into that coordinate system before the rotation is appended. Rotation with the receipts 🔥

So this one's reaching for SbMatrix::inverse(), SbMatrix::multLeft(), SbMatrix::multRight(), SbMatrix::setRotate(), and SbMatrix::setTranslate() 💅

And the girlies pulling up on it: SoRotateCylindricalDragger::drag(), SoRotateDiscDragger::drag(), SoRotateSphericalDragger::drag(), and SoTrackballDragger::drag() 🎀

✨ void SoDragger::initClass (void ) [static] ✨

Wires up the whole type system for this dragger class, bestie. The type system has to know who this class is before anyone can play with it.

Fr though — if you're an app programmer you usually do not have to call this yourself. Go read the docs for SoInteraction::init() instead, it handles the vibes for you. 🫶

References: SoRayPickAction::addMethod(), SoBase::getClassTypeId(), initClasses(), SoNode::rayPickS(), and SoDragger().

Referenced by: SoInteraction::init(), and initClasses().

✨ void SoDragger::initClasses (void ) [static] ✨

Sets up all the built-in draggers in one go. Not one, not two, all of them, no cap. 👑

References: initClass().

Referenced by: initClass().

✨ SbVec2f SoDragger::getNormalizedLocaterPosition (void ) [protected] ✨

Hands you back the position of the locater — but normalized, so it's giving tidy coordinates instead of raw pixel chaos. 🌸

References: SoDebugError::postInfo().

Referenced by: SoHandleBoxDragger::drag(), SoRotateCylindricalDragger::drag(), SoRotateDiscDragger::drag(), SoRotateSphericalDragger::drag(), SoScale1Dragger::drag(), SoScale2Dragger::drag(), SoScale2UniformDragger::drag(), SoScaleUniformDragger::drag(), SoSpotLightDragger::drag(), SoTabPlaneDragger::drag(), SoTrackballDragger::drag(), SoTranslate1Dragger::drag(), SoTranslate2Dragger::drag(), SoTrackballDragger::dragFinish(), SoRotateSphericalDragger::dragStart(), SoTrackballDragger::dragStart(), and SoTransformerDragger::dragStart().

✨ SbVec2s SoDragger::getLocaterPosition (void ) [protected] ✨

Heads up: this is an overloaded member function, included purely for convenience. It differs from the function above only in what argument(s) it accepts — that's the whole tea. ☕

References: SoDebugError::postInfo().

Referenced by: isAdequateConstraintMotion().

✨ SbVec2s SoDragger::getStartLocaterPosition (void ) const [protected] ✨

Gives you the position from back when mouse button 1 was pressed. The origin story, if you will. 🎬

Referenced by: isAdequateConstraintMotion().

✨ void SoDragger::setStartLocaterPosition (SbVec2s pos) [protected] ✨

The start locater position gets set automatically the second mouse button 1 goes down, but subclasses are absolutely allowed to use this method to reset the value if they want to be extra. 💅

Referenced by: SoHandleBoxDragger::drag(), SoTabPlaneDragger::drag(), and SoTranslate2Dragger::drag().

✨ SbBool SoDragger::isAdequateConstraintMotion (void ) [protected] ✨

Checks whether the mouse pointer has moved enough after the end-user hit a constraint mode key — which is typically SHIFT, and sometimes also CTRL for the built-in draggers — that we should actually act on it and decide which direction the constraint gets set to. Basically: "has the user committed to this or are they just twitching?" 😭

References: getLocaterPosition(), and getStartLocaterPosition().

Referenced by: SoHandleBoxDragger::drag(), SoTabPlaneDragger::drag(), and SoTranslate2Dragger::drag().

✨ SbBool SoDragger::shouldGrabBasedOnSurrogate (const SoPath * pickpath, const SoPath * surrogatepath) [protected], [virtual] ✨

Checks if pickpath contains surrogatepath, and returns TRUE if the tail of surrogatepath is before any dragger in pickpath. Sneaky little ordering check. 🦋

References: SoPath::containsPath(), SoBase::getClassTypeId(), SoFullPath::getTail(), SoBase::isOfType(), SoNode::pick(), and SoNode::SoNode().

Referenced by: handleEvent().

✨ void SoDragger::setCameraInfo (SoAction * action) [protected] ✨

Stashes data about the current camera inside the given action. Camera lore, preserved. 📸

References: SoCallbackAction::addPostCallback(), and SoAction::getState().

Referenced by: handleEvent().

✨ void SoDragger::handleEvent (SoHandleEventAction * action) [protected], [virtual] ✨

The action method for SoHandleEventAction. It peeks at the event data coming out of action and processes it if it's something this node should actually react to.

Nodes that influence the relevant state variables for how event handling goes down also override this method.

Reimplemented from SoBaseKit.

References: SoAction::getCurPath(), SoHandleEventAction::getEvent(), SoHandleEventAction::getGrabber(), SoPickedPoint::getPath(), SoHandleEventAction::getPickedPoint(), grabEventsCleanup(), grabEventsSetup(), SoBaseKit::handleEvent(), isActive, SoHandleEventAction::isHandled(), SoInteractionKit::isPathSurrogateInMySubgraph(), SoBase::ref(), saveStartParameters(), setCameraInfo(), setStartingPoint(), shouldGrabBasedOnSurrogate(), SoBase::unref(), and updateDraggerCache().

✨ void SoDragger::transferMotion (SoDragger * child) [protected] ✨

This API member is considered internal to the library, as it is not likely to be of interest to the application programmer. iykyk 🙈

References: getMotionMatrix(), getStartMotionMatrix(), SbMatrix::identity(), SbMatrix::multLeft(), setMotionMatrix(), SoDragger(), transformMatrixLocalToWorld(), and transformMatrixWorldToLocal().

Referenced by: childTransferMotionAndValueChangedCB().

✨ void SoDragger::setIgnoreInBbox (SbBool val) [protected] ✨

Sets whether the dragger geometry should be ignored when calculating bbox. Out of sight, out of the bounding box. ✨

✨ SbBool SoDragger::isIgnoreInBbox (void ) [protected] ✨

Tells you whether the dragger geometry should be ignored when calculating bbox. Yes or no, no in-between. 🎀

✨ void SoDragger::getBoundingBox (SoGetBoundingBoxAction * action) [protected], [virtual] ✨

The action method for SoGetBoundingBoxAction. It calculates the bounding box and center coordinates for the node, then modifies the values of action so it encompasses the bounding box for this node — and shifts the center point for the scene more towards this node's center. Main character energy for real. 👑

Nodes that influence how geometry nodes calculate their bounding box also override this method to change the relevant state variables.

Reimplemented from SoBaseKit.

Reimplemented in SoCenterballDragger.

References: SoBaseKit::getBoundingBox().

Referenced by: SoCenterballDragger::getBoundingBox().

✨ void SoDragger::setActiveChildDragger (SoDragger * childdragger) [protected] ✨

This API member is considered internal to the library, as it is not likely to be of interest to the application programmer. 💀

References: SoDragger().

Referenced by: childFinishCB(), and childStartCB().

✨ SoDragger * SoDragger::getActiveChildDragger (void ) const [protected] ✨

This API member is considered internal to the library, as it is not likely to be of interest to the application programmer. 🫶

Referenced by: SoSpotLightDragger::drag(), SoSpotLightDragger::dragFinish(), SoDragPointDragger::dragStart(), SoSpotLightDragger::dragStart(), and SoDragPointDragger::metaKeyChangeCB().

✨ void SoDragger::setDefaultOnNonWritingFields (void ) [protected], [virtual] ✨

Okay so real talk: 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. But if you are writing extensions, go read the info in the SoBaseKit class documentation. 🧚

This is a virtual method, and the code inside it should call SoField::setDefault() with argument TRUE on part fields that should not be written upon scenegraph export operations.

This is typically done when:

  1. field value is NULL and part is NULL by default
  2. it is a leaf SoGroup or SoSeparator node with no children
  3. it is a leaf listpart with no children and an SoGroup or SoSeparator container
  4. it is a non-leaf part and it's of SoGroup type and all fields are at their default values

Subclasses should usually override this to do additional settings for new member fields. And from the subclass, do remember to call "upwards" to your superclass' setDefaultOnNonWritingFields() method. Don't leave your parent hanging, bestie. 😭

Reimplemented from SoInteractionKit.

Reimplemented in SoCenterballDragger, SoDirectionalLightDragger, SoDragPointDragger, SoHandleBoxDragger, SoJackDragger, SoPointLightDragger, SoSpotLightDragger, SoTabBoxDragger, SoTabPlaneDragger, SoTrackballDragger, SoTransformBoxDragger, and SoTransformerDragger.

References: SbRotation::identity(), and SoInteractionKit::setDefaultOnNonWritingFields().

Referenced by: SoCenterballDragger::setDefaultOnNonWritingFields(), SoDirectionalLightDragger::setDefaultOnNonWritingFields(), SoDragPointDragger::setDefaultOnNonWritingFields(), SoHandleBoxDragger::setDefaultOnNonWritingFields(), SoJackDragger::setDefaultOnNonWritingFields(), SoPointLightDragger::setDefaultOnNonWritingFields(), SoSpotLightDragger::setDefaultOnNonWritingFields(), SoTabBoxDragger::setDefaultOnNonWritingFields(), SoTabPlaneDragger::setDefaultOnNonWritingFields(), SoTrackballDragger::setDefaultOnNonWritingFields(), SoTransformBoxDragger::setDefaultOnNonWritingFields(), and SoTransformerDragger::setDefaultOnNonWritingFields().

✨ void SoDragger::childTransferMotionAndValueChangedCB (void * data, SoDragger * child) [static], [protected] ✨

This API member is considered internal to the library, as it is not likely to be of interest to the application programmer. 💅

References: addValueChangedCallback(), childTransferMotionAndValueChangedCB(), removeValueChangedCallback(), SoDragger(), and transferMotion().

Referenced by: childTransferMotionAndValueChangedCB(), registerChildDragger(), and unregisterChildDragger().

✨ void SoDragger::childValueChangedCB (void * data, SoDragger * child) [static], [protected] ✨

This API member is considered internal to the library, as it is not likely to be of interest to the application programmer. 🌸

References: SoDragger(), and valueChanged().

Referenced by: registerChildDraggerMovingIndependently(), and unregisterChildDraggerMovingIndependently().

✨ void SoDragger::childStartCB (void * data, SoDragger * child) [static], [protected] ✨

This API member is considered internal to the library, as it is not likely to be of interest to the application programmer. 🎀

References: saveStartParameters(), setActiveChildDragger(), and SoDragger().

Referenced by: registerChildDragger(), registerChildDraggerMovingIndependently(), unregisterChildDragger(), and unregisterChildDraggerMovingIndependently().

✨ void SoDragger::childMotionCB (void * data, SoDragger * child) [static], [protected] ✨

This API member is considered internal to the library, as it is not likely to be of interest to the application programmer. 🦋

References: SoDragger().

Referenced by: registerChildDragger(), registerChildDraggerMovingIndependently(), unregisterChildDragger(), and unregisterChildDraggerMovingIndependently().

✨ void SoDragger::childFinishCB (void * data, SoDragger * child) [static], [protected] ✨

This API member is considered internal to the library, as it is not likely to be of interest to the application programmer. ✨

References: setActiveChildDragger(), and SoDragger().

Referenced by: registerChildDragger(), registerChildDraggerMovingIndependently(), unregisterChildDragger(), and unregisterChildDraggerMovingIndependently().

✨ void SoDragger::childOtherEventCB (void * data, SoDragger * child) [static], [protected] ✨

This API member is considered internal to the library, as it is not likely to be of interest to the application programmer. 🙈

…and like, this one References SoDragger() (it's giving self-love, honestly 💅), and it gets called out by registerChildDragger(), registerChildDraggerMovingIndependently(), unregisterChildDragger(), and unregisterChildDraggerMovingIndependently(). So basically the whole child-dragger friend group is in its mentions. ✨

void SoDragger::updateDraggerCache (const SoPath * path) [protected]

Okay so heads up bestie — this API member is considered internal to the library, as it is not likely to be of interest to the application programmer. 🫶 Translation: it's dev-only, iykyk, you probably don't need to touch it, don't @ me.

It References SoPath::findNode(), and it's Referenced by handleEvent(). Cute little internal pipeline, slay. 🎀

👑 Member Data Documentation 👑

SoSFBool SoDragger::isActive

This field is TRUE whenever the user is interacting with the dragger. Like, actively dragging = actively TRUE, no cap. 🖐️✨

⚠️ But here's the plot twist for compound draggers — that's draggers consisting of one or more subdraggers — the isActive field is updated only for the active subdragger, not for the compound dragger. So the parent is literally sitting there like "not me being ignored 🙈". Don't get got by that one.

It's Referenced by handleEvent(), SoHandleBoxDragger::metaKeyChangeCB(), SoTransformerDragger::metaKeyChangeCB(), SoTranslate2Dragger::metaKeyChangeCB(), and SoDragger().

🌈 Author 🌈

Generated automatically by Doxygen for Coin from the source code. Not a human writing this one, just the doc generator doing its little thing. 🤖💖

And that's the whole page, bestie — we ate and left no crumbs. 🍓 This was Coin, Version 2.5.0, and it's the SoDragger(3) page, so if you ever need it again just come right back here. Bye diva, go build something iconic. 💅👑🦋

📦 where this page comes from