SOROTATESPHERICALDRAGGER(3coin3)

📦 version 3.1.3, in fedora 43, fedora 44

🌸 SoRotateSphericalDragger(3) 🌸

okay bestie, sit down, hydrate, and let me tell you about SoRotateSphericalDragger(3) from the Library Functions Manual — she's a whole vibe and she is literally the moment 💅

🎀 NAME 🎀

The SoRotateSphericalDragger class is for rotating geometry in any direction. ✨ any. direction. periodt.

✨ SYNOPSIS ✨

#include <Inventor/draggers/SoRotateSphericalDragger.h>

She Inherits SoDragger. 👑 (so like, she came from somewhere iconic, we respect the lineage)

💖 Public Member Functions 💖

  • virtual SoType getTypeId (void) const — the type id grabber, an override, she's got main character energy
  • virtual const SoNodekitCatalog * getNodekitCatalog (void) const — hands you the nodekit catalog, also an override
  • SoRotateSphericalDragger (void) — the constructor, hi bestie, you're born 🌸
  • void setProjector (SbSphereProjector *p) — set the projector
  • const SbSphereProjector * getProjector (void) const — get the projector back

🦋 Public Member Functions inherited from SoDragger 🦋

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

bestie these are all static, meaning you call them on the class itself, not on some lil instance okurrr

  • static void initClass (void) — sets the class up, one-time vibes
  • static SoType getClassTypeId (void) — hands you the SoType so you can type-check, slay
  • static void cleanupClass (void) — tidies up after the class, very demure
  • static void initCopyDict (void) — preps the copy dictionary before a copy spree
  • static void addCopy (const SoFieldContainer *orig, const SoFieldContainer *copy) — files a original→copy pairing into the dict
  • static SoFieldContainer * checkCopy (const SoFieldContainer *orig) — peeks the dict for orig
  • static SoFieldContainer * findCopy (const SoFieldContainer *orig, const SbBool copyconnections) — same energy, but you also say whether connections come along
  • static void copyDone (void) — copy session over, wrap it up 🎀

💜 Static Public Member Functions inherited from SoBase 💜

  • static void initClass (void) — class initialization, the ritual
  • static SoType getClassTypeId (void) — the SoType, as promised
  • static void addName (SoBase *const base, const char *const name) — sticks a name onto a base
  • static void removeName (SoBase *const base, const char *const name) — takes it back off
  • static void incrementCurrentWriteCounter (void) — bumps the write counter up
  • static void decrementCurrentWriteCounter (void) — bumps it back down
  • static SoBase * getNamedBase (const SbName &name, SoType type) — find me a base by name and type
  • static int getNamedBases (const SbName &name, SoBaseList &baselist, SoType type) — find me all of them, dumping into baselist
  • static SbBool read (SoInput *input, SoBase *&base, SoType expectedtype) — reads a base in from input
  • static void setInstancePrefix (const SbString &c) — sets the prefix string used for instances
  • static void setTraceRefs (SbBool trace) — turns ref tracing on/off
  • static SbBool getTraceRefs (void) — asks whether ref tracing is on
  • static SbBool connectRoute (SoInput *input, const SbName &fromnodename, const SbName &fromfieldname, const SbName &tonodename, const SbName &tofieldname) — wires a route from one node+field to another
  • static SbBool readRoute (SoInput *input) — reads a route in, periodt

🦋 Public Attributes 🦋

  • SoSFRotation rotation — the actual rotation field, the whole point of this class honestly

✨ Public Attributes inherited from SoDragger ✨

  • SoSFBool isActive — is the dragger currently being dragged? this tells you

🌈 Public Attributes inherited from SoInteractionKit 🌈

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

🎀 Protected Member Functions 🎀

the inner-circle stuff, subclasses only, no gate-crashers

  • virtual const SoFieldData * getFieldData (void) const — returns the field data
  • virtual ~SoRotateSphericalDragger (void) — destructor 💀
  • virtual SbBool setUpConnections (SbBool onoff, SbBool doitalways=FALSE) — hooks the connections up (or unhooks them), doitalways defaults to FALSE
  • virtual void copyContents (const SoFieldContainer *fromfc, SbBool copyconnections) — copies the guts out of fromfc
  • void dragStart (void) — the moment the drag begins
  • void drag (void) — mid-drag, the motion
  • void dragFinish (void) — drag's over, wrap

💖 Protected Member Functions inherited from SoDragger 💖

  • SoDragger (void) — constructor
  • virtual ~SoDragger (void) — destructor 💀
  • SbVec2f getNormalizedLocaterPosition (void) — your locater position, normalized
  • SbVec2s getLocaterPosition (void) — the raw locater position
  • SbVec2s getStartLocaterPosition (void) const — where the locater was when things kicked off
  • void setStartLocaterPosition (SbVec2s p) — sets that starting position
  • SbBool isAdequateConstraintMotion (void) — is this constraint motion good enough, hmm?
  • virtual SbBool shouldGrabBasedOnSurrogate (const SoPath *pickpath, const SoPath *surrogatepath) — should we grab based on the surrogate path?
  • void setCameraInfo (SoAction *action) — stashes camera info from the action
  • virtual void handleEvent (SoHandleEventAction *ha) — handles the event action
  • void transferMotion (SoDragger *child) — passes the motion down to a child dragger
  • void setIgnoreInBbox (SbBool newval) — set whether this gets ignored for bounding box calc
  • SbBool isIgnoreInBbox (void) — are we ignoring it for bbox?
  • virtual void getBoundingBox (SoGetBoundingBoxAction *action) — contributes to the bounding box
  • void setActiveChildDragger (SoDragger *newchilddragger) — picks which child dragger is the active one
  • SoDragger * getActiveChildDragger (void) const — which child dragger is active rn
  • virtual void setDefaultOnNonWritingFields (void) — sets defaults on the non-writing fields
  • void updateDraggerCache (const SoPath *path) — refreshes the dragger cache for a path

🌸 Protected Member Functions inherited from SoInteractionKit 🌸

  • virtual ~SoInteractionKit () — destructor 💀
  • virtual SbBool setPart (const int partNum, SoNode *node) — assigns a node to a part number
  • virtual SbBool readInstance (SoInput *in, unsigned short flags) — reads an instance
  • virtual SbBool setAnyPartAsDefault (const SbName &partname, SoNode *node, SbBool anypart=TRUE, SbBool onlyifdefault=TRUE) — sets a part as default by node, anypart=TRUE, onlyifdefault=TRUE
  • virtual SbBool setAnyPartAsDefault (const SbName &partname, const SbName &nodename, SbBool anypart=TRUE, SbBool onlyifdefault=TRUE) — same but you name the node instead
  • SbBool setAnySurrogatePath (const SbName &name, SoPath *path, SbBool leafcheck=FALSE, SbBool publiccheck=FALSE) — sets a surrogate path, leafcheck=FALSE, publiccheck=FALSE
  • void connectSeparatorFields (SoSeparator *dest, SbBool onOff) — connects the separator fields, on or off

⭐ Protected Member Functions inherited from SoBaseKit ⭐

  • virtual ~SoBaseKit () — destructor 💀
  • virtual SoNode * addToCopyDict (void) const — adds itself into the copy dictionary
  • SoGroup * getContainerNode (const SbName &listname, SbBool makeifneeded=TRUE) — grabs the container node for a list, makeifneeded=TRUE
  • virtual SoNode * getAnyPart (const SbName &partname, SbBool makeifneeded, SbBool leafcheck=FALSE, SbBool publiccheck=FALSE) — gets any part by name, with makeifneeded, leafcheck=FALSE, publiccheck=FALSE
  • virtual SoNodeKitPath * createPathToAnyPart (const SbName &partname, SbBool makeifneeded, SbBool leafcheck=FALSE, SbBool publiccheck=FALSE, const SoPath *pathtoextend=NULL) — builds a path to any part, pathtoextend defaults to NULL
  • virtual SbBool setAnyPart (const SbName &partname, SoNode *from, SbBool anypart=TRUE) — sets any part from a node, anypart=TRUE
  • void createNodekitPartsList (void) — builds the nodekit parts list
  • void createFieldList (void) — builds the field list
  • virtual void createDefaultParts (void) — makes the default parts
  • const SoNodekitParts * getNodekitPartsList (void) const — hands over the nodekit parts list
  • const SbList< SoSFNode * > & getCatalogInstances (void) const — the catalog instances, as a SbList< SoSFNode * > reference
  • void catalogError (void) — throws a catalog error 😭
  • void countMyFields (SoOutput *out) — counts the fields, for out

🧚 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) — destroys the thing
  • SbBool hasMultipleWriteRefs (void) const — does it have multiple write refs?
  • SbBool writeHeader (SoOutput *out, SbBool isgroup, SbBool isengine) const — writes the header, telling it if it's a group and if it's an engine
  • void writeFooter (SoOutput *out) const — writes the footer
  • virtual const char * getFileFormatName (void) const — the file format name, as a const char *

🔥 Static Protected Member Functions 🔥

  • static const SoFieldData ** getFieldDataPtr (void) — a pointer to the field data pointer, iykyk
  • static const SoNodekitCatalog ** getClassNodekitCatalogPtr (void) — pointer to the nodekit catalog pointer
  • static void startCB (void *f, SoDragger *d) — the start callback
  • static void motionCB (void *f, SoDragger *d) — the motion callback
  • static void doneCB (void *f, SoDragger *d) — the done 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)
  • static const SoNodekitCatalog ** getClassNodekitCatalogPtr (void)
  • static void childTransferMotionAndValueChangedCB (void *, SoDragger *) — the child's motion-transfer-and-value-changed callback, a whole mouthful fr
  • 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) — reads default parts from fileName and a default buffer of size 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) — sets the next action method index
  • static int getNextActionMethodIndex (void) — gets it
  • static void incNextActionMethodIndex (void) — increments it
  • static void setCompatibilityTypes (const SoType &nodetype, const uint32_t bitmask) — sets the compatibility types from a node type and a bitmask

💫 Static Protected Member Functions inherited from SoBase 💫

  • static uint32_t getCurrentWriteCounter (void) — the current write counter, as a uint32_t
  • static void staticDataLock (void) — locks the static data
  • static void staticDataUnlock (void) — unlocks it, we're done bestie

💎 Protected Attributes 💎

  • SoSFNode feedback
  • SoSFNode feedbackActive
  • SoSFNode feedbackSwitch
  • SoSFNode rotator
  • SoSFNode rotatorActive
  • SoSFNode rotatorSwitch
  • SoFieldSensor * fieldSensor
  • SbMatrix prevMotionMatrix
  • SbVec3f prevWorldHitPt
  • SbSphereProjector * sphereProj
  • SbBool userProj

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

  • uint32_t uniqueId

💜 Protected Attributes inherited from SoFieldContainer 💜

  • SbBool isBuiltIn

✨ Additional Inherited Members ✨

👑 Public Types inherited from SoDragger 👑

  • enum ProjectorFrontSetting { FRONT, BACK, USE_PICK } — your three projector-front options, no notes

🎀 Public Types inherited from SoInteractionKit 🎀

  • enum CacheEnabled { OFF, ON, AUTO } — caching: off, on, or let it decide (AUTO, the main character)

🌈 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 } — the whole node-type bitflag lineup, every single value, we are not skipping a one

🦋 Protected Types inherited from SoBase 🦋

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

⭐ Static Protected Attributes inherited from SoNode ⭐

  • static uint32_t nextUniqueId = 1 — starts at 1, and it counts up from there
  • static int nextActionMethodIndex = 0 — starts at 0

🌸 Detailed Description 🌸

The SoRotateSphericalDragger class is for rotating geometry in any direction. That's it. That's the whole job. Any direction. Free rotation. Iconic behavior honestly. 🔥

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

(picture it: the lil dragger sphere, just sitting there, vibing, not being dragged — the default-geometry inactive look 💅)

Use an instance of this dragger class in your scenegraph to let the end-users of your application rotate geometry freely in any direction. Yes bestie, any. Give the people freedom of rotation.

For the initial dragger orientation and the dragger geometry positioning itself, use some kind of transformation node in your scenegraph, as usual. That's the standard move, nothing new, you already know this one 🫶

✨ Constructor & Destructor Documentation ✨

🎀 SoRotateSphericalDragger::SoRotateSphericalDragger (void ) 🎀

okay so default constructor? It sets up the dragger nodekit catalog with the interaction and feedback geometry. literally setting the whole vibe, no cap.

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

       CLASS SoRotateSphericalDragger
       -->"this"
             "callbackList"
             "topSeparator"
                "motionMatrix"
                "geomSeparator"
       -->         "rotatorSwitch"
       -->            "rotator"
       -->            "rotatorActive"
       -->         "feedbackSwitch"
       -->            "feedback"
       -->            "feedbackActive"

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

Detailed information on catalog parts:

       CLASS SoRotateSphericalDragger
       PVT   "this",  SoRotateSphericalDragger  ---
             "callbackList",  SoNodeKitListPart [ SoCallback, SoEventCallback ]
       PVT   "topSeparator",  SoSeparator  ---
       PVT   "motionMatrix",  SoMatrixTransform  ---
       PVT   "geomSeparator",  SoSeparator  ---
       PVT   "rotatorSwitch",  SoSwitch  ---
             "rotator",  SoSeparator  ---
             "rotatorActive",  SoSeparator  ---
       PVT   "feedbackSwitch",  SoSwitch  ---
             "feedback",  SoSeparator  ---
             "feedbackActive",  SoSeparator  ---

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

💅 SoRotateSphericalDragger::~SoRotateSphericalDragger (void ) [protected], [virtual] 💅

Protected destructor, bestie. (Dragger classes are derived from SoBase, so they are reference counted and automatically destroyed when their reference count goes to 0.) so if you were worried about leaks, the refcount said not today. 🫶

✨ Member Function Documentation ✨

🌈 SoType SoRotateSphericalDragger::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. iykyk.

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 * SoRotateSphericalDragger::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. so either you get the pointer or you get absolutely nothing, and that's on periodt.

Reimplemented from SoDragger.

🌸 const SoNodekitCatalog * SoRotateSphericalDragger::getNodekitCatalog (void ) const [virtual] 🌸

Returns the nodekit catalog which defines the layout of this class' kit. it's literally the map of the whole kit, bestie.

Reimplemented from SoDragger.

💖 void SoRotateSphericalDragger::setProjector (SbSphereProjector * p) 💖

Replace the default sphere projection strategy. You may want to do this if you change the dragger geometry, for instance.

The default projection is an SbSpherePlaneProjector.

See also SbSphereSectionProjector, SbSphereSheetProjector

🎀 const SbSphereProjector * SoRotateSphericalDragger::getProjector (void ) const 🎀

Returns projector instance used for converting from user interaction dragger movements to 3D dragger re-orientation. yes, it's giving translator energy.

See also setProjector()

✨ SbBool SoRotateSphericalDragger::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 SoRotateSphericalDragger::copyContents (const SoFieldContainer * from, SbBool copyconnections) [protected], [virtual] 🔥

Makes a deep copy of all data of from into this instance, except external scenegraph references if copyconnections is FALSE.

This is the protected method that should be overridden by extension node / engine / dragger / whatever subclasses which needs to account for internal data that are not handled automatically.

For copying nodes from application code, you should not invoke this function directly, but rather call the SoNode::copy() function:

       SoNode * mynewnode = templatenode->copy();

The same also goes for engines.

Make sure that when you override the copyContents() method in your extension class that you also make it call upwards to it's parent superclass in the inheritance hierarchy, as copyContents() in for instance SoNode and SoFieldContainer does important work. It should go something like this:

       void
       MyCoinExtensionNode::copyContents(const SoFieldContainer * from,
                                         SbBool copyconnections)
       {
         // let parent superclasses do their thing (copy fields, copy
         // instance name, etc etc)
         SoNode::copyContents(from, copyconnections);

         // [..then copy internal data..]
       }

Reimplemented from SoInteractionKit.

🌟 void SoRotateSphericalDragger::startCB (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. so if that's not you, keep scrolling bestie.

🌈 void SoRotateSphericalDragger::motionCB (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. same energy, different callback.

💜 void SoRotateSphericalDragger::doneCB (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. internal business, fr fr.

🌸 void SoRotateSphericalDragger::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. sensor callback said no visitors allowed.

🦋 void SoRotateSphericalDragger::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. value changed, but not for you unless you're extending the library.

💅 void SoRotateSphericalDragger::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. so this is the moment the user said "oh, that one" and grabbed it.

🎀 void SoRotateSphericalDragger::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. the main character moment of mouse movement.

✨ void SoRotateSphericalDragger::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. and that's a wrap, bestie.

✨ Member Data Documentation ✨

💖 SoSFRotation SoRotateSphericalDragger::rotation 💖

This field is continuously updated to contain the rotation of the current direction vector of the dragger. it's literally always updating, no cap.

The application programmer using this dragger in his scenegraph should connect the relevant node fields in the scene to this field to make them follow the dragger orientation. so connect those nodes, bestie, if you want the scene to follow the vibe.

🎀 SoFieldSensor* SoRotateSphericalDragger::fieldSensor [protected] 🎀

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

🌈 SbMatrix SoRotateSphericalDragger::prevMotionMatrix [protected] 🌈

This API member is considered internal to the library, as it is not likely to be of interest to the application programmer. previous motion matrix stays in its own lane.

🦋 SbVec3f SoRotateSphericalDragger::prevWorldHitPt [protected] 🦋

This API member is considered internal to the library, as it is not likely to be of interest to the application programmer. previous world hit point, internal only, iykyk.

🌸 SbSphereProjector* SoRotateSphericalDragger::sphereProj [protected] 🌸

This API member is considered internal to the library, as it is not likely to be of interest to the application programmer. the sphere projector is minding its own business.

💜 SbBool SoRotateSphericalDragger::userProj [protected] 💜

This API member is considered internal to the library, as it is not likely to be of interest to the application programmer. user projection flag? protected. periodt.

🌟 Author 🌟

Generated automatically by Doxygen for Coin from the source code.

okay that's the whole page, bestie! 🫶 this was auto-generated by Doxygen for Coin from the source code, and it's giving Coin Version 3.1.3, page SoRotateSphericalDragger(3). no cap, that's the sign-off. 💅✨

📦 where this page comes from