SoHandleBoxDragger(3)

📦 version 3.1.3, in fedora 43, fedora 44

🌸 SoHandleBoxDragger 🌸

okay so before we even get into it — hi bestie, this is the SoHandleBoxDragger(3) page, from the Library Functions Manual. She's a whole vibe and she's about to hand you interactive scaling AND translation in one gorgeous package. let's get into it 💅

✨ NAME ✨

SoHandleBoxDragger — the class that gives you support for interactive scaling and translation. that's it, that's the girl. 🎀

🦋 SYNOPSIS 🦋

#include <Inventor/draggers/SoHandleBoxDragger.h>

Inherits SoDragger. (so she's got a whole family tree, and we're listing every single one of them because we love thoroughness in this house ✨)

💖 Public Member Functions 💖

virtual SoType getTypeId (void) const
virtual const SoNodekitCatalog * getNodekitCatalog (void) const
SoHandleBoxDragger (void)

🫶 Public Member Functions inherited from SoDragger 🫶

like, she inherits ALL of this. it's giving generous.

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

🧚 Public Member Functions inherited from SoInteractionKit 🧚

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

🌈 Public Member Functions inherited from SoBaseKit 🌈

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

💜 Public Member Functions inherited from SoNode 💜

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

🍓 Public Member Functions inherited from SoFieldContainer 🍓

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

🎀 Public Member Functions inherited from SoBase 🎀

void ref (void) const
void unref (void) const
void unrefNoDelete (void) const
int32_t getRefCount (void) const
void touch (void)
SbBool isOfType (SoType type) const
virtual SbName getName (void) const
virtual void setName (const SbName &newname)
void addAuditor (void *const auditor, const SoNotRec::Type type)
void removeAuditor (void *const auditor, const SoNotRec::Type type)
const SoAuditorList & getAuditors (void) const
SbBool shouldWrite (void)
void assertAlive (void) const

⭐ Static Public Member Functions ⭐

the static girlies — no instance needed, they just exist:

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

💫 Static Public Member Functions inherited from SoDragger 💫

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

🌟 Static Public Member Functions inherited from SoInteractionKit 🌟

static SoType getClassTypeId (void)
static const SoNodekitCatalog * getClassNodekitCatalog (void)
static void initClass (void)
static void setSwitchValue (SoNode *node, const int newVal)

🦄 Static Public Member Functions inherited from SoBaseKit 🦄

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

🔥 Static Public Member Functions inherited from SoNode 🔥

okay this one's a whole list, she's popular:

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 rest is coming — stay with me, we are SO not done here 🫶

💫 Static Public Member Functions inherited from SoFieldContainer 💫

bestie these are the ones your class gets handed down like vintage jeans from a cooler older cousin 🫶

  • static void initClass (void) — sets the class up so the whole type system knows it exists
  • static SoType getClassTypeId (void) — hands you back the SoType for this class
  • static void cleanupClass (void) — the tidy-up-at-the-end girlie
  • static void initCopyDict (void) — kicks off the copy dictionary
  • static void addCopy (const SoFieldContainer *orig, const SoFieldContainer *copy) — files a copy under its original
  • static SoFieldContainer * checkCopy (const SoFieldContainer *orig) — "is this one already in the dict?" energy
  • static SoFieldContainer * findCopy (const SoFieldContainer *orig, const SbBool copyconnections) — goes looking for the copy, connections and all
  • static void copyDone (void) — copy session over, bye 💅

🦋 Static Public Member Functions inherited from SoBase 🦋

  • static void initClass (void) — classic initClass, iconic, never misses
  • static SoType getClassTypeId (void) — the SoType please and thank you
  • static void addName (SoBase *const base, const char *const name) — gives a base a name
  • static void removeName (SoBase *const base, const char *const name) — takes that name right back
  • 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) — finds a named base of a given type
  • static int getNamedBases (const SbName &name, SoBaseList &baselist, SoType type) — same vibe but it collects them all into baselist and returns a count
  • static SbBool read (SoInput *input, SoBase *&base, SoType expectedtype) — reads a base in from input
  • static void setInstancePrefix (const SbString &c) — sets the instance prefix string
  • static void setTraceRefs (SbBool trace) — turns ref tracing on or off
  • static SbBool getTraceRefs (void) — tells you if ref tracing is on
  • static SbBool connectRoute (SoInput *input, const SbName &fromnodename, const SbName &fromfieldname, const SbName &tonodename, const SbName &tofieldname) — wires up a route from one node/field to another
  • static SbBool readRoute (SoInput *input) — reads a route in

👑 Public Attributes 👑

  • SoSFVec3f scaleFactor — the scale factor, a 3-float vector, doing the most ✨
  • SoSFVec3f translation — the translation vector, also 3 floats, also slaying

Public Attributes inherited from SoDragger

  • SoSFBool isActive — are we active rn? a bool, a mood

Public Attributes inherited from SoInteractionKit

  • SoSFEnum renderCaching — render caching mode, an enum
  • SoSFEnum boundingBoxCaching — bounding box caching mode, an enum
  • SoSFEnum renderCulling — render culling mode, an enum
  • SoSFEnum pickCulling — pick culling mode, an enum

🎀 Protected Member Functions 🎀

  • virtual const SoFieldData * getFieldData (void) const — the field data hookup, const-correct and unbothered
  • virtual ~SoHandleBoxDragger (void) — the destructor, virtual as ever
  • virtual SbBool setUpConnections (SbBool onoff, SbBool doitalways=FALSE) — sets up (or tears down) the connections
  • virtual void setDefaultOnNonWritingFields (void) — sets defaults on the non-writing fields
  • void dragStart (void) — a drag begins, it's giving beginning
  • void drag (void) — mid-drag, the main character moment
  • void dragFinish (void) — drag's done, credits roll
  • void setAllPartsActive (SbBool onoroff) — flips every part active or not, all at once

Protected Member Functions inherited from SoDragger

  • SoDragger (void) — the constructor
  • virtual ~SoDragger (void) — the destructor
  • SbVec2f getNormalizedLocaterPosition (void) — the locater position, but normalized
  • SbVec2s getLocaterPosition (void) — the locater position, unnormalized, raw, unfiltered
  • SbVec2s getStartLocaterPosition (void) const — where the locater started, const
  • void setStartLocaterPosition (SbVec2s p) — sets where the locater started to p
  • SbBool isAdequateConstraintMotion (void) — is this motion adequate for the constraint?
  • virtual SbBool shouldGrabBasedOnSurrogate (const SoPath *pickpath, const SoPath *surrogatepath) — should we grab based on the surrogate path?
  • void setCameraInfo (SoAction *action) — stashes camera info from action
  • virtual void handleEvent (SoHandleEventAction *ha) — handles the event, as one does
  • void transferMotion (SoDragger *child) — passes motion along to the child dragger
  • void setIgnoreInBbox (SbBool newval) — sets whether to ignore this in the bbox
  • SbBool isIgnoreInBbox (void) — are we ignoring it in the bbox? asking for a friend
  • virtual void getBoundingBox (SoGetBoundingBoxAction *action) — fetches the bounding box
  • void setActiveChildDragger (SoDragger *newchilddragger) — sets the active child dragger
  • SoDragger * getActiveChildDragger (void) const — gets the active child dragger
  • void updateDraggerCache (const SoPath *path) — refreshes the dragger cache for path

Protected Member Functions inherited from SoInteractionKit

  • virtual ~SoInteractionKit () — destructor
  • virtual void copyContents (const SoFieldContainer *fromFC, SbBool copyConnections) — copies the contents over, connections optional
  • virtual SbBool setPart (const int partNum, SoNode *node) — sets a part by number
  • virtual SbBool readInstance (SoInput *in, unsigned short flags) — reads the instance
  • virtual SbBool setAnyPartAsDefault (const SbName &partname, SoNode *node, SbBool anypart=TRUE, SbBool onlyifdefault=TRUE) — sets any part as default, from a node
  • virtual SbBool setAnyPartAsDefault (const SbName &partname, const SbName &nodename, SbBool anypart=TRUE, SbBool onlyifdefault=TRUE) — same thing but from a node name
  • SbBool setAnySurrogatePath (const SbName &name, SoPath *path, SbBool leafcheck=FALSE, SbBool publiccheck=FALSE) — sets a surrogate path
  • void connectSeparatorFields (SoSeparator *dest, SbBool onOff) — connects the separator fields on dest

Protected Member Functions inherited from SoBaseKit

  • virtual ~SoBaseKit () — destructor
  • virtual SoNode * addToCopyDict (void) const — adds this to the copy dict, const
  • SoGroup * getContainerNode (const SbName &listname, SbBool makeifneeded=TRUE) — gets the container node for a list
  • virtual SoNode * getAnyPart (const SbName &partname, SbBool makeifneeded, SbBool leafcheck=FALSE, SbBool publiccheck=FALSE) — gets any part by name
  • virtual SoNodeKitPath * createPathToAnyPart (const SbName &partname, SbBool makeifneeded, SbBool leafcheck=FALSE, SbBool publiccheck=FALSE, const SoPath *pathtoextend=NULL) — builds a path all the way to any part
  • virtual SbBool setAnyPart (const SbName &partname, SoNode *from, SbBool anypart=TRUE) — sets any part from a node
  • void createNodekitPartsList (void) — makes the nodekit parts list
  • void createFieldList (void) — makes the field list
  • virtual void createDefaultParts (void) — makes the default parts
  • const SoNodekitParts * getNodekitPartsList (void) const — gets the nodekit parts list
  • const SbList< SoSFNode * > & getCatalogInstances (void) const — gets the catalog instances list
  • void catalogError (void) — the catalog error handler, we don't talk about her 🙈
  • void countMyFields (SoOutput *out) — counts the fields into out

Protected Member Functions inherited from SoNode

  • SoNode (void) — constructor
  • virtual ~SoNode () — destructor

Protected Member Functions inherited from SoFieldContainer

  • SoFieldContainer (void) — constructor
  • virtual ~SoFieldContainer () — destructor

Protected Member Functions inherited from SoBase

  • SoBase (void) — constructor
  • virtual ~SoBase () — destructor
  • virtual void destroy (void) — destroys it
  • SbBool hasMultipleWriteRefs (void) const — does it have multiple write refs?
  • SbBool writeHeader (SoOutput *out, SbBool isgroup, SbBool isengine) const — writes the header out
  • void writeFooter (SoOutput *out) const — writes the footer out
  • virtual const char * getFileFormatName (void) const — the file format name, as a const char *

🌈 Static Protected Member Functions 🌈

  • static const SoFieldData ** getFieldDataPtr (void) — pointer to the field data pointer, don't think about it too hard
  • static const SoNodekitCatalog ** getClassNodekitCatalogPtr (void) — pointer to the class nodekit catalog pointer
  • static void startCB (void *f, SoDragger *d) — the start callback
  • static void motionCB (void *f, SoDragger *d) — the motion callback
  • static void finishCB (void *f, SoDragger *d) — the finish callback
  • static void metaKeyChangeCB (void *f, SoDragger *d) — the meta-key-change callback
  • static void fieldSensorCB (void *f, SoSensor *s) — the field sensor callback
  • static void valueChangedCB (void *f, SoDragger *d) — the value-changed callback

Static Protected Member Functions inherited from SoDragger

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

Static Protected Member Functions inherited from SoInteractionKit

  • static const SoFieldData ** getFieldDataPtr (void) — field data pointer, encore
  • static const SoNodekitCatalog ** getClassNodekitCatalogPtr (void) — nodekit catalog pointer, encore
  • static void readDefaultParts (const char *fileName, const char defaultBuffer[], int defBufSize) — reads the default parts from a file or buffer
  • static void fieldSensorCB (void *, SoSensor *) — field sensor callback

Static Protected Member Functions inherited from SoBaseKit

  • static const SoFieldData ** getFieldDataPtr (void) — field data pointer, the remix
  • static const SoNodekitCatalog ** getClassNodekitCatalogPtr (void) — nodekit catalog pointer, the remix

Static Protected Member Functions inherited from SoNode

  • static const SoFieldData ** getFieldDataPtr (void) — field data pointer, part 4
  • static void setNextActionMethodIndex (int index) — sets the next action method index
  • static int getNextActionMethodIndex (void) — gets the next action method index
  • static void incNextActionMethodIndex (void) — increments the next action method index
  • static void setCompatibilityTypes (const SoType &nodetype, const uint32_t bitmask) — sets compatibility types via a uint32_t bitmask

Static Protected Member Functions inherited from SoBase

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

💜 Protected Attributes 💜

okay so this is the long bit, bestie. buckle up. every single part of this dragger lives here 🧚

  • SoSFNode arrow1 — arrow number one
  • SoSFNode arrow1Switch — arrow one's switch
  • SoSFNode arrow2 — arrow two
  • SoSFNode arrow2Switch — arrow two's switch
  • SoSFNode arrow3 — arrow three
  • SoSFNode arrow3Switch — arrow three's switch
  • SoSFNode arrow4 — arrow four
  • SoSFNode arrow4Switch — arrow four's switch
  • SoSFNode arrow5 — arrow five
  • SoSFNode arrow5Switch — arrow five's switch
  • SoSFNode arrow6 — arrow six
  • SoSFNode arrow6Switch — arrow six's switch
  • SoSFNode arrowTranslation — the arrows' translation
  • SoSFNode drawStyle — the draw style
  • SoSFNode extruder1 — extruder one
  • SoSFNode extruder1Active — extruder one's active flag
  • SoSFNode extruder1Switch — extruder one's switch
  • SoSFNode extruder2 — extruder two
  • SoSFNode extruder2Active — extruder two's active flag
  • SoSFNode extruder2Switch — extruder two's switch
  • SoSFNode extruder3 — extruder three
  • SoSFNode extruder3Active — extruder three's active flag
  • SoSFNode extruder3Switch — extruder three's switch
  • SoSFNode extruder4 — extruder four
  • SoSFNode extruder4Active — extruder four's active flag
  • SoSFNode extruder4Switch — extruder four's switch
  • SoSFNode extruder5 — extruder five
  • SoSFNode extruder5Active — extruder five's active flag
  • SoSFNode extruder5Switch — extruder five's switch
  • SoSFNode extruder6 — extruder six
  • SoSFNode extruder6Active — extruder six's active flag
  • SoSFNode extruder6Switch — extruder six's switch
  • SoSFNode surroundScale — the surround scale
  • SoSFNode translator1 — translator one
  • SoSFNode translator1Active — translator one's active flag
  • SoSFNode translator1Switch — translator one's switch
  • SoSFNode translator2 — translator two
  • SoSFNode translator2Active — translator two's active flag
  • SoSFNode translator2Switch — translator two's switch
  • SoSFNode translator3 — translator three
  • SoSFNode translator3Active — translator three's active flag
  • SoSFNode translator3Switch — translator three's switch
  • SoSFNode translator4 — translator four
  • SoSFNode translator4Active — translator four's active flag
  • SoSFNode translator4Switch — translator four's switch
  • SoSFNode translator5 — translator five
  • SoSFNode translator5Active — translator five's active flag
  • SoSFNode translator5Switch — translator five's switch
  • SoSFNode translator6 — translator six
  • SoSFNode translator6Active — translator six's active flag
  • SoSFNode translator6Switch — translator six's switch
  • SoSFNode uniform1 — uniform one
  • SoSFNode uniform1Active — uniform one's active flag
  • SoSFNode uniform1Switch — uniform one's switch
  • SoSFNode uniform2 — uniform two
  • SoSFNode uniform2Active — uniform two's active flag
  • SoSFNode uniform2Switch — uniform two's switch
  • SoSFNode uniform3 — uniform three
  • SoSFNode uniform3Active — uniform three's active flag
  • SoSFNode uniform3Switch — uniform three's switch
  • SoSFNode uniform4 — uniform four
  • SoSFNode uniform4Active — uniform four's active flag
  • SoSFNode uniform4Switch — uniform four's switch
  • SoSFNode uniform5 — uniform five
  • SoSFNode uniform5Active — uniform five's active flag
  • SoSFNode uniform5Switch — uniform five's switch
  • SoSFNode uniform6 — uniform six
  • SoSFNode uniform6Active — uniform six's active flag
  • SoSFNode uniform6Switch — uniform six's switch
  • SoSFNode uniform7 — uniform seven
  • SoSFNode uniform7Active — uniform seven's active flag
  • SoSFNode uniform7Switch — uniform seven's switch
  • SoSFNode uniform8 — uniform eight
  • SoSFNode uniform8Active — uniform eight's active flag
  • SoSFNode uniform8Switch — uniform eight's switch
  • SoFieldSensor * translFieldSensor — the translation field sensor
  • SoFieldSensor * scaleFieldSensor — the scale field sensor

Protected Attributes inherited from SoDragger

  • SoSFNode motionMatrix — the motion matrix

Protected Attributes inherited from SoInteractionKit

  • SoSFNode geomSeparator — the geometry separator
  • SoSFNode topSeparator — the top separator
  • SoFieldSensor * fieldSensor — the field sensor
  • SoSeparator * oldTopSep — the old top separator, keeping her around

Protected Attributes inherited from SoBaseKit

  • SoSFNode callbackList — the callback list
  • SoChildList * children — the children
  • SbBool connectionsSetUp — are the connections set up? a whole bool for that

Protected Attributes inherited from SoNode

  • uint32_t uniqueId — a uint32_t unique id, no two the same 💅

Protected Attributes inherited from SoFieldContainer

  • SbBool isBuiltIn — is it built in?

✨ Additional Inherited Members ✨

Public Types inherited from SoDragger

  • enum ProjectorFrontSetting { FRONT, BACK, USE_PICK } — pick your projector front: FRONT, BACK, or USE_PICK

Public Types inherited from SoInteractionKit

  • enum CacheEnabled { OFF, ON, AUTO } — caching, your choice: OFF, ON, or AUTO

Public Types inherited from SoNode

  • enum NodeType { INVENTOR = 0x0000, VRML1 = 0x0001, VRML2 = 0x0002, INVENTOR_1 = 0x0004, INVENTOR_2_0 = 0x0008, INVENTOR_2_1 = 0x0010, INVENTOR_2_5 = 0x0020, INVENTOR_2_6 = 0x0040, COIN_1_0 = 0x0080, COIN_2_0 = 0x0100, EXTENSION = 0x0200, COIN_2_2 = 0x0400, COIN_2_3 = 0x0800, COIN_2_4 = 0x1000, INVENTOR_5_0 = 0x2000, COIN_2_5 = 0x4000, COIN_3_0 = 0x8000, INVENTOR_6_0 = 0x10000 } — the whole node-type bitmask roster, every version of every era, all accounted for ⭐

Protected Types inherited from SoBase

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

Static Protected Attributes inherited from SoNode

  • static uint32_t nextUniqueId = 1 — the next unique id, starting at 1
  • static int nextActionMethodIndex = 0 — the next action method index, starting at 0

🦋 Detailed Description 🦋

Okay so bestie, meet SoHandleBoxDragger — the class that has your back for interactive scaling and translation. Both. At the same time. Multitasking queen behavior. 👑

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

(yep, there's a whole picture of it in the original docs — go peek, she's serving default geometry while inactive ✨)

A handlebox dragger is literally the move when you want the user to interact with geometry that can be scaled (uniformly or in a non-uniform way, both are valid and we don't judge) and translated in 3D. 💅

The dragger is built from 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. Cube sides = move it, corners and edges = stretch it. Simple as. 🎀

✨ Constructor & Destructor Documentation ✨

🌸 SoHandleBoxDragger::SoHandleBoxDragger (void )

Default constructor, and she comes fully set up — it builds the dragger nodekit catalog with the interaction geometry and the feedback geometry. No extra assembly required, periodt. 💖

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

Six translators, six extruders, eight uniforms, six arrows — the catalog is stacked, iykyk. 🌈

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

Every single part, type, and PVT flag right there. Not me memorizing the whole table... okay maybe me. 😭

🎀 SoHandleBoxDragger::~SoHandleBoxDragger (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.)

Heads up bestie: she's protected — you don't call this one yourself. She's ref-counted and cleans herself up the moment that reference count hits zero. Self-care, honestly. 💅

and there's still more coming, don't go anywhere ✨

💖 Member Function Documentation 💖

✨ SoType SoHandleBoxDragger::getTypeId (void ) const [virtual]

okay so this one returns the type identification of an object derived from a class inheriting SoBase. it's used for run-time type checking and "downward" casting. very main character energy for the type system, fr fr.

Usage example:

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

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

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

Reimplemented from SoDragger.

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

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

Reimplemented from SoDragger.

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

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

Reimplemented from SoDragger.

💅 SbBool SoHandleBoxDragger::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 SoHandleBoxDragger::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:

  1. field value is NULL and part is NULL by default
  2. it is a leaf SoGroup or SoSeparator node with no children
  3. it is a leaf listpart with no children and an SoGroup or SoSeparator container
  4. 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.

⭐ 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.

⭐ 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.

⭐ 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.

⭐ 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.

⭐ 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.

⭐ 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.

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

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

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

👑 void SoHandleBoxDragger::setAllPartsActive (SbBool onoroff) [protected]

Activate or deactive all dragger geometry parts.

🌈 Member Data Documentation 🌈

💜 SoSFVec3f SoHandleBoxDragger::scaleFactor

Continuously updated to contain the current vector of scaling along the X, Y and Z axes.

💜 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.

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

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

🌟 Author 🌟

Generated automatically by Doxygen for Coin from the source code.

and that's the whole vibe, bestie 💖 this page came from Coin, version 3.1.3, and the footer's date is doing its little timestamp thing down there — you know the one. mwah 💋✨

📦 where this page comes from