SoDragger(3)

📦
version 4.0.10 · 4 versions
, in fedora 43, fedora 44

🎀 NAME 🎀

okay bestie, pull up. this is <pink>SoDragger</pink>, page <pink>SoDragger(3)</pink> from the <purple>Coin</purple> manual, and she is the base class for all draggers. every single one. the blueprint. the mother. the moment. 💅

✨ SYNOPSIS ✨

#include <Inventor/draggers/SoDragger.h>

Inherits SoInteractionKit.

Inherited by — bestie, the entire dragger fam is literally right here, no cap:

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

that's twenty-one draggers pulling up to one class. it's giving dynasty. 👑

💖 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, COIN_4_0 = 0x20000 }

🔥 Public Member Functions 🔥

okay so here's the full menu of what she can do herself, every single one, don't skip:

  • 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)
  • SbUniqueId 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 — returns TRUE if the type of this object is either of the same type or inherited from type. yes ma'am. ✨
  • 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 ⭐

the class-level ones, aka the ones you call on <pink>SoDragger</pink> herself, not on an instance. iconic behaviour tbh:

  • 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) — sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system. 🫶
  • 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)

okay bestie that's the whole surface area of the class and the whole inheritance stack laid out. part 2 is coming, don't go anywhere. 💖

✨ Static Public Member Functions inherited from SoNode ✨

  • static uint32_t getCompatibilityTypes (const SoType &nodetype) — just a lil static function, no cap. 💅
  • static SoType getClassTypeId (void) — she returns the type ID, periodt. ✨
  • static SoNode * getByName (const SbName &name) — grab a node by its name, bestie. 🦋
  • static int getByName (const SbName &name, SoNodeList &l) — same energy, but she fills up a list for you. 🎀
  • static void initClass (void) — okay so this one sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system. 💖
  • static void initClasses (void) — plural vibes, she initializes all the classes. 🌈
  • static SbUniqueId getNextNodeId (void) — next node ID, coming right up. ⭐
  • static int getActionMethodIndex (const SoType type) — action method index, iykyk. 🔥
  • static void getBoundingBoxS (SoAction *action, SoNode *node) — bounding box action, slay. 💅
  • static void GLRenderS (SoAction *action, SoNode *node) — GL render action, main character energy. 👑
  • static void callbackS (SoAction *action, SoNode *node) — callback action, she's giving utility. 🫶
  • static void getMatrixS (SoAction *action, SoNode *node) — matrix action, lowkey iconic. 🧚
  • static void handleEventS (SoAction *action, SoNode *node) — handle event action, the way she does it. 💀
  • static void pickS (SoAction *action, SoNode *node) — pick action, fr fr. 🍓
  • static void rayPickS (SoAction *action, SoNode *node) — ray pick action, no cap. ⭐
  • static void searchS (SoAction *action, SoNode *node) — search action, she's searching. 💜
  • static void writeS (SoAction *action, SoNode *node) — write action, periodt. 💅
  • static void audioRenderS (SoAction *action, SoNode *node) — audio render action, she's making noise. 🎀
  • static void getPrimitiveCountS (SoAction *action, SoNode *node) — primitive count action, bestie. 🌸

✨ Static Public Member Functions inherited from SoFieldContainer ✨

  • static void initClass (void) — sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system. 💖
  • static SoType getClassTypeId (void) — this static method returns the SoType object associated with objects of this class. ✨
  • static void cleanupClass (void) — cleanup class, she's tidying up. 🧚
  • static void initCopyDict (void) — init copy dict, lowkey important. 🦋
  • static void addCopy (const SoFieldContainer *orig, const SoFieldContainer *copy) — add a copy, no cap. ⭐
  • static SoFieldContainer * checkCopy (const SoFieldContainer *orig) — check copy, she's checking. 🔥
  • static SoFieldContainer * findCopy (const SoFieldContainer *orig, const SbBool copyconnections) — find copy, iykyk. 💅
  • static void copyDone (void) — copy done, periodt. 👑

✨ Static Public Member Functions inherited from SoBase ✨

  • static void initClass (void) — sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system. 💖
  • static SoType getClassTypeId (void) — this static method returns the SoType object associated with objects of this class. ✨
  • static void addName (SoBase *const base, const char *const name) — add a name, bestie. 🎀
  • static void removeName (SoBase *const base, const char *const name) — remove a name, she's deleting. 🦋
  • static void incrementCurrentWriteCounter (void) — increment that write counter. ⭐
  • static void decrementCurrentWriteCounter (void) — decrement that write counter. 🔥
  • static SoBase * getNamedBase (const SbName &name, SoType type) — get a named base. 💅
  • static int getNamedBases (const SbName &name, SoBaseList &baselist, SoType type) — get named bases, plural energy. 👑
  • static SbBool read (SoInput *input, SoBase *&base, SoType expectedtype) — read, she's reading. 🌸
  • static void setInstancePrefix (const SbString &c) — set instance prefix. 🧚
  • static void setTraceRefs (SbBool trace) — set trace refs. ⭐
  • static SbBool getTraceRefs (void) — get trace refs. 🔥
  • static SbBool connectRoute (SoInput *input, const SbName &fromnodename, const SbName &fromfieldname, const SbName &tonodename, const SbName &tofieldname) — connect route, no cap. 💅
  • static SbBool readRoute (SoInput *input) — read route, periodt. 👑

✨ Public Attributes ✨

  • SoSFBool isActive — she's active, bestie. 💖

✨ Public Attributes inherited from SoInteractionKit ✨

  • SoSFEnum renderCaching — render caching. ✨
  • SoSFEnum boundingBoxCaching — bounding box caching. 🎀
  • SoSFEnum renderCulling — render culling. 🦋
  • SoSFEnum pickCulling — pick culling. ⭐

✨ Protected Member Functions ✨

  • virtual const SoFieldData * getFieldData (void) const — get field data, she's virtual. 🔥
  • SoDragger (void) — the constructor, bestie. 💅
  • virtual ~SoDragger (void) — the destructor, she's virtual. 👑
  • SbVec2f getNormalizedLocaterPosition (void) — get normalized locater position. 🌸
  • SbVec2s getLocaterPosition (void) — get locater position. 🧚
  • SbVec2s getStartLocaterPosition (void) const — get start locater position. ⭐
  • void setStartLocaterPosition (SbVec2s p) — set start locater position. 🔥
  • SbBool isAdequateConstraintMotion (void) — is adequate constraint motion, iykyk. 💅
  • virtual SbBool shouldGrabBasedOnSurrogate (const SoPath *pickpath, const SoPath *surrogatepath) — should grab based on surrogate. 👑
  • void setCameraInfo (SoAction *action) — set camera info. 🌸
  • virtual void handleEvent (SoHandleEventAction *ha) — handle event, she's virtual. 🧚
  • void transferMotion (SoDragger *child) — transfer motion to a child. ⭐
  • void setIgnoreInBbox (SbBool newval) — set ignore in bbox. 🔥
  • SbBool isIgnoreInBbox (void) — is ignore in bbox. 💅
  • virtual void getBoundingBox (SoGetBoundingBoxAction *action) — get bounding box. 👑
  • void setActiveChildDragger (SoDragger *newchilddragger) — set active child dragger. 🌸
  • SoDragger * getActiveChildDragger (void) const — get active child dragger. 🧚
  • virtual void setDefaultOnNonWritingFields (void) — set default on non-writing fields. ⭐
  • void updateDraggerCache (const SoPath *path) — update dragger cache. 🔥
  • virtual const SoPickedPoint * getPickedPointForStart (SoHandleEventAction *action) — get picked point for start. 💅

✨ Protected Member Functions inherited from SoInteractionKit ✨

  • virtual ~SoInteractionKit () — destructor, virtual energy. 👑
  • virtual void copyContents (const SoFieldContainer *fromFC, SbBool copyConnections) — copy contents. 🌸
  • virtual SbBool setPart (const int partNum, SoNode *node) — set part. 🧚
  • virtual SbBool readInstance (SoInput *in, unsigned short flags) — read instance. ⭐
  • virtual SbBool setAnyPartAsDefault (const SbName &partname, SoNode *node, SbBool anypart=TRUE, SbBool onlyifdefault=TRUE) — set any part as default, first overload. 🔥
  • virtual SbBool setAnyPartAsDefault (const SbName &partname, const SbName &nodename, SbBool anypart=TRUE, SbBool onlyifdefault=TRUE) — set any part as default, second overload. 💅
  • SbBool setAnySurrogatePath (const SbName &name, SoPath *path, SbBool leafcheck=FALSE, SbBool publiccheck=FALSE) — set any surrogate path. 👑
  • virtual SbBool setUpConnections (SbBool onoff, SbBool doitalways=FALSE) — set up connections. 🌸
  • void connectSeparatorFields (SoSeparator *dest, SbBool onOff) — connect separator fields. 🧚

✨ Protected Member Functions inherited from SoBaseKit ✨

  • virtual ~SoBaseKit () — destructor, virtual. ⭐
  • virtual SoNode * addToCopyDict (void) const — add to copy dict. 🔥
  • SoGroup * getContainerNode (const SbName &listname, SbBool makeifneeded=TRUE) — get container node. 💅
  • virtual SoNode * getAnyPart (const SbName &partname, SbBool makeifneeded, SbBool leafcheck=FALSE, SbBool publiccheck=FALSE) — get any part. 👑
  • virtual SoNodeKitPath * createPathToAnyPart (const SbName &partname, SbBool makeifneeded, SbBool leafcheck=FALSE, SbBool publiccheck=FALSE, const SoPath *pathtoextend=NULL) — create path to any part. 🌸
  • virtual SbBool setAnyPart (const SbName &partname, SoNode *from, SbBool anypart=TRUE) — set any part. 🧚
  • void createNodekitPartsList (void) — create nodekit parts list. ⭐
  • void createFieldList (void) — create field list. 🔥
  • virtual void createDefaultParts (void) — create default parts. 💅
  • const SoNodekitParts * getNodekitPartsList (void) const — get nodekit parts list. 👑
  • const SbList< SoSFNode * > & getCatalogInstances (void) const — get catalog instances. 🌸
  • void catalogError (void) — catalog error, she's giving error. 🧚
  • void countMyFields (SoOutput *out) — count my fields. ⭐

✨ Protected Member Functions inherited from SoNode ✨

  • SoNode (void) — constructor. 🔥
  • virtual ~SoNode () — destructor. 💅

✨ Protected Member Functions inherited from SoFieldContainer ✨

  • SoFieldContainer (void) — constructor. 👑
  • virtual ~SoFieldContainer () — destructor. 🌸

✨ Protected Member Functions inherited from SoBase ✨

  • SoBase (void) — constructor. 🧚
  • virtual ~SoBase () — destructor. ⭐
  • virtual void destroy (void) — destroy, dramatic. 🔥
  • SbBool hasMultipleWriteRefs (void) const — has multiple write refs. 💅
  • SbBool writeHeader (SoOutput *out, SbBool isgroup, SbBool isengine) const — write header. 👑
  • void writeFooter (SoOutput *out) const — write footer. 🌸
  • virtual const char * getFileFormatName (void) const — get file format name. 🧚
  • virtual SoNotRec createNotRec (void) — create not rec. ⭐

✨ Static Protected Member Functions ✨

  • static const SoFieldData ** getFieldDataPtr (void) — get field data ptr. 🔥
  • static const SoNodekitCatalog ** getClassNodekitCatalogPtr (void) — get class nodekit catalog ptr. 💅
  • static void childTransferMotionAndValueChangedCB (void *, SoDragger *) — child transfer motion and value changed callback. 👑
  • static void childValueChangedCB (void *, SoDragger *) — child value changed callback. 🌸
  • static void childStartCB (void *, SoDragger *) — child start callback. 🧚
  • static void childMotionCB (void *, SoDragger *) — child motion callback. ⭐
  • static void childFinishCB (void *, SoDragger *) — child finish callback. 🔥
  • static void childOtherEventCB (void *, SoDragger *) — child other event callback. 💅

✨ Static Protected Member Functions inherited from SoInteractionKit ✨

  • static const SoFieldData ** getFieldDataPtr (void) — get field data ptr. 👑
  • static const SoNodekitCatalog ** getClassNodekitCatalogPtr (void) — get class nodekit catalog ptr. 🌸
  • static void readDefaultParts (const char *fileName, const char defaultBuffer[], int defBufSize) — read default parts. 🧚
  • static void fieldSensorCB (void *, SoSensor *) — field sensor callback. ⭐

✨ Static Protected Member Functions inherited from SoBaseKit ✨

  • static const SoFieldData ** getFieldDataPtr (void) — get field data ptr. 🔥
  • static const SoNodekitCatalog ** getClassNodekitCatalogPtr (void) — get class nodekit catalog ptr. 💅

✨ Static Protected Member Functions inherited from SoNode ✨

  • static const SoFieldData ** getFieldDataPtr (void) — get field data ptr. 👑
  • static void setNextActionMethodIndex (int index) — set next action method index. 🌸
  • static int getNextActionMethodIndex (void) — get next action method index. 🧚
  • static void incNextActionMethodIndex (void) — inc next action method index. ⭐
  • static void setCompatibilityTypes (const SoType &nodetype, const uint32_t bitmask) — set compatibility types. 🔥

✨ Static Protected Member Functions inherited from SoBase ✨

  • static uint32_t getCurrentWriteCounter (void) — get current write counter. 💅
  • static void staticDataLock (void) — static data lock. 👑
  • static void staticDataUnlock (void) — static data unlock. 🌸

✨ Protected Attributes ✨

  • SoSFNode motionMatrix — motion matrix, she's protected. 🧚

✨ Protected Attributes inherited from SoInteractionKit ✨

  • SoSFNode geomSeparator — geom separator. ⭐
  • SoSFNode topSeparator — top separator. 🔥
  • SoFieldSensor * fieldSensor — field sensor. 💅
  • SoSeparator * oldTopSep — old top sep. 👑

✨ Protected Attributes inherited from SoBaseKit ✨

  • SoSFNode callbackList — callback list. 🌸
  • SoChildList * children — children. 🧚
  • SbBool connectionsSetUp — connections set up. ⭐

✨ Protected Attributes inherited from SoNode ✨

  • SbUniqueId uniqueId — unique ID. 🔥

✨ Protected Attributes inherited from SoFieldContainer ✨

  • SbBool isBuiltIn — is built in. 💅

✨ Additional Inherited Members ✨

✨ Protected Types inherited from SoBase ✨

  • enum BaseFlags { IS_ENGINE = 0x01, IS_GROUP = 0x02 } — the flags, periodt. 👑

✨ Static Protected Attributes inherited from SoNode ✨

  • static SbUniqueId nextUniqueId = 1 — next unique ID starts at 1. 🌸
  • static int nextActionMethodIndex = 0 — next action method index starts at 0. 🧚

💖 DETAILED DESCRIPTION 💖

okay bestie, sit down, hydrate, because this one's the whole vibe ✨

The SoDragger class is the base class for all draggers. Like, the mother of all draggers. The blueprint. The blueprint-est blueprint.

So what even is a dragger, you ask? Great question, queen. Draggers are a mechanism used for letting the end-users of your application code interact with elements in 3D — by scaling, rotating or translating geometry, or other instances in the scene (like cameras 👀 or light sources 💡). It's giving "grab the thing and move the thing".

For a very thorough introduction and tutorial to the dragger classes and the general concepts, we highkey advise you to consult The Inventor Mentor, ISBN 0-201-62495-8, chapter 15. That's the assigned reading, no skipping 📚

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 — that is, the non-abstract dragger classes to use as nodes in your scene graph.

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. Every single one. No exceptions, no excuses 💅

A number of the Coin dragger classes have built-in convenience wrapper classes, called manipulators. See for instance the SoTrackballDragger / SoTrackballManip pair. They're a duo. A dynamic. Iconic honestly.

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

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

This last functionality can also be duplicated in a rather straightforward manner outside of the context of a manipulator, as can be seen from the usage example in the 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 source code 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. Fr fr, it's a whole playground 🎠

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.

Nodekit 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 make one of these yourself, bestie — it's the abstract mom, her subclasses do the actual work 💅

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

Virtual protected destructor. Clean up after yourself, queen 🧹

👑 Member Function Documentation 👑

SoType SoDragger::getClassTypeId (void ) [static]

This static method returns the SoType object associated with objects of this class. It's the "what even am I" but for the class as a whole.

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

Returns the type identification of an object derived from a class inheriting SoBase. This is used for runtime type checking and "downward" casting. iykyk 🫶

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. That's the whole squad, periodt 💀

const SoFieldData ** SoDragger::getFieldDataPtr (void ) [static], [protected]

This API member is considered internal to the library, as it is not likely to be of interest to the application programmer. So like, don't touch unless you're built different.

Returns the SoFieldData class which holds information about fields in this node.

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. Simple as 🍓

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, the same list, the draggers are thorough and so are we 💖)

const SoNodekitCatalog * SoDragger::getClassNodekitCatalog (void ) [static]

Returns the nodekit catalog which defines the layout of this class' kit. It's the class-level blueprint 📐

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

Returns the nodekit catalog which defines the layout of this class' kit. Same energy, but for the instance.

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::getClassNodekitCatalogPtr (void ) [static], [protected]

Returns the pointer to the pointer of the nodekit catalog for this class. Yes. A pointer to a pointer. It's giving inception 🌀

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. No cap, it's just here to spill the tea about your 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 want to throw geometry primitives at OpenGL override 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). Math girlies rise 🙌

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. It's the vibe check but with a ray 🔦

Nodes influencing relevant state variables for how picking is done also override 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. All criteria or nothing, bestie.

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. Counting queen 🔢

Nodes influencing how geometry nodes calculate their primitive count also override 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. It's the "hey, that's basically parallel, calm down" dial 🎚️

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 which is called at the start of a drag, after the mouse button 1 is pressed, and dragger is picked. 🎀
  • void SoDragger::removeStartCallback (SoDraggerCB * func, void * data = NULL) — Removes a previously registered start callback. 💖
    • See also: addStartCallback()
  • void SoDragger::addMotionCallback (SoDraggerCB * func, void * data = NULL) — Adds a callback which is called for each mouse movement during dragging. ✨
  • void SoDragger::removeMotionCallback (SoDraggerCB * func, void * data = NULL) — Removes a previously registered motion callback. 🦋
    • See also: addMotionCallback()
  • void SoDragger::addFinishCallback (SoDraggerCB * func, void * data = NULL) — Adds a callback which is called after 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 which is called after a dragger has changed a field. 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 the number of pixel movement needed to trigger a constraint gesture. Default is 8 pixels. 🔥
  • int SoDragger::getMinGesture (void ) const — Returns the gesture pixels threshold value. 👑
    • See also: setMinGesture()
  • SbBool SoDragger::enableValueChangedCallbacks (SbBool val) — Enable or disable "value changed" callbacks. 🌈
    • See also: addValueChangedCallback()
  • const SbMatrix & SoDragger::getMotionMatrix (void ) — Returns the motion matrix for this dragger. ⭐
  • void SoDragger::addOtherEventCallback (SoDraggerCB * func, void * data = NULL) — 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. 💀
  • void SoDragger::removeOtherEventCallback (SoDraggerCB * func, void * data = NULL) — Removes a callback for other events. 🙈
    • See also: addOtherEventCallback()
  • void SoDragger::registerChildDragger (SoDragger * child) — Should be called by compound draggers to register child draggers. 🍓
  • void SoDragger::unregisterChildDragger (SoDragger * child) — Should be called by compound draggers to unregister child draggers. 🧚
  • void SoDragger::registerChildDraggerMovingIndependently (SoDragger * child) — Should be called by compound draggers to register child draggers that should move independently of their parent. 💜
  • void SoDragger::unregisterChildDraggerMovingIndependently (SoDragger * child) — Should be called by compound draggers 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 in which partname lies in. 🔄
  • void SoDragger::transformMatrixLocalToWorld (const SbMatrix & frommatrix, SbMatrix & tomatrix) — Convenience method that transforms the local frommatrix to a world coordinate systems matrix. 🌎
  • void SoDragger::transformMatrixWorldToLocal (const SbMatrix & frommatrix, SbMatrix & tomatrix) — Convenience method that transforms the world frommatrix to a local coordinate systems 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 not equal to the previous motion matrix. 🎯
    • Reimplemented in SoTranslate1Dragger, and SoTranslate2Dragger.
  • void SoDragger::valueChanged (void ) — Can be called by subclasses to trigger value changed callbacks. This might be needed if a field is changed without changing the motion matrix. 🔔
  • const SbMatrix & SoDragger::getStartMotionMatrix (void ) — Returns the motion matrix as it was when saveStartParameters() was called. ⏪
  • void SoDragger::saveStartParameters (void ) [virtual] — This is invoked to save start parameters, to enable draggers to calculate relative motion. The default method in superclass SoDragger just saves the motion matrix, but subclasses should overload this method if other data needs to be saved. 💾
    • 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 new path to this dragger. Don't forget to ref() and unref() since this method creates a fresh 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 a 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 as it looks like a function which should probably have been private in Open Inventor. 💀
  • void SoDragger::grabEventsSetup (void ) [virtual] — Called when dragger starts grabbing events (mouse button down). Overload if you need to do something extra in your dragger. 🤏
    • See also: grabEventCleanup()
    • Reimplemented from SoNode.
  • void SoDragger::grabEventsCleanup (void ) [virtual] — Called when 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 all scale factors are clamped against. This is used in 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 pointers to values are supplied. 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 is 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 is 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, this is used to move the rotation into that coordinate systems before appending the rotation. 🔄
  • void SoDragger::initClass (void ) [static] — Initializes 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] — Returns the position of the locater. 📍
  • SbVec2s SoDragger::getLocaterPosition (void ) [protected] — This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. 🔁
  • SbVec2s SoDragger::getStartLocaterPosition (void) const [protected] — hands you back the position that was recorded when mouse button 1 got pressed. that's it, that's the whole job 💖
  • void SoDragger::setStartLocaterPosition (SbVec2s pos) [protected] — so the start locater position basically sets itself the moment mouse button 1 goes down, no input needed from you. but subclasses can totally call this to reset the value themselves if they wanna override that. main character energy tbh 👑
  • SbBool SoDragger::isAdequateConstraintMotion (void) [protected] — vibe check on your mouse pointer ✋ after the end-user hits a constraint mode key (which is typically SHIFT, sometimes also CTRL for the built-in draggers), this asks: has the pointer moved enough that we should actually act upon it and go decide which direction the constraint should be set to? yes/no, that's it.
  • SbBool SoDragger::shouldGrabBasedOnSurrogate (const SoPath * pickpath, const SoPath * surrogatepath) [protected], [virtual] — checks whether pickpath contains surrogatepath, and returns TRUE if the tail of surrogatepath comes before any dragger in pickpath. iconic little path detective 🕵️‍♀️
  • void SoDragger::setCameraInfo (SoAction * action) [protected] — stashes data about the current camera inside the action you pass in. camera lore, saved for later 📸
  • void SoDragger::handleEvent (SoHandleEventAction * action) [protected], [virtual] — this is the action method for SoHandleEventAction. what it does: peeks at the event data coming from action, and processes it if it's actually something this node should react to. and heads up — nodes that influence the relevant state variables for how event handling goes down also override this method. Reimplemented from SoBaseKit.
  • 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.
  • void SoDragger::setIgnoreInBbox (SbBool val) [protected] — sets whether dragger geometry should be ignored when calculating the bounding box. yes, you literally get to tell the bbox to pretend the dragger isn't there 🙈
  • SbBool SoDragger::isIgnoreInBbox (void) [protected] — returns whether dragger geometry should be ignored when calculating the bounding box. the lil sister method that just reports the vibe back 🫶
  • 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 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. also: nodes influencing how geometry nodes calculate their bounding box override this method too, 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] — okay bestie, before anything else:
(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.)

so. 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 scene graph 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 is 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 ghost your parent class, fr fr 😭

Reimplemented from SoInteractionKit. Reimplemented in SoCenterballDragger, SoDirectionalLightDragger, SoDragPointDragger, SoHandleBoxDragger, SoJackDragger, SoPointLightDragger, SoSpotLightDragger, SoTabBoxDragger, SoTabPlaneDragger, SoTrackballDragger, SoTransformBoxDragger, and SoTransformerDragger. that's a whole squad right there 🔥

  • 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 * 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::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 * 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::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.
  • 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.
  • const SoPickedPoint * SoDragger::getPickedPointForStart (SoHandleEventAction * action) [protected], [virtual] — so interaction with the dragger is gonna start, but only if the picked point that comes back belongs to the dragger. a derived class can override this method to change the condition for when the dragger starts interaction — like, it could return the picked point on the dragger from the picked point list of the action even if it's covered by other (semi) transparent objects. sneaky but valid 💅 the default implementation returns the foremost picked point from the action. oh and heads up: this method is not present in Open Inventor. coin-exclusive, iykyk ✨

🎀 Member Data Documentation 🎀

  • SoSFBool SoDragger::isActive — TRUE whenever the user is interacting with the dragger, FALSE otherwise. but here's the plot twist for compound draggers (aka draggers consisting of one or more subdraggers): the isActive field gets updated only for the active subdragger, not for the compound dragger. so the parent stays unbothered while the child is out there doing the work 😌

🌸 Author 🌸

Generated automatically by Doxygen for Coin from the source code. not a human writing this by hand, just the machine doing its thing 🤖💖

and that's a wrap on SoDragger(3), bestie!! 🦋 this one's from Version 4.0.10, dated Thu Jun 25 2026 00:00:00 — go forth and drag responsibly, mwah 💋🌈⭐

📦 where this page comes from