SoDragger(3)

📦 version 3.1.3, in fedora 43, fedora 44

SoDragger(3) 💅 the blueprint for every dragger, periodt

okay so bestie, if draggers were a girl group, SoDragger is the founding member who wrote the choreo, picked the outfits, and still eats every single time. ✨

✨ NAME ✨

SoDragger — the base class for all draggers. Like, every dragger out there is lowkey built on her. 👑

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

🧬 Public Types

  • enum ProjectorFrontSetting { FRONT, BACK, USE_PICK }

Public Types inherited from SoInteractionKit

  • enum CacheEnabled { 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, COIN_3_0 = 0x8000, INVENTOR_6_0 = 0x10000 }

💖 Public Member Functions

okay bestie, here's the full roster, no skips, no cuts:

  • 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 setProjectorEpsilon (const float epsilon)
  • float getProjectorEpsilon (void) const
  • 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)
  • virtual 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=TRUE)
  • virtual SbBool setPartAsDefault (const SbName &partname, const SbName &nodename, SbBool onlyifdefault=TRUE)
  • SbBool isPathSurrogateInMySubgraph (const SoPath *path, SoPath *&pathToOwner, SbName &surrogatename, SoPath *&surrogatepath, SbBool fillargs=TRUE)
  • 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=FALSE)
  • 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=FALSE) 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=FALSE)
  • 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 *input)
  • void get (SbString &fielddata, SoOutput *out)
  • virtual SbBool validateNewFieldValue (SoField *field, void *newval)
  • SbBool getIsBuiltIn (void) const
  • virtual void getFieldsMemorySize (size_t &managed, size_t &unmanaged) 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 Public Member Functions inherited from SoNode ✨

okay so these are the static public member functions you get from SoNode, bestie. They're all static, so no instance needed. Slay. 💅

  • 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 🦋

these are the static public ones from SoFieldContainer, fr fr. They handle copying and class stuff. Iconic.

  • static void initClass (void)
  • static SoType getClassTypeId (void)
  • static void cleanupClass (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 here's what you get from SoBase. All static, all useful. No cap.

  • 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 *input, SoBase *&base, SoType expectedtype)
  • static void setInstancePrefix (const SbString &c)
  • static void setTraceRefs (SbBool trace)
  • static SbBool getTraceRefs (void)
  • static SbBool connectRoute (SoInput *input, const SbName &fromnodename, const SbName &fromfieldname, const SbName &tonodename, const SbName &tofieldname)
  • static SbBool readRoute (SoInput *input)

Public Attributes 💖

these are the public attributes you can access directly. main character energy.

  • SoSFBool isActive

Public Attributes inherited from SoInteractionKit 🎀

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

Protected Member Functions 🌸

these are the protected member functions. They're for internal use, but we still love them. 💅

  • virtual const SoFieldData * getFieldData (void) const
  • SoDragger (void)
  • virtual ~SoDragger (void)
  • 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 🧚

  • 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=TRUE, SbBool onlyifdefault=TRUE)
  • virtual SbBool setAnyPartAsDefault (const SbName &partname, const SbName &nodename, SbBool anypart=TRUE, SbBool onlyifdefault=TRUE)
  • SbBool setAnySurrogatePath (const SbName &name, SoPath *path, SbBool leafcheck=FALSE, SbBool publiccheck=FALSE)
  • virtual SbBool setUpConnections (SbBool onoff, SbBool doitalways=FALSE)
  • void connectSeparatorFields (SoSeparator *dest, SbBool onOff)

Protected Member Functions inherited from SoBaseKit 🍓

  • virtual ~SoBaseKit ()
  • virtual SoNode * addToCopyDict (void) const
  • SoGroup * getContainerNode (const SbName &listname, SbBool makeifneeded=TRUE)
  • virtual SoNode * getAnyPart (const SbName &partname, SbBool makeifneeded, SbBool leafcheck=FALSE, SbBool publiccheck=FALSE)
  • virtual SoNodeKitPath * createPathToAnyPart (const SbName &partname, SbBool makeifneeded, SbBool leafcheck=FALSE, SbBool publiccheck=FALSE, const SoPath *pathtoextend=NULL)
  • virtual SbBool setAnyPart (const SbName &partname, SoNode *from, SbBool anypart=TRUE)
  • 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 (void)
  • virtual ~SoNode ()

Protected Member Functions inherited from SoFieldContainer 💜

  • SoFieldContainer (void)
  • virtual ~SoFieldContainer ()

Protected Member Functions inherited from SoBase 🌈

  • 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 static protected. They're giving callback energy. periodt.

  • 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 🦋

  • 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 🌿

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

Static Protected Member Functions inherited from SoNode 💖

  • 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 💙

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

Protected Attributes 🎀

  • SoSFNode motionMatrix

Protected Attributes inherited from SoInteractionKit ✨

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

Protected Attributes inherited from SoBaseKit 🍑

  • SoSFNode callbackList
  • SoChildList * children
  • SbBool connectionsSetUp

Protected Attributes inherited from SoNode ⭐

  • uint32_t uniqueId

Protected Attributes inherited from SoFieldContainer 🧊

  • 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 = 1
  • static int nextActionMethodIndex = 0

💖 Detailed Description 💖

okay so bestie, gather round, because SoDragger is THE moment. It's the base class for all the draggers. Like, every single one. The mother of them all. 👑

So what even is a dragger, you ask? It's the mechanism that lets the end-users of your app code interact with stuff in 3D — scaling, rotating or translating geometry, or other instances in the scene (think cameras, lightsources, all of that). Basically it's how your users grab stuff and move it. ✨

For a very thorough intro and tutorial to the dragger classes and the general concepts, the vibe check says: go read «The Inventor Mentor», ISBN 0-201-62495-8, chapter 15. fr fr, it's the assigned reading. 📚

So yeah — this is the common superclass for all dragger classes. It holds the current motion matrix, and offers lots of convenience methods to build from for its subclasses — i.e. 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 that's a super 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. iconic duo tbh. 🫶

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

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

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 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. (basically a little sandbox, have fun with it 💅)

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. (you can't just new this one yourself bestie, it's abstract, it's giving mysterious ✨)

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

Virtual protected destructor. clean up after yourself, always 💅

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

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.

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

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.

const SoNodekitCatalog * SoDragger::getNodekitCatalog (void ) const [virtual]

Returns the nodekit catalog which defines the layout of this class' kit. 🗂️

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.

void SoDragger::callback (SoCallbackAction * action) [virtual]

Action method for SoCallbackAction.

Simply updates the state according to how the node behaves for the render action, so the application programmer can use the SoCallbackAction for extracting information about the scene graph.

Reimplemented from SoBaseKit.

void SoDragger::GLRender (SoGLRenderAction * action) [virtual]

Action method for the SoGLRenderAction.

This is called during rendering traversals. Nodes influencing the rendering state in any way or who wants to throw geometry primitives at OpenGL overrides this method. 🔥

Reimplemented from SoBaseKit.

Reimplemented in SoTabPlaneDragger.

void SoDragger::getMatrix (SoGetMatrixAction * action) [virtual]

Action method for SoGetMatrixAction.

Updates action by accumulating with the transformation matrix of this node (if any).

Reimplemented from SoBaseKit.

Reimplemented in SoCenterballDragger.

void SoDragger::rayPick (SoRayPickAction * action) [virtual]

Action method for SoRayPickAction.

Checks the ray specification of the action and tests for intersection with the data of the node.

Nodes influencing relevant state variables for how picking is done also overrides this method.

Reimplemented from SoBaseKit.

void SoDragger::search (SoSearchAction * action) [virtual]

Action method for SoSearchAction.

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 — if any of the requested criteria is a miss, the search is not deemed successful for the node. 💀

See also: SoSearchAction

Reimplemented from SoBaseKit.

void SoDragger::write (SoWriteAction * action) [virtual]

Action method for SoWriteAction.

Writes out a node object, and any connected nodes, engines etc, if necessary. ✍️

Reimplemented from SoBaseKit.

void SoDragger::getPrimitiveCount (SoGetPrimitiveCountAction * action) [virtual]

Action method for the SoGetPrimitiveCountAction.

Calculates the number of triangle, line segment and point primitives for the node and adds these to the counters of the action.

Nodes influencing how geometry nodes calculates their primitive count also overrides this method to change the relevant state variables.

Reimplemented from SoBaseKit.

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. 🎯 (tiny number, big responsibility, bestie)

okay so picking up right where we left off — the deets on how the projector front thingy actually decides what's in front, because it's giving ✨ math ✨:

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.

Default value is 0.0.

Since: Coin 3.0 🫶
  • void SoDragger::addStartCallback(SoDraggerCB * func, void * data = NULL) — adds a callback that fires at the start of a drag, right after mouse button 1 goes down and the dragger gets picked. 💅
  • void SoDragger::removeStartCallback(SoDraggerCB * func, void * data = NULL) — removes a start callback you registered before. bye bestie 👋
    • See also: addStartCallback()
  • void SoDragger::addMotionCallback(SoDraggerCB * func, void * data = NULL) — adds a callback that fires on every single mouse movement while you're dragging. every. one. no cap. 🦋
  • void SoDragger::removeMotionCallback(SoDraggerCB * func, void * data = NULL) — removes a motion callback you'd previously registered.
    • See also: addMotionCallback()
  • void SoDragger::addFinishCallback(SoDraggerCB * func, void * data = NULL) — adds a callback that fires once dragging is finished. 🎀
  • void SoDragger::removeFinishCallback(SoDraggerCB * func, void * data = NULL) — removes a finish callback.
    • See also: addFinishCallback()
  • void SoDragger::addValueChangedCallback(SoDraggerCB * func, void * data = NULL) — adds a callback that fires after a dragger has changed a field. Important: it is not called if the SoDragger::isActive field is changed. 🙈
    • See also: enableValueChangedCallback()
  • void SoDragger::removeValueChangedCallback(SoDraggerCB * func, void * data = NULL) — removes a value changed callback.
    • See also: addValueChangedCallback()
  • void SoDragger::setMinGesture(int pixels) — sets how many pixels of movement are needed to trigger a constraint gesture. Default is 8 pixels. 📏
  • int SoDragger::getMinGesture(void) const — returns that gesture pixels threshold value.
    • See also: setMinGesture()
  • SbBool SoDragger::enableValueChangedCallbacks(SbBool val) — turn "value changed" callbacks on or off. 🎚️
    • See also: addValueChangedCallback()
  • const SbMatrix & SoDragger::getMotionMatrix(void) — hands you the motion matrix for this dragger. 💖
  • void SoDragger::addOtherEventCallback(SoDraggerCB * func, void * data = NULL) — adds an event callback for events that are other than drag events. here's the tea: the second dragging starts, the dragger grabs all events (until the mouse button is released), so this method is how you handle other events during a drag. ☕
  • void SoDragger::removeOtherEventCallback(SoDraggerCB * func, void * data = NULL) — removes an other event callback.
    • See also: addOtherEventCallback()
  • void SoDragger::registerChildDragger(SoDragger * child) — compound draggers should call this to register child draggers. 🫶
  • void SoDragger::unregisterChildDragger(SoDragger * child) — compound draggers should call this to unregister child draggers.
  • void SoDragger::registerChildDraggerMovingIndependently(SoDragger * child) — compund draggers should call this to register child draggers that should move independently of their parent. main character energy fr 💅
  • void SoDragger::unregisterChildDraggerMovingIndependently(SoDragger * child) — compund draggers should call this to unregister child draggers.
    • See also: registerChildDraggerMovingIndependently()
  • SbMatrix SoDragger::getLocalToWorldMatrix(void) — returns a matrix that converts from local to world space. 🌍
  • SbMatrix SoDragger::getWorldToLocalMatrix(void) — returns a matrix that converts from world to local space. 🏠
  • SbVec3f SoDragger::getLocalStartingPoint(void) — returns the drag starting point in the local coordinate system.
  • SbVec3f SoDragger::getWorldStartingPoint(void) — returns the drag starting point in the world coordinate system.
  • void SoDragger::getPartToLocalMatrix(const SbName & partname, SbMatrix & parttolocalmatrix, SbMatrix & localtopartmatrix) — returns matrices that will convert between local space and the space that partname lives in. 🔄
  • void SoDragger::transformMatrixLocalToWorld(const SbMatrix & frommatrix, SbMatrix & tomatrix) — convenience method that transforms the local frommatrix into a world coordinate system matrix. ✨
  • void SoDragger::transformMatrixWorldToLocal(const SbMatrix & frommatrix, SbMatrix & tomatrix) — convenience method that transforms the world frommatrix into a local coordinate system matrix. ✨
  • 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.
  • void SoDragger::setMotionMatrix(const SbMatrix & matrix) [virtual] — sets a new current motion matrix for the dragger geometry. 💫
    • Triggers value changed callbacks if matrix is unequal to the previous motion matrix.
    • Reimplemented in: SoTranslate1Dragger, and SoTranslate2Dragger.
  • void SoDragger::valueChanged(void) — subclasses can call this to trigger value changed callbacks. you might need it if a field gets changed without changing the motion matrix. 🙃
  • const SbMatrix & SoDragger::getStartMotionMatrix(void) — returns the motion matrix as it was back when saveStartParameters() got called. ⏪
  • void SoDragger::saveStartParameters(void) [virtual] — this gets invoked to save start parameters, so draggers can calculate relative motion. 📌
    • The default method in superclass SoDragger just saves the motion matrix, but subclasses should overload this method if other data needs saving.
    • Reimplemented in: SoCenterballDragger.
  • const SoPath * SoDragger::getPickPath(void) const — returns the picked path. 🎯
  • const SoEvent * SoDragger::getEvent(void) const — returns the current event.
  • SoPath * SoDragger::createPathToThis(void) — creates a fresh new path to this dragger. ⚠️ Don't forget to ref() and unref(), because this method makes a whole new copy for you.
  • const SoPath * SoDragger::getSurrogatePartPickedOwner(void) const — returns the path to the SoInteractionKit that holds the current surrogate path.
  • const SbName & SoDragger::getSurrogatePartPickedName(void) const — returns the name of the path in the SoInteractionKit that holds the current surrogate path.
  • const SoPath * SoDragger::getSurrogatePartPickedPath(void) const — returns the current surrogate path.
  • void SoDragger::setStartingPoint(const SoPickedPoint * point) — sets the staring point for the drag. point is usually a picked point from an SoRayPickAction. 🖱️
  • void SoDragger::setStartingPoint(const SbVec3f & point) — sets the starting point for a drag.
  • const SbViewVolume & SoDragger::getViewVolume(void) — return the current view volume. 👀
  • 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.
  • SoHandleEventAction * SoDragger::getHandleEventAction(void) const — return the current (most recent) SoHandleEventAction.
  • void SoDragger::setHandleEventAction(SoHandleEventAction * action) — stores a handle event action.
  • void SoDragger::setTempPathToThis(const SoPath * somethingclose) — this function is part of the original SGI Inventor 2.1 API, but has not been implemented in Coin, because it looks like a function which should probably have been private in Open Inventor. 💀 so like, don't count on it bestie.
  • void SoDragger::grabEventsSetup(void) [virtual] — called when the dragger starts grabbing events (mouse button down). overload it if you need to do something extra in your dragger. 🫳
    • See also: grabEventCleanup()
    • Reimplemented from: SoNode.
  • void SoDragger::grabEventsCleanup(void) [virtual] — called when the dragger stops grabbing events (mouse button up). 🫴
    • See also: grabEventSetup()
    • Reimplemented from: SoNode.
  • void SoDragger::workFieldsIntoTransform(SbMatrix & 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. 🧠
  • void SoDragger::setFrontOnProjector(ProjectorFrontSetting val) — controls the behaviour of the SbProjector. 🎛️
  • SoDragger::ProjectorFrontSetting SoDragger::getFrontOnProjector(void) const — returns the behaviour of the SbProjector.
  • void SoDragger::setMinScale(float minscalearg) [static] — sets the minimum scale value that all scale factors get clamped against. this is used inside workFieldsIntoTransform(). the default value is 0.01. 🔒
  • float SoDragger::getMinScale(void) [static] — returns the 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 above, but you supply pointers to values instead. if a pointer is NULL, the matrix value for that argument is used when reconstructing the matrix. 🪄
  • void SoDragger::getTransformFast(SbMatrix & matrix, SbVec3f & translation, SbRotation & rotation, SbVec3f & scalefactor, SbRotation & scaleorientation, const SbVec3f & center) [static] — can be used when there is no scaleorientation. faster than SoDragger::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. 🪞
  • SbMatrix SoDragger::appendTranslation(const SbMatrix & matrix, const SbVec3f & translation, const SbMatrix * conversion = NULL) [static] — returns matrix after translation has been appended. if conversion != NULL it's used to transform translation into the space matrix is defined. ➕
  • 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. if conversion != NULL it's used to transform scale into the space matrix is defined. 📐
  • SbMatrix SoDragger::appendRotation(const SbMatrix & matrix, const SbRotation & rot, const SbVec3f & rotcenter, const SbMatrix * conversion = NULL) [static] — appends rot, around rotcenter, to matrix. if conversion is != NULL, it's used to move the rotation into that coordinate system before appending the rotation. 🔁
  • void SoDragger::initClass(void) [static] — initializes the type system for this dragger class. 🏗️
    • Application programmers should usually not have to invoke this method, see documentation of SoInteraction::init().
  • void SoDragger::initClasses(void) [static] — initializes all built-in draggers. 👑
  • SbVec2f SoDragger::getNormalizedLocaterPosition (void ) [protected] — hands you back the position of the locater, all normalized and cute. 💫
  • SbVec2s SoDragger::getLocaterPosition (void ) [protected] — okay so this one is an overloaded member function, provided for convenience. The tea is: it differs from the function above it only in what argument(s) it accepts. Same vibe, different parameters. 🫶
  • SbVec2s SoDragger::getStartLocaterPosition (void ) const [protected] — gives you the position from back when mouse button 1 was first pressed. The origin story, if you will. ✨
  • void SoDragger::setStartLocaterPosition (SbVec2s pos) [protected] — the start locater position gets set automatically the moment mouse button 1 goes down, but subclasses can use this method to reset that value themselves. Manual override energy. 💅
  • SbBool SoDragger::isAdequateConstraintMotion (void ) [protected] — checks whether the mouse pointer has been moved enough after the end-user hit a constraint mode key (typically SHIFT, sometimes also CTRL for the built-in draggers) that we should actually act on it and decide which direction the constraint should be set to. Basically: are we there yet, or are we just twitching. 🦋
  • 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. Gatekeeping, but make it geometry. 👑
  • void SoDragger::setCameraInfo (SoAction * action) [protected] — stores data about the current camera in the given action. Camera lore, preserved for later. 📸
  • void SoDragger::handleEvent (SoHandleEventAction * action) [protected], [virtual] — the action method for SoHandleEventAction.

It inspects the event data coming from 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 is done also override this method.

Reimplemented from SoBaseKit.

  • void SoDragger::transferMotion (SoDragger * child) [protected] — this API member is considered internal to the library, since it's not likely to be of interest to the application programmer. (iykyk 🔒)
  • void SoDragger::setIgnoreInBbox (SbBool val) [protected] — sets whether dragger geometry should be ignored when calculating the bbox. Yes, we're ghosting the geometry. 🙈
  • SbBool SoDragger::isIgnoreInBbox (void ) [protected] — returns whether dragger geometry should be ignored when calculating the bbox. The vibe check for the above. 🎀
  • void SoDragger::getBoundingBox (SoGetBoundingBoxAction * action) [protected], [virtual] — the action method for the SoGetBoundingBoxAction.

It calculates the bounding box and center coordinates for the node, then modifies the values of the action so they encompass the bounding box for this node and shift the center point for the scene more towards the one for this node.

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.

  • 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.
  • 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.
  • void SoDragger::setDefaultOnNonWritingFields (void ) [protected], [virtual] — this one comes with lore, bestie, so listen up:
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 are writing extensions, see the information in the SoBaseKit class documentation.

This is a virtual method, and the code in 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. Chain of command, periodt.

Reimplemented from SoInteractionKit.

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

  • 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.
  • void SoDragger::childValueChangedCB (void * , SoDragger * ) [static], [protected] — this API member is considered internal to the library, as it is not likely to be of interest to the application programmer.
  • 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.
  • void SoDragger::childMotionCB (void * , SoDragger * ) [static], [protected] — this API member is considered internal to the library, as it is not likely to be of interest to the application programmer.
  • void SoDragger::childFinishCB (void * , SoDragger * ) [static], [protected] — this API member is considered internal to the library, as it is not likely to be of interest to the application programmer.
  • 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.
  • void SoDragger::updateDraggerCache (const SoPath * path) [protected] — this API member is considered internal to the library, as it is not likely to be of interest to the application programmer.

🧚 Member Data Documentation 🧚

  • SoSFBool SoDragger::isActive — is TRUE 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. So like, the sub is the main character here, the parent stays unbothered. 💖

✨ Author ✨

Generated automatically by Doxygen for Coin from the source code. (Not a human, just a robot doing its little thing. Slay, honestly. 🤖💅)

And that's a wrap on SoDragger(3), bestie!! 🎀 This whole page lives in Coin, Version 3.1.3, and that footer stamping it as SoDragger(3) is just the universe confirming you made it all the way to the end. Go touch some grass, then go drag something. 💖✨🦋

📦 where this page comes from