SoRotateDiscDragger(3)

📦 version 3.1.3, in fedora 43, fedora 44

💖 SoRotateDiscDragger 💖

okay bestie, welcome to the Library Functions Manual — today's main character is SoRotateDiscDragger, and she is here to serve. 🎀

✨ NAME ✨

SoRotateDiscDragger — the class that rotates geometry around a single axis. That's her whole thing. One axis. Iconic, focused, no cap. 🌀

🌸 SYNOPSIS 🌸

#include <Inventor/draggers/SoRotateDiscDragger.h>

Inherits SoDragger. 👑

🫶 Public Member Functions

  • virtual SoType getTypeId (void) const
  • virtual const SoNodekitCatalog * getNodekitCatalog (void) const
  • SoRotateDiscDragger (void)

💜 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

okay so these are all the static goodies that come free with SoFieldContainer, bestie, you don't write them, you just inherit them 💅

  • static void initClass (void) — sets up the class, the whole rigmarole
  • static SoType getClassTypeId (void) — hands you back the type id for this class
  • static void cleanupClass (void) — tears it all down again when you're done
  • static void initCopyDict (void) — preps the copy dictionary before a copy run
  • static void addCopy (const SoFieldContainer *orig, const SoFieldContainer *copy) — registers a orig → copy pair in the copy dict
  • static SoFieldContainer * checkCopy (const SoFieldContainer *orig) — peeks at the copy dict for orig
  • static SoFieldContainer * findCopy (const SoFieldContainer *orig, const SbBool copyconnections) — finds the copy of orig, with a say in whether connections get copied
  • static void copyDone (void) — wraps up the copy process, we're done here ✨

Static Public Member Functions inherited from SoBase

  • static void initClass (void) — class init, same energy
  • static SoType getClassTypeId (void) — the type id please
  • 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 away again 🙈
  • 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) — grabs the base called name that matches type
  • static int getNamedBases (const SbName &name, SoBaseList &baselist, SoType type) — same but plural, fills up baselist
  • static SbBool read (SoInput *input, SoBase *&base, SoType expectedtype) — reads a base out of input expecting expectedtype
  • static void setInstancePrefix (const SbString &c) — sets the instance prefix string
  • static void setTraceRefs (SbBool trace) — turns ref tracing on or off
  • static SbBool getTraceRefs (void) — is ref tracing on tho?
  • static SbBool connectRoute (SoInput *input, const SbName &fromnodename, const SbName &fromfieldname, const SbName &tonodename, const SbName &tofieldname) — wires up a route from one node+field to another
  • static SbBool readRoute (SoInput *input) — reads a route in from input

Public Attributes

  • SoSFRotation rotation — the rotation field, the whole point of this icon 💫

Public Attributes inherited from SoDragger

  • SoSFBool isActive — is the dragger active rn or nah

Public Attributes inherited from SoInteractionKit

  • SoSFEnum renderCaching — render caching mode, go figure
  • SoSFEnum boundingBoxCaching — bounding box caching mode
  • SoSFEnum renderCulling — render culling mode
  • SoSFEnum pickCulling — pick culling mode

Protected Member Functions

  • virtual const SoFieldData * getFieldData (void) const — returns the field data blob
  • virtual ~SoRotateDiscDragger (void) — the destructor, it's virtual, she's leaving 🫶
  • virtual SbBool setUpConnections (SbBool onoff, SbBool doitalways=FALSE) — sets up (or tears down) the internal connections, doitalways defaults to FALSE
  • void dragStart (void) — called when a drag kicks off
  • void drag (void) — called while the drag is happening
  • void dragFinish (void) — called when the drag wraps up

Protected Member Functions inherited from SoDragger

  • SoDragger (void) — the constructor
  • virtual ~SoDragger (void) — the destructor
  • SbVec2f getNormalizedLocaterPosition (void) — the locater position, normalized
  • SbVec2s getLocaterPosition (void) — the locater position, raw
  • SbVec2s getStartLocaterPosition (void) const — where the locater was when the drag started
  • void setStartLocaterPosition (SbVec2s p) — sets that start position to p
  • SbBool isAdequateConstraintMotion (void) — is this motion good enough for the constraint
  • virtual SbBool shouldGrabBasedOnSurrogate (const SoPath *pickpath, const SoPath *surrogatepath) — should we grab, given the pick path and the surrogate path
  • void setCameraInfo (SoAction *action) — stashes the camera info off the action
  • virtual void handleEvent (SoHandleEventAction *ha) — handles an event, big job energy
  • void transferMotion (SoDragger *child) — passes motion along to a child dragger
  • void setIgnoreInBbox (SbBool newval) — set whether to ignore this in the bounding box, to newval
  • SbBool isIgnoreInBbox (void) — are we ignoring this in the bbox?
  • virtual void getBoundingBox (SoGetBoundingBoxAction *action) — computes the bounding box into action
  • void setActiveChildDragger (SoDragger *newchilddragger) — sets the active child dragger
  • SoDragger * getActiveChildDragger (void) const — gets the active child dragger
  • virtual void setDefaultOnNonWritingFields (void) — sets defaults on the fields that don't get written out
  • void updateDraggerCache (const SoPath *path) — refreshes the dragger cache for path

Protected Member Functions inherited from SoInteractionKit

  • virtual ~SoInteractionKit () — destructor, no void, she's just vibing
  • virtual void copyContents (const SoFieldContainer *fromFC, SbBool copyConnections) — copies contents over from fromFC, with a say on copyConnections
  • 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 flags
  • virtual SbBool setAnyPartAsDefault (const SbName &partname, SoNode *node, SbBool anypart=TRUE, SbBool onlyifdefault=TRUE) — sets the part called partname to node as a default; anypart defaults to TRUE, onlyifdefault defaults to TRUE
  • virtual SbBool setAnyPartAsDefault (const SbName &partname, const SbName &nodename, SbBool anypart=TRUE, SbBool onlyifdefault=TRUE) — same deal but by node name instead of node pointer
  • SbBool setAnySurrogatePath (const SbName &name, SoPath *path, SbBool leafcheck=FALSE, SbBool publiccheck=FALSE) — sets a surrogate path for name; leafcheck and publiccheck both default to FALSE
  • void connectSeparatorFields (SoSeparator *dest, SbBool onOff) — connects the separator fields to dest, onOff decides which way

Protected Member Functions inherited from SoBaseKit

  • virtual ~SoBaseKit () — destructor again
  • virtual SoNode * addToCopyDict (void) const — adds this to the copy dict
  • SoGroup * getContainerNode (const SbName &listname, SbBool makeifneeded=TRUE) — gets the container node for listname, and makeifneeded defaults to TRUE
  • virtual SoNode * getAnyPart (const SbName &partname, SbBool makeifneeded, SbBool leafcheck=FALSE, SbBool publiccheck=FALSE) — gets the part called partname; leafcheck and publiccheck default to FALSE
  • virtual SoNodeKitPath * createPathToAnyPart (const SbName &partname, SbBool makeifneeded, SbBool leafcheck=FALSE, SbBool publiccheck=FALSE, const SoPath *pathtoextend=NULL) — builds a path to partname; leafcheck and publiccheck default to FALSE, pathtoextend defaults to NULL
  • virtual SbBool setAnyPart (const SbName &partname, SoNode *from, SbBool anypart=TRUE) — sets the part partname from from, anypart defaults to TRUE
  • 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) — throws a catalog error
  • 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
  • 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 a header out, with isgroup and isengine flags
  • void writeFooter (SoOutput *out) const — writes the footer out
  • virtual const char * getFileFormatName (void) const — the file format name, as a string

Static Protected Member Functions

  • static const SoFieldData ** getFieldDataPtr (void) — pointer to the field data pointer
  • static const SoNodekitCatalog ** getClassNodekitCatalogPtr (void) — pointer to the class 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) — fires when the value changes

Static Protected Member Functions inherited from SoDragger

  • static const SoFieldData ** getFieldDataPtr (void) — field data pointer, again
  • static const SoNodekitCatalog ** getClassNodekitCatalogPtr (void) — nodekit catalog pointer, again
  • static void childTransferMotionAndValueChangedCB (void *, SoDragger *) — child's motion-transfer + value-changed callback
  • static void childValueChangedCB (void *, SoDragger *) — child's value-changed callback
  • static void childStartCB (void *, SoDragger *) — child's start callback
  • static void childMotionCB (void *, SoDragger *) — child's motion callback
  • static void childFinishCB (void *, SoDragger *) — child's finish callback
  • static void childOtherEventCB (void *, SoDragger *) — child's other-event callback

Static Protected Member Functions inherited from SoInteractionKit

  • static const SoFieldData ** getFieldDataPtr (void) — you know the drill
  • static const SoNodekitCatalog ** getClassNodekitCatalogPtr (void) — same
  • static void readDefaultParts (const char *fileName, const char defaultBuffer[], int defBufSize) — reads the default parts out of fileName using defaultBuffer of size defBufSize
  • static void fieldSensorCB (void *, SoSensor *) — field sensor callback

Static Protected Member Functions inherited from SoBaseKit

  • static const SoFieldData ** getFieldDataPtr (void) — yes
  • static const SoNodekitCatalog ** getClassNodekitCatalogPtr (void) — yes ma'am

Static Protected Member Functions inherited from SoNode

  • static const SoFieldData ** getFieldDataPtr (void) — pointer, once more
  • static void setNextActionMethodIndex (int index) — sets the next action method index to index
  • static int getNextActionMethodIndex (void) — gets the next action method index
  • static void incNextActionMethodIndex (void) — increments the next action method index
  • static void setCompatibilityTypes (const SoType &nodetype, const uint32_t bitmask) — sets compatibility types for nodetype with bitmask

Static Protected Member Functions inherited from SoBase

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

Protected Attributes

  • SoSFNode feedback — the feedback node
  • SoSFNode feedbackActive — the active feedback node
  • SoSFNode feedbackSwitch — the switch for the feedback
  • SoSFNode rotator — the rotator node
  • SoSFNode rotatorActive — the active rotator node
  • SoSFNode rotatorSwitch — the switch for the rotator
  • SoFieldSensor * fieldSensor — the field sensor pointer
  • SbPlaneProjector * planeProj — the plane projector pointer

Protected Attributes inherited from SoDragger

  • SoSFNode motionMatrix — the motion matrix field

Protected Attributes inherited from SoInteractionKit

  • SoSFNode geomSeparator — the geometry separator
  • SoSFNode topSeparator — the top separator
  • SoFieldSensor * fieldSensor — field sensor pointer
  • SoSeparator * oldTopSep — the old top separator

Protected Attributes inherited from SoBaseKit

  • SoSFNode callbackList — the callback list field
  • SoChildList * children — the children list pointer
  • SbBool connectionsSetUp — are the connections set up or nah

Protected Attributes inherited from SoNode

  • uint32_t uniqueId — the unique id, every node's lil fingerprint

Protected Attributes inherited from SoFieldContainer

  • SbBool isBuiltIn — is this a built-in field container

Additional Inherited Members

Public Types inherited from SoDragger

  • enum ProjectorFrontSetting { FRONT, BACK, USE_PICK } — the projector front setting enum, three moods: FRONT, BACK, and USE_PICK

Public Types inherited from SoInteractionKit

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

Public Types inherited from SoNode

  • enum NodeType { INVENTOR = 0x0000, VRML1 = 0x0001, VRML2 = 0x0002, INVENTOR_1 = 0x0004, INVENTOR_2_0 = 0x0008, INVENTOR_2_1 = 0x0010, INVENTOR_2_5 = 0x0020, INVENTOR_2_6 = 0x0040, COIN_1_0 = 0x0080, COIN_2_0 = 0x0100, EXTENSION = 0x0200, COIN_2_2 = 0x0400, COIN_2_3 = 0x0800, COIN_2_4 = 0x1000, INVENTOR_5_0 = 0x2000, COIN_2_5 = 0x4000, COIN_3_0 = 0x8000, INVENTOR_6_0 = 0x10000 } — the full node type enum with every single value, don't @ me 💀

Protected Types inherited from SoBase

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

Static Protected Attributes inherited from SoNode

  • static uint32_t nextUniqueId = 1 — starts at 1
  • static int nextActionMethodIndex = 0 — starts at 0

Detailed Description

okay bestie, here's the tea ☕ The SoRotateDiscDragger class is for rotating geometry around a single axis.

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

Use an instance of this dragger class in your scenegraph to let the end-users of your application rotate geometry around a pre-defined axis vector in 3D.

The special feature of this dragger that sets it apart from the other draggers that provides rotation around an axis (like the SoRotateCylindricalDragger) is that it provides a convenient interface to rotate around an axis that is pointing in approximately the same direction as the camera. This is useful for interacting with for instance something like a "volume" knob. 🔥

For the dragger orientation and positioning itself, use some kind of transformation node in your scenegraph, as usual. 🎀

✨ Constructor & Destructor Documentation ✨

💖 SoRotateDiscDragger::SoRotateDiscDragger (void )

Okay bestie, this is the default constructor — it sets up the dragger nodekit catalog with the interaction and feedback geometry. Slay.

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

       CLASS SoRotateDiscDragger
       -->"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 SoRotateDiscDragger
       PVT   "this",  SoRotateDiscDragger  ---
             "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.)

💀 SoRotateDiscDragger::~SoRotateDiscDragger (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.) 💅

✨ Member Function Documentation ✨

🌟 SoType SoRotateDiscDragger::getTypeId (void ) const [virtual]

Returns the type identification of an object derived from a class inheriting SoBase. This is used for run-time type checking and "downward" casting.

Usage example:

       void foo(SoNode * node)
       {
         if (node->getTypeId() == SoFile::getClassTypeId()) {
           SoFile * filenode = (SoFile *)node;  // safe downward cast, knows the type
         }
       }

For application programmers wanting to extend the library with new nodes, engines, nodekits, draggers or others: this method needs to be overridden in all subclasses. This is typically done as part of setting up the full type system for extension classes, which is usually accomplished by using the pre-defined macros available through for instance Inventor/nodes/SoSubNode.h (SO_NODE_INIT_CLASS and SO_NODE_CONSTRUCTOR for node classes), Inventor/engines/SoSubEngine.h (for engine classes) and so on.

For more information on writing Coin extensions, see the class documentation of the toplevel superclasses for the various class groups.

Reimplemented from SoDragger.

🌸 const SoFieldData * SoRotateDiscDragger::getFieldData (void ) const [protected], [virtual]

Returns a pointer to the class-wide field data storage object for this instance. If no fields are present, returns NULL.

Reimplemented from SoDragger.

🦋 const SoNodekitCatalog * SoRotateDiscDragger::getNodekitCatalog (void ) const [virtual]

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

Reimplemented from SoDragger.

🎀 SbBool SoRotateDiscDragger::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 SoRotateDiscDragger::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.

✨ void SoRotateDiscDragger::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.

✨ void SoRotateDiscDragger::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.

✨ void SoRotateDiscDragger::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 SoRotateDiscDragger::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.

💅 void SoRotateDiscDragger::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.

💅 void SoRotateDiscDragger::drag (void ) [protected]

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

Called when user drags the mouse after picking the dragger.

💅 void SoRotateDiscDragger::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.

✨ Member Data Documentation ✨

👑 SoSFRotation SoRotateDiscDragger::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.

🔒 SoFieldSensor* SoRotateDiscDragger::fieldSensor [protected]

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

🔒 SbPlaneProjector* SoRotateDiscDragger::planeProj [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.

Stay iconic, bestie! This page is from Coin, Version 3.1.3, and it's the SoRotateDiscDragger(3) manual. 💖✨

📦 where this page comes from