SoRotateCy...calDragger(3)

📦 version 3.1.3, in fedora 43, fedora 44

✨ SoRotateCy...calDragger(3) ✨

okay so bestie, welcome to the Library Functions Manual entry for SoRotateCy...calDragger(3) — yes the title got squished, that's just how the page header renders, the real star is SoRotateCylindricalDragger. Sit down, grab a 🍓, we're doing this.

🌸 NAME 🌸

SoRotateCylindricalDragger — the class that's for rotating geometry around a single axis. That's it. That's the whole job. One axis, all the spin. iconic behavior honestly 💅

🦋 SYNOPSIS 🦋

pull it in like this:

#include <Inventor/draggers/SoRotateCylindricalDragger.h>

and the tea is: it Inherits SoDragger. so everything a dragger can do, she can do too. generational talent 👑

💖 Public Member Functions 💖

the ones that belong to her directly:

virtual SoType getTypeId (void) const — hands you her type id, the little name tag every Coin node carries 🎀
virtual const SoNodekitCatalog * getNodekitCatalog (void) const — gives back the nodekit catalog for this class, i.e. the map of all her parts ✨
SoRotateCylindricalDragger (void) — the constructor, no args, she just exists 🌸
void setProjector (SbCylinderProjector *p) — set the cylinder projector she uses to figure out the rotation 🌀
const SbCylinderProjector * getProjector (void) const — read that projector back out 👀

💅 Public Member Functions inherited from `SoDragger` 💅

yes she got ALL of this from her parent and we're listing every single one because we don't skip:

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

the callback add/remove pairs are giving subscribe and unsubscribe energy, the data=NULL is the default so you can be lazy about it, and ProjectorFrontSetting is a whole type name, respect it 🫶

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

note there's two setPartAsDefault overloads and two isPathSurrogateInMySubgraph overloads — she's flexible like that 💖 and yeah, onlyifdefault=TRUE and fillargs=TRUE are the defaults, don't come for me.

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

pathtoextend=NULL and isfromfield=FALSE are the defaults. and yes there are two set() overloads here, plus printDiagram, printSubDiagram and printTable so you can stare at the whole kit structure like it's a family tree 🌳

⭐ 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

copyconnections=FALSE default, uint32_t getNodeId returns a whole 32-bit id, and there's a NodeType type name floating around too. very demure, very mindful 🎀

💜 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

another pair of set() and get() overloads, copyconnections=FALSE again, and getFieldsMemorySize hands you both managed and unmanaged sizes because she's thorough 🔥

🎀 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

ref counting, auditor bookkeeping, SoNotRec::Type as a type name — this is the foundation layer and she is carrying the whole family on her back, no cap 😭

👑 Static Public Member Functions 👑

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

class-level type id, class-level nodekit catalog, and initClass to get her registered. the static trio. slay ✨

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

two getTransformFast overloads, and every single one of appendTranslation, appendScale, appendRotation has conversion=NULL as its default — she'll do the conversion for you but only if you ask 💅 and don't forget initClasses is plural here, she registers a whole squad.

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

setSwitchValue taking an int newVal — very switch, very value 🌸

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

the get/set pair isSearchingChildren / setSearchingChildren is literally a toggle for whether she's out here searching children. relatable 🙈

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

two getByName overloads (one returns a SoNode *, one returns an int and fills a SoNodeList &l), plus the whole ...S static trampoline family — getBoundingBoxS, GLRenderS, callbackS, getMatrixS, handleEventS, pickS, rayPickS, searchS, writeS, audioRenderS, getPrimitiveCountS. every one takes (SoAction *action, SoNode *node). it's giving assembly line and honestly? it ate 👑

okay that's the whole header section bestie, all the inherited functions catalogued and accounted for. we are so not done yet though — keep scrolling, there's more of this page coming 💖

💖 Static Public Member Functions inherited from `SoFieldContainer` 💖

okay so these are the static besties your class borrowed from SoFieldContainer, no cap:

static void initClass (void) — sets the class up in the type system so everything else knows it exists 🎀
static SoType getClassTypeId (void) — hands you back the SoType for this class
static void cleanupClass (void) — tidies the class back up again
static void initCopyDict (void) — spins up the little dictionary used while copying
static void addCopy (const SoFieldContainer *orig, const SoFieldContainer *copy) — files an *orig → *copy pairing in that dictionary
static SoFieldContainer * checkCopy (const SoFieldContainer *orig) — peeks in the dictionary to see if *orig already got a copy
static SoFieldContainer * findCopy (const SoFieldContainer *orig, const SbBool copyconnections) — same energy, but you tell it whether to copyconnections too
static void copyDone (void) — copy session over, wrap it up ✨

🌸 Static Public Member Functions inherited from `SoBase` 🌸

and here's the SoBase static squad, still iconic:

static void initClass (void) — class registration, the classic
static SoType getClassTypeId (void) — returns the SoType, periodt
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 back off *base
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) — hunts for the base called name of that type
static int getNamedBases (const SbName &name, SoBaseList &baselist, SoType type) — collects all of them into baselist instead of just one
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 to c
static void setTraceRefs (SbBool trace) — turns reference tracing on or off 🕵️
static SbBool getTraceRefs (void) — tells you whether reference tracing is currently on
static SbBool connectRoute (SoInput *input, 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 *input) — reads a route out of *input

👑 Public Attributes 👑

SoSFRotation rotation — the rotation itself. the whole point. the main character 💅

Public Attributes inherited from `SoDragger`

SoSFBool isActive — whether the dragger is currently active

Public Attributes inherited from `SoInteractionKit`

SoSFEnum renderCaching
SoSFEnum boundingBoxCaching
SoSFEnum renderCulling
SoSFEnum pickCulling

🦋 Protected Member Functions 🦋

virtual const SoFieldData * getFieldData (void) const — returns the field data for this class
virtual ~SoRotateCylindricalDragger (void) — the destructor
virtual SbBool setUpConnections (SbBool onoff, SbBool doitalways=FALSE) — flips the internal field connections onoff, and doitalways lets you force it even if nothing changed
virtual void copyContents (const SoFieldContainer *fromfc, SbBool copyconnections) — copies contents over from *fromfc, with copyconnections deciding if the connections come along too
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)
virtual ~SoDragger (void)
SbVec2f getNormalizedLocaterPosition (void)
SbVec2s getLocaterPosition (void)
SbVec2s getStartLocaterPosition (void) const
void setStartLocaterPosition (SbVec2s p)
SbBool isAdequateConstraintMotion (void)
virtual SbBool shouldGrabBasedOnSurrogate (const SoPath *pickpath, const SoPath *surrogatepath)
void setCameraInfo (SoAction *action)
virtual void handleEvent (SoHandleEventAction *ha)
void transferMotion (SoDragger *child)
void setIgnoreInBbox (SbBool newval)
SbBool isIgnoreInBbox (void)
virtual void getBoundingBox (SoGetBoundingBoxAction *action)
void setActiveChildDragger (SoDragger *newchilddragger)
SoDragger * getActiveChildDragger (void) const
virtual void setDefaultOnNonWritingFields (void)
void updateDraggerCache (const SoPath *path)

Protected Member Functions inherited from `SoInteractionKit`

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

Protected Member Functions inherited from `SoBaseKit`

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

Protected Member Functions inherited from `SoNode`

SoNode (void)
virtual ~SoNode ()

Protected Member Functions inherited from `SoFieldContainer`

SoFieldContainer (void)
virtual ~SoFieldContainer ()

Protected Member Functions inherited from `SoBase`

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

🌈 Static Protected Member Functions 🌈

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

Static Protected Member Functions inherited from `SoDragger`

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

Static Protected Member Functions inherited from `SoInteractionKit`

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

Static Protected Member Functions inherited from `SoBaseKit`

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

Static Protected Member Functions inherited from `SoNode`

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

Static Protected Member Functions inherited from `SoBase`

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

🎀 Protected Attributes 🎀

SoSFNode feedback
SoSFNode feedbackActive
SoSFNode feedbackSwitch
SoSFNode rotator
SoSFNode rotatorActive
SoSFNode rotatorSwitch
SoFieldSensor * fieldSensor
SbCylinderProjector * cylinderProj — yes bestie, a cylinder projector, that's the whole vibe
SbBool userProj — whether a user supplied the projector

Protected Attributes inherited from `SoDragger`

SoSFNode motionMatrix

Protected Attributes inherited from `SoInteractionKit`

SoSFNode geomSeparator
SoSFNode topSeparator
SoFieldSensor * fieldSensor
SoSeparator * oldTopSep

Protected Attributes inherited from `SoBaseKit`

SoSFNode callbackList
SoChildList * children
SbBool connectionsSetUp

Protected Attributes inherited from `SoNode`

uint32_t uniqueId

Protected Attributes inherited from `SoFieldContainer`

SbBool isBuiltIn

⭐ Additional Inherited Members ⭐

Public Types inherited from `SoDragger`

enum ProjectorFrontSetting { FRONT, BACK, USE_PICK }

Public Types inherited from `SoInteractionKit`

enum CacheEnabled { 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, COIN_3_0 = 0x8000, INVENTOR_6_0 = 0x10000 }

Protected Types inherited from `SoBase`

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

Static Protected Attributes inherited from `SoNode`

static uint32_t nextUniqueId = 1
static int nextActionMethodIndex = 0

💜 Detailed Description 💜

The SoRotateCylindricalDragger class is for rotating geometry around a single axis. that's it, that's the assignment 💅

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

🖼️ (yes bestie, there is a picture of the dragger right here in the original, chilling in its inactive state — imagine it and it's yours)

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. so you set the axis, they get to spin stuff around it. iconic behavior fr fr 🌀

For the dragger orientation and positioning itself, use some kind of transformation node in your scenegraph, as usual. no special tricks needed, just your normal transformation node, periodt.

🌟 Constructor & Destructor Documentation 🌟

🍓 `SoRotateCylindricalDragger::SoRotateCylindricalDragger (void )`

Default constructor, sets up the dragger nodekit catalog with the interaction and feedback geometry.

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

CLASS SoRotateCylindricalDragger
-->"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 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 information about the output formatting.)

🧚 `SoRotateCylindricalDragger::~SoRotateCylindricalDragger (void )` [protected], [virtual]

Protected destructor. 🙈

(Dragger classes are derived from SoBase, so they are reference counted and automatically destroyed when their reference count goes to 0.)

so ngl you don't call this yourself — the refcount hits zero and it just ✨evaporates✨. that's the deal.

✨ Member Function Documentation ✨

💫 `SoType SoRotateCylindricalDragger::getTypeId (void ) const [virtual]`

okay bestie, this one hands you back the type identification of any object derived from a class that inherits SoBase. it's literally what makes run-time type checking and "downward" casting possible. the moment of truth, no cap.

usage example, copy it exactly:

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

so for all you application programmers out there wanting to extend the library with new nodes, engines, nodekits, draggers or others: this method needs to be overridden in all subclasses. it's 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. slay.

want more on writing Coin extensions? go read the class documentation of the toplevel superclasses for the various class groups. iykyk.

Reimplemented from SoDragger.

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

returns a pointer to the class-wide field data storage object for this instance. and if there are literally no fields present? it returns NULL. periodt.

Reimplemented from SoDragger.

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

returns the nodekit catalog that defines the layout of this class' kit. the blueprint, the map, the whole vibe. 🗺️

Reimplemented from SoDragger.

💅 `void SoRotateCylindricalDragger::setProjector (SbCylinderProjector * p)`

swap out the default cylinder projection strategy. you might wanna do this if you change the dragger geometry, for instance. like, new look, new projector, it's giving glow-up.

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 your mouse and the third dimension, bestie. 🌈

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 want to extend the library with new custom nodekits or dragger classes. if so, see the SoBaseKit class documentation.)

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 scenegraph references if copyconnections is FALSE.

this is the protected 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, 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 its parent superclass in the inheritance hierarchy, as copyContents() in for instance SoNode and SoFieldContainer does important work. it should go something like this:

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

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

Reimplemented from SoInteractionKit.

💜 `void SoRotateCylindricalDragger::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 SoRotateCylindricalDragger::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 SoRotateCylindricalDragger::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 SoRotateCylindricalDragger::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 SoRotateCylindricalDragger::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 SoRotateCylindricalDragger::dragStart (void ) [protected]`

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

called when the dragger is selected (picked) by the user. the main character moment begins. ✨

🔥 `void SoRotateCylindricalDragger::drag (void ) [protected]`

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

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

🌟 `void SoRotateCylindricalDragger::dragFinish (void ) [protected]`

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

called when the mouse button is released after picking and interacting with the dragger. that's a wrap, bestie. 🎬

🎀 Member Data Documentation 🎀

🌈 `SoSFRotation SoRotateCylindricalDragger::rotation`

this field is continuously updated to contain the rotation of the current direction vector of the dragger. always on, always fresh.

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. link them up, let them vibe together. 🔗

🧚 `SoFieldSensor* SoRotateCylindricalDragger::fieldSensor [protected]`

this API member is considered internal to the library, as it is 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 is 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 is not likely to be of interest to the application programmer.

💖 Author 💖

generated automatically by Doxygen for Coin from the source code. the robots did this one, not me, but i made it cute. 🤖✨

aaaand that's the whole page, bestie!! 🫶 this one came from Coin, Version 3.1.3, and the manpage is SoRotateCy...calDragger(3) — you ate that, fr fr. go rotate some cylinders. 💅🎀🦋

📦 where this page comes from

fedora 43: Coin3-devel 3.1.3-40.fc43 · GPL-2.0-only
fedora 43: Coin3-devel 3.1.3-40.fc43 · GPL-2.0-only
fedora 44: Coin3-devel 3.1.3-42.fc44 · GPL-2.0-only
fedora 44: Coin3-devel 3.1.3-42.fc44 · GPL-2.0-only
💖 girlified by deepseek-ai/DeepSeek-V4.1-Flash on 2026-10-14: a language model's rewrite of the original, under its terms

SoRotateCy...calDragger(3)