SOROTATESPHERICALDRAGGER(3coin2)

📦 version 2.5.0, in fedora 43, fedora 44

💖 SoRotateSphericalDragger(3) — Library Functions Manual 💖

🌸 NAME 🌸

SoRotateSphericalDragger — the SoRotateSphericalDragger class is for rotating geometry in any direction. No cap, literally any direction. Main character energy only. 💅✨

✨ SYNOPSIS ✨

#include <Inventor/draggers/SoRotateSphericalDragger.h>

Inherits SoDragger.

💅 Public Member Functions 💅

okay so these are the ones you actually get on this class:

  • virtual SoType getTypeId (void) const
  • virtual const SoNodekitCatalog * getNodekitCatalog (void) const
  • SoRotateSphericalDragger (void)
  • void setProjector (SbSphereProjector *p)
  • const SbSphereProjector * getProjector (void) const

🫶 Public Member Functions inherited from SoDragger 🫶

inherited, but still yours to call, periodt:

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

these came from the interaction kit, but they're still part of the whole vibe:

  • SoInteractionKit (void)
  • virtual SbBool setPartAsPath (const SbName &partname, SoPath *path)
  • virtual SbBool setPartAsDefault (const SbName &partname, SoNode *node, SbBool onlyifdefault=1)
  • virtual SbBool setPartAsDefault (const SbName &partname, const SbName &nodename, SbBool onlyifdefault=1)
  • SbBool isPathSurrogateInMySubgraph (const SoPath *path, SoPath *&pathToOwner, SbName &surrogatename, SoPath *&surrogatepath, SbBool fillargs=1)
  • SbBool isPathSurrogateInMySubgraph (const SoPath *path)
  • virtual SbBool setPart (const SbName &partname, SoNode *from)

🎀 Public Member Functions inherited from SoBaseKit 🎀

base kit stuff, still iconic, still yours:

  • 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=0)
  • SbBool forceChildDrivenWriteRefs (SoOutput *out)

🌈 Public Member Functions inherited from SoNode 🌈

node behavior, inherited but never forgotten:

  • void setOverride (const SbBool state)
  • SbBool isOverride (void) const
  • void setNodeType (const NodeType type)
  • NodeType getNodeType (void) const
  • virtual SoNode * copy (SbBool copyconnections=0) 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 💜

field container bestie, all inherited, all here:

  • void setToDefaults (void)
  • SbBool hasDefaultValues (void) const
  • SbBool fieldsAreEqual (const SoFieldContainer *container) const
  • void copyFieldValues (const SoFieldContainer *container, SbBool copyconnections=0)
  • 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 *in)
  • void get (SbString &fielddata, SoOutput *out)
  • virtual SbBool validateNewFieldValue (SoField *field, void *newval)
  • SbBool getIsBuiltIn (void) const
  • void setUserData (void *userdata) const
  • void * getUserData (void) const

🍓 Public Member Functions inherited from SoBase 🍓

the base of all bases, still giving:

  • 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 queen behavior:

  • static SoType getClassTypeId (void)
  • static const SoNodekitCatalog * getClassNodekitCatalog (void)
  • static void initClass (void)

✨ Static Public Member Functions inherited from SoDragger ✨

inherited static magic, no cap:

  • 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 SoNode * typeCheck (const SbName &partname, const SoType &parttype, SoNode *node)

👑 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 you're borrowing from SoFieldContainer, no cap:

  • static void initClass(void) — sets the class up, does the whole registry thing 🎀
  • static SoType getClassTypeId(void) — hands you back the class's SoType ✨
  • static void initCopyDict(void) — kicks off the copy dictionary, like opening a fresh notes app 📝
  • static void addCopy(const SoFieldContainer *orig, const SoFieldContainer *copy) — registers a copy under its original 🫶
  • static SoFieldContainer * checkCopy(const SoFieldContainer *orig) — peeks to see if that original already has a copy 💅
  • static SoFieldContainer * findCopy(const SoFieldContainer *orig, const SbBool copyconnections) — finds the copy, and whether connections come along is literally up to copyconnections 🦋
  • static void copyDone(void) — done copying, we can all go home 🌙

🌸 Static Public Member Functions inherited from SoBase 🌸

more borrowed statics, and yes they all live here too:

  • static void initClass(void) — class init, the usual ritual ⭐
  • static SoType getClassTypeId(void) — returns the SoType 👑
  • static void addName(SoBase *const base, const char *const name) — gives base the name name 💜
  • static void removeName(SoBase *const base, const char *const name) — takes that name right back off 🙈
  • static void incrementCurrentWriteCounter(void) — bumps the current write counter up ⬆️
  • static void decrementCurrentWriteCounter(void) — and bumps it back down ⬇️
  • static SoBase * getNamedBase(const SbName &name, SoType type) — hunts down the base with that name and that type 🔍
  • static int getNamedBases(const SbName &name, SoBaseList &baselist, SoType type) — same vibe but it grabs a whole list of them into baselist 🧺
  • static SbBool read(SoInput *in, SoBase *&base, SoType expectedtype) — reads a base in from in, and yeah it wants that expectedtype 📖
  • static void setInstancePrefix(const SbString &c) — sets the instance prefix to c ✏️
  • static void setTraceRefs(SbBool trace) — flips reference tracing on or off 🕵️
  • static SbBool getTraceRefs(void) — tells you if it's on 🫧
  • static SbBool connectRoute(SoInput *in, const SbName &fromnodename, const SbName &fromfieldname, const SbName &tonodename, const SbName &tofieldname) — wires a route from fromnodename.fromfieldname over to tonodename.tofieldname 🔌
  • static SbBool readRoute(SoInput *in) — reads a route in from in 🛣️

💫 Public Attributes 💫

  • SoSFRotation rotation — the rotation field. this is literally the whole point of the dragger, bestie 🔥

🎀 Public Attributes inherited from SoDragger 🎀

  • SoSFBool isActive — whether the dragger is currently active or just vibing 🌈

✨ Public Attributes inherited from SoInteractionKit ✨

  • SoSFEnum renderCaching — the render caching setting 🎨
  • SoSFEnum boundingBoxCaching — the bounding box caching setting 📦
  • SoSFEnum renderCulling — the render culling setting ✂️
  • SoSFEnum pickCulling — the pick culling setting 🎯

🦋 Protected Member Functions 🦋

the internal ones, lowkey the mechanics of the whole thing:

  • virtual const SoFieldData * getFieldData(void) const — returns the field data 📋
  • ~SoRotateSphericalDragger() — destructor, say bye 👋
  • virtual SbBool setUpConnections(SbBool onoff, SbBool doitalways=0) — sets up (or tears down) the connections, onoff style. and doitalways defaults to 0 🔗
  • virtual void copyContents(const SoFieldContainer *fromfc, SbBool copyconnections) — copies the contents over from fromfc, with copyconnections deciding about connections 📋
  • void dragStart(void) — fires when the drag starts 🚀
  • void drag(void) — fires while you're dragging, the main character moment 🕺
  • void dragFinish(void) — fires when the drag is over, periodt 🏁

💅 Protected Member Functions inherited from SoDragger 💅

  • SoDragger(void) — constructor 🐣
  • virtual ~SoDragger() — destructor 🫧
  • SbVec2f getNormalizedLocaterPosition(void) — the locater position, but normalized 🧭
  • SbVec2s getLocaterPosition(void) — the raw locater position 📍
  • SbVec2s getStartLocaterPosition(void) const — where the locater was when it all started 🕰️
  • void setStartLocaterPosition(SbVec2s p) — sets that start position to p ✏️
  • SbBool isAdequateConstraintMotion(void) — is the constraint motion adequate? enquiring minds 🤔
  • virtual SbBool shouldGrabBasedOnSurrogate(const SoPath *pickpath, const SoPath *surrogatepath) — should it grab based on the surrogate? pickpath and surrogatepath say 🎭
  • void setCameraInfo(SoAction *action) — sets camera info from action 📷
  • virtual void handleEvent(SoHandleEventAction *ha) — handles the event via ha ⚡
  • void transferMotion(SoDragger *child) — passes the motion along to child 🤝
  • void setIgnoreInBbox(SbBool newval) — sets the ignore-in-bbox flag to newval 🚫
  • SbBool isIgnoreInBbox(void) — is it ignored in the bbox? 🤨
  • virtual void getBoundingBox(SoGetBoundingBoxAction *action) — grabs the bounding box via action 📐
  • void setActiveChildDragger(SoDragger *newchilddragger) — makes newchilddragger the active child dragger 👶
  • SoDragger * getActiveChildDragger(void) const — returns the active child dragger 🫴
  • virtual void setDefaultOnNonWritingFields(void) — sets defaults on the non-writing fields 🪄
  • void updateDraggerCache(const SoPath *path) — refreshes the dragger cache for path 🔄

🌷 Protected Member Functions inherited from SoInteractionKit 🌷

  • virtual ~SoInteractionKit() — destructor 🌙
  • virtual SbBool setPart(const int partNum, SoNode *node) — sets part number partNum to node 🧩
  • virtual SbBool readInstance(SoInput *in, unsigned short flags) — reads an instance from in with those flags 📥
  • virtual SbBool setAnyPartAsDefault(const SbName &partname, SoNode *node, SbBool anypart=1, SbBool onlyifdefault=1) — sets the part called partname as default from node; anypart defaults to 1, onlyifdefault defaults to 1 🎁
  • virtual SbBool setAnyPartAsDefault(const SbName &partname, const SbName &nodename, SbBool anypart=1, SbBool onlyifdefault=1) — same deal but you're naming the node by nodename instead 🏷️
  • SbBool setAnySurrogatePath(const SbName &name, SoPath *path, SbBool leafcheck=0, SbBool publiccheck=0) — sets the surrogate path for name; leafcheck defaults to 0, publiccheck defaults to 0 🛤️
  • void connectSeparatorFields(SoSeparator *dest, SbBool onOff) — connects the separator fields to dest, toggled by onOff 🔗

🧚 Protected Member Functions inherited from SoBaseKit 🧚

  • virtual ~SoBaseKit() — destructor 💫
  • virtual SoNode * addToCopyDict(void) const — adds itself to the copy dictionary 📚
  • SoGroup * getContainerNode(const SbName &listname, SbBool makeifneeded=1) — gets the container node for listname; makeifneeded defaults to 1 🗃️
  • virtual SoNode * getAnyPart(const SbName &partname, SbBool makeifneeded, SbBool leafcheck=0, SbBool publiccheck=0) — gets the part called partname; leafcheck and publiccheck both default to 0 🔎
  • virtual SoNodeKitPath * createPathToAnyPart(const SbName &partname, SbBool makeifneeded, SbBool leafcheck=0, SbBool publiccheck=0, const SoPath *pathtoextend=NULL) — builds a path to partname; leafcheck=0, publiccheck=0, and pathtoextend defaults to NULL 🛣️
  • virtual SbBool setAnyPart(const SbName &partname, SoNode *from, SbBool anypart=1) — sets the part partname from from; anypart defaults to 1 🧷
  • void createNodekitPartsList(void) — builds the nodekit parts list 📝
  • void createFieldList(void) — builds the field list 📄
  • virtual void createDefaultParts(void) — creates the default parts 🧱
  • const SoNodekitParts * getNodekitPartsList(void) const — returns the nodekit parts list 📋
  • const SbList< SoSFNode * > & getCatalogInstances(void) const — returns the catalog instances 🗂️
  • void catalogError(void) — complains about a catalog problem 🚨
  • void countMyFields(SoOutput *out) — counts the fields into out 🔢

⭐ Protected Member Functions inherited from SoNode ⭐

  • SoNode(void) — constructor 🐣
  • virtual ~SoNode() — destructor 🍃

🎀 Protected Member Functions inherited from SoFieldContainer 🎀

  • SoFieldContainer(void) — constructor 🐣
  • ~SoFieldContainer() — destructor 🍂

💜 Protected Member Functions inherited from SoBase 💜

  • SoBase(void) — constructor 🐣
  • virtual ~SoBase() — destructor 🌙
  • virtual void destroy(void) — destroys it 💥
  • SbBool hasMultipleWriteRefs(void) const — does it have multiple write refs? 👀
  • SbBool writeHeader(SoOutput *out, SbBool isgroup, SbBool isengine) const — writes the header to out, with isgroup and isengine 🏷️
  • void writeFooter(SoOutput *out) const — writes the footer to out 🦶
  • virtual const char * getFileFormatName(void) const — returns the file format name 📁

🔥 Static Protected Member Functions 🔥

  • static const SoFieldData ** getFieldDataPtr(void) — hands back the pointer to the field data 📋
  • static const SoNodekitCatalog ** getClassNodekitCatalogPtr(void) — hands back the pointer to the class nodekit catalog 🗂️
  • static void startCB(void *f, SoDragger *d) — the start callback, with f and d 🚦
  • 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) — field data pointer 📋
  • static const SoNodekitCatalog ** getClassNodekitCatalogPtr(void) — class nodekit catalog pointer 🗂️
  • static void childTransferMotionAndValueChangedCB(void *, SoDragger *) — the child transfer-motion-and-value-changed callback 🤝
  • static void childValueChangedCB(void *, SoDragger *) — the child value-changed callback 💥
  • static void childStartCB(void *, SoDragger *) — the child start callback 🚦
  • static void childMotionCB(void *, SoDragger *) — the child motion callback 🏃
  • static void childFinishCB(void *, SoDragger *) — the child finish callback 🏁
  • static void childOtherEventCB(void *, SoDragger *) — the child other-event callback 🎪

🫶 Static Protected Member Functions inherited from SoInteractionKit 🫶

  • static const SoFieldData ** getFieldDataPtr(void) — field data pointer 📋
  • static const SoNodekitCatalog ** getClassNodekitCatalogPtr(void) — class nodekit catalog pointer 🗂️
  • static void readDefaultParts(const char *fileName, const char defaultBuffer[], int defBufSize) — reads the default parts from fileName, using defaultBuffer[] and defBufSize 📥
  • static void fieldSensorCB(void *, SoSensor *) — the field sensor callback 📡

✨ Static Protected Member Functions inherited from SoBaseKit ✨

  • static const SoFieldData ** getFieldDataPtr(void) — field data pointer 📋
  • static const SoNodekitCatalog ** getClassNodekitCatalogPtr(void) — class nodekit catalog pointer 🗂️

🌸 Static Protected Member Functions inherited from SoNode 🌸

  • static const SoFieldData ** getFieldDataPtr(void) — field data pointer 📋
  • static void setNextActionMethodIndex(int index) — sets the next action method index to index 🔢
  • static int getNextActionMethodIndex(void) — returns that index 🔢
  • static void incNextActionMethodIndex(void) — increments it ⬆️
  • static void setCompatibilityTypes(const SoType &nodetype, const uint32_t bitmask) — sets the compatibility types for nodetype with that bitmask 🧬

🎀 Static Protected Member Functions inherited from SoBase 🎀

  • static uint32_t getCurrentWriteCounter(void) — returns the current write counter 🔢
  • static void staticDataLock(void) — locks the static data 🔒
  • static void staticDataUnlock(void) — unlocks it 🔓

💖 Protected Attributes 💖

  • SoSFNode feedback — the feedback node 📢
  • SoSFNode feedbackActive — the active feedback node ⚡
  • SoSFNode feedbackSwitch — the switch that decides which feedback shows 🔀
  • SoSFNode rotator — the rotator node 🎡
  • SoSFNode rotatorActive — the active rotator node ⚡
  • SoSFNode rotatorSwitch — the switch for the rotator 🔀
  • SoFieldSensor * fieldSensor — pointer to the field sensor 📡
  • SbMatrix prevMotionMatrix — the previous motion matrix 🧮
  • SbVec3f prevWorldHitPt — the previous world hit point 🎯
  • SbSphereProjector * sphereProj — pointer to the sphere projector 🔮
  • SbBool userProj — whether a user projector is in play 🙋

🌟 Protected Attributes inherited from SoDragger 🌟

  • SoSFNode motionMatrix — the motion matrix 🧮

🦋 Protected Attributes inherited from SoInteractionKit 🦋

  • SoSFNode geomSeparator — the geometry separator 📦
  • SoSFNode topSeparator — the top separator 🔝
  • SoFieldSensor * fieldSensor — pointer to the field sensor 📡
  • SoSeparator * oldTopSep — pointer to the old top separator 🕰️

💜 Protected Attributes inherited from SoBaseKit 💜

  • SoSFNode callbackList — the callback list 📝
  • SoChildList * children — pointer to the child list 👶
  • SbBool connectionsSetUp — whether the connections are set up 🔗

🎀 Protected Attributes inherited from SoNode 🎀

  • uint32_t uniqueId — the node's unique id 🆔

✨ Protected Attributes inherited from SoFieldContainer ✨

  • SbBool isBuiltIn — is it built in? 🏠

👑 Additional Inherited Members 👑

🎭 Public Types inherited from SoDragger 🎭

  • enum ProjectorFrontSetting { FRONT, BACK, USE_PICK } — the projector front setting options: FRONT, BACK, USE_PICK 🎪

🎪 Public Types inherited from SoInteractionKit 🎪

  • enum CacheEnabled { OFF, ON, AUTO } — caching options: OFF, ON, AUTO 🔋

🧬 Public Types inherited from SoNode 🧬

  • enum NodeType { INVENTOR = 0x0000, VRML1 = 0x0001, VRML2 = 0x0002, INVENTOR_1 = 0x0004, INVENTOR_2_0 = 0x0008, INVENTOR_2_1 = 0x0010, INVENTOR_2_5 = 0x0020, INVENTOR_2_6 = 0x0040, COIN_1_0 = 0x0080, COIN_2_0 = 0x0100, EXTENSION = 0x0200, COIN_2_2 = 0x0400, COIN_2_3 = 0x0800, COIN_2_4 = 0x1000, INVENTOR_5_0 = 0x2000, COIN_2_5 = 0x4000 } — all the node type flags, each with its own hex value, exactly as listed 📇

🌙 Protected Types inherited from SoBase 🌙

  • enum BaseFlags { IS_ENGINE = 0x01, IS_GROUP = 0x02 } — the base flags: IS_ENGINE = 0x01 and IS_GROUP = 0x02 🚩

⭐ Static Protected Attributes inherited from SoNode ⭐

  • static uint32_t nextUniqueId = 0 — the next unique id, starting at 0 🔢
  • static int nextActionMethodIndex = 0 — the next action method index, starting at 0 🔢

🦋 Detailed Description 🦋

okay so the SoRotateSphericalDragger class is for rotating geometry in any direction. like, any. all of them. no limits 💫

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

🖼️ (picture of the dragger sitting there, inactive, looking cute and slightly bored)

Use an instance of this dragger class in your scenegraph to let the end-users of your application rotate geometry freely in any direction. give the people what they want 🔥

For the initial dragger orientation and the dragger geometry positioning itself, use some kind of transformation node in your scenegraph, as usual. you already know this one, bestie 💅

💖 Constructor & Destructor Documentation 💖

🎀 SoRotateSphericalDragger::SoRotateSphericalDragger (void)

Okay bestie, this is the default constructor, and no cap it does a LOT — it sets up the dragger nodekit catalog with all the interaction and feedback geometry. She's built different fr fr.

Node kit structure, and heads up: new entries versus the parent class get marked with an arrow prefix 👑

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

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

The deets on the catalog parts, bestie:

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

References: SoDragger::addFinishCallback(), SoDragger::addMotionCallback(), SoDragger::addStartCallback(), SoDragger::addValueChangedCallback(), doneCB(), fieldSensor, fieldSensorCB(), motionCB(), SoInteractionKit::readDefaultParts(), rotation, SoInteractionKit::setPartAsDefault(), SoInteractionKit::setSwitchValue(), setUpConnections(), SoRotateSphericalDragger(), sphereProj, startCB(), userProj, and valueChangedCB().

Referenced by copyContents(), doneCB(), fieldSensorCB(), getFieldData(), motionCB(), SoRotateSphericalDragger(), startCB(), and valueChangedCB().

🌸 SoRotateSphericalDragger::~SoRotateSphericalDragger () [protected]

Protected destructor, bestie 🫶

(Dragger classes are derived from SoBase, so they are reference counted and automatically destroyed when their reference count goes to 0. She leaves when nobody's holding on anymore, iconic behaviour tbh.)

References: fieldSensor, sphereProj, and userProj.

✨ Member Function Documentation ✨

🦋 SoType SoRotateSphericalDragger::getTypeId (void ) const [virtual]

Returns the type identification of an object derived from a class inheriting SoBase. This is what you use for run-time type checking and "downward" casting. Very much the vibe check of the type system 💅

Usage example:

void foo(SoNode * node)
{
  if (node->getTypeId() == SoFile::getClassTypeId()) {
    SoFile * filenode = (SoFile *)node;  // safe downward cast, knows the type
  }
  else if (node->getTypeId().isOfType(SoGroup::getClassTypeId())) {
    SoGroup * group = (SoGroup *)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. That's it, that's the whole thing ✨

Reimplemented from SoDragger.

References: SoRotateSphericalDragger().

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

Returns the nodekit catalog which defines the layout of this class' kit. The blueprint, the floor plan, the whole layout bestie 📐

Reimplemented from SoDragger.

💅 void SoRotateSphericalDragger::setProjector (SbSphereProjector * p)

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

The default projection is an SbSpherePlaneProjector.

See also: SbSphereSectionProjector, SbSphereSheetProjector

References: sphereProj, and userProj.

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

Returns the projector instance used for converting from user interaction dragger movements to 3D dragger re-orientation. Lowkey the translator between your mouse and 3D space 🌸

See also: setProjector()

References: sphereProj.

👑 SbBool SoRotateSphericalDragger::setUpConnections (SbBool onoff, SbBool doitalways = 0) [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.

References: SoBaseKit::connectionsSetUp, fieldSensor, fieldSensorCB(), rotation, and SoBaseKit::setUpConnections().

Referenced by SoRotateSphericalDragger().

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

References: SbProjector::copy(), SoFieldContainer::copyContents(), SoBase::isOfType(), SoRotateSphericalDragger(), sphereProj, and userProj.

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

References: dragStart(), SoDragger::SoDragger(), and SoRotateSphericalDragger().

Referenced by SoRotateSphericalDragger().

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

References: drag(), SoDragger::SoDragger(), and SoRotateSphericalDragger().

Referenced by SoRotateSphericalDragger().

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

References: dragFinish(), SoDragger::SoDragger(), and SoRotateSphericalDragger().

Referenced by SoRotateSphericalDragger().

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

References: SoDragger::getMotionMatrix(), SbMatrix::getTransform(), rotation, SoDragger::setMotionMatrix(), SbMatrix::setTransform(), and SoRotateSphericalDragger().

Referenced by setUpConnections(), and SoRotateSphericalDragger().

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

References: SoFieldSensor::attach(), SoFieldSensor::detach(), fieldSensor, SoDragger::getMotionMatrix(), SbMatrix::getTransform(), rotation, SoDragger::SoDragger(), and SoRotateSphericalDragger().

Referenced by SoRotateSphericalDragger().

🦋 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. Main character moment ✨

References: SoDragger::BACK, SoDragger::FRONT, SoDragger::getFrontOnProjector(), SoDragger::getLocalStartingPoint(), SoDragger::getLocalToWorldMatrix(), SoDragger::getMotionMatrix(), SoDragger::getNormalizedLocaterPosition(), SoDragger::getViewVolume(), SbVec3f::length(), SbMatrix::multVecMatrix(), prevMotionMatrix, prevWorldHitPt, SoInteractionKit::setSwitchValue(), sphereProj, and SoDragger::USE_PICK.

Referenced by startCB().

🌈 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. That's the whole moment-to-moment vibe right there 🫶

References: SoDragger::appendRotation(), SoDragger::getLocalToWorldMatrix(), SoDragger::getNormalizedLocaterPosition(), SoDragger::getViewVolume(), SoDragger::getWorldToLocalMatrix(), SbMatrix::multVecMatrix(), prevMotionMatrix, prevWorldHitPt, SoDragger::setMotionMatrix(), and sphereProj.

Referenced by motionCB().

🎀 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. The little goodbye moment 💜

References: SoInteractionKit::setSwitchValue().

Referenced by doneCB().

✨ Member Data Documentation ✨

Okay bestie, these are the data members — the little fields that hold the dragger's whole vibe. Let's get into it. 💖

SoSFRotation SoRotateSphericalDragger::rotation

This field is continuously updated to contain the rotation of the current direction vector of the dragger. 💫

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

Referenced by fieldSensorCB(), setUpConnections(), SoRotateSphericalDragger(), and valueChangedCB().

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. (iykyk, it's giving backend bestie. 🫶)

Referenced by setUpConnections(), SoRotateSphericalDragger(), valueChangedCB(), and ~SoRotateSphericalDragger().

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

Referenced by drag(), and dragStart().

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

Referenced by drag(), and dragStart().

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

Referenced by copyContents(), drag(), dragStart(), getProjector(), setProjector(), SoRotateSphericalDragger(), and ~SoRotateSphericalDragger().

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

Referenced by copyContents(), setProjector(), SoRotateSphericalDragger(), and ~SoRotateSphericalDragger().

👑 Author

Generated automatically by Doxygen for Coin from the source code. No cap, the robot did it. ✨

This page is from Coin, version 2.5.0 — and if a date was supposed to be here, it's not in the footer, bestie. Either way, slay. 💖
📦 where this page comes from