SoTrackballDragger(3)

📦 version 2.5.0, in fedora 43, fedora 44

🎀 SoTrackballDragger 🎀

hiii bestie, welcome to SoTrackballDragger(3) straight outta the Library Functions Manual ✨ this is the one that lets your end-user spin stuff AND squish stuff with their mouse and honestly? iconic.

🌸 NAME 🌸

SoTrackballDragger — she's the dragger that hands your end-user rotation and scaling interaction possibilities. like, both. at once. main character energy fr 💅

✨ SYNOPSIS ✨

first things first, you gotta pull her in:

#include <Inventor/draggers/SoTrackballDragger.h>

Inherits SoDragger 🫶 (so everything her parent can do, she can do too, no cap)

💖 Public Member Functions 💖

virtual SoType getTypeId (void) const — grab the runtime type id for this exact class ✨
virtual const SoNodekitCatalog * getNodekitCatalog (void) const — hand back the nodekit catalog for this class, the little map of all her parts 🗺️
SoTrackballDragger (void) — the constructor, wake her up 💫
SbBool isAnimationEnabled (void) — is the animation turned on? asking for me 🙈
void setAnimationEnabled (SbBool newval) — turn the animation on or off with newval 🎚️

🦋 Public Member Functions inherited from `SoDragger` 🦋

your girl got all of these from her parent, no re-typing needed:

virtual void callback (SoCallbackAction *action)
virtual void GLRender (SoGLRenderAction *action)
virtual void getMatrix (SoGetMatrixAction *action)
virtual void rayPick (SoRayPickAction *action)
virtual void search (SoSearchAction *action)
virtual void write (SoWriteAction *action)
virtual void getPrimitiveCount (SoGetPrimitiveCountAction *action)
void addStartCallback (SoDraggerCB *func, void *data=NULL)
void removeStartCallback (SoDraggerCB *func, void *data=NULL)
void addMotionCallback (SoDraggerCB *func, void *data=NULL)
void removeMotionCallback (SoDraggerCB *func, void *data=NULL)
void addFinishCallback (SoDraggerCB *func, void *data=NULL)
void removeFinishCallback (SoDraggerCB *func, void *data=NULL)
void addValueChangedCallback (SoDraggerCB *func, void *data=NULL)
void removeValueChangedCallback (SoDraggerCB *func, void *data=NULL)
void setMinGesture (int pixels)
int getMinGesture (void) const
SbBool enableValueChangedCallbacks (SbBool newval)
const SbMatrix & getMotionMatrix (void)
void addOtherEventCallback (SoDraggerCB *func, void *data=NULL)
void removeOtherEventCallback (SoDraggerCB *func, void *data=NULL)
void registerChildDragger (SoDragger *child)
void unregisterChildDragger (SoDragger *child)
void registerChildDraggerMovingIndependently (SoDragger *child)
void unregisterChildDraggerMovingIndependently (SoDragger *child)
SbMatrix getLocalToWorldMatrix (void)
SbMatrix getWorldToLocalMatrix (void)
SbVec3f getLocalStartingPoint (void)
SbVec3f getWorldStartingPoint (void)
void getPartToLocalMatrix (const SbName &partname, SbMatrix &parttolocalmatrix, SbMatrix &localtopartmatrix)
void transformMatrixLocalToWorld (const SbMatrix &frommatrix, SbMatrix &tomatrix)
void transformMatrixWorldToLocal (const SbMatrix &frommatrix, SbMatrix &tomatrix)
void transformMatrixToLocalSpace (const SbMatrix &frommatrix, SbMatrix &tomatrix, const SbName &fromspacepartname)
void setMotionMatrix (const SbMatrix &newmatrix)
void valueChanged (void)
const SbMatrix & getStartMotionMatrix (void)
virtual void saveStartParameters (void)
const SoPath * getPickPath (void) const
const SoEvent * getEvent (void) const
SoPath * createPathToThis (void)
const SoPath * getSurrogatePartPickedOwner (void) const
const SbName & getSurrogatePartPickedName (void) const
const SoPath * getSurrogatePartPickedPath (void) const
void setStartingPoint (const SoPickedPoint *newpoint)
void setStartingPoint (const SbVec3f &newpoint)
const SbViewVolume & getViewVolume (void)
void setViewVolume (const SbViewVolume &vol)
const SbViewportRegion & getViewportRegion (void)
void setViewportRegion (const SbViewportRegion &reg)
SoHandleEventAction * getHandleEventAction (void) const
void setHandleEventAction (SoHandleEventAction *newAction)
void setTempPathToThis (const SoPath *somethingclose)
virtual void grabEventsSetup (void)
virtual void grabEventsCleanup (void)
void workFieldsIntoTransform (SbMatrix &mtx)
void setFrontOnProjector (ProjectorFrontSetting newval)
ProjectorFrontSetting getFrontOnProjector (void) const

🌈 Public Member Functions inherited from `SoInteractionKit` 🌈

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

🌸 Public Member Functions inherited from `SoBaseKit` 🌸

SoBaseKit (void)
virtual SoNode * getPart (const SbName &partname, SbBool makeifneeded)
SbString getPartString (const SoBase *part)
virtual SoNodeKitPath * createPathToPart (const SbName &partname, SbBool makeifneeded, const SoPath *pathtoextend=NULL)
SbBool set (const char *namevaluepairliststring)
SbBool set (const char *partnamestring, const char *parameterstring)
virtual void doAction (SoAction *action)
virtual SoChildList * getChildren (void) const
void printDiagram (void)
void printSubDiagram (const SbName &rootname, int level)
void printTable (void)
virtual void addWriteReference (SoOutput *out, SbBool isfromfield=0)
SbBool forceChildDrivenWriteRefs (SoOutput *out)

⭐ Public Member Functions inherited from `SoNode` ⭐

void setOverride (const SbBool state)
SbBool isOverride (void) const
void setNodeType (const NodeType type)
NodeType getNodeType (void) const
virtual SoNode * copy (SbBool copyconnections=0) const
virtual SbBool affectsState (void) const
virtual void GLRenderBelowPath (SoGLRenderAction *action)
virtual void GLRenderInPath (SoGLRenderAction *action)
virtual void GLRenderOffPath (SoGLRenderAction *action)
virtual void pick (SoPickAction *action)
virtual void audioRender (SoAudioRenderAction *action)
virtual void startNotify (void)
virtual void notify (SoNotList *l)
uint32_t getNodeId (void) const
virtual void writeInstance (SoOutput *out)
virtual SoFieldContainer * copyThroughConnection (void) const

💜 Public Member Functions inherited from `SoFieldContainer` 💜

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

🧚 Public Member Functions inherited from `SoBase` 🧚

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) — the class-level type id, no instance needed 💫
static const SoNodekitCatalog * getClassNodekitCatalog (void) — the class-level nodekit catalog 🗂️
static void initClass (void) — boot her up, run this once 🚀

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

✨ Static Public Member Functions inherited from `SoNode` ✨

static uint32_t getCompatibilityTypes (const SoType &nodetype)
static SoType getClassTypeId (void)
static SoNode * getByName (const SbName &name)
static int getByName (const SbName &name, SoNodeList &l)
static void initClass (void)
static void initClasses (void)
static uint32_t getNextNodeId (void)
static int getActionMethodIndex (const SoType type)
static void getBoundingBoxS (SoAction *action, SoNode *node)
static void GLRenderS (SoAction *action, SoNode *node)
static void callbackS (SoAction *action, SoNode *node)
static void getMatrixS (SoAction *action, SoNode *node)
static void handleEventS (SoAction *action, SoNode *node)
static void pickS (SoAction *action, SoNode *node)
static void rayPickS (SoAction *action, SoNode *node)
static void searchS (SoAction *action, SoNode *node)
static void writeS (SoAction *action, SoNode *node)
static void audioRenderS (SoAction *action, SoNode *node)
static void getPrimitiveCountS (SoAction *action, SoNode *node)

okay that's the whole SYNOPSIS dump bestie, every last signature accounted for 🫡 the actual tea — what this dragger does and how you boss her around — is coming up next, don't go anywhere 💅

✨ Static Public Member Functions inherited from SoFieldContainer ✨

static void initClass (void) — the classic init, doing its thing 💅
static SoType getClassTypeId (void) — grabs the class type id, no cap
static void initCopyDict (void) — sets up the copy dictionary, bestie
static void addCopy (const SoFieldContainer *orig, const SoFieldContainer *copy) — adds a copy, periodt
static SoFieldContainer * checkCopy (const SoFieldContainer *orig) — checks the copy, iykyk
static SoFieldContainer * findCopy (const SoFieldContainer *orig, const SbBool copyconnections) — finds the copy, slay
static void copyDone (void) — copy is done, bye 👋

✨ Static Public Member Functions inherited from SoBase ✨

static void initClass (void) — yep, init again, we love consistency 💫
static SoType getClassTypeId (void) — type id, iconic
static void addName (SoBase *const base, const char *const name) — adds a name, fr fr
static void removeName (SoBase *const base, const char *const name) — removes a name, bye 👋
static void incrementCurrentWriteCounter (void) — increments the write counter, no cap
static void decrementCurrentWriteCounter (void) — decrements it, periodt
static SoBase * getNamedBase (const SbName &name, SoType type) — gets a named base, slay
static int getNamedBases (const SbName &name, SoBaseList &baselist, SoType type) — gets named bases, plural, we love that
static SbBool read (SoInput *in, SoBase *&base, SoType expectedtype) — reads, bestie
static void setInstancePrefix (const SbString &c) — sets the instance prefix, iykyk
static void setTraceRefs (SbBool trace) — sets trace refs, lowkey
static SbBool getTraceRefs (void) — gets trace refs, highkey
static SbBool connectRoute (SoInput *in, const SbName &fromnodename, const SbName &fromfieldname, const SbName &tonodename, const SbName &tofieldname) — connects a route, main character energy 👑
static SbBool readRoute (SoInput *in) — reads a route, vibe check ✅

✨ Public Attributes ✨

SoSFRotation rotation — the rotation field, literally the moment 💅
SoSFVec3f scaleFactor — the scale factor field, iconic

✨ Public Attributes inherited from SoDragger ✨

SoSFBool isActive — is it active? this field knows, no cap

✨ Public Attributes inherited from SoInteractionKit ✨

SoSFEnum renderCaching — render caching enum, slay
SoSFEnum boundingBoxCaching — bounding box caching enum, periodt
SoSFEnum renderCulling — render culling enum, fr fr
SoSFEnum pickCulling — pick culling enum, iykyk

✨ Protected Member Functions ✨

virtual const SoFieldData * getFieldData (void) const — gets the field data, bestie
~SoTrackballDragger () — destructor, bye bestie 💀
virtual SbBool setUpConnections (SbBool onoff, SbBool doitalways=0) — sets up connections, no cap
virtual void setDefaultOnNonWritingFields (void) — sets defaults on non-writing fields, slay
void dragStart (void) — starts the drag, main character energy 👑
void drag (void) — the drag itself, we love to see it
void dragFinish (void) — finishes the drag, periodt
void setAllPartsActive (SbBool onoroff) — sets all parts active, iconic

✨ Protected Member Functions inherited from SoDragger ✨

SoDragger (void) — constructor, hi bestie 👋
virtual ~SoDragger () — destructor, bye 💀
SbVec2f getNormalizedLocaterPosition (void) — gets normalized locater position, no cap
SbVec2s getLocaterPosition (void) — gets locater position, fr fr
SbVec2s getStartLocaterPosition (void) const — gets start locater position, iykyk
void setStartLocaterPosition (SbVec2s p) — sets start locater position, slay
SbBool isAdequateConstraintMotion (void) — checks if adequate constraint motion, periodt
virtual SbBool shouldGrabBasedOnSurrogate (const SoPath *pickpath, const SoPath *surrogatepath) — should grab based on surrogate, lowkey
void setCameraInfo (SoAction *action) — sets camera info, highkey
virtual void handleEvent (SoHandleEventAction *ha) — handles event, main character energy 👑
void transferMotion (SoDragger *child) — transfers motion, we love that
void setIgnoreInBbox (SbBool newval) — sets ignore in bbox, iconic
SbBool isIgnoreInBbox (void) — is ignore in bbox? vibe check ✅
virtual void getBoundingBox (SoGetBoundingBoxAction *action) — gets bounding box, slay
void setActiveChildDragger (SoDragger *newchilddragger) — sets active child dragger, periodt
SoDragger * getActiveChildDragger (void) const — gets active child dragger, fr fr
void updateDraggerCache (const SoPath *path) — updates dragger cache, iykyk

✨ Protected Member Functions inherited from SoInteractionKit ✨

virtual ~SoInteractionKit () — destructor, bye 💀
virtual void copyContents (const SoFieldContainer *fromFC, SbBool copyConnections) — copies contents, no cap
virtual SbBool setPart (const int partNum, SoNode *node) — sets part, slay
virtual SbBool readInstance (SoInput *in, unsigned short flags) — reads instance, periodt
virtual SbBool setAnyPartAsDefault (const SbName &partname, SoNode *node, SbBool anypart=1, SbBool onlyifdefault=1) — sets any part as default (node version), iconic
virtual SbBool setAnyPartAsDefault (const SbName &partname, const SbName &nodename, SbBool anypart=1, SbBool onlyifdefault=1) — sets any part as default (name version), fr fr
SbBool setAnySurrogatePath (const SbName &name, SoPath *path, SbBool leafcheck=0, SbBool publiccheck=0) — sets any surrogate path, iykyk
void connectSeparatorFields (SoSeparator *dest, SbBool onOff) — connects separator fields, main character energy 👑

✨ Protected Member Functions inherited from SoBaseKit ✨

virtual ~SoBaseKit () — destructor, bye 💀
virtual SoNode * addToCopyDict (void) const — adds to copy dict, no cap
SoGroup * getContainerNode (const SbName &listname, SbBool makeifneeded=1) — gets container node, slay
virtual SoNode * getAnyPart (const SbName &partname, SbBool makeifneeded, SbBool leafcheck=0, SbBool publiccheck=0) — gets any part, periodt
virtual SoNodeKitPath * createPathToAnyPart (const SbName &partname, SbBool makeifneeded, SbBool leafcheck=0, SbBool publiccheck=0, const SoPath *pathtoextend=NULL) — creates path to any part, iconic
virtual SbBool setAnyPart (const SbName &partname, SoNode *from, SbBool anypart=1) — sets any part, fr fr
void createNodekitPartsList (void) — creates nodekit parts list, iykyk
void createFieldList (void) — creates field list, vibe check ✅
virtual void createDefaultParts (void) — creates default parts, main character energy 👑
const SoNodekitParts * getNodekitPartsList (void) const — gets nodekit parts list, slay
const SbList< SoSFNode * > & getCatalogInstances (void) const — gets catalog instances, periodt
void catalogError (void) — catalog error, yikes 😭
void countMyFields (SoOutput *out) — counts my fields, no cap

✨ Protected Member Functions inherited from SoNode ✨

SoNode (void) — constructor, hi 👋
virtual ~SoNode () — destructor, bye 💀

✨ Protected Member Functions inherited from SoFieldContainer ✨

SoFieldContainer (void) — constructor, hi 👋
~SoFieldContainer () — destructor, bye 💀

✨ Protected Member Functions inherited from SoBase ✨

SoBase (void) — constructor, hi 👋
virtual ~SoBase () — destructor, bye 💀
virtual void destroy (void) — destroys, yikes 😭
SbBool hasMultipleWriteRefs (void) const — has multiple write refs? no cap
SbBool writeHeader (SoOutput *out, SbBool isgroup, SbBool isengine) const — writes header, slay
void writeFooter (SoOutput *out) const — writes footer, periodt
virtual const char * getFileFormatName (void) const — gets file format name, iconic

✨ Static Protected Member Functions ✨

static const SoFieldData ** getFieldDataPtr (void) — gets field data ptr, bestie
static const SoNodekitCatalog ** getClassNodekitCatalogPtr (void) — gets class nodekit catalog ptr, no cap
static void startCB (void *f, SoDragger *d) — start callback, main character energy 👑
static void motionCB (void *f, SoDragger *d) — motion callback, slay
static void finishCB (void *f, SoDragger *d) — finish callback, periodt
static void metaKeyChangeCB (void *f, SoDragger *d) — meta key change callback, fr fr
static void fieldSensorCB (void *f, SoSensor *s) — field sensor callback, iykyk
static void valueChangedCB (void *f, SoDragger *d) — value changed callback, vibe check ✅

✨ Static Protected Member Functions inherited from SoDragger ✨

static const SoFieldData ** getFieldDataPtr (void) — gets field data ptr, again 💫
static const SoNodekitCatalog ** getClassNodekitCatalogPtr (void) — gets class nodekit catalog ptr, again
static void childTransferMotionAndValueChangedCB (void *, SoDragger *) — child transfer motion and value changed callback, no cap
static void childValueChangedCB (void *, SoDragger *) — child value changed callback, slay
static void childStartCB (void *, SoDragger *) — child start callback, periodt
static void childMotionCB (void *, SoDragger *) — child motion callback, iconic
static void childFinishCB (void *, SoDragger *) — child finish callback, fr fr
static void childOtherEventCB (void *, SoDragger *) — child other event callback, iykyk

✨ Static Protected Member Functions inherited from SoInteractionKit ✨

static const SoFieldData ** getFieldDataPtr (void) — gets field data ptr, again
static const SoNodekitCatalog ** getClassNodekitCatalogPtr (void) — gets class nodekit catalog ptr, again
static void readDefaultParts (const char *fileName, const char defaultBuffer[], int defBufSize) — reads default parts, main character energy 👑
static void fieldSensorCB (void *, SoSensor *) — field sensor callback, no cap

✨ Static Protected Member Functions inherited from SoBaseKit ✨

static const SoFieldData ** getFieldDataPtr (void) — gets field data ptr, again
static const SoNodekitCatalog ** getClassNodekitCatalogPtr (void) — gets class nodekit catalog ptr, again

✨ Static Protected Member Functions inherited from SoNode ✨

static const SoFieldData ** getFieldDataPtr (void) — gets field data ptr, again
static void setNextActionMethodIndex (int index) — sets next action method index, slay
static int getNextActionMethodIndex (void) — gets next action method index, periodt
static void incNextActionMethodIndex (void) — increments next action method index, fr fr
static void setCompatibilityTypes (const SoType &nodetype, const uint32_t bitmask) — sets compatibility types, iykyk

✨ Static Protected Member Functions inherited from SoBase ✨

static uint32_t getCurrentWriteCounter (void) — gets current write counter, no cap
static void staticDataLock (void) — static data lock, slay
static void staticDataUnlock (void) — static data unlock, periodt

✨ Protected Attributes ✨

SoSFNode XRotator
SoSFNode XRotatorActive
SoSFNode XRotatorSwitch
SoSFNode YRotator
SoSFNode YRotatorActive
SoSFNode YRotatorSwitch
SoSFNode ZRotator
SoSFNode ZRotatorActive
SoSFNode ZRotatorSwitch
SoSFNode antiSquish
SoSFNode rotator
SoSFNode rotatorActive
SoSFNode rotatorSwitch
SoSFNode surroundScale
SoSFNode userAxis
SoSFNode userAxisActive
SoSFNode userAxisRotation
SoSFNode userAxisSwitch
SoSFNode userRotator
SoSFNode userRotatorActive
SoSFNode userRotatorSwitch
SoFieldSensor * rotFieldSensor
SoFieldSensor * scaleFieldSensor

✨ Protected Attributes inherited from SoDragger ✨

SoSFNode motionMatrix — the motion matrix, main character energy 👑

✨ 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

✨ Friends ✨

class SoTrackballDraggerP — bestie class, iykyk

✨ Additional Inherited Members ✨

Public Types inherited from SoDragger

enum ProjectorFrontSetting { FRONT, BACK, USE_PICK } — projector front setting, slay

Public Types inherited from SoInteractionKit

enum CacheEnabled { OFF, ON, AUTO } — cache enabled, periodt

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 } — node types, iconic

Protected Types inherited from SoBase

enum BaseFlags { IS_ENGINE = 0x01, IS_GROUP = 0x02 } — base flags, fr fr

Static Protected Attributes inherited from SoNode

static uint32_t nextUniqueId = 0 — next unique id, no cap
static int nextActionMethodIndex = 0 — next action method index, iykyk

✨ Detailed Description ✨

Okay so the SoTrackballDragger is literally the moment for rotation and scaling interaction, bestie. It gives the end-user all the rotation and scaling possibilities. 💅

Here's how the dragger looks with its default geometry in the inactive state: (imagine the glow-up ✨)

The dragger has three "bands" around a transparent sphere, which when clicked and dragged will rotate around the three principal axes. In addition, the user can define his own rotation axis by holding down a SHIFT key while clicking with the left mouse button and dragging. A new, distinctively colored axis and dragger band will be then be added. 🔥

Free-form rotation on the sphere can be done by clicking and dragging outside the pre-defined "rotation bands". 🌈

Scale operations are made available by holding down a CTRL key when clicking with the left mouse button. The dragger is then in scaling mode, and dragging while holding down the mouse button will uniformly scale the trackball sphere. 👑

For the application programmer's convenience, the Coin library also provides a manipulator class called SoTrackballManip, which wraps the SoTrackballDragger into the necessary mechanisms for making direct insertion of this dragger into a scenegraph possible with very little effort. No cap, it's that easy. 🫶

✨ See also ✨

SoTrackballManip — go check it out, bestie 💖

✨ Constructor & Destructor Documentation ✨

okay bestie, this part is all about how you birth a SoTrackballDragger and how it gets yeeted when its ref count hits zero. let's get into it 💅

🌸 `SoTrackballDragger::SoTrackballDragger (void )` 🌸

Default constructor, and it sets up the dragger nodekit catalog with the interaction and feedback geometry. like, it's giving ✨structured✨.

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

       CLASS SoTrackballDragger
       -->"this"
             "callbackList"
             "topSeparator"
                "motionMatrix"
       -->      "surroundScale"
       -->      "antiSquish"
                "geomSeparator"
       -->         "rotatorSwitch"
       -->            "rotator"
       -->            "rotatorActive"
       -->         "XRotatorSwitch"
       -->            "XRotator"
       -->            "XRotatorActive"
       -->         "YRotatorSwitch"
       -->            "YRotator"
       -->            "YRotatorActive"
       -->         "ZRotatorSwitch"
       -->            "ZRotator"
       -->            "ZRotatorActive"
       -->         "userAxisRotation"
       -->         "userAxisSwitch"
       -->            "userAxis"
       -->            "userAxisActive"
       -->         "userRotatorSwitch"
       -->            "userRotator"
       -->            "userRotatorActive"

(See SoBaseKit::printDiagram() for information about the output formatting.) — yes, that's the function that explains how this diagram prints, iykyk.

Detailed information on catalog parts:

       CLASS SoTrackballDragger
       PVT   "this",  SoTrackballDragger  ---
             "callbackList",  SoNodeKitListPart [ SoCallback, SoEventCallback ]
       PVT   "topSeparator",  SoSeparator  ---
       PVT   "motionMatrix",  SoMatrixTransform  ---
             "surroundScale",  SoSurroundScale  ---
             "antiSquish",  SoAntiSquish  ---
       PVT   "geomSeparator",  SoSeparator  ---
       PVT   "rotatorSwitch",  SoSwitch  ---
             "rotator",  SoSeparator  ---
             "rotatorActive",  SoSeparator  ---
       PVT   "XRotatorSwitch",  SoSwitch  ---
             "XRotator",  SoSeparator  ---
             "XRotatorActive",  SoSeparator  ---
       PVT   "YRotatorSwitch",  SoSwitch  ---
             "YRotator",  SoSeparator  ---
             "YRotatorActive",  SoSeparator  ---
       PVT   "ZRotatorSwitch",  SoSwitch  ---
             "ZRotator",  SoSeparator  ---
             "ZRotatorActive",  SoSeparator  ---
       PVT   "userAxisRotation",  SoRotation  ---
       PVT   "userAxisSwitch",  SoSwitch  ---
             "userAxis",  SoSeparator  ---
             "userAxisActive",  SoSeparator  ---
       PVT   "userRotatorSwitch",  SoSwitch  ---
             "userRotator",  SoSeparator  ---
             "userRotatorActive",  SoSeparator  ---

(See SoBaseKit::printTable() for information about the output formatting.) — that's your cheat sheet for reading this table, bestie.

References SoDragger::addFinishCallback(), SoDragger::addMotionCallback(), SoDragger::addOtherEventCallback(), SoDragger::addStartCallback(), SoDragger::addValueChangedCallback(), fieldSensorCB(), finishCB(), metaKeyChangeCB(), motionCB(), SoInteractionKit::readDefaultParts(), rotation, rotFieldSensor, scaleFactor, scaleFieldSensor, setAllPartsActive(), SoInteractionKit::setPartAsDefault(), setUpConnections(), SoAntiSquish::sizing, SoTrackballDragger(), startCB(), and valueChangedCB().

Referenced by fieldSensorCB(), finishCB(), getFieldData(), motionCB(), SoTrackballDragger(), startCB(), and valueChangedCB().

💅 `SoTrackballDragger::~SoTrackballDragger () [protected]` 💅

Protected destructor. lowkey important: (Dragger classes are derived from SoBase, so they are reference counted and automatically destroyed when their reference count goes to 0.) periodt.

References rotFieldSensor, and scaleFieldSensor.

✨ Member Function Documentation ✨

Okay bestie, here's the whole function tea. ☕💖

`SoType SoTrackballDragger::getTypeId (void ) const [virtual]`

Returns the type identification of an object derived from a class inheriting SoBase. It's 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
  }
  else if (node->getTypeId().isOfType(SoGroup::getClassTypeId())) {
    SoGroup * group = (SoGroup *)node;  // safe downward cast, knows the type
  }
}

For application programmers who want to extend the library with new nodes, engines, nodekits, draggers or others: this method needs to be overridden in all subclasses. That'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.

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 * SoTrackballDragger::getFieldData (void ) const [protected], [virtual]`

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

Reimplemented from SoDragger.

References: SoTrackballDragger().

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

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

Reimplemented from SoDragger.

`SbBool SoTrackballDragger::isAnimationEnabled (void )`

Tells you whether or not the trackball will start a spin animation after a quick drag-and-release. 🌀

⚠️ Note: this feature is not supported yet in the Coin library, so even if TRUE is returned, spin animations will not be possible to trigger.

`void SoTrackballDragger::setAnimationEnabled (SbBool newval)`

Sets a flag which will decide whether or not the trackball will start a spin animation after a quick drag-and-release. 🎛️

⚠️ Note: this feature is not supported yet in the Coin library.

`SbBool SoTrackballDragger::setUpConnections (SbBool onoff, SbBool doitalways = 0) [protected], [virtual]`

Sets up all internal connections for instances of this class. 🔌

(This method will usually not be of interest to the application programmer, unless you want to extend the library with new custom nodekits or dragger classes. If so, see the SoBaseKit class documentation.)

Reimplemented from SoInteractionKit.

References: SoBaseKit::connectionsSetUp, fieldSensorCB(), rotation, rotFieldSensor, scaleFactor, scaleFieldSensor, and SoBaseKit::setUpConnections().
Referenced by: SoTrackballDragger().

`void SoTrackballDragger::setDefaultOnNonWritingFields (void ) [protected], [virtual]`

(Be aware that this method is unlikely to be of interest to the application programmer who does not want to extend the library with new custom nodekits or draggers. If you indeed are writing extensions, see the information in the SoBaseKit class documentation.) 👀

This is a virtual method, and the code in it should call SoField::setDefault() with argument TRUE on part fields that should not be written upon scenegraph export operations.

This is typically done when:

field value is NULL and part is NULL by default
it is a leaf SoGroup or SoSeparator node with no children
it is a leaf listpart with no children and an SoGroup or SoSeparator container
it is a non-leaf part and it's of SoGroup type and all fields are at their default values

Subclasses should usually override this to do additional settings for new member fields. From the subclass, do remember to call "upwards" to your superclass' setDefaultOnNonWritingFields() method.

Reimplemented from SoDragger.

References: SoBaseKit::getAnyPart(), SbRotation::identity(), SoRotation::rotation, SoDragger::setDefaultOnNonWritingFields(), and SoSwitch::whichChild.

`void SoTrackballDragger::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.

References: SoDragger::BACK, SoPath::findNode(), SoDragger::FRONT, SoDragger::getEvent(), SoDragger::getFrontOnProjector(), SoDragger::getMotionMatrix(), SoDragger::getNormalizedLocaterPosition(), SoDragger::getPickPath(), SbRotation::getValue(), SoDragger::getViewVolume(), SoDragger::getWorldStartingPoint(), SbVec3f::length(), SbRotation::multVec(), SbMatrix::multVecMatrix(), SbVec3f::normalize(), SoDebugError::postWarning(), setAllPartsActive(), SoDragger::setStartingPoint(), SoInteractionKit::setSwitchValue(), SbVec3f::setValue(), and SoDragger::USE_PICK.
Referenced by: startCB().

`void SoTrackballDragger::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.

References: SoDragger::appendRotation(), SoDragger::appendScale(), SbVec3f::dot(), SoDragger::getNormalizedLocaterPosition(), SoDragger::getStartMotionMatrix(), SoDragger::getViewVolume(), SoDragger::getWorldStartingPoint(), SbVec3f::length(), SbMatrix::multVecMatrix(), SbVec3f::normalize(), SoDebugError::postWarning(), and SoDragger::setMotionMatrix().
Referenced by: motionCB().

`void SoTrackballDragger::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.

References: SoDragger::getNormalizedLocaterPosition(), SbRotation::getValue(), SoDragger::saveStartParameters(), and setAllPartsActive().
Referenced by: finishCB().

`void SoTrackballDragger::setAllPartsActive (SbBool onoroff) [protected]`

If the input argument is TRUE, all the geometry parts of the dragger will become highlighted, as when active. ✨

Used internally during scaling operations and free-form rotations.

References: SoInteractionKit::setSwitchValue().
Referenced by: dragFinish(), dragStart(), and SoTrackballDragger().

`void SoTrackballDragger::startCB (void * f, SoDragger * d) [static], [protected]`

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

References: dragStart(), SoDragger::SoDragger(), and SoTrackballDragger().
Referenced by: SoTrackballDragger().

`void SoTrackballDragger::motionCB (void * f, SoDragger * d) [static], [protected]`

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

References: drag(), SoDragger::SoDragger(), and SoTrackballDragger().
Referenced by: SoTrackballDragger().

`void SoTrackballDragger::finishCB (void * f, SoDragger * d) [static], [protected]`

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

References: dragFinish(), SoDragger::SoDragger(), and SoTrackballDragger().
Referenced by: SoTrackballDragger().

`void SoTrackballDragger::metaKeyChangeCB (void * f, SoDragger * d) [static], [protected]`

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

References: SoDragger::SoDragger().
Referenced by: SoTrackballDragger().

`void SoTrackballDragger::fieldSensorCB (void * d, SoSensor * s) [static], [protected]`

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

References: SoDragger::getMotionMatrix(), SoDragger::setMotionMatrix(), SoTrackballDragger(), and SoDragger::workFieldsIntoTransform().
Referenced by: setUpConnections(), and SoTrackballDragger().

`void SoTrackballDragger::valueChangedCB (void * f, SoDragger * d) [static], [protected]`

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

References: SoFieldSensor::attach(), SoFieldSensor::detach(), SoDragger::getMotionMatrix(), SbMatrix::getTransform(), rotation, rotFieldSensor, scaleFactor, scaleFieldSensor, SoDragger::SoDragger(), and SoTrackballDragger().
Referenced by: SoTrackballDragger().

✨ Member Data Documentation ✨

`SoSFRotation SoTrackballDragger::rotation`

This field is continuously updated to contain the rotation of the dragger's trackball. 🔄

Referenced by: setUpConnections(), SoTrackballDragger(), and valueChangedCB().

`SoSFVec3f SoTrackballDragger::scaleFactor`

Continuously updated to contain the current vector of scaling along the X, Y and Z axes. The three components will always be equal, as this dragger only supports uniform scale operations. 📏

Referenced by: setUpConnections(), SoTrackballDragger(), and valueChangedCB().

`SoFieldSensor* SoTrackballDragger::rotFieldSensor [protected]`

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

Referenced by: setUpConnections(), SoTrackballDragger(), valueChangedCB(), and ~SoTrackballDragger().

`SoFieldSensor* SoTrackballDragger::scaleFieldSensor [protected]`

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

Referenced by: setUpConnections(), SoTrackballDragger(), valueChangedCB(), and ~SoTrackballDragger().

🌸 Author 🌸

Generated automatically by Doxygen for Coin from the source code.

That's the whole page, bestie! Coin — Version 2.5.0 — SoTrackballDragger(3). Stay iconic! 💅✨🦋

📦 where this page comes from

fedora 43: Coin2-devel 2.5.0-52.fc43 · GPL-2.0-only
fedora 43: Coin2-devel 2.5.0-52.fc43 · GPL-2.0-only
fedora 44: Coin2-devel 2.5.0-54.fc44 · GPL-2.0-only
fedora 44: Coin2-devel 2.5.0-54.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

SoTrackballDragger(3)