SoRotateCylindricalDragger(3)

📦
version 4.0.10 · 4 versions
, in fedora 43, fedora 44

💖 NAME 💖

okay so bestie, welcome to the group chat — this is SoRotateCylindricalDragger, from the Coin manual, section 3, and she is the class for rotating geometry around a single axis. One axis. That's her lane, she stays in it, no cap. 💅

✨ SYNOPSIS ✨

#include <Inventor/draggers/SoRotateCylindricalDragger.h>

Inherits SoDragger.

🎀 Public Member Functions

  • virtual SoType getTypeId (void) const — the type-id getter, virtual edition, she's giving polymorphism 🦋
  • virtual const SoNodekitCatalog * getNodekitCatalog (void) const — hands you the nodekit catalog pointer, virtual flavor
  • SoRotateCylindricalDragger (void) — the constructor, the origin story, the main character entrance 👑
  • void setProjector (SbCylinderProjector *p) — drop in your projector, p
  • const SbCylinderProjector * getProjector (void) const — and here's where you ask which projector she's holding

💫 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)
  • SbUniqueId getNodeId (void) const
  • virtual void writeInstance (SoOutput *out)
  • virtual SoFieldContainer * copyThroughConnection (void) const

💜 Public Member Functions inherited from SoFieldContainer

  • void setToDefaults (void)
  • SbBool hasDefaultValues (void) const
  • SbBool fieldsAreEqual (const SoFieldContainer *container) const
  • void copyFieldValues (const SoFieldContainer *container, SbBool copyconnections=FALSE)
  • SbBool set (const char *const fielddata)
  • void get (SbString &fielddata)
  • virtual int getFields (SoFieldList &l) const
  • virtual int getAllFields (SoFieldList &l) const
  • virtual SoField * getField (const SbName &name) const
  • virtual SoField * getEventIn (const SbName &name) const
  • virtual SoField * getEventOut (const SbName &name) const
  • SbBool getFieldName (const SoField *const field, SbName &name) const
  • SbBool enableNotify (const SbBool flag)
  • SbBool isNotifyEnabled (void) const
  • SbBool set (const char *fielddata, SoInput *input)
  • void get (SbString &fielddata, SoOutput *out)
  • virtual SbBool validateNewFieldValue (SoField *field, void *newval)
  • SbBool getIsBuiltIn (void) const
  • virtual void getFieldsMemorySize (size_t &managed, size_t &unmanaged) const
  • void setUserData (void *userdata) const
  • void * getUserData (void) const

🫶 Public Member Functions inherited from SoBase

  • void ref (void) const
  • void unref (void) const
  • void unrefNoDelete (void) const
  • int32_t getRefCount (void) const
  • void touch (void)
  • SbBool isOfType (SoType type) const — Returns TRUE if the type of this object is either of the same type or inherited from type.
  • 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) — class-wide type id, no instance needed 🫡
  • static const SoNodekitCatalog * getClassNodekitCatalog (void) — the class-level nodekit catalog pointer
  • static void initClass (void) — the init, static style

🌈 Static Public Member Functions inherited from SoDragger

  • static SoType getClassTypeId (void)
  • static const SoNodekitCatalog * getClassNodekitCatalog (void)
  • static void setMinScale (float newminscale)
  • static float getMinScale (void)
  • static void workValuesIntoTransform (SbMatrix &mtx, const SbVec3f *translationptr, const SbRotation *rotationptr, const SbVec3f *scalefactorptr, const SbRotation *scaleorientationptr, const SbVec3f *centerptr)
  • static void getTransformFast (SbMatrix &mtx, SbVec3f &translation, SbRotation &rotation, SbVec3f &scalefactor, SbRotation &scaleorientation, const SbVec3f &center)
  • static void getTransformFast (SbMatrix &mtx, SbVec3f &translation, SbRotation &rotation, SbVec3f &scalefactor, SbRotation &scaleorientation)
  • static SbMatrix appendTranslation (const SbMatrix &mtx, const SbVec3f &translation, const SbMatrix *conversion=NULL)
  • static SbMatrix appendScale (const SbMatrix &mtx, const SbVec3f &scale, const SbVec3f &scalecenter, const SbMatrix *conversion=NULL)
  • static SbMatrix appendRotation (const SbMatrix &mtx, const SbRotation &rot, const SbVec3f &rotcenter, const SbMatrix *conversion=NULL)
  • static void initClass (void)
  • static void initClasses (void)

🧚 Static Public Member Functions inherited from SoInteractionKit

  • static SoType getClassTypeId (void)
  • static const SoNodekitCatalog * getClassNodekitCatalog (void)
  • static void initClass (void) — Sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system. 💖
  • static void setSwitchValue (SoNode *node, const int newVal)

🍓 Static Public Member Functions inherited from SoBaseKit

  • static SoType getClassTypeId (void)
  • static void initClass (void)
  • static const SoNodekitCatalog * getClassNodekitCatalog (void)
  • static SbBool isSearchingChildren (void)
  • static void setSearchingChildren (const SbBool newval)

okay that was the whole cast list bestie, every single signature accounted for, not one skipped, we ate 🍽️✨ and this is literally just part 1 — the rest is coming, stay tuned 💅

✨ Static Public Member Functions inherited from SoNode ✨

  • static uint32_t getCompatibilityTypes (const SoType &nodetype) — grabs the compatibility types for a node type. It's giving compatibility realness. 💅
  • static SoType getClassTypeId (void) — returns the SoType for this class. The classic "what am I?" moment. 🪪
  • static SoNode * getByName (const SbName &name) — finds a node by name. Like a search party for your scene graph. 🔍
  • static int getByName (const SbName &name, SoNodeList &l) — same but fills a list. Because sometimes you need options. 📋
  • static void initClass (void) — sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system. It's the class's official debut. 🌟
  • static void initClasses (void) — initializes all the classes. The whole squad gets ready. 💃
  • static SbUniqueId getNextNodeId (void) — hands out the next unique node ID. Every node needs its own number. 🔢
  • static int getActionMethodIndex (const SoType type) — gets the action method index for a type. Indexing the action, periodt. 📇
  • static void getBoundingBoxS (SoAction *action, SoNode *node) — the static bounding box action callback. It's giving spatial awareness. 📦
  • static void GLRenderS (SoAction *action, SoNode *node) — static GL render callback. Making it render, slay. 🎨
  • static void callbackS (SoAction *action, SoNode *node) — static callback. Just callback things. 📞
  • static void getMatrixS (SoAction *action, SoNode *node) — static get matrix. Matrix vibes. 🧮
  • static void handleEventS (SoAction *action, SoNode *node) — static event handler. Handling events like a pro. 🎮
  • static void pickS (SoAction *action, SoNode *node) — static pick callback. Pick me, choose me. 👉
  • static void rayPickS (SoAction *action, SoNode *node) — static ray pick. Ray tracing but make it pick. 🔦
  • static void searchS (SoAction *action, SoNode *node) — static search. Searching for answers. 🔎
  • static void writeS (SoAction *action, SoNode *node) — static write. Write it down. ✍️
  • static void audioRenderS (SoAction *action, SoNode *node) — static audio render. Making noise. 🔊
  • static void getPrimitiveCountS (SoAction *action, SoNode *node) — static primitive count. Counting the primitives. 🔢

✨ Static Public Member Functions inherited from SoFieldContainer ✨

  • static void initClass (void) — sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system. Same energy as before. 🌟
  • static SoType getClassTypeId (void) — this static method returns the SoType object associated with objects of this class. Your class ID, bestie. 🪪
  • static void cleanupClass (void) — cleans up the class. Marie Kondo vibes. 🧹
  • static void initCopyDict (void) — initializes the copy dictionary. Getting the copy party started. 📚
  • static void addCopy (const SoFieldContainer *orig, const SoFieldContainer *copy) — adds a copy to the dictionary. Original and copy, together. 👯
  • static SoFieldContainer * checkCopy (const SoFieldContainer *orig) — checks for a copy. Did someone say copy? 🔍
  • static SoFieldContainer * findCopy (const SoFieldContainer *orig, const SbBool copyconnections) — finds a copy. With a flag for copy connections. 🔎
  • static void copyDone (void) — signals that copying is done. That's a wrap. 🎬

✨ Static Public Member Functions inherited from SoBase ✨

  • static void initClass (void) — sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system. The classic init. 🌟
  • static SoType getClassTypeId (void) — this static method returns the SoType object associated with objects of this class. Class ID, again. 🪪
  • static void addName (SoBase *const base, const char *const name) — adds a name to a base. Naming things is important. 🏷️
  • static void removeName (SoBase *const base, const char *const name) — removes a name. Bye, name. 👋
  • static void incrementCurrentWriteCounter (void) — increments the write counter. One more write. ➕
  • static void decrementCurrentWriteCounter (void) — decrements the write counter. One less. ➖
  • static SoBase * getNamedBase (const SbName &name, SoType type) — gets a named base of a given type. Finding your base. 🏠
  • static int getNamedBases (const SbName &name, SoBaseList &baselist, SoType type) — gets named bases into a list. The whole base squad. 👯‍♀️
  • static SbBool read (SoInput *input, SoBase *&base, SoType expectedtype) — reads a base from input. Reading is fundamental. 📖
  • static void setInstancePrefix (const SbString &c) — sets the instance prefix. Prefix it up. 🔤
  • static void setTraceRefs (SbBool trace) — sets trace refs. Tracing the references. 🕵️
  • static SbBool getTraceRefs (void) — gets trace refs. Are we tracing? 🤔
  • static SbBool connectRoute (SoInput *input, const SbName &fromnodename, const SbName &fromfieldname, const SbName &tonodename, const SbName &tofieldname) — connects a route from one node/field to another. Connecting the dots. 🔗
  • static SbBool readRoute (SoInput *input) — reads a route. Reading the route. 🛣️

✨ Public Attributes ✨

  • SoSFRotation rotation — the rotation field. Spin it. 🌀

✨ Public Attributes inherited from SoDragger ✨

  • SoSFBool isActive — whether the dragger is active. Are we active? 💃

✨ Public Attributes inherited from SoInteractionKit ✨

  • SoSFEnum renderCaching — render caching setting. Cache it. 🗃️
  • SoSFEnum boundingBoxCaching — bounding box caching. Box it up. 📦
  • SoSFEnum renderCulling — render culling. Cull it. ✂️
  • SoSFEnum pickCulling — pick culling. Pick and cull. 👆

✨ Protected Member Functions ✨

  • virtual const SoFieldData * getFieldData (void) const — gets the field data. Data for the fields. 📊
  • virtual ~SoRotateCylindricalDragger (void) — the destructor. It's the end, but in a good way. 💀
  • virtual SbBool setUpConnections (SbBool onoff, SbBool doitalways=FALSE) — sets up connections, with an option to always do it. Connect the dots. 🔌
  • virtual void copyContents (const SoFieldContainer *fromfc, SbBool copyconnections) — copies contents. Copy that. 📋
  • void dragStart (void) — starts the drag. Drag race begins. 🏁
  • void drag (void) — drags. The main drag event. 🖱️
  • void dragFinish (void) — finishes the drag. That's a wrap on dragging. 🏁

✨ Protected Member Functions inherited from SoDragger ✨

  • SoDragger (void) — constructor. New dragger who dis. 👋
  • virtual ~SoDragger (void) — destructor. Bye, dragger. 💀
  • SbVec2f getNormalizedLocaterPosition (void) — gets the normalized locater position. Normalize it. 📍
  • SbVec2s getLocaterPosition (void) — gets the locater position. Where you at? 📍
  • SbVec2s getStartLocaterPosition (void) const — gets the start locater position. Where it all began. 📍
  • void setStartLocaterPosition (SbVec2s p) — sets the start locater position. Setting the starting point. 📍
  • SbBool isAdequateConstraintMotion (void) — checks if the constraint motion is adequate. Is it adequate? 🤔
  • virtual SbBool shouldGrabBasedOnSurrogate (const SoPath *pickpath, const SoPath *surrogatepath) — decides if it should grab based on a surrogate. Surrogate decisions. 🤖
  • void setCameraInfo (SoAction *action) — sets camera info. Camera ready. 📷
  • virtual void handleEvent (SoHandleEventAction *ha) — handles an event. Event handler. 🎮
  • void transferMotion (SoDragger *child) — transfers motion to a child. Passing the motion. 🏃
  • void setIgnoreInBbox (SbBool newval) — sets whether to ignore in bounding box. Ignore it. 🙈
  • SbBool isIgnoreInBbox (void) — checks if ignoring in bounding box. Are we ignoring? 🤔
  • virtual void getBoundingBox (SoGetBoundingBoxAction *action) — gets the bounding box. Box it up. 📦
  • void setActiveChildDragger (SoDragger *newchilddragger) — sets the active child dragger. Child dragger in charge. 👶
  • SoDragger * getActiveChildDragger (void) const — gets the active child dragger. Who's the active child? 👶
  • virtual void setDefaultOnNonWritingFields (void) — sets defaults on non-writing fields. Defaults, but only for non-writing. 🎛️
  • void updateDraggerCache (const SoPath *path) — updates the dragger cache. Cache refresh. 🔄
  • virtual const SoPickedPoint * getPickedPointForStart (SoHandleEventAction *action) — gets the picked point for start. Picked point, start. 🎯

✨ Protected Member Functions inherited from SoInteractionKit ✨

  • virtual ~SoInteractionKit () — destructor. Bye. 💀
  • virtual SbBool setPart (const int partNum, SoNode *node) — sets a part by number. Part swap. 🔧
  • virtual SbBool readInstance (SoInput *in, unsigned short flags) — reads an instance. Read it. 📖
  • virtual SbBool setAnyPartAsDefault (const SbName &partname, SoNode *node, SbBool anypart=TRUE, SbBool onlyifdefault=TRUE) — sets any part as default. Default it. 🎛️
  • virtual SbBool setAnyPartAsDefault (const SbName &partname, const SbName &nodename, SbBool anypart=TRUE, SbBool onlyifdefault=TRUE) — same but with a node name. Default by name. 🎛️
  • SbBool setAnySurrogatePath (const SbName &name, SoPath *path, SbBool leafcheck=FALSE, SbBool publiccheck=FALSE) — sets any surrogate path. Surrogate path setting. 🛤️
  • void connectSeparatorFields (SoSeparator *dest, SbBool onOff) — connects separator fields. Connect the separator. 🔌

✨ Protected Member Functions inherited from SoBaseKit ✨

  • virtual ~SoBaseKit () — destructor. Bye, kit. 💀
  • virtual SoNode * addToCopyDict (void) const — adds to the copy dictionary. Adding to the copy party. 📚
  • SoGroup * getContainerNode (const SbName &listname, SbBool makeifneeded=TRUE) — gets the container node. Container vibes. 📦
  • virtual SoNode * getAnyPart (const SbName &partname, SbBool makeifneeded, SbBool leafcheck=FALSE, SbBool publiccheck=FALSE) — gets any part. Part getter. 🔧
  • virtual SoNodeKitPath * createPathToAnyPart (const SbName &partname, SbBool makeifneeded, SbBool leafcheck=FALSE, SbBool publiccheck=FALSE, const SoPath *pathtoextend=NULL) — creates a path to any part. Path creation. 🛤️
  • virtual SbBool setAnyPart (const SbName &partname, SoNode *from, SbBool anypart=TRUE) — sets any part. Set it. 🔧
  • void createNodekitPartsList (void) — creates the nodekit parts list. List it. 📝
  • void createFieldList (void) — creates the field list. Field list. 📝
  • virtual void createDefaultParts (void) — creates default parts. Default parts. 🎛️
  • const SoNodekitParts * getNodekitPartsList (void) const — gets the nodekit parts list. Parts list. 📋
  • const SbList< SoSFNode * > & getCatalogInstances (void) const — gets catalog instances. Catalog instances. 📚
  • void catalogError (void) — catalog error. Error in the catalog. 🚨
  • void countMyFields (SoOutput *out) — counts my fields. Counting fields. 🔢

✨ Protected Member Functions inherited from SoNode ✨

  • SoNode (void) — constructor. Node born. 👶
  • virtual ~SoNode () — destructor. Node gone. 💀

✨ Protected Member Functions inherited from SoFieldContainer ✨

  • SoFieldContainer (void) — constructor. Field container born. 👶
  • virtual ~SoFieldContainer () — destructor. Field container gone. 💀

✨ Protected Member Functions inherited from SoBase ✨

  • SoBase (void) — constructor. Base born. 👶
  • virtual ~SoBase () — destructor. Base gone. 💀
  • virtual void destroy (void) — destroys. Destroy it. 💥
  • SbBool hasMultipleWriteRefs (void) const — checks for multiple write refs. Multiple refs? 🤔
  • SbBool writeHeader (SoOutput *out, SbBool isgroup, SbBool isengine) const — writes the header. Header writing. ✍️
  • void writeFooter (SoOutput *out) const — writes the footer. Footer writing. ✍️
  • virtual const char * getFileFormatName (void) const — gets the file format name. File format name. 📄
  • virtual SoNotRec createNotRec (void) — creates a notification record. Notification record. 📝

✨ Static Protected Member Functions ✨

  • static const SoFieldData ** getFieldDataPtr (void) — gets the field data pointer. Field data pointer. 📊
  • static const SoNodekitCatalog ** getClassNodekitCatalogPtr (void) — gets the class nodekit catalog pointer. Nodekit catalog pointer. 📚
  • static void startCB (void *f, SoDragger *d) — start callback. Start it. 🏁
  • static void motionCB (void *f, SoDragger *d) — motion callback. Motion. 🏃
  • static void doneCB (void *f, SoDragger *d) — done callback. Done. ✅
  • static void fieldSensorCB (void *f, SoSensor *s) — field sensor callback. Sensor callback. 📡
  • static void valueChangedCB (void *f, SoDragger *d) — value changed callback. Value changed. 🔄

✨ Static Protected Member Functions inherited from SoDragger ✨

  • static const SoFieldData ** getFieldDataPtr (void) — field data pointer. 📊
  • static const SoNodekitCatalog ** getClassNodekitCatalogPtr (void) — nodekit catalog pointer. 📚
  • static void childTransferMotionAndValueChangedCB (void *, SoDragger *) — child transfer motion and value changed callback. Child doing both. 👶
  • static void childValueChangedCB (void *, SoDragger *) — child value changed callback. Child value changed. 👶
  • static void childStartCB (void *, SoDragger *) — child start callback. Child starts. 👶
  • static void childMotionCB (void *, SoDragger *) — child motion callback. Child moves. 👶
  • static void childFinishCB (void *, SoDragger *) — child finish callback. Child finishes. 👶
  • static void childOtherEventCB (void *, SoDragger *) — child other event callback. Child other event. 👶

✨ Static Protected Member Functions inherited from SoInteractionKit ✨

  • static const SoFieldData ** getFieldDataPtr (void) — field data pointer. 📊
  • static const SoNodekitCatalog ** getClassNodekitCatalogPtr (void) — nodekit catalog pointer. 📚
  • static void readDefaultParts (const char *fileName, const char defaultBuffer[], int defBufSize) — reads default parts from a file. Reading defaults. 📖
  • static void fieldSensorCB (void *, SoSensor *) — field sensor callback. Sensor callback. 📡

✨ Static Protected Member Functions inherited from SoBaseKit ✨

  • static const SoFieldData ** getFieldDataPtr (void) — field data pointer. 📊
  • static const SoNodekitCatalog ** getClassNodekitCatalogPtr (void) — 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. Index set. 📇
  • static int getNextActionMethodIndex (void) — gets the next action method index. Index get. 📇
  • static void incNextActionMethodIndex (void) — increments the next action method index. Index up. ➕
  • static void setCompatibilityTypes (const SoType &nodetype, const uint32_t bitmask) — sets compatibility types. Compatibility set. 🔧

✨ Static Protected Member Functions inherited from SoBase ✨

  • static uint32_t getCurrentWriteCounter (void) — gets the current write counter. Counter check. 🔢
  • static void staticDataLock (void) — locks static data. Lock it. 🔒
  • static void staticDataUnlock (void) — unlocks static data. Unlock it. 🔓

✨ Protected Attributes ✨

  • SoSFNode feedback — feedback node. Feedback. 📢
  • SoSFNode feedbackActive — active feedback node. Active feedback. 📢
  • SoSFNode feedbackSwitch — feedback switch node. Switch it. 🔀
  • SoSFNode rotator — rotator node. Rotate it. 🔄
  • SoSFNode rotatorActive — active rotator node. Active rotator. 🔄
  • SoSFNode rotatorSwitch — rotator switch node. Switch the rotator. 🔀
  • SoFieldSensor * fieldSensor — field sensor pointer. Sensor. 📡
  • SbCylinderProjector * cylinderProj — cylinder projector pointer. Projector. 📽️
  • SbBool userProj — user projection flag. User projection. 👤

✨ Protected Attributes inherited from SoDragger ✨

  • SoSFNode motionMatrix — motion matrix node. Matrix of motion. 🧮

✨ Protected Attributes inherited from SoInteractionKit ✨

  • SoSFNode geomSeparator — geometry separator node. Separator. 🔲
  • SoSFNode topSeparator — top separator node. Top separator. 🔲
  • SoFieldSensor * fieldSensor — field sensor pointer. Sensor. 📡
  • SoSeparator * oldTopSep — old top separator pointer. Old separator. 🗂️

✨ Protected Attributes inherited from SoBaseKit ✨

  • SoSFNode callbackList — callback list node. Callback list. 📋
  • SoChildList * children — children list pointer. Children. 👶
  • SbBool connectionsSetUp — connections set up flag. Connections set up? 🔌

✨ Protected Attributes inherited from SoNode ✨

  • SbUniqueId uniqueId — unique ID. Unique ID. 🆔

✨ Protected Attributes inherited from SoFieldContainer ✨

  • SbBool isBuiltIn — is built-in flag. Built-in? 🏠

✨ Additional Inherited Members ✨

Public Types inherited from SoDragger

  • enum ProjectorFrontSetting { FRONT, BACK, USE_PICK } — projector front setting enum. Front, back, or use pick. 🎛️

Public Types inherited from SoInteractionKit

  • enum CacheEnabled { OFF, ON, AUTO } — cache enabled enum. 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, COIN_4_0 = 0x20000 } — node type enum with all these values. The whole node type spectrum. 🌈

Protected Types inherited from SoBase

  • enum BaseFlags { IS_ENGINE = 0x01, IS_GROUP = 0x02 } — base flags enum. Is engine or is group. 🚩

Static Protected Attributes inherited from SoNode

  • static SbUniqueId nextUniqueId = 1 — next unique ID, starts at 1. 🔢
  • static int nextActionMethodIndex = 0 — next action method index, starts at 0. 📇

💖 DETAILED DESCRIPTION 💖

okay bestie, so the SoRotateCylindricalDragger class is literally THE girl for rotating geometry around a single axis. one axis. that's her whole thing. periodt. ✨

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

(yes babe, there's a picture of it in the fancy docs — imagine the cutest little cylindrical ring dragger just vibing there, unbothered, inactive, main character energy 🌸)

so basically — drop an instance of this dragger class into your scene graph, and boom, you're letting the end-users of your application rotate geometry around a predefined axis vector in 3D. iconic. 🔥

and for the dragger's own orientation and positioning? you use some kind of transformation node in your scene graph, as usual. no cap, that's just how we do it. 💅

🎀 CONSTRUCTOR & DESTRUCTOR DOCUMENTATION 🎀

✨ SoRotateCylindricalDragger::SoRotateCylindricalDragger (void)

the default constructor, bestie. she sets up the dragger nodekit catalog with all the interaction and feedback geometry. she comes pre-styled. 💖

Nodekit structure (new entries versus the parent class are marked with an arrow prefix — keep an eye out for the -->):

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

(see SoBaseKit::printDiagram() for info about the output formatting — that's the receipts. 🧾)

Detailed information on catalog parts:

CLASS SoRotateCylindricalDragger
PVT   "this",  SoRotateCylindricalDragger  ---
      "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 info about the output formatting — yes, another one. she loves documentation. 🫶)

🌙 SoRotateCylindricalDragger::~SoRotateCylindricalDragger (void) [protected], [virtual]

the protected destructor. ✨

(dragger classes are derived from SoBase, so they're reference counted and get automatically destroyed when their reference count goes to 0. so like... she leaves when nobody's thinking about her anymore. very demure, very mindful. 💀)

🌈 MEMBER FUNCTION DOCUMENTATION 🌈

⭐ SoType SoRotateCylindricalDragger::getClassTypeId (void) [static]

this static method returns the SoType object associated with objects of this class. that's it. that's the whole job. she ate. 👑

⭐ SoType SoRotateCylindricalDragger::getTypeId (void) const [virtual]

returns the type identification of an object derived from a class inheriting SoBase. this is what powers runtime type checking and "downward" casting. iykyk.

Reimplemented from SoDragger.

⭐ const SoFieldData ** SoRotateCylindricalDragger::getFieldDataPtr (void) [static], [protected]

this API member is considered internal to the library, as it's not likely to be of interest to the application programmer. 🙈

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

⭐ const SoFieldData * SoRotateCylindricalDragger::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. (sad. empty. no fields to slay today. 😭)

Reimplemented from SoDragger.

⭐ const SoNodekitCatalog * SoRotateCylindricalDragger::getClassNodekitCatalog (void) [static]

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

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

returns the nodekit catalog which defines the layout of this class' kit. (yes, same sentence, different vibe — this one's for the instance, bestie. subtle but crucial. 💅)

Reimplemented from SoDragger.

⭐ const SoNodekitCatalog ** SoRotateCylindricalDragger::getClassNodekitCatalogPtr (void) [static], [protected]

returns the pointer to the pointer of the nodekit catalog for this class. a pointer to a pointer. inception core. 🌌

⭐ void SoRotateCylindricalDragger::initClass (void) [static]

initializes the type system for this dragger class. ✨

application programmers should usually not have to invoke this method — see the documentation of SoInteraction::init(). let the library handle it, babe. trust the process. 🫶

⭐ void SoRotateCylindricalDragger::setProjector (SbCylinderProjector * p)

replace the default cylinder projection strategy. you might wanna do this if you change the dragger geometry, for instance. glow-up time. 🔥

the default cylinder projection is an SbCylinderPlaneProjector.

See also SbCylinderSectionProjector, SbCylinderSheetProjector

⭐ const SbCylinderProjector * SoRotateCylindricalDragger::getProjector (void) const

returns the projector instance used for converting from user interaction dragger movements to 3D dragger re-orientation. the translator between "human hand moved mouse" and "geometry spun in 3D". iconic honestly. 🌸

See also setProjector()

⭐ SbBool SoRotateCylindricalDragger::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 wanna extend the library with new custom nodekits or dragger classes. if that's you, go see the SoBaseKit class documentation. you're built different, bestie. 👑)

Reimplemented from SoInteractionKit.

⭐ void SoRotateCylindricalDragger::copyContents (const SoFieldContainer * from, SbBool copyconnections) [protected], [virtual]

makes a deep copy of all data of from into this instance, except external scene graph references if copyconnections is FALSE. 🪞

this is the method that should be overridden by extension node / engine / dragger / whatever subclasses which need to account for internal data that isn't handled automatically.

for copying nodes from application code, you should not invoke this function directly — instead 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, you also make it call upwards to its parent superclass in the inheritance hierarchy — because 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.)
  SoNode::copyContents(from, copyconnections);

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

Reimplemented from SoInteractionKit.

⭐ void SoRotateCylindricalDragger::startCB (void * f, SoDragger * d) [static], [protected]

this API member is considered internal to the library, as it's not likely to be of interest to the application programmer. 🙈

⭐ void SoRotateCylindricalDragger::motionCB (void * f, SoDragger * d) [static], [protected]

this API member is considered internal to the library, as it's not likely to be of interest to the application programmer. 🙈

⭐ void SoRotateCylindricalDragger::doneCB (void * f, SoDragger * d) [static], [protected]

this API member is considered internal to the library, as it's not likely to be of interest to the application programmer. 🙈

⭐ void SoRotateCylindricalDragger::fieldSensorCB (void * d, SoSensor * s) [static], [protected]

this API member is considered internal to the library, as it's not likely to be of interest to the application programmer. 🙈

⭐ void SoRotateCylindricalDragger::valueChangedCB (void * f, SoDragger * d) [static], [protected]

this API member is considered internal to the library, as it's not likely to be of interest to the application programmer. 🙈

⭐ void SoRotateCylindricalDragger::dragStart (void) [protected]

this API member is considered internal to the library, as it's not likely to be of interest to the application programmer. 🙈

called when the dragger is selected (picked) by the user. 🫵

⭐ void SoRotateCylindricalDragger::drag (void) [protected]

this API member is considered internal to the library, as it's not likely to be of interest to the application programmer. 🙈

called when the user drags the mouse after picking the dragger. 🖱️

⭐ void SoRotateCylindricalDragger::dragFinish (void) [protected]

this API member is considered internal to the library, as it's not likely to be of interest to the application programmer. 🙈

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

💜 MEMBER DATA DOCUMENTATION 💜

🦋 SoSFRotation SoRotateCylindricalDragger::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 their scene graph should connect the relevant node fields in the scene to this field, to make them follow the dragger orientation. that's the whole point, bestie — wire it up and watch everything follow along. slay. ✨

🦋 SoFieldSensor* SoRotateCylindricalDragger::fieldSensor [protected]

this API member is considered internal to the library, as it's not likely to be of interest to the application programmer. 🙈

🦋 SbCylinderProjector* SoRotateCylindricalDragger::cylinderProj [protected]

this API member is considered internal to the library, as it's not likely to be of interest to the application programmer. 🙈

🦋 SbBool SoRotateCylindricalDragger::userProj [protected]

this API member is considered internal to the library, as it's not likely to be of interest to the application programmer. 🙈

🌟 AUTHOR 🌟

generated automatically by Doxygen for Coin from the source code. not a human hand-wrote this — the robot did it, and honestly? she ate. 🤖💅

and that's a wrap on our girl SoRotateCylindricalDragger 💖 you made it to the end, bestie, so proud of you. this page is from Coin version 4.0.10, dated Thu Jun 25 2026 00:00 — yeah that's the whole footer, i'm folding it into the outro like a little bow on top. 🎀 go rotate something cute. mwah. 🫶✨

📦 where this page comes from