SoTabBoxDragger(3)

📦 version 3.1.3, in fedora 43, fedora 44

🌸 NAME 🌸

Hiii bestie, welcome to the SoTabBoxDragger page, fresh out of the Library Functions Manual (that's the (3) energy, iykyk). And okay so what even is it?

SoTabBoxDragger — it wraps a box around your geometry, and then you can translate it and scale it. That's it. That's the whole vibe. 💅

This page is a whole trilogy, and this right here is part 1 of 3 — more parts are coming, so don't go anywhere 🫶

🎀 SYNOPSIS 🎀

#include <Inventor/draggers/SoTabBoxDragger.h>

Inherits SoDragger.

✨ Public Member Functions ✨

  • virtual SoType getTypeId (void) const — hands you the runtime SoType id for this class, the classic "who am I really" move ✨
  • virtual const SoNodekitCatalog * getNodekitCatalog (void) const — gives you the nodekit catalog, aka the full blueprint of every part this thing is built from 🗺️
  • SoTabBoxDragger (void) — the constructor, bestie. Call it, get a dragger. Periodt.
  • void adjustScaleTabSize (void) — fiddles with the size of the scale tabs so they actually look right 💅

🦋 Public Member Functions inherited from SoDragger 🦋

okay so these are all the goodies you get for free just by being a SoDragger — no cap, there's a lot of them:

  • virtual void callback (SoCallbackAction *action) — runs the callback action down through this node.
  • virtual void GLRender (SoGLRenderAction *action) — the render action, aka "draw me" ✨
  • virtual void getMatrix (SoGetMatrixAction *action) — feeds this node's transform into the matrix action.
  • virtual void rayPick (SoRayPickAction *action) — ray pick handling, for when something's aiming at you.
  • virtual void search (SoSearchAction *action) — lets a search action find this node.
  • virtual void write (SoWriteAction *action) — writes this node out.
  • virtual void getPrimitiveCount (SoGetPrimitiveCountAction *action) — counts up the primitives.
  • void setProjectorEpsilon (const float epsilon) — sets the projector epsilon to epsilon.
  • float getProjectorEpsilon (void) const — reads the projector epsilon back out.
  • void addStartCallback (SoDraggerCB *func, void *data=NULL) — registers a callback that fires when a drag starts 🎬
  • void removeStartCallback (SoDraggerCB *func, void *data=NULL) — un-registers that start callback.
  • void addMotionCallback (SoDraggerCB *func, void *data=NULL) — registers a callback for while you're dragging (the motion, the wiggle) 💃
  • void removeMotionCallback (SoDraggerCB *func, void *data=NULL) — takes that motion callback back off.
  • void addFinishCallback (SoDraggerCB *func, void *data=NULL) — registers a callback for when the drag is done, slay.
  • void removeFinishCallback (SoDraggerCB *func, void *data=NULL) — removes the finish callback.
  • void addValueChangedCallback (SoDraggerCB *func, void *data=NULL) — registers a callback for when the value changes.
  • void removeValueChangedCallback (SoDraggerCB *func, void *data=NULL) — removes that one too.
  • void setMinGesture (int pixels) — sets the minimum gesture size, in pixels.
  • int getMinGesture (void) const — gets that minimum gesture size back.
  • SbBool enableValueChangedCallbacks (SbBool newval) — turns value-changed callbacks on or off with newval.
  • const SbMatrix & getMotionMatrix (void) — hands you the motion matrix by reference.
  • void addOtherEventCallback (SoDraggerCB *func, void *data=NULL) — registers a callback for all the other events.
  • void removeOtherEventCallback (SoDraggerCB *func, void *data=NULL) — removes that other-events callback.
  • void registerChildDragger (SoDragger *child) — registers child as a child dragger.
  • void unregisterChildDragger (SoDragger *child) — un-registers it.
  • void registerChildDraggerMovingIndependently (SoDragger *child) — registers child as a child dragger that moves on its own, main character energy 👑
  • void unregisterChildDraggerMovingIndependently (SoDragger *child) — un-registers that independent mover.
  • SbMatrix getLocalToWorldMatrix (void) — the local-to-world matrix.
  • SbMatrix getWorldToLocalMatrix (void) — the world-to-local matrix.
  • SbVec3f getLocalStartingPoint (void) — where the drag started, in local space.
  • SbVec3f getWorldStartingPoint (void) — where the drag started, in world space.
  • void getPartToLocalMatrix (const SbName &partname, SbMatrix &parttolocalmatrix, SbMatrix &localtopartmatrix) — gives you both the part-to-local and local-to-part matrices for partname.
  • void transformMatrixLocalToWorld (const SbMatrix &frommatrix, SbMatrix &tomatrix) — converts frommatrix from local space into world space, in tomatrix.
  • void transformMatrixWorldToLocal (const SbMatrix &frommatrix, SbMatrix &tomatrix) — the reverse trip, world space back to local.
  • void transformMatrixToLocalSpace (const SbMatrix &frommatrix, SbMatrix &tomatrix, const SbName &fromspacepartname) — transforms frommatrix into the local space of fromspacepartname.
  • virtual void setMotionMatrix (const SbMatrix &newmatrix) — sets the motion matrix to newmatrix.
  • void valueChanged (void) — tells the dragger its value changed.
  • const SbMatrix & getStartMotionMatrix (void) — the motion matrix from when the drag began.
  • virtual void saveStartParameters (void) — stashes the starting parameters away.
  • const SoPath * getPickPath (void) const — the pick path.
  • const SoEvent * getEvent (void) const — the event.
  • SoPath * createPathToThis (void) — builds a path pointing at this thing.
  • const SoPath * getSurrogatePartPickedOwner (void) const — the owner of the surrogate part that got picked.
  • const SbName & getSurrogatePartPickedName (void) const — the name of that picked surrogate part.
  • const SoPath * getSurrogatePartPickedPath (void) const — the path of that picked surrogate part.
  • void setStartingPoint (const SoPickedPoint *newpoint) — sets the starting point from a SoPickedPoint.
  • void setStartingPoint (const SbVec3f &newpoint) — sets the starting point from a vector.
  • const SbViewVolume & getViewVolume (void) — the view volume.
  • void setViewVolume (const SbViewVolume &vol) — sets the view volume to vol.
  • const SbViewportRegion & getViewportRegion (void) — the viewport region.
  • void setViewportRegion (const SbViewportRegion &reg) — sets the viewport region to reg.
  • SoHandleEventAction * getHandleEventAction (void) const — the handle-event action.
  • void setHandleEventAction (SoHandleEventAction *newAction) — sets the handle-event action to newAction.
  • void setTempPathToThis (const SoPath *somethingclose) — sets a temporary path to this, from something close by.
  • virtual void grabEventsSetup (void) — the setup for grabbing events.
  • virtual void grabEventsCleanup (void) — the cleanup after grabbing events.
  • void workFieldsIntoTransform (SbMatrix &mtx) — works the fields into the transform mtx.
  • void setFrontOnProjector (ProjectorFrontSetting newval) — sets the front-on-projector setting to newval.
  • ProjectorFrontSetting getFrontOnProjector (void) const — reads that setting back.

💜 Public Member Functions inherited from SoInteractionKit 💜

  • SoInteractionKit (void) — constructor, standard issue.
  • virtual SbBool setPartAsPath (const SbName &partname, SoPath *path) — sets the part called partname to be the given path.
  • virtual SbBool setPartAsDefault (const SbName &partname, SoNode *node, SbBool onlyifdefault=TRUE) — sets partname to node as the default, but only if onlyifdefault says so.
  • virtual SbBool setPartAsDefault (const SbName &partname, const SbName &nodename, SbBool onlyifdefault=TRUE) — same thing but you name the node with nodename instead.
  • SbBool isPathSurrogateInMySubgraph (const SoPath *path, SoPath *&pathToOwner, SbName &surrogatename, SoPath *&surrogatepath, SbBool fillargs=TRUE) — checks whether path is a surrogate inside this subgraph, and fills in the owner path, surrogate name and surrogate path.
  • SbBool isPathSurrogateInMySubgraph (const SoPath *path) — the simpler version: just yes or no for path.
  • virtual SbBool setPart (const SbName &partname, SoNode *from) — sets the part partname using from.

🧚 Public Member Functions inherited from SoBaseKit 🧚

  • SoBaseKit (void) — constructor.
  • virtual SoNode * getPart (const SbName &partname, SbBool makeifneeded) — grabs the part partname, making it first if makeifneeded says to.
  • SbString getPartString (const SoBase *part) — gives you the part string for part.
  • virtual SoNodeKitPath * createPathToPart (const SbName &partname, SbBool makeifneeded, const SoPath *pathtoextend=NULL) — builds a nodekit path to partname, optionally extending pathtoextend.
  • SbBool set (const char *namevaluepairliststring) — sets stuff from a namevaluepairliststring.
  • SbBool set (const char *partnamestring, const char *parameterstring) — sets a part using a partnamestring and a parameterstring.
  • virtual void doAction (SoAction *action) — runs the action.
  • virtual SoChildList * getChildren (void) const — the children list.
  • void printDiagram (void) — prints the diagram, so cute.
  • void printSubDiagram (const SbName &rootname, int level) — prints a sub-diagram starting at rootname, down to level.
  • void printTable (void) — prints the table.
  • virtual void addWriteReference (SoOutput *out, SbBool isfromfield=FALSE) — adds a write reference to out.
  • SbBool forceChildDrivenWriteRefs (SoOutput *out) — forces the child-driven write references.

⭐ Public Member Functions inherited from SoNode ⭐

  • void setOverride (const SbBool state) — sets the override flag to state.
  • SbBool isOverride (void) const — is it overriding? yes/no.
  • void setNodeType (const NodeType type) — sets the node type to type.
  • NodeType getNodeType (void) const — reads the node type.
  • virtual SoNode * copy (SbBool copyconnections=FALSE) const — copies the node, connections and all if you ask nicely.
  • virtual SbBool affectsState (void) const — does this node affect state?
  • virtual void GLRenderBelowPath (SoGLRenderAction *action) — GL render, below path flavour.
  • virtual void GLRenderInPath (SoGLRenderAction *action) — GL render, in path flavour.
  • virtual void GLRenderOffPath (SoGLRenderAction *action) — GL render, off path flavour.
  • virtual void pick (SoPickAction *action) — the pick action.
  • virtual void audioRender (SoAudioRenderAction *action) — the audio render action 🔊
  • virtual void startNotify (void) — kicks off notification.
  • virtual void notify (SoNotList *l) — notifies with the list l.
  • uint32_t getNodeId (void) const — the node id.
  • virtual void writeInstance (SoOutput *out) — writes the instance out to out.
  • virtual SoFieldContainer * copyThroughConnection (void) const — copies through the connection.

🍓 Public Member Functions inherited from SoFieldContainer 🍓

  • void setToDefaults (void) — resets everything to defaults.
  • SbBool hasDefaultValues (void) const — are all the values default? yes/no.
  • SbBool fieldsAreEqual (const SoFieldContainer *container) const — compares fields against container.
  • void copyFieldValues (const SoFieldContainer *container, SbBool copyconnections=FALSE) — copies the field values from container.
  • SbBool set (const char *const fielddata) — sets from fielddata.
  • void get (SbString &fielddata) — gets the field data out into fielddata.
  • virtual int getFields (SoFieldList &l) const — gets the fields into the list l.
  • virtual int getAllFields (SoFieldList &l) const — gets all the fields into l.
  • virtual SoField * getField (const SbName &name) const — grabs the field called name.
  • virtual SoField * getEventIn (const SbName &name) const — grabs the event-in called name.
  • virtual SoField * getEventOut (const SbName &name) const — grabs the event-out called name.
  • SbBool getFieldName (const SoField *const field, SbName &name) const — works out the name of field.
  • SbBool enableNotify (const SbBool flag) — toggles notification with flag.
  • SbBool isNotifyEnabled (void) const — is notification enabled?
  • SbBool set (const char *fielddata, SoInput *input) — sets from fielddata, reading through input.
  • void get (SbString &fielddata, SoOutput *out) — gets the field data out, writing through out.
  • virtual SbBool validateNewFieldValue (SoField *field, void *newval) — checks whether newval is valid for field.
  • SbBool getIsBuiltIn (void) const — is it built in?
  • virtual void getFieldsMemorySize (size_t &managed, size_t &unmanaged) const — reports the managed and unmanaged memory sizes of the fields.
  • void setUserData (void *userdata) const — attaches userdata to this.
  • void * getUserData (void) const — gets that userdata back out.

🌈 Public Member Functions inherited from SoBase 🌈

  • void ref (void) const — bumps the reference count up.
  • void unref (void) const — drops the reference count down.
  • void unrefNoDelete (void) const — drops the count but does not delete. sneaky but valid.
  • int32_t getRefCount (void) const — what's the ref count rn?
  • void touch (void) — touches the node, so everyone knows something changed ✨
  • SbBool isOfType (SoType type) const — is this thing of type type?
  • virtual SbName getName (void) const — the name.
  • virtual void setName (const SbName &newname) — renames it to newname.
  • void addAuditor (void *const auditor, const SoNotRec::Type type) — adds an auditor of the given type.
  • void removeAuditor (void *const auditor, const SoNotRec::Type type) — removes that auditor.
  • const SoAuditorList & getAuditors (void) const — the whole auditor list.
  • SbBool shouldWrite (void) — should this be written out?
  • void assertAlive (void) const — asserts that this object is alive. don't skip this one bestie 💀

👑 Static Public Member Functions 👑

  • static SoType getClassTypeId (void) — the class-wide SoType id.
  • static const SoNodekitCatalog * getClassNodekitCatalog (void) — the class-wide nodekit catalog.
  • static void initClass (void) — initializes the class. call it once, love it forever.

🫶 Static Public Member Functions inherited from SoDragger 🫶

  • static SoType getClassTypeId (void) — the class type id.
  • static const SoNodekitCatalog * getClassNodekitCatalog (void) — the class nodekit catalog.
  • static void setMinScale (float newminscale) — sets the minimum scale to newminscale.
  • static float getMinScale (void) — reads the minimum scale back.
  • static void workValuesIntoTransform (SbMatrix &mtx, const SbVec3f *translationptr, const SbRotation *rotationptr, const SbVec3f *scalefactorptr, const SbRotation *scaleorientationptr, const SbVec3f *centerptr) — works translation, rotation, scale factor, scale orientation and center all into the transform mtx.
  • static void getTransformFast (SbMatrix &mtx, SbVec3f &translation, SbRotation &rotation, SbVec3f &scalefactor, SbRotation &scaleorientation, const SbVec3f &center) — the fast transform extraction, with a center.
  • static void getTransformFast (SbMatrix &mtx, SbVec3f &translation, SbRotation &rotation, SbVec3f &scalefactor, SbRotation &scaleorientation) — same, no center.
  • static SbMatrix appendTranslation (const SbMatrix &mtx, const SbVec3f &translation, const SbMatrix *conversion=NULL) — appends a translation onto mtx, with optional conversion.
  • static SbMatrix appendScale (const SbMatrix &mtx, const SbVec3f &scale, const SbVec3f &scalecenter, const SbMatrix *conversion=NULL) — appends a scale around scalecenter.
  • static SbMatrix appendRotation (const SbMatrix &mtx, const SbRotation &rot, const SbVec3f &rotcenter, const SbMatrix *conversion=NULL) — appends a rotation rot around rotcenter.
  • static void initClass (void) — initializes the class.
  • static void initClasses (void) — initializes all the classes. overachiever behavior 💅

💖 Static Public Member Functions inherited from SoInteractionKit 💖

  • static SoType getClassTypeId (void) — class type id.
  • static const SoNodekitCatalog * getClassNodekitCatalog (void) — class nodekit catalog.
  • static void initClass (void) — initializes the class.
  • static void setSwitchValue (SoNode *node, const int newVal) — sets the switch value on node to newVal.

🦋 Static Public Member Functions inherited from SoBaseKit 🦋

  • static SoType getClassTypeId (void) — class type id.
  • static void initClass (void) — initializes the class.
  • static const SoNodekitCatalog * getClassNodekitCatalog (void) — class nodekit catalog.
  • static SbBool isSearchingChildren (void) — is it searching children?
  • static void setSearchingChildren (const SbBool newval) — sets searching-children to newval.

🌟 Static Public Member Functions inherited from SoNode 🌟

  • static uint32_t getCompatibilityTypes (const SoType &nodetype) — the compatibility types for nodetype.
  • static SoType getClassTypeId (void) — class type id.
  • static SoNode * getByName (const SbName &name) — finds a node by name.
  • static int getByName (const SbName &name, SoNodeList &l) — finds nodes by name and drops them into l.
  • static void initClass (void) — initializes the class.
  • static void initClasses (void) — initializes the classes.
  • static uint32_t getNextNodeId (void) — the next node id.
  • static int getActionMethodIndex (const SoType type) — the action method index for type.
  • static void getBoundingBoxS (SoAction *action, SoNode *node) — the static bounding-box entry point.
  • static void GLRenderS (SoAction *action, SoNode *node) — the static GL render entry point.
  • static void callbackS (SoAction *action, SoNode *node) — the static callback entry point.
  • static void getMatrixS (SoAction *action, SoNode *node) — the static get-matrix entry point.
  • static void handleEventS (SoAction *action, SoNode *node) — the static handle-event entry point.
  • static void pickS (SoAction *action, SoNode *node) — the static pick entry point.
  • static void rayPickS (SoAction *action, SoNode *node) — the static ray-pick entry point.
  • static void searchS (SoAction *action, SoNode *node) — the static search entry point.
  • static void writeS (SoAction *action, SoNode *node) — the static write entry point.
  • static void audioRenderS (SoAction *action, SoNode *node) — the static audio render entry point 🔊
  • static void getPrimitiveCountS (SoAction *action, SoNode *node) — the static primitive-count entry point.

✨ Static Public Member Functions inherited from SoFieldContainer ✨

bestie these are the ones you get handed down, no need to write them yourself:

  • static void initClass (void) — sets the class up so the type system knows it exists 💅
  • static SoType getClassTypeId (void) — hands you the SoType for this class
  • static void cleanupClass (void) — tears down whatever initClass built
  • static void initCopyDict (void) — gets the copy dictionary ready for business
  • static void addCopy (const SoFieldContainer *orig, const SoFieldContainer *copy) — registers an original→copy pairing in that dict
  • static SoFieldContainer * checkCopy (const SoFieldContainer *orig) — peeks at the dict to see if orig has a copy already
  • static SoFieldContainer * findCopy (const SoFieldContainer *orig, const SbBool copyconnections) — same energy, but you also get to say whether connections come along
  • static void copyDone (void) — okay we're done copying, wrap it up 🎀

✨ Static Public Member Functions inherited from SoBase ✨

the SoBase starter pack, fr fr:

  • static void initClass (void) — class init, classic
  • static SoType getClassTypeId (void) — the type id, as always
  • static void addName (SoBase *const base, const char *const name) — gives base a name so you can find it later
  • static void removeName (SoBase *const base, const char *const name) — takes that name away again 🙈
  • 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) — looks up a named base of the type you asked for
  • static int getNamedBases (const SbName &name, SoBaseList &baselist, SoType type) — the plural version, drops them all into baselist
  • static SbBool read (SoInput *input, SoBase *&base, SoType expectedtype) — reads a base off the input, returns whether it worked
  • static void setInstancePrefix (const SbString &c) — sets the prefix used for instances
  • static void setTraceRefs (SbBool trace) — turns reference tracing on or off
  • static SbBool getTraceRefs (void) — tells you if reference tracing is on
  • static SbBool connectRoute (SoInput *input, const SbName &fromnodename, const SbName &fromfieldname, const SbName &tonodename, const SbName &tofieldname) — wires a route up from one node's field to another's
  • static SbBool readRoute (SoInput *input) — reads a route in from the input

💖 Public Attributes 💖

  • SoSFVec3f translation — the translation, as a vec3f, obviously 💅
  • SoSFVec3f scaleFactor — the scale factor, also a vec3f

inherited from SoDragger

  • SoSFBool isActive — are we active right now or nah

inherited from SoInteractionKit

  • SoSFEnum renderCaching — caching setting for rendering
  • SoSFEnum boundingBoxCaching — caching setting for bounding boxes
  • SoSFEnum renderCulling — culling setting for rendering
  • SoSFEnum pickCulling — culling setting for picking

🛡️ Protected Member Functions 🛡️

for the subclass girlies only:

  • virtual const SoFieldData * getFieldData (void) const — hands back the field data
  • virtual ~SoTabBoxDragger (void) — the destructor, it's virtual, it's protected, it's doing its thing
  • virtual SbBool setUpConnections (SbBool onoff, SbBool doitalways=FALSE) — hooks up (or unhooks) the internal connections; pass doitalways=TRUE if you want it done regardless
  • virtual void setDefaultOnNonWritingFields (void) — sets the defaults on the fields that don't get written out

inherited from SoDragger

  • SoDragger (void) — constructor
  • virtual ~SoDragger (void) — destructor
  • SbVec2f getNormalizedLocaterPosition (void) — the locater position, but normalized
  • SbVec2s getLocaterPosition (void) — where the locater is, raw
  • SbVec2s getStartLocaterPosition (void) const — where the locater was when it all started
  • void setStartLocaterPosition (SbVec2s p) — set that starting position to p
  • SbBool isAdequateConstraintMotion (void) — is this motion good enough for the constraint
  • virtual SbBool shouldGrabBasedOnSurrogate (const SoPath *pickpath, const SoPath *surrogatepath) — decides whether a grab should happen based on the surrogate path
  • void setCameraInfo (SoAction *action) — pulls camera info out of the 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) — should this be ignored when computing bounding boxes
  • SbBool isIgnoreInBbox (void) — is it being ignored in the bbox or not
  • virtual void getBoundingBox (SoGetBoundingBoxAction *action) — fills in the bounding box
  • void setActiveChildDragger (SoDragger *newchilddragger) — sets which child dragger is the active one
  • SoDragger * getActiveChildDragger (void) const — which child dragger is active rn
  • void updateDraggerCache (const SoPath *path) — refreshes the dragger cache for that path

inherited from SoInteractionKit

  • virtual ~SoInteractionKit () — destructor szn
  • virtual void copyContents (const SoFieldContainer *fromFC, SbBool copyConnections) — copies the contents over from fromFC, connections optional
  • virtual SbBool setPart (const int partNum, SoNode *node) — assigns node to part number partNum
  • virtual SbBool readInstance (SoInput *in, unsigned short flags) — reads an instance off the input
  • virtual SbBool setAnyPartAsDefault (const SbName &partname, SoNode *node, SbBool anypart=TRUE, SbBool onlyifdefault=TRUE) — sets a part as the default, with anypart and onlyifdefault toggles
  • virtual SbBool setAnyPartAsDefault (const SbName &partname, const SbName &nodename, SbBool anypart=TRUE, SbBool onlyifdefault=TRUE) — same deal but you name the node instead
  • SbBool setAnySurrogatePath (const SbName &name, SoPath *path, SbBool leafcheck=FALSE, SbBool publiccheck=FALSE) — sets a surrogate path, with optional leaf and public checks
  • void connectSeparatorFields (SoSeparator *dest, SbBool onOff) — wires up the separator fields on dest, on or off

inherited from SoBaseKit

  • virtual ~SoBaseKit () — destructor again, it's giving consistency
  • virtual SoNode * addToCopyDict (void) const — adds this node to the copy dictionary
  • SoGroup * getContainerNode (const SbName &listname, SbBool makeifneeded=TRUE) — grabs the container node for listname, making it if needed
  • virtual SoNode * getAnyPart (const SbName &partname, SbBool makeifneeded, SbBool leafcheck=FALSE, SbBool publiccheck=FALSE) — gets any part by name, with all the little toggles
  • virtual SoNodeKitPath * createPathToAnyPart (const SbName &partname, SbBool makeifneeded, SbBool leafcheck=FALSE, SbBool publiccheck=FALSE, const SoPath *pathtoextend=NULL) — builds a path to any part, optionally extending an existing pathtoextend
  • virtual SbBool setAnyPart (const SbName &partname, SoNode *from, SbBool anypart=TRUE) — sets any part from a node
  • void createNodekitPartsList (void) — builds the nodekit parts list
  • void createFieldList (void) — builds the field list
  • virtual void createDefaultParts (void) — creates the default parts 🫶
  • const SoNodekitParts * getNodekitPartsList (void) const — returns the nodekit parts list
  • const SbList< SoSFNode * > & getCatalogInstances (void) const — returns the catalog instances
  • void catalogError (void) — throws a catalog error
  • void countMyFields (SoOutput *out) — counts the fields on the way out

inherited from SoNode

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

inherited from SoFieldContainer

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

inherited from SoBase

  • SoBase (void) — constructor
  • virtual ~SoBase () — destructor
  • virtual void destroy (void) — destroys the thing 💀
  • SbBool hasMultipleWriteRefs (void) const — does it have more than one write ref
  • SbBool writeHeader (SoOutput *out, SbBool isgroup, SbBool isengine) const — writes the header, tells it whether it's a group and whether it's an engine
  • void writeFooter (SoOutput *out) const — writes the footer to match
  • virtual const char * getFileFormatName (void) const — the name of the file format

🌟 Static Protected Member Functions 🌟

  • static const SoFieldData ** getFieldDataPtr (void) — a pointer to the field data pointer, iconic
  • static const SoNodekitCatalog ** getClassNodekitCatalogPtr (void) — same energy, but for the nodekit catalog
  • static void invalidateSurroundScaleCB (void *f, SoDragger *d) — callback that invalidates the surround scale
  • static void fieldSensorCB (void *f, SoSensor *s) — the field sensor callback
  • static void valueChangedCB (void *f, SoDragger *d) — the value-changed callback

inherited from SoDragger

  • static const SoFieldData ** getFieldDataPtr (void) — field data pointer pointer
  • static const SoNodekitCatalog ** getClassNodekitCatalogPtr (void) — nodekit catalog pointer pointer
  • static void childTransferMotionAndValueChangedCB (void *, SoDragger *) — when a child transfers motion and the value changes
  • static void childValueChangedCB (void *, SoDragger *) — when a child's value changes
  • static void childStartCB (void *, SoDragger *) — when a child starts
  • static void childMotionCB (void *, SoDragger *) — when a child moves
  • static void childFinishCB (void *, SoDragger *) — when a child finishes
  • static void childOtherEventCB (void *, SoDragger *) — when a child gets literally any other event

inherited from SoInteractionKit

  • static const SoFieldData ** getFieldDataPtr (void) — yes, again
  • static const SoNodekitCatalog ** getClassNodekitCatalogPtr (void) — and again
  • static void readDefaultParts (const char *fileName, const char defaultBuffer[], int defBufSize) — reads the default parts from fileName out of defaultBuffer of size defBufSize
  • static void fieldSensorCB (void *, SoSensor *) — the field sensor callback

inherited from SoBaseKit

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

inherited from SoNode

  • static const SoFieldData ** getFieldDataPtr (void) — ok you get it by now 💅
  • static void setNextActionMethodIndex (int index) — sets the next action method index to index
  • static int getNextActionMethodIndex (void) — reads the next action method index
  • static void incNextActionMethodIndex (void) — bumps the next action method index up
  • static void setCompatibilityTypes (const SoType &nodetype, const uint32_t bitmask) — sets compatibility types for nodetype with a bitmask

inherited from SoBase

  • static uint32_t getCurrentWriteCounter (void) — the current write counter value
  • static void staticDataLock (void) — locks the static data
  • static void staticDataUnlock (void) — unlocks it, we're free 🦋

🧚 Protected Attributes 🧚

these are the internal parts, lowkey the whole kit:

  • SoSFNode boxGeom — the box geometry
  • SoSFNode surroundScale — the surround scale
  • SoSFNode tabPlane1 — tab plane number one
  • SoSFNode tabPlane1Sep — its separator
  • SoSFNode tabPlane1Xf — its transform
  • SoSFNode tabPlane2 — tab plane number two
  • SoSFNode tabPlane2Sep — its separator
  • SoSFNode tabPlane2Xf — its transform
  • SoSFNode tabPlane3 — tab plane number three
  • SoSFNode tabPlane3Sep — its separator
  • SoSFNode tabPlane3Xf — its transform
  • SoSFNode tabPlane4 — tab plane number four
  • SoSFNode tabPlane4Sep — its separator
  • SoSFNode tabPlane4Xf — its transform
  • SoSFNode tabPlane5 — tab plane number five
  • SoSFNode tabPlane5Sep — its separator
  • SoSFNode tabPlane5Xf — its transform
  • SoSFNode tabPlane6 — tab plane number six
  • SoSFNode tabPlane6Sep — its separator
  • SoSFNode tabPlane6Xf — its transform
  • SoFieldSensor * translFieldSensor — the sensor watching the translation field
  • SoFieldSensor * scaleFieldSensor — the sensor watching the scale field

inherited from SoDragger

  • SoSFNode motionMatrix — the motion matrix ✨

inherited from SoInteractionKit

  • SoSFNode geomSeparator — the geometry separator
  • SoSFNode topSeparator — the top separator
  • SoFieldSensor * fieldSensor — the field sensor
  • SoSeparator * oldTopSep — the previous top separator, kept around

inherited from SoBaseKit

  • SoSFNode callbackList — the callback list
  • SoChildList * children — the children
  • SbBool connectionsSetUp — have the connections been set up yet

inherited from SoNode

  • uint32_t uniqueId — every node gets a unique id, periodt

inherited from SoFieldContainer

  • SbBool isBuiltIn — is it built in or not

🌈 Additional Inherited Members 🌈

Public Types inherited from SoDragger

  • enum ProjectorFrontSetting { FRONT, BACK, USE_PICK } — where the projector faces: front, back, or just use whatever the pick says

Public Types inherited from SoInteractionKit

  • enum CacheEnabled { OFF, ON, AUTO } — caching: off, on, or auto, the holy trinity

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 } — every node type bit, all eighteen of them, no cap 💯

Protected Types inherited from SoBase

  • enum BaseFlags { IS_ENGINE = 0x01, IS_GROUP = 0x02 } — two flags, engine or group

Static Protected Attributes inherited from SoNode

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

👑 Detailed Description 👑

okay so the SoTabBoxDragger wraps a box around geometry you can then translate and scale. it's giving hands-on, it's giving direct manipulation, and honestly? iconic.

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

This dragger lets the end-user do translation and non-uniform scaling of geometry with an easy to understand interface.

Click and drag any side of the box to translate — and hold down a SHIFT key to lock it to one axis 🔒. Click and drag any of the tab markers in the corners to scale. The way the different tabs influence the scale operation should be straight-forward and intuitive to the end-user.

The SoTabBoxDragger is a composite dragger, implemented with 6 SoTabPlaneDragger instances set up as the sides of a box. six of them. one per side. it's a whole squad 🫶

🎀 CONSTRUCTOR & DESTRUCTOR DOCUMENTATION 🎀

💖 SoTabBoxDragger::SoTabBoxDragger (void)

okay bestie, this is the default constructor and she is booked and busy — she sets up the dragger nodekit catalog with all the interaction and feedback geometry. 💅

Here's the node kit structure, and the entries that are new versus the parent class are marked with an arrow prefix, so keep an eye out:

CLASS SoTabBoxDragger
-->"this"
      "callbackList"
      "topSeparator"
         "motionMatrix"
-->      "surroundScale"
-->      "tabPlane1Sep"
-->         "tabPlane1Xf"
-->         "tabPlane1"
-->      "tabPlane2Sep"
-->         "tabPlane2Xf"
-->         "tabPlane2"
-->      "tabPlane3Sep"
-->         "tabPlane3Xf"
-->         "tabPlane3"
-->      "tabPlane4Sep"
-->         "tabPlane4Xf"
-->         "tabPlane4"
-->      "tabPlane5Sep"
-->         "tabPlane5Xf"
-->         "tabPlane5"
-->      "tabPlane6Sep"
-->         "tabPlane6Xf"
-->         "tabPlane6"
         "geomSeparator"
-->         "boxGeom"

(if you wanna know how that output formatting works, peek at SoBaseKit::printDiagram(), iykyk ✨)

and now the detailed info on catalog parts, because we are nothing if not thorough:

CLASS SoTabBoxDragger
PVT   "this",  SoTabBoxDragger  ---
      "callbackList",  SoNodeKitListPart [ SoCallback, SoEventCallback ]
PVT   "topSeparator",  SoSeparator  ---
PVT   "motionMatrix",  SoMatrixTransform  ---
      "surroundScale",  SoSurroundScale  ---
PVT   "tabPlane1Sep",  SoSeparator  ---
PVT   "tabPlane1Xf",  SoTransform  ---
      "tabPlane1",  SoTabPlaneDragger  ---
PVT   "tabPlane2Sep",  SoSeparator  ---
PVT   "tabPlane2Xf",  SoTransform  ---
      "tabPlane2",  SoTabPlaneDragger  ---
PVT   "tabPlane3Sep",  SoSeparator  ---
PVT   "tabPlane3Xf",  SoTransform  ---
      "tabPlane3",  SoTabPlaneDragger  ---
PVT   "tabPlane4Sep",  SoSeparator  ---
PVT   "tabPlane4Xf",  SoTransform  ---
      "tabPlane4",  SoTabPlaneDragger  ---
PVT   "tabPlane5Sep",  SoSeparator  ---
PVT   "tabPlane5Xf",  SoTransform  ---
      "tabPlane5",  SoTabPlaneDragger  ---
PVT   "tabPlane6Sep",  SoSeparator  ---
PVT   "tabPlane6Xf",  SoTransform  ---
      "tabPlane6",  SoTabPlaneDragger  ---
PVT   "geomSeparator",  SoSeparator  ---
      "boxGeom",  SoSeparator  ---

(and for that output formatting, go say hi to SoBaseKit::printTable() 🌸)

🦋 SoTabBoxDragger::~SoTabBoxDragger (void) [protected], [virtual]

The protected destructor, bestie. 🫶

and no, you don't need to stress about cleanup — dragger classes are derived from SoBase, so they're reference counted and get automatically destroyed when their reference count hits 0. she cleans up after herself, periodt. 💅

✨ MEMBER FUNCTION DOCUMENTATION ✨

👑 SoType SoTabBoxDragger::getTypeId (void) const [virtual]

Returns the type identification of an object derived from a class inheriting SoBase. This is what powers run-time type checking and "downward" casting, fr fr.

Usage example, so you can see it in the wild:

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

Now listen — for any application programmer out there wanting to extend the library with new nodes, engines, nodekits, draggers or whatever else: this method needs to be overridden in all subclasses. That's typically done as part of setting up the full type system for your extension classes, which usually happens 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. 🌈

For more info on writing Coin extensions, go check the class documentation of the toplevel superclasses for the various class groups.

Reimplemented from SoDragger.

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

Hands you a pointer to the class-wide field data storage object for this instance. And if there are no fields present? It returns NULL. that's it, that's the whole vibe. 🙈

Reimplemented from SoDragger.

🧚 const SoNodekitCatalog * SoTabBoxDragger::getNodekitCatalog (void) const [virtual]

Returns the nodekit catalog which defines the layout of this class' kit. she's the blueprint bestie. 💜

Reimplemented from SoDragger.

⭐ void SoTabBoxDragger::adjustScaleTabSize (void)

Signals the dragger to recalculate the size of its tabs. iconic behavior.

Literally, it just calls SoTabPlaneDragger::adjustScaleTabSize() for all 6 planes this dragger consists of. six for six, no skips. 🔥

🎀 SbBool SoTabBoxDragger::setUpConnections (SbBool onoff, SbBool doitalways = FALSE) [protected], [virtual]

Sets up all internal connections for instances of this class.

heads up: this method will usually not be of interest to the application programmer — unless you wanna extend the library with new custom nodekits or dragger classes. If that's you, go read the SoBaseKit class documentation. 📚

Reimplemented from SoInteractionKit.

💅 void SoTabBoxDragger::setDefaultOnNonWritingFields (void) [protected], [virtual]

quick note bestie: this method is unlikely to be of interest to the application programmer who doesn't want to extend the library with new custom nodekits or draggers. but if you are writing extensions, the info lives 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. And from the subclass — do not forget to call "upwards" to your superclass' setDefaultOnNonWritingFields() method. 🙏

Reimplemented from SoDragger.

💖 void SoTabBoxDragger::invalidateSurroundScaleCB (void * d, SoDragger * d) [static], [protected]

surroundScale is invalidated every time a child dragger is activated/deactivated using this callback. she stays in her lane and stays fresh. ✨

🔥 void SoTabBoxDragger::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. (i.e. not your problem, bestie 💀)

🌈 void SoTabBoxDragger::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. (same energy, different function 🦋)

🍓 MEMBER DATA DOCUMENTATION 🍓

💜 SoSFVec3f SoTabBoxDragger::translation

Continuously updated to contain the current translation from the dragger's local origo position. she's always keeping you posted. 📍

🧚 SoSFVec3f SoTabBoxDragger::scaleFactor

Continuously updated to contain the current vector of scaling along the X, Y and Z axes. all three axes, accounted for. 👑

🎀 SoFieldSensor* SoTabBoxDragger::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* SoTabBoxDragger::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. (yes, the docs wrote themselves, slay 🤖✨)

and that's a wrap on the whole page, bestie!! 🫶 this one came from the Coin source, Version 3.1.3, and she's filed under SoTabBoxDragger(3). go forth and drag those tabs, you absolute icon. 💖🌈👑

📦 where this page comes from