SoHandleBoxDragger(3)
✨ NAME ✨
okay so bestie, meet SoHandleBoxDragger 💖 — straight out of the library functions manual, section 3. The whole vibe of this class? interactive scaling and translation. That's it, that's the job, and it does it flawlessly. Say the name with your chest. 💅
🦋 SYNOPSIS 🦋
First things first, you gotta summon the header or nothing works, fr fr:
#include <Inventor/draggers/SoHandleBoxDragger.h>And the family tree? It inherits SoDragger 🧬 — so everything SoDragger can do, this lil icon can do too.
💖 Public Member Functions 💖
Here's what SoHandleBoxDragger brings to the group chat all on its own:
virtual SoType getTypeId (void) const
virtual const SoNodekitCatalog * getNodekitCatalog (void) const
SoHandleBoxDragger (void)🌸 Public Member Functions inherited from SoDragger 🌸
not me listing every single one because we do not skip details in this house 🫶:
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 ®)
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 ⭐
the class's own static besties:
static SoType getClassTypeId (void)
static const SoNodekitCatalog * getClassNodekitCatalog (void)
static void initClass (void)💖 Static Public Member Functions inherited from SoDragger 💖
static SoType getClassTypeId (void)
static const SoNodekitCatalog * getClassNodekitCatalog (void)
static void setMinScale (float newminscale)
static float getMinScale (void)
static void workValuesIntoTransform (SbMatrix &mtx, const SbVec3f *translationptr, const SbRotation *rotationptr, const SbVec3f *scalefactorptr, const SbRotation *scaleorientationptr, const SbVec3f *centerptr)
static void getTransformFast (SbMatrix &mtx, SbVec3f &translation, SbRotation &rotation, SbVec3f &scalefactor, SbRotation &scaleorientation, const SbVec3f ¢er)
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)and that's just the SYNOPSIS, bestie — the real tea keeps coming 👀
✨ Static Public Member Functions inherited from SoFieldContainer ✨
okay bestie, these are the inherited static public member functions from SoFieldContainer. they're lowkey essential and highkey serving. 💅
static void initClass (void)— inherited, still valid, no notes. 🎀static SoType getClassTypeId (void)— yep, it's giving class type ID. ✨static void initCopyDict (void)— a whole vibe. 🦋static void addCopy (const SoFieldContainer *orig, const SoFieldContainer *copy)— add that copy, periodt. 💖static SoFieldContainer * checkCopy (const SoFieldContainer *orig)— check it, bestie. 👑static SoFieldContainer * findCopy (const SoFieldContainer *orig, const SbBool copyconnections)— finders keepers. 🔥static void copyDone (void)— done and dusted. 💅
✨ Static Public Member Functions inherited from SoBase ✨
from SoBase, another icon. 🌸
static void initClass (void)— the classic. 💜static SoType getClassTypeId (void)— type ID, but make it fashion. 🎀static void addName (SoBase *const base, const char *const name)— add a name, slay. ✨static void removeName (SoBase *const base, const char *const name)— remove it, bye. 🦋static void incrementCurrentWriteCounter (void)— up up up. ⭐static void decrementCurrentWriteCounter (void)— down down down. 💫static SoBase * getNamedBase (const SbName &name, SoType type)— get that base. 👑static int getNamedBases (const SbName &name, SoBaseList &baselist, SoType type)— get all the bases. 🔥static SbBool read (SoInput *in, SoBase *&base, SoType expectedtype)— read it and weep. 😭static void setInstancePrefix (const SbString &c)— set that prefix. 💅static void setTraceRefs (SbBool trace)— trace those refs. 🫶static SbBool getTraceRefs (void)— get the trace refs. 💖static SbBool connectRoute (SoInput *in, const SbName &fromnodename, const SbName &fromfieldname, const SbName &tonodename, const SbName &tofieldname)— connect the route, bestie. 🌈static SbBool readRoute (SoInput *in)— read that route. 🎀
✨ Public Attributes ✨
these are the public attributes, and they're giving main character energy. 👑
SoSFVec3f scaleFactor— the scale factor, iconic. 💅SoSFVec3f translation— the translation, also iconic. ✨
✨ Public Attributes inherited from SoDragger ✨
from SoDragger, we love to see it. 💖
SoSFBool isActive— is it active? yes bestie. 🔥
✨ Public Attributes inherited from SoInteractionKit ✨
from SoInteractionKit, more inherited gems. 🦋
SoSFEnum renderCaching— render caching, periodt. 💅SoSFEnum boundingBoxCaching— bounding box caching, slay. ✨SoSFEnum renderCulling— render culling, no cap. 🎀SoSFEnum pickCulling— pick culling, iconic. 👑
✨ Protected Member Functions ✨
these are protected, so don't touch unless you're family. 💅
virtual const SoFieldData * getFieldData (void) const— get that field data. 🎀~SoHandleBoxDragger ()— destructor, bye bestie. 😭virtual SbBool setUpConnections (SbBool onoff, SbBool doitalways=0)— set up those connections. ✨virtual void setDefaultOnNonWritingFields (void)— set the default on non-writing fields. 🦋void dragStart (void)— start the drag. 🔥void drag (void)— do the drag. 💖void dragFinish (void)— finish the drag. 💅void setAllPartsActive (SbBool onoroff)— set all parts active. 👑
✨ Protected Member Functions inherited from SoDragger ✨
from SoDragger, the blueprint. 🌸
SoDragger (void)— constructor, hey. 💜virtual ~SoDragger ()— destructor, bye. 🦋SbVec2f getNormalizedLocaterPosition (void)— get that normalized locater position. ✨SbVec2s getLocaterPosition (void)— get the locater position. 🎀SbVec2s getStartLocaterPosition (void) const— get the start locater position. 👑void setStartLocaterPosition (SbVec2s p)— set it. 🔥SbBool isAdequateConstraintMotion (void)— is it adequate? 💅virtual SbBool shouldGrabBasedOnSurrogate (const SoPath *pickpath, const SoPath *surrogatepath)— should it grab? 🤔void setCameraInfo (SoAction *action)— set camera info. 📸virtual void handleEvent (SoHandleEventAction *ha)— handle that event. 🎀void transferMotion (SoDragger *child)— transfer motion, slay. ✨void setIgnoreInBbox (SbBool newval)— set ignore in bbox. 🦋SbBool isIgnoreInBbox (void)— is it ignoring? 💖virtual void getBoundingBox (SoGetBoundingBoxAction *action)— get that bounding box. 🔥void setActiveChildDragger (SoDragger *newchilddragger)— set active child dragger. 👑SoDragger * getActiveChildDragger (void) const— get it. 💅void updateDraggerCache (const SoPath *path)— update that cache. ✨
✨ Protected Member Functions inherited from SoInteractionKit ✨
from SoInteractionKit, more protected goodness. 🎀
virtual ~SoInteractionKit ()— destructor. 🦋virtual void copyContents (const SoFieldContainer *fromFC, SbBool copyConnections)— copy contents. 💖virtual SbBool setPart (const int partNum, SoNode *node)— set part. 🔥virtual SbBool readInstance (SoInput *in, unsigned short flags)— read instance. 👑virtual SbBool setAnyPartAsDefault (const SbName &partname, SoNode *node, SbBool anypart=1, SbBool onlyifdefault=1)— set any part as default. 💅virtual SbBool setAnyPartAsDefault (const SbName &partname, const SbName &nodename, SbBool anypart=1, SbBool onlyifdefault=1)— the other overload. ✨SbBool setAnySurrogatePath (const SbName &name, SoPath *path, SbBool leafcheck=0, SbBool publiccheck=0)— set any surrogate path. 🎀void connectSeparatorFields (SoSeparator *dest, SbBool onOff)— connect separator fields. 🦋
✨ Protected Member Functions inherited from SoBaseKit ✨
from SoBaseKit, still serving. 💖
virtual ~SoBaseKit ()— destructor. 🔥virtual SoNode * addToCopyDict (void) const— add to copy dict. 👑SoGroup * getContainerNode (const SbName &listname, SbBool makeifneeded=1)— get container node. 💅virtual SoNode * getAnyPart (const SbName &partname, SbBool makeifneeded, SbBool leafcheck=0, SbBool publiccheck=0)— get any part. ✨virtual SoNodeKitPath * createPathToAnyPart (const SbName &partname, SbBool makeifneeded, SbBool leafcheck=0, SbBool publiccheck=0, const SoPath *pathtoextend=NULL)— create path to any part. 🎀virtual SbBool setAnyPart (const SbName &partname, SoNode *from, SbBool anypart=1)— set any part. 🦋void createNodekitPartsList (void)— create nodekit parts list. 💖void createFieldList (void)— create field list. 🔥virtual void createDefaultParts (void)— create default parts. 👑const SoNodekitParts * getNodekitPartsList (void) const— get nodekit parts list. 💅const SbList< SoSFNode * > & getCatalogInstances (void) const— get catalog instances. ✨void catalogError (void)— catalog error. 😭void countMyFields (SoOutput *out)— count my fields. 🎀
✨ Protected Member Functions inherited from SoNode ✨
from SoNode, the blueprint. 🦋
SoNode (void)— constructor. 💖virtual ~SoNode ()— destructor. 🔥
✨ Protected Member Functions inherited from SoFieldContainer ✨
from SoFieldContainer, more. 👑
SoFieldContainer (void)— constructor. 💅~SoFieldContainer ()— destructor. ✨
✨ Protected Member Functions inherited from SoBase ✨
from SoBase, the foundation. 🎀
SoBase (void)— constructor. 🦋virtual ~SoBase ()— destructor. 💖virtual void destroy (void)— destroy. 🔥SbBool hasMultipleWriteRefs (void) const— has multiple write refs? 👑SbBool writeHeader (SoOutput *out, SbBool isgroup, SbBool isengine) const— write header. 💅void writeFooter (SoOutput *out) const— write footer. ✨virtual const char * getFileFormatName (void) const— get file format name. 🎀
✨ Static Protected Member Functions ✨
static protected, bestie. 🦋
static const SoFieldData ** getFieldDataPtr (void)— get field data ptr. 💖static const SoNodekitCatalog ** getClassNodekitCatalogPtr (void)— get class nodekit catalog ptr. 🔥static void startCB (void *f, SoDragger *d)— start callback. 👑static void motionCB (void *f, SoDragger *d)— motion callback. 💅static void finishCB (void *f, SoDragger *d)— finish callback. ✨static void metaKeyChangeCB (void *f, SoDragger *d)— meta key change callback. 🎀static void fieldSensorCB (void *f, SoSensor *s)— field sensor callback. 🦋static void valueChangedCB (void *f, SoDragger *d)— value changed callback. 💖
✨ Static Protected Member Functions inherited from SoDragger ✨
from SoDragger, callbacks galore. 🔥
static const SoFieldData ** getFieldDataPtr (void)— get field data ptr. 👑static const SoNodekitCatalog ** getClassNodekitCatalogPtr (void)— get class nodekit catalog ptr. 💅static void childTransferMotionAndValueChangedCB (void *, SoDragger *)— child transfer motion and value changed callback. ✨static void childValueChangedCB (void *, SoDragger *)— child value changed callback. 🎀static void childStartCB (void *, SoDragger *)— child start callback. 🦋static void childMotionCB (void *, SoDragger *)— child motion callback. 💖static void childFinishCB (void *, SoDragger *)— child finish callback. 🔥static void childOtherEventCB (void *, SoDragger *)— child other event callback. 👑
✨ Static Protected Member Functions inherited from SoInteractionKit ✨
from SoInteractionKit, more static protected. 💅
static const SoFieldData ** getFieldDataPtr (void)— get field data ptr. ✨static const SoNodekitCatalog ** getClassNodekitCatalogPtr (void)— get class nodekit catalog ptr. 🎀static void readDefaultParts (const char *fileName, const char defaultBuffer[], int defBufSize)— read default parts. 🦋static void fieldSensorCB (void *, SoSensor *)— field sensor callback. 💖
✨ Static Protected Member Functions inherited from SoBaseKit ✨
from SoBaseKit, still going. 🔥
static const SoFieldData ** getFieldDataPtr (void)— get field data ptr. 👑static const SoNodekitCatalog ** getClassNodekitCatalogPtr (void)— get class nodekit catalog ptr. 💅
✨ Static Protected Member Functions inherited from SoNode ✨
from SoNode, static protected. ✨
static const SoFieldData ** getFieldDataPtr (void)— get field data ptr. 🎀static void setNextActionMethodIndex (int index)— set next action method index. 🦋static int getNextActionMethodIndex (void)— get next action method index. 💖static void incNextActionMethodIndex (void)— inc next action method index. 🔥static void setCompatibilityTypes (const SoType &nodetype, const uint32_t bitmask)— set compatibility types. 👑
✨ Static Protected Member Functions inherited from SoBase ✨
from SoBase, the final static protected batch. 💅
static uint32_t getCurrentWriteCounter (void)— get current write counter. ✨static void staticDataLock (void)— static data lock. 🎀static void staticDataUnlock (void)— static data unlock. 🦋
✨ Protected Attributes ✨
protected attributes, so many. 💖
SoSFNode arrow1— arrow1. 🔥SoSFNode arrow1Switch— arrow1Switch. 👑SoSFNode arrow2— arrow2. 💅SoSFNode arrow2Switch— arrow2Switch. ✨SoSFNode arrow3— arrow3. 🎀SoSFNode arrow3Switch— arrow3Switch. 🦋SoSFNode arrow4— arrow4. 💖SoSFNode arrow4Switch— arrow4Switch. 🔥SoSFNode arrow5— arrow5. 👑SoSFNode arrow5Switch— arrow5Switch. 💅SoSFNode arrow6— arrow6. ✨SoSFNode arrow6Switch— arrow6Switch. 🎀SoSFNode arrowTranslation— arrowTranslation. 🦋SoSFNode drawStyle— drawStyle. 💖SoSFNode extruder1— extruder1. 🔥SoSFNode extruder1Active— extruder1Active. 👑SoSFNode extruder1Switch— extruder1Switch. 💅SoSFNode extruder2— extruder2. ✨SoSFNode extruder2Active— extruder2Active. 🎀SoSFNode extruder2Switch— extruder2Switch. 🦋SoSFNode extruder3— extruder3. 💖SoSFNode extruder3Active— extruder3Active. 🔥SoSFNode extruder3Switch— extruder3Switch. 👑SoSFNode extruder4— extruder4. 💅SoSFNode extruder4Active— extruder4Active. ✨SoSFNode extruder4Switch— extruder4Switch. 🎀SoSFNode extruder5— extruder5. 🦋SoSFNode extruder5Active— extruder5Active. 💖SoSFNode extruder5Switch— extruder5Switch. 🔥SoSFNode extruder6— extruder6. 👑SoSFNode extruder6Active— extruder6Active. 💅SoSFNode extruder6Switch— extruder6Switch. ✨SoSFNode surroundScale— surroundScale. 🎀SoSFNode translator1— translator1. 🦋SoSFNode translator1Active— translator1Active. 💖SoSFNode translator1Switch— translator1Switch. 🔥SoSFNode translator2— translator2. 👑SoSFNode translator2Active— translator2Active. 💅SoSFNode translator2Switch— translator2Switch. ✨SoSFNode translator3— translator3. 🎀SoSFNode translator3Active— translator3Active. 🦋SoSFNode translator3Switch— translator3Switch. 💖SoSFNode translator4— translator4. 🔥SoSFNode translator4Active— translator4Active. 👑SoSFNode translator4Switch— translator4Switch. 💅SoSFNode translator5— translator5. ✨SoSFNode translator5Active— translator5Active. 🎀SoSFNode translator5Switch— translator5Switch. 🦋SoSFNode translator6— translator6. 💖SoSFNode translator6Active— translator6Active. 🔥SoSFNode translator6Switch— translator6Switch. 👑SoSFNode uniform1— uniform1. 💅SoSFNode uniform1Active— uniform1Active. ✨SoSFNode uniform1Switch— uniform1Switch. 🎀SoSFNode uniform2— uniform2. 🦋SoSFNode uniform2Active— uniform2Active. 💖SoSFNode uniform2Switch— uniform2Switch. 🔥SoSFNode uniform3— uniform3. 👑SoSFNode uniform3Active— uniform3Active. 💅SoSFNode uniform3Switch— uniform3Switch. ✨SoSFNode uniform4— uniform4. 🎀SoSFNode uniform4Active— uniform4Active. 🦋SoSFNode uniform4Switch— uniform4Switch. 💖SoSFNode uniform5— uniform5. 🔥SoSFNode uniform5Active— uniform5Active. 👑SoSFNode uniform5Switch— uniform5Switch. 💅SoSFNode uniform6— uniform6. ✨SoSFNode uniform6Active— uniform6Active. 🎀SoSFNode uniform6Switch— uniform6Switch. 🦋SoSFNode uniform7— uniform7. 💖SoSFNode uniform7Active— uniform7Active. 🔥SoSFNode uniform7Switch— uniform7Switch. 👑SoSFNode uniform8— uniform8. 💅SoSFNode uniform8Active— uniform8Active. ✨SoSFNode uniform8Switch— uniform8Switch. 🎀SoFieldSensor * translFieldSensor— translFieldSensor. 🦋SoFieldSensor * scaleFieldSensor— scaleFieldSensor. 💖
✨ Protected Attributes inherited from SoDragger ✨
from SoDragger, one attribute. 🔥
SoSFNode motionMatrix— motionMatrix. 👑
✨ Protected Attributes inherited from SoInteractionKit ✨
from SoInteractionKit, four attributes. 💅
SoSFNode geomSeparator— geomSeparator. ✨SoSFNode topSeparator— topSeparator. 🎀SoFieldSensor * fieldSensor— fieldSensor. 🦋SoSeparator * oldTopSep— oldTopSep. 💖
✨ Protected Attributes inherited from SoBaseKit ✨
from SoBaseKit, three attributes. 🔥
SoSFNode callbackList— callbackList. 👑SoChildList * children— children. 💅SbBool connectionsSetUp— connectionsSetUp. ✨
✨ Protected Attributes inherited from SoNode ✨
from SoNode, one attribute. 🎀
uint32_t uniqueId— uniqueId. 🦋
✨ Protected Attributes inherited from SoFieldContainer ✨
from SoFieldContainer, one attribute. 💖
SbBool isBuiltIn— isBuiltIn. 🔥
✨ Additional Inherited Members ✨
okay bestie, here's the extra inherited stuff. 👑
✨ Public Types inherited from SoDragger ✨
enum ProjectorFrontSetting { FRONT, BACK, USE_PICK }— the projector front setting options. 💅
✨ Public Types inherited from SoInteractionKit ✨
enum CacheEnabled { OFF, ON, AUTO }— cache enabled options. ✨
✨ 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, periodt. 🎀
✨ Protected Types inherited from SoBase ✨
enum BaseFlags { IS_ENGINE = 0x01, IS_GROUP = 0x02 }— base flags. 🦋
✨ Static Protected Attributes inherited from SoNode ✨
static uint32_t nextUniqueId = 0— next unique ID. 💖static int nextActionMethodIndex = 0— next action method index. 🔥
🎀 Detailed Description 🎀
Okay bestie, gather round, because the SoHandleBoxDragger class is literally the moment. 💅 It provides support for interactive scaling and translation. That's the whole vibe.
Here's how the dragger looks with its default geometry in the inactive state:
🖼️ (the manpage has a picture right here of the dragger sitting there, chilling, in its inactive state)
A handlebox dragger is convenient to use for letting the user interact with geometry that can be scaled (uniformly or in a non-uniform way) and translated in 3D. Like, both. In three dee. Iconic behavior, no cap. ✨
The dragger consists of a "cube" of interaction geometry. The end-user can click and drag any side of the cube to translate the dragger and click and drag any of the corner or edge markers for scaling operations. So: sides = move it, corners & edges = resize it. That's the whole user experience, and honestly? She ate. 🍓
🛠️ Constructor & Destructor Documentation
SoHandleBoxDragger::SoHandleBoxDragger (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 SoHandleBoxDragger
-->"this"
"callbackList"
"topSeparator"
"motionMatrix"
--> "surroundScale"
"geomSeparator"
--> "drawStyle"
--> "translator1Switch"
--> "translator1"
--> "translator1Active"
--> "translator2Switch"
--> "translator2"
--> "translator2Active"
--> "translator3Switch"
--> "translator3"
--> "translator3Active"
--> "translator4Switch"
--> "translator4"
--> "translator4Active"
--> "translator5Switch"
--> "translator5"
--> "translator5Active"
--> "translator6Switch"
--> "translator6"
--> "translator6Active"
--> "extruder1Switch"
--> "extruder1"
--> "extruder1Active"
--> "extruder2Switch"
--> "extruder2"
--> "extruder2Active"
--> "extruder3Switch"
--> "extruder3"
--> "extruder3Active"
--> "extruder4Switch"
--> "extruder4"
--> "extruder4Active"
--> "extruder5Switch"
--> "extruder5"
--> "extruder5Active"
--> "extruder6Switch"
--> "extruder6"
--> "extruder6Active"
--> "uniform1Switch"
--> "uniform1"
--> "uniform1Active"
--> "uniform2Switch"
--> "uniform2"
--> "uniform2Active"
--> "uniform3Switch"
--> "uniform3"
--> "uniform3Active"
--> "uniform4Switch"
--> "uniform4"
--> "uniform4Active"
--> "uniform5Switch"
--> "uniform5"
--> "uniform5Active"
--> "uniform6Switch"
--> "uniform6"
--> "uniform6Active"
--> "uniform7Switch"
--> "uniform7"
--> "uniform7Active"
--> "uniform8Switch"
--> "uniform8"
--> "uniform8Active"
--> "arrowTranslation"
--> "arrow1Switch"
--> "arrow1"
--> "arrow2Switch"
--> "arrow2"
--> "arrow3Switch"
--> "arrow3"
--> "arrow4Switch"
--> "arrow4"
--> "arrow5Switch"
--> "arrow5"
--> "arrow6Switch"
--> "arrow6"(See SoBaseKit::printDiagram() for information about the output formatting.)
Detailed information on catalog parts:
CLASS SoHandleBoxDragger
PVT "this", SoHandleBoxDragger ---
"callbackList", SoNodeKitListPart [ SoCallback, SoEventCallback ]
PVT "topSeparator", SoSeparator ---
PVT "motionMatrix", SoMatrixTransform ---
"surroundScale", SoSurroundScale ---
PVT "geomSeparator", SoSeparator ---
PVT "drawStyle", SoDrawStyle ---
PVT "translator1Switch", SoSwitch ---
"translator1", SoSeparator ---
"translator1Active", SoSeparator ---
PVT "translator2Switch", SoSwitch ---
"translator2", SoSeparator ---
"translator2Active", SoSeparator ---
PVT "translator3Switch", SoSwitch ---
"translator3", SoSeparator ---
"translator3Active", SoSeparator ---
PVT "translator4Switch", SoSwitch ---
"translator4", SoSeparator ---
"translator4Active", SoSeparator ---
PVT "translator5Switch", SoSwitch ---
"translator5", SoSeparator ---
"translator5Active", SoSeparator ---
PVT "translator6Switch", SoSwitch ---
"translator6", SoSeparator ---
"translator6Active", SoSeparator ---
PVT "extruder1Switch", SoSwitch ---
"extruder1", SoSeparator ---
"extruder1Active", SoSeparator ---
PVT "extruder2Switch", SoSwitch ---
"extruder2", SoSeparator ---
"extruder2Active", SoSeparator ---
PVT "extruder3Switch", SoSwitch ---
"extruder3", SoSeparator ---
"extruder3Active", SoSeparator ---
PVT "extruder4Switch", SoSwitch ---
"extruder4", SoSeparator ---
"extruder4Active", SoSeparator ---
PVT "extruder5Switch", SoSwitch ---
"extruder5", SoSeparator ---
"extruder5Active", SoSeparator ---
PVT "extruder6Switch", SoSwitch ---
"extruder6", SoSeparator ---
"extruder6Active", SoSeparator ---
PVT "uniform1Switch", SoSwitch ---
"uniform1", SoSeparator ---
"uniform1Active", SoSeparator ---
PVT "uniform2Switch", SoSwitch ---
"uniform2", SoSeparator ---
"uniform2Active", SoSeparator ---
PVT "uniform3Switch", SoSwitch ---
"uniform3", SoSeparator ---
"uniform3Active", SoSeparator ---
PVT "uniform4Switch", SoSwitch ---
"uniform4", SoSeparator ---
"uniform4Active", SoSeparator ---
PVT "uniform5Switch", SoSwitch ---
"uniform5", SoSeparator ---
"uniform5Active", SoSeparator ---
PVT "uniform6Switch", SoSwitch ---
"uniform6", SoSeparator ---
"uniform6Active", SoSeparator ---
PVT "uniform7Switch", SoSwitch ---
"uniform7", SoSeparator ---
"uniform7Active", SoSeparator ---
PVT "uniform8Switch", SoSwitch ---
"uniform8", SoSeparator ---
"uniform8Active", SoSeparator ---
PVT "arrowTranslation", SoTranslation ---
PVT "arrow1Switch", SoSwitch ---
"arrow1", SoSeparator ---
PVT "arrow2Switch", SoSwitch ---
"arrow2", SoSeparator ---
PVT "arrow3Switch", SoSwitch ---
"arrow3", SoSeparator ---
PVT "arrow4Switch", SoSwitch ---
"arrow4", SoSeparator ---
PVT "arrow5Switch", SoSwitch ---
"arrow5", SoSeparator ---
PVT "arrow6Switch", SoSwitch ---
"arrow6", SoSeparator ---(See SoBaseKit::printTable() for information about the output formatting.)
References SoDragger::addFinishCallback(), SoDragger::addMotionCallback(), SoDragger::addOtherEventCallback(), SoDragger::addStartCallback(), SoDragger::addValueChangedCallback(), fieldSensorCB(), finishCB(), metaKeyChangeCB(), motionCB(), SoInteractionKit::readDefaultParts(), scaleFactor, scaleFieldSensor, setAllPartsActive(), SoInteractionKit::setPartAsDefault(), setUpConnections(), SoHandleBoxDragger(), startCB(), translation, translFieldSensor, and valueChangedCB().
Referenced by fieldSensorCB(), finishCB(), getFieldData(), metaKeyChangeCB(), motionCB(), SoHandleBoxDragger(), startCB(), and valueChangedCB().
SoHandleBoxDragger::~SoHandleBoxDragger () [protected]
Protected destructor. 🫶 She's not for public consumption, bestie, she's protected.
(Dragger classes are derived from SoBase, so they are reference counted and automatically destroyed when their reference count goes to 0.) So like — when the last person holding a ref lets go, she's gone. Poof. 💀 But the counting handles it, you don't have to.
References scaleFieldSensor, and translFieldSensor.
💖 Member Function Documentation 💖
SoType SoHandleBoxDragger::getTypeId (void ) const [virtual]
Okay bestie, this one hands you back the type identification of any object derived from a class that inherits SoBase. What's it for? Run-time type checking, and "downward" casting. iykyk. 💅
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
}
}Now, for the application programmers out there who wanna extend the library with brand new nodes, engines, nodekits, draggers or whatever else — this method needs to be overridden in all subclasses. No skipping, fr fr. This is typically done as part of setting up the full type system for extension classes, which is usually accomplished by using the pre-defined macros available through, for instance, Inventor/nodes/SoSubNode.h (that's SO_NODE_INIT_CLASS and SO_NODE_CONSTRUCTOR for node classes), Inventor/engines/SoSubEngine.h (for engine classes), and so on and so forth. 🌈
Want more tea on writing Coin extensions? Go check the class documentation of the toplevel superclasses for the various class groups. 👑
Reimplemented from SoDragger.
const SoFieldData * SoHandleBoxDragger::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. That's it, that's the whole vibe. 🫶
Reimplemented from SoDragger.
References: SoHandleBoxDragger().
const SoNodekitCatalog * SoHandleBoxDragger::getNodekitCatalog (void ) const [virtual]
Returns the nodekit catalog which defines the layout of this class' kit. It's giving floor plan energy. ✨
Reimplemented from SoDragger.
SbBool SoHandleBoxDragger::setUpConnections (SbBool onoff, SbBool doitalways = 0) [protected], [virtual]
Sets up all internal connections for instances of this class. 🔗
(Quick heads up: this method will usually not be of interest to the application programmer, unless you're trying to extend the library with new custom nodekits or dragger classes. If that's you, go read the SoBaseKit class documentation. Go on, I'll wait. 💖)
Reimplemented from SoInteractionKit.
References: SoBaseKit::connectionsSetUp, fieldSensorCB(), scaleFactor, scaleFieldSensor, SoBaseKit::setUpConnections(), translation, and translFieldSensor.
Referenced by: SoHandleBoxDragger().
void SoHandleBoxDragger::setDefaultOnNonWritingFields (void ) [protected], [virtual]
(Bestie, 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. But 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
NULLand part isNULLby default - it is a leaf
SoGrouporSoSeparatornode with no children - it is a leaf listpart with no children and an
SoGrouporSoSeparatorcontainer - it is a non-leaf part and it's of
SoGrouptype 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. Don't leave your superclass on read, okay? 😭
Reimplemented from SoDragger.
References: SoDragger::setDefaultOnNonWritingFields().
void SoHandleBoxDragger::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 SoHandleBoxDragger().
Referenced by: SoHandleBoxDragger().
void SoHandleBoxDragger::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 SoHandleBoxDragger().
Referenced by: SoHandleBoxDragger().
void SoHandleBoxDragger::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 SoHandleBoxDragger().
Referenced by: SoHandleBoxDragger().
void SoHandleBoxDragger::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: drag(), SoDragger::getEvent(), SoDragger::isActive, SoDragger::SoDragger(), and SoHandleBoxDragger().
Referenced by: SoHandleBoxDragger().
void SoHandleBoxDragger::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(), SoHandleBoxDragger(), and SoDragger::workFieldsIntoTransform().
Referenced by: setUpConnections(), and SoHandleBoxDragger().
void SoHandleBoxDragger::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(), scaleFactor, scaleFieldSensor, SoDragger::SoDragger(), SoHandleBoxDragger(), translation, and translFieldSensor.
Referenced by: SoHandleBoxDragger().
void SoHandleBoxDragger::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. It's giving main character energy. 👑
References: SoPath::findNode(), SbLine::getClosestPoint(), SoDragger::getEvent(), SoDragger::getLocalStartingPoint(), SoDragger::getLocalToWorldMatrix(), SoDragger::getPickPath(), SbString::getString(), SbMatrix::multVecMatrix(), SbString::sprintf(), SoTranslation::translation, and SoEvent::wasCtrlDown().
Referenced by: startCB().
void SoHandleBoxDragger::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. Slay, literally. ✨
References: SoDragger::appendScale(), SoDragger::appendTranslation(), SoDragger::getEvent(), SoDragger::getLocalStartingPoint(), SoDragger::getLocalToWorldMatrix(), SoDragger::getNormalizedLocaterPosition(), SoDragger::getStartMotionMatrix(), SoDragger::getViewVolume(), SoDragger::getWorldToLocalMatrix(), SoDragger::isAdequateConstraintMotion(), SbMatrix::multVecMatrix(), SoDragger::setMotionMatrix(), and SoDragger::setStartLocaterPosition().
Referenced by: metaKeyChangeCB(), and motionCB().
void SoHandleBoxDragger::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. Bye bestie, hands off. 🫶
References: setAllPartsActive().
Referenced by: finishCB().
void SoHandleBoxDragger::setAllPartsActive (SbBool onoroff) [protected]
Activate or deactive all dragger geometry parts. That's the whole job. 💜
References: SbString::getString(), SoInteractionKit::setSwitchValue(), and SbString::sprintf().
Referenced by: dragFinish(), and SoHandleBoxDragger().
👑 Member Data Documentation 👑
SoSFVec3f SoHandleBoxDragger::scaleFactor
Continuously updated to contain the current vector of scaling along the X, Y and Z axes. It's tracking the vibes in 3D. 🌈
Referenced by: setUpConnections(), SoHandleBoxDragger(), and valueChangedCB().
SoSFVec3f SoHandleBoxDragger::translation
Continuously updated to contain the current translation from the dragger's local origo position. 📍
The application programmer applying this dragger in his code should connect the relevant node fields in the scene to this field to make it follow the dragger. No cap, that's how you make it move. 💫
Referenced by: setUpConnections(), SoHandleBoxDragger(), and valueChangedCB().
SoFieldSensor* SoHandleBoxDragger::translFieldSensor [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(), SoHandleBoxDragger(), valueChangedCB(), and ~SoHandleBoxDragger().
SoFieldSensor* SoHandleBoxDragger::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(), SoHandleBoxDragger(), valueChangedCB(), and ~SoHandleBoxDragger().
🌸 Author 🌸
Generated automatically by Doxygen for Coin from the source code. 🤖✨
That's a wrap, bestie! 🎀 This whole page came straight out of Coin, Version 2.5.0, and it's all about SoHandleBoxDragger(3) — go forth and drag those boxes, you icon. 💅🦋
📦 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 : a language model's rewrite of the original, under its terms