SoTabPlaneDragger(3)

📦 version 3.1.3, in fedora 43, fedora 44

okay so bestie, you're looking at SoTabPlaneDragger(3) from the Library Functions Manual, and honestly? this one is a whole main character 💅 she's a dragger that lets you translate and scale stuff inside a plane, which is lowkey iconic. this is part 1 of 3 so buckle up, we're not even at the plot twist yet 🦋

🎀 NAME 🎀

The SoTabPlaneDragger class is a dragger you can translate and scale within a plane. periodt. no cap, that's literally her whole job 💖

✨ SYNOPSIS ✨

#include <Inventor/draggers/SoTabPlaneDragger.h>

she inherits from SoDragger, which means she got the whole family tree behind her 👑

💅 Public Member Functions 💅

  • virtual SoType getTypeId (void) const
  • virtual const SoNodekitCatalog * getNodekitCatalog (void) const
  • SoTabPlaneDragger (void)
  • void adjustScaleTabSize (void)

these four? they're hers. hers specifically. the rest below are the inherited flexes, and there are a LOT of them, so grab a snack 🍓

🦋 Public Member Functions inherited from SoDragger 🦋

the way she gets all of these for free... obsessed.

  • virtual void callback (SoCallbackAction *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

okay that was a lot. hydrate. 💧

🌸 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. they don't need an instance, they just are 💅

  • 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 👑

  • 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 ✨

bestie these are the static ones your SoFieldContainer ancestors are handing down, they're giving legacy, they're giving foundation 💅

  • static void initClass (void) — the lil class-initializer ritual, run it and the class is officially awake ✨
  • static SoType getClassTypeId (void) — hands you the SoType id for this class 🎀
  • static void cleanupClass (void) — the tidy-up-on-the-way-out one 🧹
  • static void initCopyDict (void) — kicks off the copy dictionary 🦋
  • static void addCopy (const SoFieldContainer *orig, const SoFieldContainer *copy) — registers a copy against its original 📝
  • static SoFieldContainer * checkCopy (const SoFieldContainer *orig) — peeks for the copy that belongs to orig 👀
  • static SoFieldContainer * findCopy (const SoFieldContainer *orig, const SbBool copyconnections) — the full lookup, connections and all 🔍
  • static void copyDone (void) — copy session over, we're done here 💖

✨ Static Public Member Functions inherited from SoBase ✨

more statics, this time from SoBase, the grandparent of basically everything fr fr

  • static void initClass (void) — same energy, different class 🫶
  • static SoType getClassTypeId (void) — the SoType id, once again 💫
  • 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 current write counter up ⬆️
  • static void decrementCurrentWriteCounter (void) — bumps it back down ⬇️
  • static SoBase * getNamedBase (const SbName &name, SoType type) — finds you the base with that name and type 🎯
  • static int getNamedBases (const SbName &name, SoBaseList &baselist, SoType type) — the plural version, fills up a SoBaseList 🧺
  • static SbBool read (SoInput *input, SoBase *&base, SoType expectedtype) — reads a base in from SoInput 📖
  • static void setInstancePrefix (const SbString &c) — sets the instance prefix string ✏️
  • static void setTraceRefs (SbBool trace) — turns reference tracing on or off 🔦
  • static SbBool getTraceRefs (void) — asks whether reference tracing is on 🤔
  • static SbBool connectRoute (SoInput *input, const SbName &fromnodename, const SbName &fromfieldname, const SbName &tonodename, const SbName &tofieldname) — wires a route from one node+field to another 🔌
  • static SbBool readRoute (SoInput *input) — reads a route in from SoInput 🛣️

💫 Public Attributes 💫

the actual juicy fields you can poke at:

  • SoSFVec3f translation — the translation, a whole SoSFVec3f of it 🌈
  • SoSFVec3f scaleFactor — the scale factor, also an SoSFVec3f 👑

🌸 Public Attributes inherited from SoDragger 🌸

  • SoSFBool isActive — is this dragger active or not, classic yes/no energy 💅

🎀 Public Attributes inherited from SoInteractionKit 🎀

  • SoSFEnum renderCaching — the render caching mode 🖼️
  • SoSFEnum boundingBoxCaching — the bounding box caching mode 📦
  • SoSFEnum renderCulling — the render culling mode ✂️
  • SoSFEnum pickCulling — the pick culling mode 🎯

🦋 Protected Member Functions 🦋

the behind-the-scenes besties, only the family gets to call these:

  • virtual const SoFieldData * getFieldData (void) const — hands back the SoFieldData ✨
  • virtual ~SoTabPlaneDragger (void) — the destructor, say bye 👋
  • virtual void GLRender (SoGLRenderAction *action) — the GL render hook, this is where it actually gets drawn 🎨
  • virtual SbBool setUpConnections (SbBool onoff, SbBool doitalways=FALSE) — sets the connections up (or tears them down), with a doitalways flag defaulting to FALSE 🔗
  • virtual void setDefaultOnNonWritingFields (void) — sets defaults on the non-writing fields 📝
  • void reallyAdjustScaleTabSize (SoGLRenderAction *action) — yes, really adjusts the scale tab size 😭 the name is not kidding
  • void getXYScreenLengths (SbVec2f &lengths, const SbMatrix &localtoscreen, const SbVec2s &winsize) — works out the X/Y screen lengths from the local-to-screen matrix and window size 📐
  • void dragStart (void) — the drag begins 🏁
  • void drag (void) — mid-drag, we're moving 🛼
  • void dragFinish (void) — drag over, we did it 🏆

💜 Protected Member Functions inherited from SoDragger 💜

  • SoDragger (void) — the constructor 🫶
  • virtual ~SoDragger (void) — the destructor 💔
  • SbVec2f getNormalizedLocaterPosition (void) — the normalized locater position 🧭
  • SbVec2s getLocaterPosition (void) — the raw locater position 📍
  • SbVec2s getStartLocaterPosition (void) const — where the locater was when we started 📌
  • void setStartLocaterPosition (SbVec2s p) — set that start position, using p ✏️
  • SbBool isAdequateConstraintMotion (void) — is this constraint motion adequate, y/n ❓
  • virtual SbBool shouldGrabBasedOnSurrogate (const SoPath *pickpath, const SoPath *surrogatepath) — decides whether to grab based on the surrogate 🎣
  • void setCameraInfo (SoAction *action) — stashes the camera info from the action 📷
  • virtual void handleEvent (SoHandleEventAction *ha) — the event handler, this is where input lands 🎪
  • void transferMotion (SoDragger *child) — passes the motion along to the child dragger 🔄
  • void setIgnoreInBbox (SbBool newval) — set whether to ignore this in the bounding box 🙈
  • SbBool isIgnoreInBbox (void) — are we ignoring it in the bbox or not 🤨
  • virtual void getBoundingBox (SoGetBoundingBoxAction *action) — the bounding box hook 📦
  • void setActiveChildDragger (SoDragger *newchilddragger) — set the active child dragger 👶
  • SoDragger * getActiveChildDragger (void) const — get the active child dragger 👀
  • void updateDraggerCache (const SoPath *path) — refreshes the dragger cache 🗂️

⭐ Protected Member Functions inherited from SoInteractionKit ⭐

(noting that a couple of these are written without the void, and we're keeping them exactly as they came 💅)

  • 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 an instance in 📖
  • virtual SbBool setAnyPartAsDefault (const SbName &partname, SoNode *node, SbBool anypart=TRUE, SbBool onlyifdefault=TRUE) — sets any part as the default, anypart=TRUE and onlyifdefault=TRUE by default 🎯
  • virtual SbBool setAnyPartAsDefault (const SbName &partname, const SbName &nodename, SbBool anypart=TRUE, SbBool onlyifdefault=TRUE) — same deal but by node name 🏷️
  • SbBool setAnySurrogatePath (const SbName &name, SoPath *path, SbBool leafcheck=FALSE, SbBool publiccheck=FALSE) — sets a surrogate path, leafcheck=FALSE, publiccheck=FALSE 🌿
  • void connectSeparatorFields (SoSeparator *dest, SbBool onOff) — connects the separator fields on the destination 🔌

🍓 Protected Member Functions inherited from SoBaseKit 🍓

  • virtual ~SoBaseKit () — destructor 💔
  • virtual SoNode * addToCopyDict (void) const — adds itself to the copy dict 📚
  • SoGroup * getContainerNode (const SbName &listname, SbBool makeifneeded=TRUE) — gets the container node for listname, makeifneeded=TRUE 📦
  • virtual SoNode * getAnyPart (const SbName &partname, SbBool makeifneeded, SbBool leafcheck=FALSE, SbBool publiccheck=FALSE) — gets any part, with leafcheck=FALSE and publiccheck=FALSE 🧩
  • virtual SoNodeKitPath * createPathToAnyPart (const SbName &partname, SbBool makeifneeded, SbBool leafcheck=FALSE, SbBool publiccheck=FALSE, const SoPath *pathtoextend=NULL) — builds a path to any part, pathtoextend=NULL by default 🛤️
  • virtual SbBool setAnyPart (const SbName &partname, SoNode *from, SbBool anypart=TRUE) — sets any part, anypart=TRUE 🎀
  • 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 — hands back the nodekit parts list 🗂️
  • const SbList< SoSFNode * > & getCatalogInstances (void) const — the catalog instances list 📚
  • void catalogError (void) — a catalog error, oh no 😭
  • void countMyFields (SoOutput *out) — counts the fields, writes to SoOutput 🔢

🧚 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) — the destroy call 💀
  • 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 📄

🌟 Static Protected Member Functions 🌟

  • static const SoFieldData ** getFieldDataPtr (void) — pointer to the field data pointer, yes it's a double pointer, slay 🎯
  • static const SoNodekitCatalog ** getClassNodekitCatalogPtr (void) — pointer to the class nodekit catalog pointer 🗂️

💖 Static Protected Member Functions inherited from SoDragger 💖

  • static const SoFieldData ** getFieldDataPtr (void) — the field data pointer again ✨
  • static const SoNodekitCatalog ** getClassNodekitCatalogPtr (void) — the nodekit catalog pointer again 📚
  • static void childTransferMotionAndValueChangedCB (void *, SoDragger *) — the child motion-transfer + value-changed callback 🎠
  • static void childValueChangedCB (void *, SoDragger *) — child value-changed callback 🔔
  • static void childStartCB (void *, SoDragger *) — child start callback 🏁
  • static void childMotionCB (void *, SoDragger *) — child motion callback 🛼
  • static void childFinishCB (void *, SoDragger *) — child finish callback 🏆
  • static void childOtherEventCB (void *, SoDragger *) — the catch-all child "other event" callback 🎪

🎠 Static Protected Member Functions inherited from SoInteractionKit 🎠

  • static const SoFieldData ** getFieldDataPtr (void) — the pointer to field data, encore 🌟
  • static const SoNodekitCatalog ** getClassNodekitCatalogPtr (void) — the nodekit catalog pointer, encore 🗂️
  • static void readDefaultParts (const char *fileName, const char defaultBuffer[], int defBufSize) — reads the default parts from a file, given the buffer and its size 📥
  • static void fieldSensorCB (void *, SoSensor *) — the field sensor callback 🛰️

🧁 Static Protected Member Functions inherited from SoBaseKit 🧁

  • static const SoFieldData ** getFieldDataPtr (void) — yes, the field data pointer, again 💫
  • static const SoNodekitCatalog ** getClassNodekitCatalogPtr (void) — and the nodekit catalog pointer, again 📖

🌸 Static Protected Member Functions inherited from SoNode 🌸

  • static const SoFieldData ** getFieldDataPtr (void) — the field data pointer, never not here ✨
  • 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 for a node type with a bitmask 🎛️

🫶 Static Protected Member Functions inherited from SoBase 🫶

  • static uint32_t getCurrentWriteCounter (void) — the current write counter 🔢
  • static void staticDataLock (void) — lock the static data 🔒
  • static void staticDataUnlock (void) — unlock the static data 🔓

👑 Protected Attributes 👑

the protected fields, the private-ish family members:

  • SoSFNode cornerScaleCoords — corner scale coords 📐
  • SoSFNode cornerScaleTab0 — corner scale tab 0️⃣
  • SoSFNode cornerScaleTab1 — corner scale tab 1️⃣
  • SoSFNode cornerScaleTab2 — corner scale tab 2️⃣
  • SoSFNode cornerScaleTab3 — corner scale tab 3️⃣
  • SoSFNode edgeScaleCoords — edge scale coords 📏
  • SoSFNode edgeScaleTab0 — edge scale tab 0️⃣
  • SoSFNode edgeScaleTab1 — edge scale tab 1️⃣
  • SoSFNode edgeScaleTab2 — edge scale tab 2️⃣
  • SoSFNode edgeScaleTab3 — edge scale tab 3️⃣
  • SoSFNode planeSwitch — the plane switch 🎚️
  • SoSFNode scaleTabHints — scale tab hints 💡
  • SoSFNode scaleTabMaterial — the scale tab material 🎨
  • SoSFNode scaleTabMaterialBinding — the scale tab material binding 🔗
  • SoSFNode scaleTabNormal — the scale tab normal 📐
  • SoSFNode scaleTabNormalBinding — the scale tab normal binding 🔗
  • SoSFNode scaleTabs — the scale tabs themselves 🎀
  • SoSFNode translator — the translator 🌐

💅 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 — pointer to the field sensor 🛰️
  • SoSeparator * oldTopSep — pointer to the old top separator 👵

🎀 Protected Attributes inherited from SoBaseKit 🎀

  • SoSFNode callbackList — the callback list 📞
  • SoChildList * children — pointer to the children 👶
  • SbBool connectionsSetUp — whether the connections are set up ✅

⭐ Protected Attributes inherited from SoNode ⭐

  • uint32_t uniqueId — the unique id, one per node 🆔

🍓 Protected Attributes inherited from SoFieldContainer 🍓

  • SbBool isBuiltIn — is it built in, y/n 🏠

🌈 Additional Inherited Members 🌈

💫 Public Types inherited from SoDragger

  • enum ProjectorFrontSetting { FRONT, BACK, USE_PICK } — the projector front setting: FRONT, BACK, or USE_PICK 🎯

🌸 Public Types inherited from SoInteractionKit

  • enum CacheEnabled { OFF, ON, AUTO } — caching options: OFF, ON, AUTO 🎚️

🧚 Public Types inherited from SoNode

  • enum NodeType — and here's the whole lineup, every flag and its exact value, no cap:
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

👑 Protected Types inherited from SoBase

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

🎠 Static Protected Attributes inherited from SoNode

  • static uint32_t nextUniqueId = 1 — starts at 1 🆔
  • static int nextActionMethodIndex = 0 — starts at 0 🔢

📖 Detailed Description 📖

The SoTabPlaneDragger class is a dragger you can translate and scale within a plane. 🛼✨

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

(picture it, bestie — the default geometry, just vibing, inactive, not yet being dragged) 🖼️

For translation, click anywhere inside the dragger's plane and move it about in 2D. 🖱️

For non-uniform scaling operations, click and drag any of the 4 side tabs. For uniform scaling, click and drag any of the 4 corner tabs. 🎀

👀 See also 👀

  • SoTabBoxDragger — go read that one next bestie, it's giving cousin energy 💖

🔨 Constructor & Destructor Documentation 🎀

✨ SoTabPlaneDragger::SoTabPlaneDragger (void )

Okay bestie, this is the default constructor — it sets up the dragger nodekit catalog with all the interaction and feedback geometry. It's giving ✨*foundation*✨ energy.

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

CLASS SoTabPlaneDragger
-->"this"
      "callbackList"
      "topSeparator"
         "motionMatrix"
         "geomSeparator"
-->         "planeSwitch"
-->            "translator"
-->            "scaleTabs"
-->               "scaleTabMaterial"
-->               "scaleTabHints"
-->               "scaleTabMaterialBinding"
-->               "scaleTabNormalBinding"
-->               "scaleTabNormal"
-->               "edgeScaleCoords"
-->               "edgeScaleTab0"
-->               "edgeScaleTab1"
-->               "edgeScaleTab2"
-->               "edgeScaleTab3"
-->               "cornerScaleCoords"
-->               "cornerScaleTab0"
-->               "cornerScaleTab1"
-->               "cornerScaleTab2"
-->               "cornerScaleTab3"

(See SoBaseKit::printDiagram() for information about the output formatting — that's the one that renders this lil tree for you.)

Detailed information on catalog parts:

CLASS SoTabPlaneDragger
PVT   "this",  SoTabPlaneDragger  ---
      "callbackList",  SoNodeKitListPart [ SoCallback, SoEventCallback ]
PVT   "topSeparator",  SoSeparator  ---
PVT   "motionMatrix",  SoMatrixTransform  ---
PVT   "geomSeparator",  SoSeparator  ---
PVT   "planeSwitch",  SoSwitch  ---
      "translator",  SoSeparator  ---
PVT   "scaleTabs",  SoSeparator  ---
      "scaleTabMaterial",  SoMaterial  ---
      "scaleTabHints",  SoShapeHints  ---
PVT   "scaleTabMaterialBinding",  SoMaterialBinding  ---
PVT   "scaleTabNormalBinding",  SoNormalBinding  ---
PVT   "scaleTabNormal",  SoNormal  ---
PVT   "edgeScaleCoords",  SoCoordinate3  ---
PVT   "edgeScaleTab0",  SoIndexedFaceSet  ---
PVT   "edgeScaleTab1",  SoIndexedFaceSet  ---
PVT   "edgeScaleTab2",  SoIndexedFaceSet  ---
PVT   "edgeScaleTab3",  SoIndexedFaceSet  ---
PVT   "cornerScaleCoords",  SoCoordinate3  ---
PVT   "cornerScaleTab0",  SoIndexedFaceSet  ---
PVT   "cornerScaleTab1",  SoIndexedFaceSet  ---
PVT   "cornerScaleTab2",  SoIndexedFaceSet  ---
PVT   "cornerScaleTab3",  SoIndexedFaceSet  ---

(See SoBaseKit::printTable() for information about the output formatting — yes, there's a whole other printer for the table version. iconic.)

✨ SoTabPlaneDragger::~SoTabPlaneDragger (void ) — [protected], [virtual]

Protected destructor, bestie. She's shy. 🙈

(Dragger classes are derived from SoBase, so they are reference counted and automatically destroyed when their reference count goes to 0 — no manual cleanup, she just leaves when nobody's holding on anymore. 💅)

🛠️ Member Function Documentation 💖

⭐ SoType SoTabPlaneDragger::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. Basically the "who dis?" check but for classes. 👑

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 * SoTabPlaneDragger::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. That's it, that's the whole vibe. 🫶

Reimplemented from SoDragger.

⭐ const SoNodekitCatalog * SoTabPlaneDragger::getNodekitCatalog (void ) const — [virtual]

Returns the nodekit catalog which defines the layout of this class' kit. It's literally the blueprint bestie 📐✨

Reimplemented from SoDragger.

⭐ void SoTabPlaneDragger::adjustScaleTabSize (void )

Signals the dragger to recalculate the size of its tabs.

Heads up: this method is not doing anything useful in Coin, since the tab sizes are recalculated every time the dragger is rendered, even though this method has not been called. So it's giving "I'm helping" but actually it's just standing there. 😭

⭐ void SoTabPlaneDragger::GLRender (SoGLRenderAction * action) — [protected], [virtual]

Action method for the SoGLRenderAction.

This is called during rendering traversals. Nodes influencing the rendering state in any way, or who wants to throw geometry primitives at OpenGL, override this method. Go off, throw those primitives 💅🔥

Reimplemented from SoDragger.

⭐ SbBool SoTabPlaneDragger::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. So like… not your problem unless it's your problem, yk? 🦋)

Reimplemented from SoInteractionKit.

⭐ void SoTabPlaneDragger::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 — don't ghost your parent class bestie, call up. ☎️✨

Reimplemented from SoDragger.

⭐ void SoTabPlaneDragger::reallyAdjustScaleTabSize (SoGLRenderAction * action) — [protected]

Recalculates the size of the tabs, based on the current view volume, the current viewport, the current model matrix and the current scale factor. If action == NULL, a default size will be used. She does the actual work the other one claimed to do. main character energy fr 💅

⭐ void SoTabPlaneDragger::getXYScreenLengths (SbVec2f & lengths, const SbMatrix & localtoscreen, const SbVec2s & winsize) — [protected]

Not implemented. That's it. That's the whole entry. She said "no ❤️". 💀

⭐ void SoTabPlaneDragger::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. ✨ the moment of picking ✨

⭐ void SoTabPlaneDragger::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 SoTabPlaneDragger::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. 🎬 that's a wrap, periodt.

📦 Member Data Documentation 🍓

🌸 SoSFVec3f SoTabPlaneDragger::translation

Continuously updated to contain the current translation from the dragger's local origo position. She's always keeping you posted bestie, never ghosting the update. 💖

🌸 SoSFVec3f SoTabPlaneDragger::scaleFactor

Continuously updated to contain the current vector of scaling along the X, Y and Z axes. The Z component will always be 1.0. Always. No exceptions. That Z is a fixed icon and she knows it. 👑

👑 Author

Generated automatically by Doxygen for Coin from the source code. Not a human, just a lil robot doing its best. 🤖💖

So that's the whole page, bestie — this one came from Coin Version 3.1.3 and it's the SoTabPlaneDragger(3) manual page. Thanks for reading all the way through, you're literally the strongest soldier I know 🫶✨

📦 where this page comes from