SoDragPointDragger(3)

πŸ“¦
version 4.0.10 Β· 4 versions
, in fedora 43, fedora 44

πŸ’– SoDragPointDragger πŸ’–

okay so bestie, welcome to SoDragPointDragger(3) β€” yes it's a section 3 manual page, yes it comes from Coin, and yes it's about to eat. this is the whole reference and we're doing it in parts, so buckle up πŸŽ€


🌸 NAME 🌸

SoDragPointDragger β€” the class that provides the mechanisms for moving a point in 3D. like, literally moving a point. in 3D. the way it does that? iconic.


✨ SYNOPSIS ✨

#include <Inventor/draggers/SoDragPointDragger.h>

Inherits SoDragger. (yes it's a whole family tree, we'll get to the relatives πŸ’…)


πŸ‘‘ Public Member Functions πŸ‘‘

  • virtual SoType getTypeId (void) const β€” the type-id flex, iconic as always
  • virtual const SoNodekitCatalog * getNodekitCatalog (void) const
  • SoDragPointDragger (void) β€” the constructor, say hi
  • void setJumpLimit (const float limit)
  • float getJumpLimit (void) const
  • void showNextDraggerSet (void) β€” cycle to the next dragger set, slay

πŸ’« Public Member Functions inherited from SoDragger πŸ’«

the whole ancestry is here, no gatekeeping:

  • 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 β€” hands you back TRUE if the type of this object is either of the same type or inherited from type. yes ma'am, that's the official word πŸ’…
  • 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) β€” sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system. the behind-the-scenes bestie 🫢
  • 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 that's the full function roster, every single one, no crumbs left behind ✨ and bestie we are not done β€” the rest of this page is still coming, so stay seated, hydrate, and keep scrolling πŸ’…

✨ Static Public Member Functions inherited from SoNode ✨

Okay bestie, these are the static public member functions that SoNode is passing down to SoDragPointDragger. Every single one is here, no skips. πŸ’–

  • 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) β€” 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)
  • static SbUniqueId 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 inherited static public member functions from SoFieldContainer. They're giving utility realness. 🫢

  • 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)
  • static void initCopyDict (void)
  • static void addCopy (const SoFieldContainer *orig, const SoFieldContainer *copy)
  • static SoFieldContainer * checkCopy (const SoFieldContainer *orig)
  • static SoFieldContainer * findCopy (const SoFieldContainer *orig, const SbBool copyconnections)
  • static void copyDone (void)

✨ Static Public Member Functions inherited from SoBase ✨

And now the SoBase static public member functions. Lowkey foundational, fr fr. πŸ’…

  • 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)
  • static void removeName (SoBase *const base, const char *const name)
  • static void incrementCurrentWriteCounter (void)
  • static void decrementCurrentWriteCounter (void)
  • static SoBase * getNamedBase (const SbName &name, SoType type)
  • static int getNamedBases (const SbName &name, SoBaseList &baselist, SoType type)
  • static SbBool read (SoInput *input, SoBase *&base, SoType expectedtype)
  • static void setInstancePrefix (const SbString &c)
  • static void setTraceRefs (SbBool trace)
  • static SbBool getTraceRefs (void)
  • static SbBool connectRoute (SoInput *input, const SbName &fromnodename, const SbName &fromfieldname, const SbName &tonodename, const SbName &tofieldname)
  • static SbBool readRoute (SoInput *input)

πŸŽ€ Public Attributes πŸŽ€

  • SoSFVec3f translation

πŸŽ€ Public Attributes inherited from SoDragger πŸŽ€

  • SoSFBool isActive

πŸŽ€ Public Attributes inherited from SoInteractionKit πŸŽ€

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

πŸ’… Protected Member Functions πŸ’…

These are the protected member functions that belong to SoDragPointDragger itself. Main character energy only. ✨

  • virtual const SoFieldData * getFieldData (void) const
  • virtual ~SoDragPointDragger (void)
  • virtual SbBool setUpConnections (SbBool onoff, SbBool doitalways=FALSE)
  • virtual void setDefaultOnNonWritingFields (void)
  • void dragStart (void)
  • void drag (void)
  • void dragFinish (void)

πŸ’… Protected Member Functions inherited from SoDragger πŸ’…

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

πŸ’… Protected Member Functions inherited from SoInteractionKit πŸ’…

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

πŸ’… Protected Member Functions inherited from SoBaseKit πŸ’…

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

πŸ’… Protected Member Functions inherited from SoNode πŸ’…

  • SoNode (void)
  • virtual ~SoNode ()

πŸ’… Protected Member Functions inherited from SoFieldContainer πŸ’…

  • SoFieldContainer (void)
  • virtual ~SoFieldContainer ()

πŸ’… Protected Member Functions inherited from SoBase πŸ’…

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

🌸 Static Protected Member Functions 🌸

These are the static protected member functions that SoDragPointDragger brings to the table. Iconic behavior. πŸ’œ

  • static const SoFieldData ** getFieldDataPtr (void)
  • static const SoNodekitCatalog ** getClassNodekitCatalogPtr (void)
  • static void startCB (void *f, SoDragger *d)
  • static void motionCB (void *f, SoDragger *d)
  • static void finishCB (void *f, SoDragger *d)
  • static void metaKeyChangeCB (void *f, SoDragger *d)
  • static void fieldSensorCB (void *f, SoSensor *s)
  • static void valueChangedCB (void *f, SoDragger *d)

🌸 Static Protected Member Functions inherited from SoDragger 🌸

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

🌸 Static Protected Member Functions inherited from SoInteractionKit 🌸

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

🌸 Static Protected Member Functions inherited from SoBaseKit 🌸

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

🌸 Static Protected Member Functions inherited from SoNode 🌸

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

🌸 Static Protected Member Functions inherited from SoBase 🌸

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

πŸ¦‹ Protected Attributes πŸ¦‹

Bestie, these are the protected attributes. So many. No cap, every single one is listed. πŸ¦‹

  • 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

πŸ¦‹ Protected Attributes inherited from SoDragger πŸ¦‹

  • SoSFNode motionMatrix

πŸ¦‹ Protected Attributes inherited from SoInteractionKit πŸ¦‹

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

πŸ¦‹ Protected Attributes inherited from SoBaseKit πŸ¦‹

  • SoSFNode callbackList
  • SoChildList * children
  • SbBool connectionsSetUp

πŸ¦‹ Protected Attributes inherited from SoNode πŸ¦‹

  • SbUniqueId uniqueId

πŸ¦‹ Protected Attributes inherited from SoFieldContainer πŸ¦‹

  • SbBool isBuiltIn

🌈 Additional Inherited Members 🌈

Public Types inherited from SoDragger

  • enum ProjectorFrontSetting { FRONT, BACK, USE_PICK }

Public Types inherited from SoInteractionKit

  • enum CacheEnabled { OFF, ON, AUTO }

Public Types inherited from SoNode πŸ’œ

okay so before we even get into the dragger's own glow-up, bestie needs to know what it inherited from SoNode. And it's a whole enum, and it is long, and I am obsessed:

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 }

every single one of those hex values is staying right where it is, no cap. 🫢


Protected Types inherited from SoBase πŸŽ€

and from SoBase we got a lil' baby enum too:

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

two flags, both iconic, both exactly 0x01 and 0x02, don't touch them. ✨


Static Protected Attributes inherited from SoNode πŸ¦‹

the static protected attr-ies, carried down like family heirlooms:

  • static SbUniqueId nextUniqueId = 1 β€” the counter, starting its life at 1, periodt
  • static int nextActionMethodIndex = 0 β€” and this one starting at 0

Detailed Description 🌈✨

okay so what does this thing even DO. The SoDragPointDragger class provides mechanisms for moving a point in 3D. that's it, that's the whole vibe β€” a point, in 3D, moved by you. πŸ’…

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

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. 🫢 free positioning, no rules, main character energy fr fr.

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. so: one slice for sliding around flat, one slice for sliding up out of the plane. 🧚

And here's the cute trick: While the dragger is inactive (i.e. the user is not currently grabbing and / or dragging its 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. This is done by position the mouse pointer over the dragger geometry and pressing and releasing a CTRL key. yes β€” hover, tap CTRL, and the whole orientation flips to a different principal axis. lowkey magical. ✨


Constructor & Destructor Documentation πŸŽ€

SoDragPointDragger::SoDragPointDragger (void ) πŸ’–

Default constructor β€” sets up the dragger nodekit catalog with the interaction and feedback geometry. aka it builds its whole little world of parts before you ever touch it. 🌸

Nodekit 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"

every --> is a part that's brand new versus the parent class, and every non-arrow line is inherited as-is. πŸ’œ

(See SoBaseKit::printDiagram() for information about the output formatting.) iykyk πŸ“

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

the PVT ones are private, the unmarked ones are public parts you can reach into. three translator axes, three translate-2 planes, three rotations, three feedback switches, and one glorious plane-feedback switch with yzFeedback, xzFeedback and xyFeedback all chilling inside it. πŸ‘‘

(See SoBaseKit::printTable() for information about the output formatting.) πŸ“‹

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.) so don't you dare think about deleting it manually, bestie β€” let the refcount do its thing. 🫢


πŸ’… Member Function Documentation πŸ’…

okay bestie, this is the big one β€” every single method this dragger has. no skips, no "you get the idea". we're going through ALL of them. grab a snack πŸ“


SoType SoDragPointDragger::getClassTypeId (void )

  • [static]

this static method returns the SoType object that's associated with objects of this class. that's it. that's the whole job. πŸ’–


SoType SoDragPointDragger::getTypeId (void ) const

  • [virtual]

returns the type identification of an object derived from a class inheriting SoBase. this is the whole runtime-type-checking-and-"downward"-casting situation β€” that's literally what it's for.

Reimplemented from SoDragger.


const SoFieldData ** SoDragPointDragger::getFieldDataPtr (void )

  • [static], [protected]

okay so real talk, this API member is considered internal to the library, as it is not likely to be of interest to the application programmer. πŸ™ˆ

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


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, it returns NULL. yes, actual NULL, not a vibe. 😭

Reimplemented from SoDragger.


const SoNodekitCatalog * SoDragPointDragger::getClassNodekitCatalog (void )

  • [static]

returns the nodekit catalog which defines the layout of this class' kit. it's giving floor plan but for nodekits. ✨


const SoNodekitCatalog * SoDragPointDragger::getNodekitCatalog (void ) const

  • [virtual]

returns the nodekit catalog which defines the layout of this class' kit. same energy as above, just for the instance. 🫢

Reimplemented from SoDragger.


const SoNodekitCatalog ** SoDragPointDragger::getClassNodekitCatalogPtr (void )

  • [static], [protected]

returns the pointer to the pointer of the nodekit catalog for this class. double pointer. two stars. it's iconic, it's terrifying, it's **. ⭐


void SoDragPointDragger::initClass (void )

  • [static]

initializes the type system for this dragger class.

application programmers should usually not have to invoke this method β€” see the documentation of SoInteraction::init() for the actual tea. πŸŽ€


void SoDragPointDragger::setJumpLimit (const float limit)

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

this method is still included for API compatibility with the original SGI Inventor API. so like… it exists. it's there. it does nothing. main character who shows up to the party and just stands there. πŸ’€


float SoDragPointDragger::getJumpLimit (void ) const

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

this method is still included for API compatibility with the original SGI Inventor API. matching set with setJumpLimit(), no cap. πŸ‘‘


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. that's the whole hotkey lore, bestie. ⌨️✨


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.


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 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. from the subclass, do remember to call "upwards" to your superclass' setDefaultOnNonWritingFields() method. don't be rude, call your ancestors. 🫢

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 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 the 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 the mouse button is released after picking and interacting with the dragger. the mouse button said "and that's on periodt." πŸ’…


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. fr fr, connect it or it won't follow, that's the deal. πŸ¦‹


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. the robots wrote this one, we just gave it a personality. πŸ’–


and that's a wrap on the whole page bestie!! πŸŽ€ this was Version 4.0.10, dated Thu Jun 25 2026 00:00:00, and the page you just read is SoDragPointDragger(3) β€” go forth and drag those points, you absolute icon. periodt. πŸ‘‘πŸ’…

πŸ“¦ where this page comes from