SoTransformBoxDragger(3)

📦 version 2.5.0, in fedora 43, fedora 44

🌸 NAME 🌸

okay bestie, welcome to the SoTransformBoxDragger(3) page 💖 this is a Library Functions Manual entry and honestly? iconic.

SoTransformBoxDragger — it's the dragger that gives you a whole box ✨ and that box can be translated, scaled and rotated. three vibes in one dragger, we love a multitasker 👑

🦋 SYNOPSIS 🦋

#include <Inventor/draggers/SoTransformBoxDragger.h>

Inherits SoDragger. so like, everything SoDragger can do? it can do too. nepotism but make it useful 💅

✨ Public Member Functions ✨

these are the ones that are specifically hers, no cap:

  • virtual SoType getTypeId (void) const — get her type id, standard icon behaviour 🎀
  • virtual const SoNodekitCatalog * getNodekitCatalog (void) const — the nodekit catalog, returned as a const pointer
  • SoTransformBoxDragger (void) — the constructor, aka her grand entrance 🌟

💖 Public Member Functions inherited from SoDragger 💖

the whole ancestral group chat, all of it, nothing skipped:

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

🎀 Public Member Functions inherited from SoInteractionKit 🎀

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

🌈 Public Member Functions inherited from SoBaseKit 🌈

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

⭐ Public Member Functions inherited from SoNode ⭐

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

💜 Public Member Functions inherited from SoFieldContainer 💜

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

🫶 Public Member Functions inherited from SoBase 🫶

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

✨ Static Public Member Functions ✨

hers, the class-level 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 &center)
  • static void getTransformFast (SbMatrix &mtx, SbVec3f &translation, SbRotation &rotation, SbVec3f &scalefactor, SbRotation &scaleorientation)
  • static SbMatrix appendTranslation (const SbMatrix &mtx, const SbVec3f &translation, const SbMatrix *conversion=NULL)
  • static SbMatrix appendScale (const SbMatrix &mtx, const SbVec3f &scale, const SbVec3f &scalecenter, const SbMatrix *conversion=NULL)
  • static SbMatrix appendRotation (const SbMatrix &mtx, const SbRotation &rot, const SbVec3f &rotcenter, const SbMatrix *conversion=NULL)
  • static void initClass (void)
  • static void initClasses (void)

🧚 Static Public Member Functions inherited from SoInteractionKit 🧚

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

🔥 Static Public Member Functions inherited from SoBaseKit 🔥

  • static SoType getClassTypeId (void)
  • static void initClass (void)
  • static const SoNodekitCatalog * getClassNodekitCatalog (void)
  • static SbBool isSearchingChildren (void)
  • static void setSearchingChildren (const SbBool newval)
  • static SoNode * typeCheck (const SbName &partname, const SoType &parttype, SoNode *node)

👑 Static Public Member Functions inherited from SoNode 👑

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

Static Public Member Functions inherited from SoFieldContainer

  • static void initClass (void) — sets up the class for the whole inheritance chain, bestie. one and done.
  • static SoType getClassTypeId (void) — hands you the SoType id for this class, no cap.
  • static void initCopyDict (void) — spins up the copy dictionary so copying can happen. iconic prep work.
  • static void addCopy (const SoFieldContainer *orig, const SoFieldContainer *copy) — registers orig → copy in that dictionary.
  • static SoFieldContainer * checkCopy (const SoFieldContainer *orig) — checks if orig already has a copy registered.
  • static SoFieldContainer * findCopy (const SoFieldContainer *orig, const SbBool copyconnections) — goes hunting for the copy of orig, and copyconnections is the flag that decides the vibe.
  • static void copyDone (void) — cleanup time, the copy dictionary gets wrapped up.

Static Public Member Functions inherited from SoBase

  • static void initClass (void) — class init, as always.
  • static SoType getClassTypeId (void) — the SoType id please and thank you.
  • static void addName (SoBase *const base, const char *const name) — gives base a name. it's giving named.
  • static void removeName (SoBase *const base, const char *const name) — takes that name away.
  • static void incrementCurrentWriteCounter (void) — bumps the current write counter up.
  • static void decrementCurrentWriteCounter (void) — bumps it back down.
  • static SoBase * getNamedBase (const SbName &name, SoType type) — finds the base matching name and type.
  • static int getNamedBases (const SbName &name, SoBaseList &baselist, SoType type) — collects every match into baselist, returns a count.
  • static SbBool read (SoInput *in, SoBase *&base, SoType expectedtype) — reads a base off in, checking it against expectedtype.
  • static void setInstancePrefix (const SbString &c) — sets the instance prefix to c.
  • static void setTraceRefs (SbBool trace) — toggles reference tracing.
  • static SbBool getTraceRefs (void) — tells you whether reference tracing is on.
  • static SbBool connectRoute (SoInput *in, 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 *in) — reads a route in from in.

Public Attributes

  • SoSFRotation rotation — the rotation value, lowkey the whole point of the rotate-y part.
  • SoSFVec3f translation — the translation vector. moves the whole vibe.
  • SoSFVec3f scaleFactor — the scale factor. uniform only, bestie, we'll get to that.

Public Attributes inherited from SoDragger

  • SoSFBool isActive — is this dragger currently active? TRUE or FALSE, that's the tea.

Public Attributes inherited from SoInteractionKit

  • SoSFEnum renderCaching — render caching mode.
  • SoSFEnum boundingBoxCaching — bounding box caching mode.
  • SoSFEnum renderCulling — render culling mode.
  • SoSFEnum pickCulling — pick culling mode.

Protected Member Functions

  • virtual const SoFieldData * getFieldData (void) const — returns the field data for this class.
  • ~SoTransformBoxDragger () — the destructor, protected because it's ✨internal business✨.
  • virtual SbBool setUpConnections (SbBool onoff, SbBool doitalways=0) — hooks up (or unhooks) the internal connections.
  • virtual void setDefaultOnNonWritingFields (void) — sets defaults on fields that aren't being written out.

Protected Member Functions inherited from SoDragger

  • SoDragger (void) — constructor, protected.
  • virtual ~SoDragger () — destructor, protected.
  • SbVec2f getNormalizedLocaterPosition (void) — the locater position, normalized.
  • SbVec2s getLocaterPosition (void) — the raw locater position.
  • SbVec2s getStartLocaterPosition (void) const — where the locater was when the drag started.
  • void setStartLocaterPosition (SbVec2s p) — sets that starting locater position to p.
  • SbBool isAdequateConstraintMotion (void) — is the constraint motion adequate? vibe check, basically.
  • virtual SbBool shouldGrabBasedOnSurrogate (const SoPath *pickpath, const SoPath *surrogatepath) — decides whether to grab based on the surrogate path.
  • void setCameraInfo (SoAction *action) — pulls camera info out of action.
  • virtual void handleEvent (SoHandleEventAction *ha) — handles the event action ha.
  • void transferMotion (SoDragger *child) — passes motion along to child.
  • void setIgnoreInBbox (SbBool newval) — sets whether to ignore this in bounding box calculations.
  • SbBool isIgnoreInBbox (void) — tells you whether it's being ignored in bbox.
  • virtual void getBoundingBox (SoGetBoundingBoxAction *action) — bounding box handling for action.
  • 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, protected.
  • virtual void copyContents (const SoFieldContainer *fromFC, SbBool copyConnections) — copies contents over from fromFC.
  • virtual SbBool setPart (const int partNum, SoNode *node) — sets part number partNum to node.
  • virtual SbBool readInstance (SoInput *in, unsigned short flags) — reads an instance in from in.
  • virtual SbBool setAnyPartAsDefault (const SbName &partname, SoNode *node, SbBool anypart=1, SbBool onlyifdefault=1) — sets any part named partname as default from a node.
  • virtual SbBool setAnyPartAsDefault (const SbName &partname, const SbName &nodename, SbBool anypart=1, SbBool onlyifdefault=1) — same deal, but you name the node instead.
  • SbBool setAnySurrogatePath (const SbName &name, SoPath *path, SbBool leafcheck=0, SbBool publiccheck=0) — sets any surrogate path for name.
  • void connectSeparatorFields (SoSeparator *dest, SbBool onOff) — connects separator fields on dest.

Protected Member Functions inherited from SoBaseKit

  • virtual ~SoBaseKit () — destructor, protected.
  • virtual SoNode * addToCopyDict (void) const — adds this to the copy dictionary.
  • SoGroup * getContainerNode (const SbName &listname, SbBool makeifneeded=1) — grabs the container node for listname.
  • virtual SoNode * getAnyPart (const SbName &partname, SbBool makeifneeded, SbBool leafcheck=0, SbBool publiccheck=0) — gets any part by name.
  • virtual SoNodeKitPath * createPathToAnyPart (const SbName &partname, SbBool makeifneeded, SbBool leafcheck=0, SbBool publiccheck=0, const SoPath *pathtoextend=NULL) — builds a nodekit path to any part.
  • virtual SbBool setAnyPart (const SbName &partname, SoNode *from, SbBool anypart=1) — sets any part from from.
  • void createNodekitPartsList (void) — builds the nodekit parts list.
  • void createFieldList (void) — builds the field list.
  • virtual void createDefaultParts (void) — creates the default parts. essential.
  • 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 into out.

Protected Member Functions inherited from SoNode

  • SoNode (void) — constructor, protected.
  • virtual ~SoNode () — destructor, protected.

Protected Member Functions inherited from SoFieldContainer

  • SoFieldContainer (void) — constructor, protected.
  • ~SoFieldContainer () — destructor, protected.

Protected Member Functions inherited from SoBase

  • SoBase (void) — constructor, protected.
  • virtual ~SoBase () — destructor, protected.
  • virtual void destroy (void) — the actual teardown.
  • SbBool hasMultipleWriteRefs (void) const — do we have multiple write refs? inquiring minds.
  • SbBool writeHeader (SoOutput *out, SbBool isgroup, SbBool isengine) const — writes the header.
  • void writeFooter (SoOutput *out) const — writes the footer.
  • virtual const char * getFileFormatName (void) const — the file format name, as a string.

Static Protected Member Functions

  • static const SoFieldData ** getFieldDataPtr (void) — pointer to the field data pointer.
  • static const SoNodekitCatalog ** getClassNodekitCatalogPtr (void) — pointer to the nodekit catalog pointer.
  • static void invalidateSurroundScaleCB (void *f, SoDragger *d) — the callback that invalidates surround scale.
  • static void fieldSensorCB (void *f, SoSensor *s) — the field sensor callback.
  • static void valueChangedCB (void *f, SoDragger *d) — fires when a value changes.

Static Protected Member Functions inherited from SoDragger

  • static const SoFieldData ** getFieldDataPtr (void) — field data pointer.
  • static const SoNodekitCatalog ** getClassNodekitCatalogPtr (void) — nodekit catalog pointer.
  • static void childTransferMotionAndValueChangedCB (void *, SoDragger *) — child callback for motion transfer + value change.
  • 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

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

Static Protected Member Functions inherited from SoBaseKit

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

Static Protected Member Functions inherited from SoNode

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

Static Protected Member Functions inherited from SoBase

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

Protected Attributes

  • SoSFNode antiSquish — the anti-squish node, keeping everything proportional. protecting the vibe.
  • SoSFNode rotator1 — rotator number one.
  • SoSFNode rotator1Rot — rotator one's rotation.
  • SoSFNode rotator1Sep — rotator one's separator.
  • SoSFNode rotator2 — rotator number two.
  • SoSFNode rotator2Rot — rotator two's rotation.
  • SoSFNode rotator2Sep — rotator two's separator.
  • SoSFNode rotator3 — rotator number three.
  • SoSFNode rotator3Rot — rotator three's rotation.
  • SoSFNode rotator3Sep — rotator three's separator.
  • SoSFNode scaler — the scaling part, bestie.
  • SoSFNode surroundScale — the surrounding scale node.
  • SoSFNode translator1 — translator one.
  • SoSFNode translator1Rot — translator one's rotation.
  • SoSFNode translator1Sep — translator one's separator.
  • SoSFNode translator2 — translator two.
  • SoSFNode translator2Rot — translator two's rotation.
  • SoSFNode translator2Sep — translator two's separator.
  • SoSFNode translator3 — translator three.
  • SoSFNode translator3Rot — translator three's rotation.
  • SoSFNode translator3Sep — translator three's separator.
  • SoSFNode translator4 — translator four.
  • SoSFNode translator4Rot — translator four's rotation.
  • SoSFNode translator4Sep — translator four's separator.
  • SoSFNode translator5 — translator five.
  • SoSFNode translator5Rot — translator five's rotation.
  • SoSFNode translator5Sep — translator five's separator.
  • SoSFNode translator6 — translator six.
  • SoSFNode translator6Rot — translator six's rotation.
  • SoSFNode translator6Sep — translator six's separator.
  • SoFieldSensor * rotFieldSensor — watches the rotation field.
  • SoFieldSensor * translFieldSensor — watches the translation field.
  • SoFieldSensor * scaleFieldSensor — watches the scale field.

Protected Attributes inherited from SoDragger

  • SoSFNode motionMatrix — the motion matrix. doing the most, as always.

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.

Protected Attributes inherited from SoBaseKit

  • SoSFNode callbackList — the callback list node.
  • SoChildList * children — the children, obviously.
  • SbBool connectionsSetUp — whether connections are set up.

Protected Attributes inherited from SoNode

  • uint32_t uniqueId — this node's unique id. everyone gets one, no exceptions.

Protected Attributes inherited from SoFieldContainer

  • SbBool isBuiltIn — is it built in? yes or no.

Additional Inherited Members

Public Types inherited from SoDragger

  • enum ProjectorFrontSetting { FRONT, BACK, USE_PICK } — which side the projector faces: FRONT, BACK, or USE_PICK.

Public Types inherited from SoInteractionKit

  • enum CacheEnabled { OFF, ON, AUTO } — caching states: OFF, ON, AUTO.

Public Types inherited from SoNode

  • enum NodeType { INVENTOR = 0x0000, VRML1 = 0x0001, VRML2 = 0x0002, INVENTOR_1 = 0x0004, INVENTOR_2_0 = 0x0008, INVENTOR_2_1 = 0x0010, INVENTOR_2_5 = 0x0020, INVENTOR_2_6 = 0x0040, COIN_1_0 = 0x0080, COIN_2_0 = 0x0100, EXTENSION = 0x0200, COIN_2_2 = 0x0400, COIN_2_3 = 0x0800, COIN_2_4 = 0x1000, INVENTOR_5_0 = 0x2000, COIN_2_5 = 0x4000 } — the whole family tree of node types with their bitmask values. a whole lineage, honestly.

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 = 0 — the next unique id to hand out, starting at 0.
  • static int nextActionMethodIndex = 0 — the next action method index, starting at 0.

Detailed Description

The SoTransformBoxDragger provides a box which can be translated, scaled and rotated. like, all three at once. multitasking queen. 👑

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

(this is where the little picture of the dragger lives — default geometry, inactive, just chilling)

Translate the dragger by clicking and dragging any of the (invisible) sides. yes bestie, invisible. you're dragging vibes. Scaling is done by dragging the corner cubes — and heads up, only uniform scaling is supported, so don't come for me with your non-uniform dreams. Rotation is done by dragging any of the 12 beams connecting the corner cubes. twelve of them. count 'em. 🦋

This dragger consists of a rigid framework for doing all the usual interaction operations on scene geometry. The "user interface" of the dragger is very simple, providing little room for the end-user to make mistakes. it's giving foolproof. it's giving "the design ate and left no crumbs." ✨

For the application programmer's convenience, the Coin library also provides a manipulator class called SoTransformBoxManip, which wraps the SoTransformBoxDragger into the necessary mechanisms for making direct insertion of this dragger into a scenegraph possible with very little effort. so if you want the plug-and-play version, that's the one. 💅

See also

  • SoTransformBoxManip

💖 Constructor & Destructor Documentation 💖

✨ SoTransformBoxDragger::SoTransformBoxDragger(void) ✨

okay so this is the default constructor bestie, and the way it sets up the dragger nodekit catalog with the interaction and feedback geometry? yeah it ate. 💅

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

CLASS SoTransformBoxDragger
-->"this"
      "callbackList"
      "topSeparator"
         "motionMatrix"
-->      "surroundScale"
-->      "antiSquish"
-->      "scaler"
-->      "rotator1Sep"
-->         "rotator1Rot"
-->         "rotator1"
-->      "rotator2Sep"
-->         "rotator2Rot"
-->         "rotator2"
-->      "rotator3Sep"
-->         "rotator3Rot"
-->         "rotator3"
-->      "translator1Sep"
-->         "translator1Rot"
-->         "translator1"
-->      "translator2Sep"
-->         "translator2Rot"
-->         "translator2"
-->      "translator3Sep"
-->         "translator3Rot"
-->         "translator3"
-->      "translator4Sep"
-->         "translator4Rot"
-->         "translator4"
-->      "translator5Sep"
-->         "translator5Rot"
-->         "translator5"
-->      "translator6Sep"
-->         "translator6Rot"
-->         "translator6"
         "geomSeparator"

(See SoBaseKit::printDiagram() for information about the output formatting.)

Detailed information on catalog parts:

CLASS SoTransformBoxDragger
PVT   "this",  SoTransformBoxDragger  ---
      "callbackList",  SoNodeKitListPart [ SoCallback, SoEventCallback ]
PVT   "topSeparator",  SoSeparator  ---
PVT   "motionMatrix",  SoMatrixTransform  ---
      "surroundScale",  SoSurroundScale  ---
      "antiSquish",  SoAntiSquish  ---
      "scaler",  SoScaleUniformDragger  ---
PVT   "rotator1Sep",  SoSeparator  ---
PVT   "rotator1Rot",  SoRotation  ---
      "rotator1",  SoRotateCylindricalDragger  ---
PVT   "rotator2Sep",  SoSeparator  ---
PVT   "rotator2Rot",  SoRotation  ---
      "rotator2",  SoRotateCylindricalDragger  ---
PVT   "rotator3Sep",  SoSeparator  ---
PVT   "rotator3Rot",  SoRotation  ---
      "rotator3",  SoRotateCylindricalDragger  ---
PVT   "translator1Sep",  SoSeparator  ---
PVT   "translator1Rot",  SoRotation  ---
      "translator1",  SoTranslate2Dragger  ---
PVT   "translator2Sep",  SoSeparator  ---
PVT   "translator2Rot",  SoRotation  ---
      "translator2",  SoTranslate2Dragger  ---
PVT   "translator3Sep",  SoSeparator  ---
PVT   "translator3Rot",  SoRotation  ---
      "translator3",  SoTranslate2Dragger  ---
PVT   "translator4Sep",  SoSeparator  ---
PVT   "translator4Rot",  SoRotation  ---
      "translator4",  SoTranslate2Dragger  ---
PVT   "translator5Sep",  SoSeparator  ---
PVT   "translator5Rot",  SoRotation  ---
      "translator5",  SoTranslate2Dragger  ---
PVT   "translator6Sep",  SoSeparator  ---
PVT   "translator6Rot",  SoRotation  ---
      "translator6",  SoTranslate2Dragger  ---
PVT   "geomSeparator",  SoSeparator  ---

(See SoBaseKit::printTable() for information about the output formatting.)

References SoDragger::addValueChangedCallback(), fieldSensorCB(), SoInteractionKit::readDefaultParts(), SoAntiSquish::recalcAlways, SoRotation::rotation, rotation, rotFieldSensor, scaleFactor, scaleFieldSensor, SoField::setDefault(), setUpConnections(), SoAntiSquish::sizing, SoTransformBoxDragger(), translation, translFieldSensor, and valueChangedCB().

Referenced by fieldSensorCB(), getFieldData(), invalidateSurroundScaleCB(), SoTransformBoxDragger(), and valueChangedCB().

🔒 SoTransformBoxDragger::~SoTransformBoxDragger() [protected] 🔒

Protected destructor, bestie. it's shy. 🙈

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

References rotFieldSensor, scaleFieldSensor, and translFieldSensor.

🎀 Member Function Documentation 🎀

💫 SoType SoTransformBoxDragger::getTypeId(void) const [virtual] 💫

Returns the type identification of an object derived from a class inheriting SoBase. This is used for run-time type checking and "downward" casting. fr fr it's how you figure out what you're actually holding. ✨

Usage example:

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

For application programmers 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 * SoTransformBoxDragger::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.

References SoTransformBoxDragger().

💫 const SoNodekitCatalog * SoTransformBoxDragger::getNodekitCatalog(void) const [virtual] 💫

Returns the nodekit catalog which defines the layout of this class' kit. it's giving blueprint energy ngl. 🗺️

Reimplemented from SoDragger.

💫 SbBool SoTransformBoxDragger::setUpConnections(SbBool onoff, SbBool doitalways = 0) [protected], [virtual] 💫

Sets up all internal connections for instances of this class. wiring arc, slay. 🔌

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

Reimplemented from SoInteractionKit.

References SoBaseKit::connectionsSetUp, SoBaseKit::getAnyPart(), SbString::getString(), rotation, rotFieldSensor, scaleFactor, scaleFieldSensor, SoInteractionKit::setPartAsDefault(), SoBaseKit::setUpConnections(), SoDragger::SoDragger(), SbString::sprintf(), translation, and translFieldSensor.

Referenced by SoTransformBoxDragger().

💫 void SoTransformBoxDragger::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.

References SoDragger::setDefaultOnNonWritingFields().

💫 void SoTransformBoxDragger::invalidateSurroundScaleCB(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. iykyk, don't touch. 🙅♀️

References SoSurroundScale::invalidate(), SoAntiSquish::recalc(), SoDragger::SoDragger(), and SoTransformBoxDragger().

💫 void SoTransformBoxDragger::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(), SoTransformBoxDragger(), and SoDragger::workFieldsIntoTransform().

Referenced by SoTransformBoxDragger().

💫 void SoTransformBoxDragger::valueChangedCB(void * f, SoDragger * d) [static], [protected] 💫

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

References SoFieldSensor::attach(), SoFieldSensor::detach(), SoDragger::getMotionMatrix(), SbMatrix::getTransform(), rotation, rotFieldSensor, scaleFactor, scaleFieldSensor, SoDragger::SoDragger(), SoTransformBoxDragger(), translation, and translFieldSensor.

Referenced by SoTransformBoxDragger().

🦋 Member Data Documentation 🦋

🌸 SoSFRotation SoTransformBoxDragger::rotation 🌸

This field is continuously updated to contain the rotation of the dragger's box. yes it spins, periodt. 💫

Referenced by setUpConnections(), SoTransformBoxDragger(), and valueChangedCB().

🌸 SoSFVec3f SoTransformBoxDragger::translation 🌸

The dragger's offset position from the local origo.

Referenced by setUpConnections(), SoTransformBoxDragger(), and valueChangedCB().

🌸 SoSFVec3f SoTransformBoxDragger::scaleFactor 🌸

Continuously updated to contain the current vector of scaling along the X, Y and Z axes. The three components will always be equal, as this dragger only supports uniform scale operations. no stretching one axis and calling it a day, bestie. ⚖️

Referenced by setUpConnections(), SoTransformBoxDragger(), and valueChangedCB().

🔐 SoFieldSensor* SoTransformBoxDragger::rotFieldSensor [protected] 🔐

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

Referenced by setUpConnections(), SoTransformBoxDragger(), valueChangedCB(), and ~SoTransformBoxDragger().

🔐 SoFieldSensor* SoTransformBoxDragger::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(), SoTransformBoxDragger(), valueChangedCB(), and ~SoTransformBoxDragger().

🔐 SoFieldSensor* SoTransformBoxDragger::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(), SoTransformBoxDragger(), valueChangedCB(), and ~SoTransformBoxDragger().

🌈 Author 🌈

Generated automatically by Doxygen for Coin from the source code.

and that's the whole page bestie!! 🫶 this lil legend came straight from Coin Version 2.5.0 — no date on the footer, so we're just vibing with the version. auto-generated by Doxygen, manually hyped by me. 💖 stay slay, stay connected, and may your draggers always drag. ✨🎀
📦 where this page comes from