SoTabPlaneDragger(3)

πŸ“¦
version 4.0.10 Β· 4 versions
, in fedora 43, fedora 44

πŸ’… SoTabPlaneDragger β€” the Coin manual but it's a group chat

okay bestie, this is SoTabPlaneDragger(3) from the Coin docs, and I am NOT skipping a single thing. every signature, every inherited member, all of it. this is part 1 of 3, so don't go anywhere. πŸŽ€βœ¨


✨ NAME ✨

SoTabPlaneDragger β€” bestie, the SoTabPlaneDragger class is a dragger you can translate and scale within a plane. that's the whole vibe. iconic. πŸ’…


🌸 SYNOPSIS 🌸

#include <Inventor/draggers/SoTabPlaneDragger.h>

Inherits SoDragger. πŸ’–


🫢 Public Member Functions

so these are the ones that belong to SoTabPlaneDragger itself, the main character ones:

  • virtual SoType getTypeId (void) const
  • virtual const SoNodekitCatalog * getNodekitCatalog (void) const
  • SoTabPlaneDragger (void) β€” yep, the constructor, hi bestie πŸ‘‹
  • void adjustScaleTabSize (void)

🌟 Public Member Functions inherited from SoDragger

all of these come from the parent class, no cap:

  • 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

🌈 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)
  • SbUniqueId 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 β€” Returns TRUE if the type of this object is either of the same type or inherited from type. πŸ’―
  • 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 ones that belong to SoTabPlaneDragger:

  • 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) β€” Sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system. πŸ› οΈ
  • 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)

and that's part 1 bestie πŸ’… more is coming, don't go anywhere ✨

✨ Static Public Member Functions inherited from SoNode ✨

squad, these are the static baddies you get for free from SoNode πŸ’«

  • static uint32_t getCompatibilityTypes (const SoType &nodetype) β€” grabs the compatibility bitmask for a node type.
  • static SoType getClassTypeId (void) β€” the class's own SoType.
  • static SoNode * getByName (const SbName &name) β€” look a node up by name, single result.
  • static int getByName (const SbName &name, SoNodeList &l) β€” the collect-them-all version, drops matches into the list.
  • static void initClass (void) β€” sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system. it's giving "welcome committee energy" 🫢
  • static void initClasses (void) β€” plural version, does the whole squad at once.
  • static SbUniqueId getNextNodeId (void) β€” next unique id, fresh off the press.
  • static int getActionMethodIndex (const SoType type) β€” the action method index for a type.
  • static void getBoundingBoxS (SoAction *action, SoNode *node) β€” the static action hook for bounding boxes.
  • static void GLRenderS (SoAction *action, SoNode *node) β€” static hook for GL rendering.
  • static void callbackS (SoAction *action, SoNode *node) β€” static hook for callbacks.
  • static void getMatrixS (SoAction *action, SoNode *node) β€” static hook for matrix actions.
  • static void handleEventS (SoAction *action, SoNode *node) β€” static hook for events.
  • static void pickS (SoAction *action, SoNode *node) β€” static hook for picking.
  • static void rayPickS (SoAction *action, SoNode *node) β€” static hook for ray picking.
  • static void searchS (SoAction *action, SoNode *node) β€” static hook for search actions.
  • static void writeS (SoAction *action, SoNode *node) β€” static hook for writing.
  • static void audioRenderS (SoAction *action, SoNode *node) β€” static hook for audio rendering.
  • static void getPrimitiveCountS (SoAction *action, SoNode *node) β€” static hook for counting primitives.

✨ Static Public Member Functions inherited from SoFieldContainer ✨

  • static void initClass (void) β€” sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system. same energy, different parent πŸ’…
  • static SoType getClassTypeId (void) β€” this static method returns the SoType object associated with objects of this class.
  • static void cleanupClass (void) β€” tidies up after the class, no crumbs left.
  • static void initCopyDict (void) β€” kicks off the copy dictionary situation.
  • static void addCopy (const SoFieldContainer *orig, const SoFieldContainer *copy) β€” registers an original β†’ copy pair.
  • static SoFieldContainer * checkCopy (const SoFieldContainer *orig) β€” checks whether a copy already exists for this original.
  • static SoFieldContainer * findCopy (const SoFieldContainer *orig, const SbBool copyconnections) β€” finds the copy, with a flag for whether connections get copied too.
  • static void copyDone (void) β€” wrap it up, copying's done.

✨ Static Public Member Functions inherited from SoBase ✨

  • static void initClass (void) β€” sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system. yes, again, it's a whole family tradition πŸŽ€
  • static SoType getClassTypeId (void) β€” this static method returns the SoType object associated with objects of this class.
  • static void addName (SoBase *const base, const char *const name) β€” give a base a name.
  • static void removeName (SoBase *const base, const char *const name) β€” take that name right back off.
  • static void incrementCurrentWriteCounter (void) β€” bumps the write counter up.
  • static void decrementCurrentWriteCounter (void) β€” brings it back down.
  • static SoBase * getNamedBase (const SbName &name, SoType type) β€” fetch a named base of a given type.
  • static int getNamedBases (const SbName &name, SoBaseList &baselist, SoType type) β€” the plural version, fills the list.
  • static SbBool read (SoInput *input, SoBase *&base, SoType expectedtype) β€” reads a base in from input.
  • static void setInstancePrefix (const SbString &c) β€” sets the instance prefix string.
  • static void setTraceRefs (SbBool trace) β€” turn reference tracing on or off.
  • static SbBool getTraceRefs (void) β€” is reference tracing on rn?
  • static SbBool connectRoute (SoInput *input, const SbName &fromnodename, const SbName &fromfieldname, const SbName &tonodename, const SbName &tofieldname) β€” wires up a route from one node's field to another's.
  • static SbBool readRoute (SoInput *input) β€” reads a route in from input.

🌸 Public Attributes 🌸

the actual knobs you can turn on this dragger, bestie:

  • SoSFVec3f translation β€” the translation field.
  • SoSFVec3f scaleFactor β€” the scale factor field.

Public Attributes inherited from SoDragger

  • SoSFBool isActive β€” whether the dragger is currently active.

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 πŸ’–

the internal machinery, not for public consumption but fully iconic:

  • virtual const SoFieldData * getFieldData (void) const β€” returns the field data.
  • virtual ~SoTabPlaneDragger (void) β€” the destructor, protected as ever.
  • virtual void GLRender (SoGLRenderAction *action) β€” renders the thing.
  • virtual SbBool setUpConnections (SbBool onoff, SbBool doitalways=FALSE) β€” wires up (or tears down) the internal connections.
  • virtual void setDefaultOnNonWritingFields (void) β€” sets defaults on the fields that don't get written out.
  • void reallyAdjustScaleTabSize (SoGLRenderAction *action) β€” actually adjusts the scale tab size (yes, "really", it means it fr fr 😭).
  • void getXYScreenLengths (SbVec2f &lengths, const SbMatrix &localtoscreen, const SbVec2s &winsize) β€” computes 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.
  • void dragFinish (void) β€” the drag ends.

Protected Member Functions inherited from SoDragger

  • SoDragger (void) β€” constructor.
  • virtual ~SoDragger (void) β€” destructor.
  • SbVec2f getNormalizedLocaterPosition (void) β€” normalized locater position.
  • SbVec2s getLocaterPosition (void) β€” raw locater position.
  • SbVec2s getStartLocaterPosition (void) const β€” where the locater was when it all started.
  • void setStartLocaterPosition (SbVec2s p) β€” sets that starting position.
  • SbBool isAdequateConstraintMotion (void) β€” is the constraint motion adequate?
  • virtual SbBool shouldGrabBasedOnSurrogate (const SoPath *pickpath, const SoPath *surrogatepath) β€” decides whether to grab based on the surrogate path.
  • void setCameraInfo (SoAction *action) β€” sets camera info from the action.
  • virtual void handleEvent (SoHandleEventAction *ha) β€” handles the event.
  • void transferMotion (SoDragger *child) β€” passes motion along to a child dragger.
  • void setIgnoreInBbox (SbBool newval) β€” set whether to ignore this in the bounding box.
  • SbBool isIgnoreInBbox (void) β€” is it being ignored in the bbox?
  • virtual void getBoundingBox (SoGetBoundingBoxAction *action) β€” computes the bounding box.
  • void setActiveChildDragger (SoDragger *newchilddragger) β€” sets the active child dragger.
  • SoDragger * getActiveChildDragger (void) const β€” gets the active child dragger.
  • void updateDraggerCache (const SoPath *path) β€” refreshes the dragger cache.
  • virtual const SoPickedPoint * getPickedPointForStart (SoHandleEventAction *action) β€” the picked point to use when starting.

Protected Member Functions inherited from SoInteractionKit

  • virtual ~SoInteractionKit () β€” destructor.
  • virtual void copyContents (const SoFieldContainer *fromFC, SbBool copyConnections) β€” copies contents over.
  • 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 default, node flavour.
  • virtual SbBool setAnyPartAsDefault (const SbName &partname, const SbName &nodename, SbBool anypart=TRUE, SbBool onlyifdefault=TRUE) β€” same thing, name flavour.
  • SbBool setAnySurrogatePath (const SbName &name, SoPath *path, SbBool leafcheck=FALSE, SbBool publiccheck=FALSE) β€” sets a surrogate path for any part.
  • void connectSeparatorFields (SoSeparator *dest, SbBool onOff) β€” connects the separator fields.

Protected Member Functions inherited from SoBaseKit

  • virtual ~SoBaseKit () β€” destructor.
  • virtual SoNode * addToCopyDict (void) const β€” adds itself to the copy dictionary.
  • SoGroup * getContainerNode (const SbName &listname, SbBool makeifneeded=TRUE) β€” gets the container node for a list.
  • virtual SoNode * getAnyPart (const SbName &partname, SbBool makeifneeded, SbBool leafcheck=FALSE, SbBool publiccheck=FALSE) β€” gets any part by name.
  • virtual SoNodeKitPath * createPathToAnyPart (const SbName &partname, SbBool makeifneeded, SbBool leafcheck=FALSE, SbBool publiccheck=FALSE, const SoPath *pathtoextend=NULL) β€” builds a path to any part.
  • virtual SbBool setAnyPart (const SbName &partname, SoNode *from, SbBool anypart=TRUE) β€” sets any part.
  • 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 β€” gets the nodekit parts list.
  • const SbList< SoSFNode * > & getCatalogInstances (void) const β€” gets the catalog instances.
  • void catalogError (void) β€” the catalog's mad about something.
  • void countMyFields (SoOutput *out) β€” counts its own fields on output.

Protected Member Functions inherited from SoNode

  • SoNode (void) β€” constructor.
  • virtual ~SoNode () β€” destructor.

Protected Member Functions inherited from SoFieldContainer

  • SoFieldContainer (void) β€” constructor.
  • virtual ~SoFieldContainer () β€” destructor.

Protected Member Functions inherited from SoBase

  • SoBase (void) β€” constructor.
  • virtual ~SoBase () β€” destructor.
  • virtual void destroy (void) β€” destroys the base.
  • 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's name.
  • virtual SoNotRec createNotRec (void) β€” creates a notification record.

🌈 Static Protected Member Functions 🌈

  • static const SoFieldData ** getFieldDataPtr (void) β€” pointer to the field data.
  • static const SoNodekitCatalog ** getClassNodekitCatalogPtr (void) β€” pointer to the class nodekit catalog.

Static Protected Member Functions inherited from SoDragger

  • static const SoFieldData ** getFieldDataPtr (void) β€” pointer to the field data.
  • static const SoNodekitCatalog ** getClassNodekitCatalogPtr (void) β€” pointer to the class nodekit catalog.
  • static void childTransferMotionAndValueChangedCB (void *, SoDragger *) β€” callback: child transferred motion and value changed.
  • static void childValueChangedCB (void *, SoDragger *) β€” callback: child value changed.
  • static void childStartCB (void *, SoDragger *) β€” callback: child started.
  • static void childMotionCB (void *, SoDragger *) β€” callback: child moved.
  • static void childFinishCB (void *, SoDragger *) β€” callback: child finished.
  • static void childOtherEventCB (void *, SoDragger *) β€” callback: child had some other event.

Static Protected Member Functions inherited from SoInteractionKit

  • static const SoFieldData ** getFieldDataPtr (void) β€” pointer to the field data.
  • static const SoNodekitCatalog ** getClassNodekitCatalogPtr (void) β€” pointer to the class nodekit catalog.
  • 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) β€” pointer to the field data.
  • static const SoNodekitCatalog ** getClassNodekitCatalogPtr (void) β€” pointer to the class nodekit catalog.

Static Protected Member Functions inherited from SoNode

  • static const SoFieldData ** getFieldDataPtr (void) β€” pointer to the field data.
  • 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 it.
  • static void setCompatibilityTypes (const SoType &nodetype, const uint32_t bitmask) β€” sets the compatibility types 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 πŸ¦‹

the internals, laid bare (respectfully):

  • SoSFNode cornerScaleCoords β€” corner scale coords node.
  • 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 node.
  • 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 node.
  • SoSFNode scaleTabHints β€” scale tab hints node.
  • SoSFNode scaleTabMaterial β€” scale tab material node.
  • SoSFNode scaleTabMaterialBinding β€” scale tab material binding node.
  • SoSFNode scaleTabNormal β€” scale tab normal node.
  • SoSFNode scaleTabNormalBinding β€” scale tab normal binding node.
  • SoSFNode scaleTabs β€” the scale tabs node.
  • SoSFNode translator β€” the translator node.

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 β€” the old top separator.

Protected Attributes inherited from SoBaseKit

  • SoSFNode callbackList β€” the callback list.
  • SoChildList * children β€” pointer to the child list.
  • SbBool connectionsSetUp β€” whether the connections are set up.

Protected Attributes inherited from SoNode

  • SbUniqueId uniqueId β€” this node's unique id.

Protected Attributes inherited from SoFieldContainer

  • SbBool isBuiltIn β€” is it built in?

πŸ‘‘ Additional Inherited Members πŸ‘‘

Public Types inherited from SoDragger

  • enum ProjectorFrontSetting { FRONT, BACK, USE_PICK } β€” the projector front setting enum. pick your fighter ✨

Public Types inherited from SoInteractionKit

  • enum CacheEnabled { OFF, ON, AUTO } β€” caching: off, on, or auto.

Public Types inherited from SoNode

  • enum NodeType { INVENTOR = 0x0000, VRML1 = 0x0001, VRML2 = 0x0002, INVENTOR_1 = 0x0004, INVENTOR_2_0 = 0x0008, INVENTOR_2_1 = 0x0010, INVENTOR_2_5 = 0x0020, INVENTOR_2_6 = 0x0040, COIN_1_0 = 0x0080, COIN_2_0 = 0x0100, EXTENSION = 0x0200, COIN_2_2 = 0x0400, COIN_2_3 = 0x0800, COIN_2_4 = 0x1000, INVENTOR_5_0 = 0x2000, COIN_2_5 = 0x4000, COIN_3_0 = 0x8000, INVENTOR_6_0 = 0x10000, COIN_4_0 = 0x20000 } β€” the whole node type bitmask menu, every flag accounted for πŸ’…

Protected Types inherited from SoBase

  • enum BaseFlags { IS_ENGINE = 0x01, IS_GROUP = 0x02 } β€” base flags: engine or group.

Static Protected Attributes inherited from SoNode

  • static SbUniqueId nextUniqueId = 1 β€” the next unique id, starting at 1.
  • static int nextActionMethodIndex = 0 β€” the next action method index, starting at 0.

✨ Detailed Description ✨

okay bestie, gather round πŸ’– the SoTabPlaneDragger class is a dragger you can translate and scale within a plane. that's the whole vibe. it's giving "move me around in 2D and also stretch me" πŸ¦‹

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

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. ✨ corner tabs = the uniform girls, side tabs = the non-uniform girls, both iconic πŸ‘‘

See also 🌈

  • SoTabBoxDragger

πŸŽ€ Constructor & Destructor Documentation πŸŽ€

SoTabPlaneDragger::SoTabPlaneDragger (void )

Default constructor, sets up the dragger nodekit catalog with the interaction and feedback geometry. it literally builds the whole outfit from scratch πŸ’…

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

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

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

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

Protected destructor. πŸ™ˆ

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

lowkey important: it's protected, so don't be out here trying to delete it yourself, the refcounting handles it, periodt πŸ’…

🌸 Member Function Documentation 🌸

SoType SoTabPlaneDragger::getClassTypeId (void ) [static]

This static method returns the SoType object associated with objects of this class. it's the class's little ID card πŸ’³

SoType SoTabPlaneDragger::getTypeId (void ) const [virtual]

Returns the type identification of an object derived from a class inheriting SoBase. This is used for runtime type checking and "downward" casting. πŸ”

Reimplemented from SoDragger.

const SoFieldData ** SoTabPlaneDragger::getFieldDataPtr (void ) [static], [protected]

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

Returns the SoFieldData class which holds information about fields in this node.

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.

Reimplemented from SoDragger.

const SoNodekitCatalog * SoTabPlaneDragger::getClassNodekitCatalog (void ) [static]

Returns the nodekit catalog which defines the layout of this class' kit. πŸ“‹βœ¨

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

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

Reimplemented from SoDragger.

const SoNodekitCatalog ** SoTabPlaneDragger::getClassNodekitCatalogPtr (void ) [static], [protected]

Returns the pointer to the pointer of the nodekit catalog for this class. (yes, pointer to a pointer. it's pointerception and we respect the hustle 😭)

void SoTabPlaneDragger::initClass (void ) [static]

Initializes type system for this dragger class.

Application programmers should usually not have to invoke this method, see documentation of SoInteraction::init().

void SoTabPlaneDragger::adjustScaleTabSize (void )

Signals the dragger to recalculate the size of its tabs. 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. 🫠

fr fr: this one is decorative. it's the "you had one job" of methods. it does nothing useful in Coin because the recalc already happens every render.

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 want to throw geometry primitives at OpenGL override this method. πŸ”₯

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

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 scene graph 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 is of SoGroup type and all fields are at their default values

Subclasses should usually override this to do additional settings for new member fields. From the subclass, do remember to call "upwards" to your superclass' setDefaultOnNonWritingFields() method.

Reimplemented from SoDragger.

void 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. πŸ“

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

Not implemented. πŸ’€ (girl just said "no" and moved on)

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. πŸ‘†

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


πŸ’œ Member Data Documentation πŸ’œ

SoSFVec3f SoTabPlaneDragger::translation

Continuously updated to contain the current translation from the dragger's local origo position. πŸ“

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. πŸ”’


🌈 Author 🌈

Generated automatically by Doxygen for Coin from the source code. πŸ€–βœ¨


and that's a wrap on SoTabPlaneDragger(3), bestie πŸŽ€ this little beauty ships as Version 4.0.10, dated Thu Jun 25 2026 00:00:00 β€” so when you see it in the wild, you'll know exactly which glow-up era it's from πŸ’… slay, go drag some planes πŸ¦‹πŸ‘‘

πŸ“¦ where this page comes from