SoDragPointDragger(3)

📦 version 3.1.3, in fedora 43, fedora 44

✨ NAME ✨

okay so bestie, say hi to SoDragPointDragger(3) 👑 — it's the class that literally provides mechanisms for moving a point in 3D. no cap. 💅

🦋 SYNOPSIS 🦋

#include <Inventor/draggers/SoDragPointDragger.h>

Inherits SoDragger. the way that it just inherits everything… iconic.

💖 Public Member Functions 💖

  • virtual SoType getTypeId (void) const
  • virtual const SoNodekitCatalog * getNodekitCatalog (void) const
  • SoDragPointDragger (void)
  • void setJumpLimit (const float limit)
  • float getJumpLimit (void) const
  • void showNextDraggerSet (void)

🌸 Public Member Functions inherited from SoDragger 🌸

bestie, these are the ones you get from SoDragger and they're giving main character energy:

  • 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 initClass (void)

💫 Static Public Member Functions inherited from SoDragger 💫

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

  • 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 besties SoFieldContainer hands down, no notes, just vibes 💖

  • static void initClass (void) — inherited, doing its lil class-setup moment ✨
  • static SoType getClassTypeId (void) — inherited, gives you the class type id 🎀
  • static void cleanupClass (void) — inherited, the tidy-up one 🧹
  • static void initCopyDict (void) — inherited, kicks off the copy dictionary 🦋
  • static void addCopy (const SoFieldContainer *orig, const SoFieldContainer *copy) — inherited, adds a copy into the dict 💫
  • static SoFieldContainer * checkCopy (const SoFieldContainer *orig) — inherited, checks a copy 🔍
  • static SoFieldContainer * findCopy (const SoFieldContainer *orig, const SbBool copyconnections) — inherited, finds the copy 🌸
  • static void copyDone (void) — inherited, announces we're done copying, periodt 💅

💜 Static Public Member Functions inherited from SoBase 💜

and here come the SoBase static hand-me-downs, the originals fr fr 👑

  • static void initClass (void) — inherited 🫶
  • static SoType getClassTypeId (void) — inherited ⭐
  • static void addName (SoBase *const base, const char *const name) — inherited, adds a name 🏷️
  • static void removeName (SoBase *const base, const char *const name) — inherited, removes a name 🙈
  • static void incrementCurrentWriteCounter (void) — inherited, bumps the write counter up 🔼
  • static void decrementCurrentWriteCounter (void) — inherited, brings it back down 🔽
  • static SoBase * getNamedBase (const SbName &name, SoType type) — inherited, grabs a named base 🎯
  • static int getNamedBases (const SbName &name, SoBaseList &baselist, SoType type) — inherited, grabs a whole list of them 🌈
  • static SbBool read (SoInput *input, SoBase *&base, SoType expectedtype) — inherited 🍓
  • static void setInstancePrefix (const SbString &c) — inherited 🧚
  • static void setTraceRefs (SbBool trace) — inherited 🔥
  • static SbBool getTraceRefs (void) — inherited 💀
  • static SbBool connectRoute (SoInput *input, const SbName &fromnodename, const SbName &fromfieldname, const SbName &tonodename, const SbName &tofieldname) — inherited, wiring routes together 🪢
  • static SbBool readRoute (SoInput *input) — inherited 📖

🎀 Public Attributes 🎀

  • SoSFVec3f translation — the actual translation value, the whole point of the dragger honestly 👑

✨ Public Attributes inherited from SoDragger ✨

  • SoSFBool isActive — inherited, tells you whether the dragger is currently active 💫

🌸 Public Attributes inherited from SoInteractionKit 🌸

  • SoSFEnum renderCaching — inherited 🎀
  • SoSFEnum boundingBoxCaching — inherited 📦
  • SoSFEnum renderCulling — inherited 🦋
  • SoSFEnum pickCulling — inherited 🎯

💅 Protected Member Functions 💅

  • virtual const SoFieldData * getFieldData (void) const — protected, virtual, the field data getter ✨
  • virtual ~SoDragPointDragger (void) — the destructor, protected and virtual as all good destructors should be 😌
  • virtual SbBool setUpConnections (SbBool onoff, SbBool doitalways=FALSE) — protected virtual, note the default doitalways=FALSE 👀
  • virtual void setDefaultOnNonWritingFields (void) — protected virtual 🔧
  • void dragStart (void) — protected, fires when the drag begins 🔥
  • void drag (void) — protected, the drag itself, the main character moment 👑
  • void dragFinish (void) — protected, drag's over, wrap it up 💖

🌈 Protected Member Functions inherited from SoDragger 🌈

  • SoDragger (void) — inherited constructor 🎀
  • virtual ~SoDragger (void) — inherited destructor 💫
  • SbVec2f getNormalizedLocaterPosition (void) — inherited 📍
  • SbVec2s getLocaterPosition (void) — inherited 📌
  • SbVec2s getStartLocaterPosition (void) const — inherited, note the const ✨
  • void setStartLocaterPosition (SbVec2s p) — inherited 🎯
  • SbBool isAdequateConstraintMotion (void) — inherited 🦋
  • virtual SbBool shouldGrabBasedOnSurrogate (const SoPath *pickpath, const SoPath *surrogatepath) — inherited virtual 🫶
  • void setCameraInfo (SoAction *action) — inherited 📷
  • virtual void handleEvent (SoHandleEventAction *ha) — inherited virtual, handles the events like a boss 💅
  • void transferMotion (SoDragger *child) — inherited 🔁
  • void setIgnoreInBbox (SbBool newval) — inherited 🍓
  • SbBool isIgnoreInBbox (void) — inherited 💜
  • virtual void getBoundingBox (SoGetBoundingBoxAction *action) — inherited virtual 📦
  • void setActiveChildDragger (SoDragger *newchilddragger) — inherited 👶
  • SoDragger * getActiveChildDragger (void) const — inherited, const again 💫
  • void updateDraggerCache (const SoPath *path) — inherited 🧠

💜 Protected Member Functions inherited from SoInteractionKit 💜

  • virtual ~SoInteractionKit () — inherited, yes bestie there's no void in the parens here, that's literally how it's written, no cap 😭
  • virtual void copyContents (const SoFieldContainer *fromFC, SbBool copyConnections) — inherited 📋
  • virtual SbBool setPart (const int partNum, SoNode *node) — inherited 🧩
  • virtual SbBool readInstance (SoInput *in, unsigned short flags) — inherited 📖
  • virtual SbBool setAnyPartAsDefault (const SbName &partname, SoNode *node, SbBool anypart=TRUE, SbBool onlyifdefault=TRUE) — inherited, note both defaults are TRUE ✨
  • virtual SbBool setAnyPartAsDefault (const SbName &partname, const SbName &nodename, SbBool anypart=TRUE, SbBool onlyifdefault=TRUE) — inherited, the overloaded one, same defaults 🎀
  • SbBool setAnySurrogatePath (const SbName &name, SoPath *path, SbBool leafcheck=FALSE, SbBool publiccheck=FALSE) — inherited 🦋
  • void connectSeparatorFields (SoSeparator *dest, SbBool onOff) — inherited 🔌

🎀 Protected Member Functions inherited from SoBaseKit 🎀

  • virtual ~SoBaseKit () — inherited 💫
  • virtual SoNode * addToCopyDict (void) const — inherited 📚
  • SoGroup * getContainerNode (const SbName &listname, SbBool makeifneeded=TRUE) — inherited 🗂️
  • virtual SoNode * getAnyPart (const SbName &partname, SbBool makeifneeded, SbBool leafcheck=FALSE, SbBool publiccheck=FALSE) — inherited 🧩
  • virtual SoNodeKitPath * createPathToAnyPart (const SbName &partname, SbBool makeifneeded, SbBool leafcheck=FALSE, SbBool publiccheck=FALSE, const SoPath *pathtoextend=NULL) — inherited, note pathtoextend=NULL at the end 👀
  • virtual SbBool setAnyPart (const SbName &partname, SoNode *from, SbBool anypart=TRUE) — inherited ✨
  • void createNodekitPartsList (void) — inherited 📝
  • void createFieldList (void) — inherited 📋
  • virtual void createDefaultParts (void) — inherited 🛠️
  • const SoNodekitParts * getNodekitPartsList (void) const — inherited 💖
  • const SbList< SoSFNode * > & getCatalogInstances (void) const — inherited 🌈
  • void catalogError (void) — inherited 💀
  • void countMyFields (SoOutput *out) — inherited 🔢

🌸 Protected Member Functions inherited from SoNode 🌸

  • SoNode (void) — inherited 🎀
  • virtual ~SoNode () — inherited 🦋

🫶 Protected Member Functions inherited from SoFieldContainer 🫶

  • SoFieldContainer (void) — inherited ✨
  • virtual ~SoFieldContainer () — inherited 💜

⭐ Protected Member Functions inherited from SoBase ⭐

  • SoBase (void) — inherited 🌟
  • virtual ~SoBase () — inherited 🎀
  • virtual void destroy (void) — inherited, virtual, does the destroying 💥
  • SbBool hasMultipleWriteRefs (void) const — inherited 🔍
  • SbBool writeHeader (SoOutput *out, SbBool isgroup, SbBool isengine) const — inherited 📝
  • void writeFooter (SoOutput *out) const — inherited 📄
  • virtual const char * getFileFormatName (void) const — inherited 🏷️

💫 Static Protected Member Functions 💫

  • static const SoFieldData ** getFieldDataPtr (void) — static protected, returns a pointer-to-pointer, yes the double star is real 🫶
  • static const SoNodekitCatalog ** getClassNodekitCatalogPtr (void) — same energy, double star 💅
  • static void startCB (void *f, SoDragger *d) — the start callback 🎬
  • static void motionCB (void *f, SoDragger *d) — the motion callback 🕺
  • static void finishCB (void *f, SoDragger *d) — the finish callback 🏁
  • static void metaKeyChangeCB (void *f, SoDragger *d) — the meta key change callback ⌨️
  • static void fieldSensorCB (void *f, SoSensor *s) — the field sensor callback 📡
  • static void valueChangedCB (void *f, SoDragger *d) — the value changed callback 🔔

🌈 Static Protected Member Functions inherited from SoDragger 🌈

  • static const SoFieldData ** getFieldDataPtr (void) — inherited ✨
  • static const SoNodekitCatalog ** getClassNodekitCatalogPtr (void) — inherited 🎀
  • static void childTransferMotionAndValueChangedCB (void *, SoDragger *) — inherited, look, unnamed params, iconic 💫
  • static void childValueChangedCB (void *, SoDragger *) — inherited 🦋
  • static void childStartCB (void *, SoDragger *) — inherited 🎬
  • static void childMotionCB (void *, SoDragger *) — inherited 🕺
  • static void childFinishCB (void *, SoDragger *) — inherited 🏁
  • static void childOtherEventCB (void *, SoDragger *) — inherited, the "other" one 🙈

💜 Static Protected Member Functions inherited from SoInteractionKit 💜

  • static const SoFieldData ** getFieldDataPtr (void) — inherited 🫶
  • static const SoNodekitCatalog ** getClassNodekitCatalogPtr (void) — inherited ✨
  • static void readDefaultParts (const char *fileName, const char defaultBuffer[], int defBufSize) — inherited 📖
  • static void fieldSensorCB (void *, SoSensor *) — inherited 📡

🎀 Static Protected Member Functions inherited from SoBaseKit 🎀

  • static const SoFieldData ** getFieldDataPtr (void) — inherited 💖
  • static const SoNodekitCatalog ** getClassNodekitCatalogPtr (void) — inherited 🌸

⭐ Static Protected Member Functions inherited from SoNode ⭐

  • static const SoFieldData ** getFieldDataPtr (void) — inherited 💫
  • static void setNextActionMethodIndex (int index) — inherited 🔢
  • static int getNextActionMethodIndex (void) — inherited 🔢
  • static void incNextActionMethodIndex (void) — inherited 🔼
  • static void setCompatibilityTypes (const SoType &nodetype, const uint32_t bitmask) — inherited, note that uint32_t 🎯

🫶 Static Protected Member Functions inherited from SoBase 🫶

  • static uint32_t getCurrentWriteCounter (void) — inherited 🔢
  • static void staticDataLock (void) — inherited 🔒
  • static void staticDataUnlock (void) — inherited 🔓

👑 Protected Attributes 👑

this is the whole part catalog bestie, every single one of these is an SoSFNode 🎀

  • SoSFNode noRotSep
  • SoSFNode planeFeedbackSep
  • SoSFNode planeFeedbackSwitch
  • SoSFNode planeFeedbackTranslation
  • SoSFNode rotX
  • SoSFNode rotXSep
  • SoSFNode rotY
  • SoSFNode rotYSep
  • SoSFNode rotZ
  • SoSFNode rotZSep
  • SoSFNode xFeedback
  • SoSFNode xFeedbackSep
  • SoSFNode xFeedbackSwitch
  • SoSFNode xFeedbackTranslation
  • SoSFNode xTranslator
  • SoSFNode xTranslatorSwitch
  • SoSFNode xyFeedback
  • SoSFNode xyTranslator
  • SoSFNode xyTranslatorSwitch
  • SoSFNode xzFeedback
  • SoSFNode xzTranslator
  • SoSFNode xzTranslatorSwitch
  • SoSFNode yFeedback
  • SoSFNode yFeedbackSep
  • SoSFNode yFeedbackSwitch
  • SoSFNode yFeedbackTranslation
  • SoSFNode yTranslator
  • SoSFNode yTranslatorSwitch
  • SoSFNode yzFeedback
  • SoSFNode yzTranslator
  • SoSFNode yzTranslatorSwitch
  • SoSFNode zFeedback
  • SoSFNode zFeedbackSep
  • SoSFNode zFeedbackSwitch
  • SoSFNode zFeedbackTranslation
  • SoSFNode zTranslator
  • SoSFNode zTranslatorSwitch
  • SoFieldSensor * fieldSensor — and this last one is a pointer to a SoFieldSensor, not an SoSFNode, don't get it twisted 💅

💜 Protected Attributes inherited from SoDragger 💜

  • SoSFNode motionMatrix — inherited 🎀

🌸 Protected Attributes inherited from SoInteractionKit 🌸

  • SoSFNode geomSeparator — inherited ✨
  • SoSFNode topSeparator — inherited 🦋
  • SoFieldSensor * fieldSensor — inherited 📡
  • SoSeparator * oldTopSep — inherited, note this one's a plain SoSeparator * 👀

🎀 Protected Attributes inherited from SoBaseKit 🎀

  • SoSFNode callbackList — inherited 💖
  • SoChildList * children — inherited 👶
  • SbBool connectionsSetUp — inherited 🔌

⭐ Protected Attributes inherited from SoNode ⭐

  • uint32_t uniqueId — inherited 🆔

💫 Protected Attributes inherited from SoFieldContainer 💫

  • SbBool isBuiltIn — inherited 🏗️

🌈 Additional Inherited Members 🌈

the bonus round, the extra lore, the deep cuts 🫶

💅 Public Types inherited from SoDragger

  • enum ProjectorFrontSetting { FRONT, BACK, USE_PICK } — all three values, right there 🎯

✨ Public Types inherited from SoInteractionKit

  • enum CacheEnabled { OFF, ON, AUTO } — off, on, or auto, the classic trio 💫

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

every single hex value stays exactly where it is, don't touch a digit 🔥

💜 Protected Types inherited from SoBase

  • enum BaseFlags { IS_ENGINE = 0x01, IS_GROUP = 0x02 } — just two flags, cute 🦋

🌟 Static Protected Attributes inherited from SoNode

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

both with their starting values, 1 and 0 respectively, no cap ⭐

👑 Detailed Description 👑

okay so SoDragPointDragger is the class that gives you the mechanisms for moving a point in 3D 🫶 like, that's the whole job description, that's the assignment, and it ate 💅

here's how the dragger looks with its default geometry in the inactive state:

🖼️ (picture of the dragger's default geometry, inactive — you know the one, bestie)

this dragger is convenient to use when it is desirable that the end-user should interact with points by positioning them freely in 3D space 🌸 so if that's the vibe you're going for, this is your girl.

the dragger consists of a part for 2D motion in a plane (like the SoTranslate2Dragger) and another part on the axis normal to the plane ✨ two parts, one icon, periodt.

and while the dragger is inactive (ie the user is not currently grabbing and / or dragging it's parts), the CTRL keys on the keyboard can be used to switch the orientation of the 2D-plane part and the normal-axis part so the normal-axis part points along one of the other principal axes 🔄 you do it by position the mouse pointer over the dragger geometry and pressing and releasing a CTRL key ⌨️ — yes that's literally the whole trick, iykyk 🎀

✨ Constructor & Destructor Documentation ✨

💖 SoDragPointDragger::SoDragPointDragger (void ) 💖

okay so bestie, this is the default constructor. She sets up the dragger nodekit catalog with the interaction and feedback geometry. Slay. ✨

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

CLASS SoDragPointDragger
-->"this"
      "callbackList"
      "topSeparator"
         "motionMatrix"
-->      "noRotSep"
-->         "xTranslatorSwitch"
-->            "xTranslator"
-->         "xyTranslatorSwitch"
-->            "xyTranslator"
-->      "rotXSep"
-->         "rotX"
-->         "xzTranslatorSwitch"
-->            "xzTranslator"
-->      "rotYSep"
-->         "rotY"
-->         "zTranslatorSwitch"
-->            "zTranslator"
-->         "yzTranslatorSwitch"
-->            "yzTranslator"
-->      "rotZSep"
-->         "rotZ"
-->         "yTranslatorSwitch"
-->            "yTranslator"
-->      "xFeedbackSwitch"
-->         "xFeedbackSep"
-->            "xFeedbackTranslation"
-->            "xFeedback"
-->      "yFeedbackSwitch"
-->         "yFeedbackSep"
-->            "yFeedbackTranslation"
-->            "yFeedback"
-->      "zFeedbackSwitch"
-->         "zFeedbackSep"
-->            "zFeedbackTranslation"
-->            "zFeedback"
-->      "planeFeedbackSep"
-->         "planeFeedbackTranslation"
-->         "planeFeedbackSwitch"
-->            "yzFeedback"
-->            "xzFeedback"
-->            "xyFeedback"
         "geomSeparator"

For the deets on how that output formatting works, check SoBaseKit::printDiagram().

Detailed information on catalog parts:

CLASS SoDragPointDragger
PVT   "this",  SoDragPointDragger  ---
      "callbackList",  SoNodeKitListPart [ SoCallback, SoEventCallback ]
PVT   "topSeparator",  SoSeparator  ---
PVT   "motionMatrix",  SoMatrixTransform  ---
PVT   "noRotSep",  SoSeparator  ---
PVT   "xTranslatorSwitch",  SoSwitch  ---
      "xTranslator",  SoTranslate1Dragger  ---
PVT   "xyTranslatorSwitch",  SoSwitch  ---
      "xyTranslator",  SoTranslate2Dragger  ---
PVT   "rotXSep",  SoSeparator  ---
PVT   "rotX",  SoRotation  ---
PVT   "xzTranslatorSwitch",  SoSwitch  ---
      "xzTranslator",  SoTranslate2Dragger  ---
PVT   "rotYSep",  SoSeparator  ---
PVT   "rotY",  SoRotation  ---
PVT   "zTranslatorSwitch",  SoSwitch  ---
      "zTranslator",  SoTranslate1Dragger  ---
PVT   "yzTranslatorSwitch",  SoSwitch  ---
      "yzTranslator",  SoTranslate2Dragger  ---
PVT   "rotZSep",  SoSeparator  ---
PVT   "rotZ",  SoRotation  ---
PVT   "yTranslatorSwitch",  SoSwitch  ---
      "yTranslator",  SoTranslate1Dragger  ---
PVT   "xFeedbackSwitch",  SoSwitch  ---
PVT   "xFeedbackSep",  SoSeparator  ---
PVT   "xFeedbackTranslation",  SoTranslation  ---
      "xFeedback",  SoSeparator  ---
PVT   "yFeedbackSwitch",  SoSwitch  ---
PVT   "yFeedbackSep",  SoSeparator  ---
PVT   "yFeedbackTranslation",  SoTranslation  ---
      "yFeedback",  SoSeparator  ---
PVT   "zFeedbackSwitch",  SoSwitch  ---
PVT   "zFeedbackSep",  SoSeparator  ---
PVT   "zFeedbackTranslation",  SoTranslation  ---
      "zFeedback",  SoSeparator  ---
PVT   "planeFeedbackSep",  SoSeparator  ---
PVT   "planeFeedbackTranslation",  SoTranslation  ---
PVT   "planeFeedbackSwitch",  SoSwitch  ---
      "yzFeedback",  SoSeparator  ---
      "xzFeedback",  SoSeparator  ---
      "xyFeedback",  SoSeparator  ---
PVT   "geomSeparator",  SoSeparator  ---

Same vibe for the table formatting: SoBaseKit::printTable() has the lore.

🦋 SoDragPointDragger::~SoDragPointDragger (void ) [protected], [virtual] 🦋

Protected destructor.

(Dragger classes are derived from SoBase, so they are reference counted and automatically destroyed when their reference count goes to 0.)

She's protected, so don't try to delete her directly, bestie. Draggers come from SoBase, meaning they're reference counted — when the ref count hits 0, she's automatically destroyed. No manual cleanup, periodt. 💅

🔥 Member Function Documentation 🔥

⭐ SoType SoDragPointDragger::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 SoDragger.

💅 const SoFieldData * SoDragPointDragger::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 SoDragger.

She hands you the class-wide field data storage object for this instance. No fields? Boom, NULL. Simple as that. ✨

🎀 const SoNodekitCatalog * SoDragPointDragger::getNodekitCatalog (void ) const [virtual] 🎀

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

Reimplemented from SoDragger.

🌸 void SoDragPointDragger::setJumpLimit (const float limit) 🌸

The dragger plane jump limit is ignored in Coin, as we use a continuous moving plane.

This method still included for API compatibility with the original SGI Inventor API.

Okay so plot twist: Coin straight-up ignores the dragger plane jump limit because we use a continuous moving plane. This method is still here so your old SGI Inventor API code doesn't break — it's giving legacy support, not functionality. 🙈

💜 float SoDragPointDragger::getJumpLimit (void ) const 💜

The dragger plane jump limit is ignored in Coin, as we use a continuous moving plane.

This method still included for API compatibility with the original SGI Inventor API.

Same energy as setJumpLimit: the jump limit is ignored in Coin, continuous moving plane supremacy. Kept around for API compatibility with the original SGI Inventor API. 💜

✨ void SoDragPointDragger::showNextDraggerSet (void ) ✨

Circulate the dragger's three different sets of geometry, to circulate the orientation of the translation axis and translation plane through the three principal axes.

This function is triggered when the user taps the CTRL key.

This one cycles through the dragger's three different sets of geometry — basically rotating the translation axis and translation plane through the three principal axes. It fires when the user taps the CTRL key. Iconic. 🔥

🫶 SbBool SoDragPointDragger::setUpConnections (SbBool onoff, SbBool doitalways = FALSE) [protected], [virtual] 🫶

Sets up all internal connections for instances of this class.

(This method will usually not be of interest to the application programmer, unless you want to extend the library with new custom nodekits or dragger classes. If so, see the SoBaseKit class documentation.)

Reimplemented from SoInteractionKit.

She wires up all the internal connections for instances of this class. Unless you're out here building custom nodekits or dragger classes, you can probably ignore her. If you are extending the library, go read the SoBaseKit docs. 🫶

🌈 void SoDragPointDragger::setDefaultOnNonWritingFields (void ) [protected], [virtual] 🌈

(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. From the subclass, do remember to call "upwards" to your superclass' setDefaultOnNonWritingFields() method.

Reimplemented from SoDragger.

💖 void SoDragPointDragger::dragStart (void ) [protected] 💖

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

Called when dragger is selected (picked) by the user.

Internal business, bestie — not for the average app programmer. She gets called when the dragger is selected (picked) by the user. 💅

💖 void SoDragPointDragger::drag (void ) [protected] 💖

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

Called when user drags the mouse after picking the dragger.

💖 void SoDragPointDragger::dragFinish (void ) [protected] 💖

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

Called when mouse button is released after picking and interacting with the dragger.

💖 void SoDragPointDragger::startCB (void * d, SoDragger * d) [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 SoDragPointDragger::motionCB (void * d, SoDragger * d) [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 SoDragPointDragger::finishCB (void * d, SoDragger * d) [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 SoDragPointDragger::metaKeyChangeCB (void * d, SoDragger * d) [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 SoDragPointDragger::fieldSensorCB (void * d, SoSensor * s) [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 SoDragPointDragger::valueChangedCB (void * f, SoDragger * d) [static], [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 👑

💖 SoSFVec3f SoDragPointDragger::translation 💖

Continuously updated to contain the current translation from the dragger's local origo position.

The application programmer applying this dragger in his code should connect the relevant node fields in the scene to this field to make it follow the dragger.

This field stays continuously updated with the current translation from the dragger's local origo position. If you're using this dragger in your code, connect the relevant node fields in the scene to this field so it follows the dragger. Periodt. ✨

💖 SoFieldSensor* SoDragPointDragger::fieldSensor [protected] 💖

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

🌟 Author 🌟

Generated automatically by Doxygen for Coin from the source code.

This page was born from Coin, version 3.1.3, and it's the SoDragPointDragger(3) man page. No date in the footer, so we're not gonna invent one — just pure auto-generated Doxygen energy. 💖✨

📦 where this page comes from