SoTranslate2Dragger(3)

📦 version 3.1.3, in fedora 43, fedora 44

💖 NAME 💖

SoTranslate2Dragger — bestie, this class is the whole mechanism that lets the end-user translate stuff in a plane. That's the vibe. That's the assignment. 🦋

It lives in the SoTranslate2Dragger corner of the Coin/Inventor universe and it inherits from SoDragger, so yes, it's a dragger, and yes, dragging is literally the point. 👑

✨ SYNOPSIS ✨

#include <Inventor/draggers/SoTranslate2Dragger.h>

Inherits SoDragger.

🌸 Public Member Functions 🌸

  • virtual SoType getTypeId (void) const — gives you back this node's type id, the little name-tag that says "yep, that's a SoTranslate2Dragger".
  • virtual const SoNodekitCatalog * getNodekitCatalog (void) const — hands you the nodekit catalog for this class, aka the blueprint of all its parts.
  • SoTranslate2Dragger (void) — the constructor, bestie. Makes you a brand new dragger. 🎀

💅 Public Member Functions inherited from SoDragger 💅

Like, so many. Sit down, hydrate, we're going through all of them:

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

🧚 Public Member Functions inherited from SoInteractionKit 🧚

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

🌈 Public Member Functions inherited from SoBaseKit 🌈

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

⭐ Public Member Functions inherited from SoNode ⭐

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

🍓 Public Member Functions inherited from SoFieldContainer 🍓

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

💜 Public Member Functions inherited from SoBase 💜

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

👑 Static Public Member Functions 👑

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

okay so that's the whole SYNOPSIS dumped out in full, no skips, no cap 💅 and there's still more of this page coming, so stay hydrated and don't close the tab 🫶

Static Public Member Functions inherited from SoFieldContainer 💖

These are the freebie static goodies SoFieldContainer hands down to ya, no cap:

  • static void initClass (void) — sets the class up, classic Coin ritual ✨
  • static SoType getClassTypeId (void) — gimme the SoType for this class 🎀
  • static void cleanupClass (void) — the tidy-up counterpart, we love a clean exit 💅
  • static void initCopyDict (void) — kicks off the copy-dictionary situation 📖
  • static void addCopy (const SoFieldContainer *orig, const SoFieldContainer *copy) — registers an original → copy pairing 🫶
  • static SoFieldContainer * checkCopy (const SoFieldContainer *orig) — peeks at the dict for that orig 👀
  • static SoFieldContainer * findCopy (const SoFieldContainer *orig, const SbBool copyconnections) — actually goes and finds the copy for orig 🔍
  • static void copyDone (void) — signals that copying is, well, done, periodt 🏁

Static Public Member Functions inherited from SoBase 🦋

The grandparent class's static roster, fr fr:

  • static void initClass (void) — class init, again, iconic behaviour ⭐
  • static SoType getClassTypeId (void) — the SoType lookup 🌸
  • static void addName (SoBase *const base, const char *const name) — slaps a name onto a base 🏷️
  • static void removeName (SoBase *const base, const char *const name) — and takes it back off, no hard feelings 😌
  • 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) — fetches a named SoBase of that type 🎯
  • static int getNamedBases (const SbName &name, SoBaseList &baselist, SoType type) — plural version, fills up baselist 📋
  • static SbBool read (SoInput *input, SoBase *&base, SoType expectedtype) — the read-in machinery 📥
  • static void setInstancePrefix (const SbString &c) — sets the instance prefix string ✍️
  • static void setTraceRefs (SbBool trace) — toggle ref-tracing 🕵️
  • static SbBool getTraceRefs (void) — and read that toggle back 💜
  • static SbBool connectRoute (SoInput *input, const SbName &fromnodename, const SbName &fromfieldname, const SbName &tonodename, const SbName &tofieldname) — wires up a route from one field to another 🔌
  • static SbBool readRoute (SoInput *input) — reads a route in 🛣️

Public Attributes 👑

These are the fields you actually get to play with, bestie:

  • SoSFVec3f translation — the translation value, a 3-float vector 💫
  • SoSFVec2f minTranslation — the minimum, 2 floats 🍓
  • SoSFVec2f maxTranslation — the maximum, 2 floats 🍓

Public Attributes inherited from SoDragger

  • SoSFBool isActive — is this dragger active or nah? 🤔

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-only crew, the backstage pass holders:

  • virtual const SoFieldData * getFieldData (void) const — hands back the field data 📚
  • virtual ~SoTranslate2Dragger (void) — the destructor 🪦
  • virtual SbBool setUpConnections (SbBool onoff, SbBool doitalways=FALSE) — flips connections on/off, with a doitalways escape hatch 🔗
  • virtual void setMotionMatrix (const SbMatrix &m) — sets the motion matrix to m 🧮
  • void dragStart (void) — drag begins, bestie ✨
  • void drag (void) — mid-drag, we're moving 💃
  • void dragFinish (void) — drag's over, slay 🏁

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 started 🏁
  • void setStartLocaterPosition (SbVec2s p) — set that start position to p ✍️
  • SbBool isAdequateConstraintMotion (void) — is this motion adequately constrained? 🤨
  • virtual SbBool shouldGrabBasedOnSurrogate (const SoPath *pickpath, const SoPath *surrogatepath) — should we grab based on the surrogate path? 🫳
  • void setCameraInfo (SoAction *action) — sets camera info from the action 🎥
  • virtual void handleEvent (SoHandleEventAction *ha) — event handling go brrr 🎪
  • void transferMotion (SoDragger *child) — passes motion to a child dragger 🤝
  • void setIgnoreInBbox (SbBool newval) — set the ignore-in-bbox flag to newval 🙈
  • SbBool isIgnoreInBbox (void) — read that flag back 👀
  • virtual void getBoundingBox (SoGetBoundingBoxAction *action) — bounding box retrieval 📐
  • void setActiveChildDragger (SoDragger *newchilddragger) — assigns the active child dragger 👶
  • SoDragger * getActiveChildDragger (void) const — grabs it back 🫴
  • virtual void setDefaultOnNonWritingFields (void) — sets defaults on non-writing fields 🤐
  • void updateDraggerCache (const SoPath *path) — refreshes the dragger cache for path 🔄

Protected Member Functions inherited from SoInteractionKit

  • virtual ~SoInteractionKit () — destructor 🪦
  • virtual void copyContents (const SoFieldContainer *fromFC, SbBool copyConnections) — copies 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 📥
  • virtual SbBool setAnyPartAsDefault (const SbName &partname, SoNode *node, SbBool anypart=TRUE, SbBool onlyifdefault=TRUE) — sets a part as default, by node 🧷
  • virtual SbBool setAnyPartAsDefault (const SbName &partname, const SbName &nodename, SbBool anypart=TRUE, SbBool onlyifdefault=TRUE) — same energy, but by node name 🏷️
  • SbBool setAnySurrogatePath (const SbName &name, SoPath *path, SbBool leafcheck=FALSE, SbBool publiccheck=FALSE) — sets a surrogate path 🛤️
  • void connectSeparatorFields (SoSeparator *dest, SbBool onOff) — connects separator fields on dest 🔗

Protected Member Functions inherited from SoBaseKit

  • virtual ~SoBaseKit () — destructor 🪦
  • virtual SoNode * addToCopyDict (void) const — adds this to the copy dict 📖
  • SoGroup * getContainerNode (const SbName &listname, SbBool makeifneeded=TRUE) — gets the container node for listname 📦
  • 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, optionally extending pathtoextend 🛤️
  • virtual SbBool setAnyPart (const SbName &partname, SoNode *from, SbBool anypart=TRUE) — sets any part from a node 🧷
  • void createNodekitPartsList (void) — builds the nodekit parts list 📝
  • void createFieldList (void) — builds the field list 📝
  • virtual void createDefaultParts (void) — builds the default parts 🏗️
  • const SoNodekitParts * getNodekitPartsList (void) const — returns the nodekit parts list 📚
  • const SbList< SoSFNode * > & getCatalogInstances (void) const — returns the catalog instances 🗂️
  • void catalogError (void) — the catalog error handler 🚨
  • void countMyFields (SoOutput *out) — counts fields into out 🧮

Protected Member Functions inherited from SoNode

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

Protected Member Functions inherited from SoFieldContainer

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

Protected Member Functions inherited from SoBase

  • SoBase (void) — constructor 🐣
  • virtual ~SoBase () — destructor 🪦
  • virtual void destroy (void) — destroy it 💥
  • SbBool hasMultipleWriteRefs (void) const — 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 — returns the file format name 🏷️

Static Protected Member Functions 🧚

  • static const SoFieldData ** getFieldDataPtr (void) — pointer to the field data 📚
  • static const SoNodekitCatalog ** getClassNodekitCatalogPtr (void) — pointer to the nodekit catalog 🗂️
  • static void startCB (void *f, SoDragger *d) — start callback 🚦
  • static void motionCB (void *f, SoDragger *d) — motion callback 💃
  • static void finishCB (void *f, SoDragger *d) — finish callback 🏁
  • static void metaKeyChangeCB (void *f, SoDragger *d) — meta-key-change callback ⌨️
  • static void fieldSensorCB (void *f, SoSensor *s) — field sensor callback 📡
  • static void valueChangedCB (void *f, SoDragger *d) — value-changed callback 🔔

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 transfer-motion + 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 *) — 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 default parts from fileName 📥
  • static void fieldSensorCB (void *, SoSensor *) — 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 to index 🔢
  • static int getNextActionMethodIndex (void) — reads it back 🔢
  • 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) — returns the current write counter 🔢
  • static void staticDataLock (void) — locks the static data 🔒
  • static void staticDataUnlock (void) — unlocks it 🔓

Protected Attributes 🫣

  • SoSFNode axisFeedbackSwitch — the axis feedback switch node 🎚️
  • SoSFNode feedback — the feedback node 💬
  • SoSFNode feedbackActive — feedback-active node 🟢
  • SoSFNode feedbackSwitch — feedback switch node 🎚️
  • SoSFNode translator — the translator node 🧳
  • SoSFNode translatorActive — translator-active node 🟢
  • SoSFNode translatorSwitch — translator switch node 🎚️
  • SoSFNode xAxisFeedback — X-axis feedback node 🅧
  • SoSFNode yAxisFeedback — Y-axis feedback node 🅨
  • SoFieldSensor * fieldSensor — pointer to the field sensor 📡
  • SbVec3f worldRestartPt — the world restart point 🌍
  • SbPlaneProjector * planeProj — pointer to the plane projector ✈️

Protected Attributes inherited from SoDragger

  • SoSFNode motionMatrix — the motion matrix node 🧮

Protected Attributes inherited from SoInteractionKit

  • SoSFNode geomSeparator — the geometry separator node 🧱
  • SoSFNode topSeparator — the top separator node 🔝
  • SoFieldSensor * fieldSensor — field sensor pointer 📡
  • SoSeparator * oldTopSep — pointer to the old top separator 🕰️

Protected Attributes inherited from SoBaseKit

  • SoSFNode callbackList — the callback list node 📞
  • SoChildList * children — pointer to the child list 👶
  • SbBool connectionsSetUp — are connections set up? 🔗

Protected Attributes inherited from SoNode

  • uint32_t uniqueId — the 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 settings, pick your fighter 🥊

Public Types inherited from SoInteractionKit

  • enum CacheEnabled { OFF, ON, AUTO } — cache: off, on, or let it decide ✨

Public Types inherited from SoNode

  • enum NodeType { … } — the whole node-type bitmask roster, here it is in all its glory 👇
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 }

Protected Types inherited from SoBase

  • enum BaseFlags { IS_ENGINE = 0x01, IS_GROUP = 0x02 } — the base flags, exactly two of them 🚩

Static Protected Attributes inherited from SoNode

  • static uint32_t nextUniqueId = 1 — next unique id, starts at 1 🆔
  • static int nextActionMethodIndex = 0 — next action method index, starts at 0 🔢

Detailed Description 💖✨

The SoTranslate2Dragger class provides a mechanism for the end-user to translate in a plane. 🛩️

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

(the manpage drops a picture right here — imagine the cutest lil dragger just vibing, inactive, default geometry, looking adorable) 🎀

Use this dragger to allow the end-user of your application to translate along the X-axis and the Y-axis at the same time, ie freely inside a 3D plane. (Use a transformation node in front of the dragger to position it and re-orient it to translate in any plane.) 🧭

By holding down a SHIFT key, the end-user can temporarily constrain the dragger to a single one of the two axes. ⌨️

See also 🔍

  • SoTranslate1Dragger
  • SoDragPointDragger

✨ Constructor & Destructor Documentation ✨

SoTranslate2Dragger::SoTranslate2Dragger (void ) 💅

okay so bestie, this is the default constructor — it sets up the dragger nodekit catalog with the interaction and feedback geometry. periodt.

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

CLASS SoTranslate2Dragger
-->"this"
      "callbackList"
      "topSeparator"
         "motionMatrix"
         "geomSeparator"
-->         "translatorSwitch"
-->            "translator"
-->            "translatorActive"
-->         "feedbackSwitch"
-->            "feedback"
-->            "feedbackActive"
-->         "axisFeedbackSwitch"
-->            "xAxisFeedback"
-->            "yAxisFeedback"

the way that this is organized? iconic. (See SoBaseKit::printDiagram() for information about the output formatting.)

Detailed information on catalog parts:

CLASS SoTranslate2Dragger
PVT   "this",  SoTranslate2Dragger  ---
      "callbackList",  SoNodeKitListPart [ SoCallback, SoEventCallback ]
PVT   "topSeparator",  SoSeparator  ---
PVT   "motionMatrix",  SoMatrixTransform  ---
PVT   "geomSeparator",  SoSeparator  ---
PVT   "translatorSwitch",  SoSwitch  ---
      "translator",  SoSeparator  ---
      "translatorActive",  SoSeparator  ---
PVT   "feedbackSwitch",  SoSwitch  ---
      "feedback",  SoSeparator  ---
      "feedbackActive",  SoSeparator  ---
PVT   "axisFeedbackSwitch",  SoSwitch  ---
      "xAxisFeedback",  SoSeparator  ---
      "yAxisFeedback",  SoSeparator  ---

ngl, this table is giving structure. (See SoBaseKit::printTable() for information about the output formatting.)

SoTranslate2Dragger::~SoTranslate2Dragger (void ) [protected], [virtual] 🛡️

Protected destructor. no cap.

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

✨ Member Function Documentation ✨

SoType SoTranslate2Dragger::getTypeId (void ) const [virtual] 🔍

okay so this hands you the type identification for any object derived from a class that inherits SoBase. It's the whole run-time type checking and "downward" casting situation. iykyk.

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. lowkey this is the extension-class lore.

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

Reimplemented from SoDragger. fr fr.

const SoFieldData * SoTranslate2Dragger::getFieldData (void ) const [protected], [virtual] 📦

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

Reimplemented from SoDragger.

const SoNodekitCatalog * SoTranslate2Dragger::getNodekitCatalog (void ) const [virtual] 🗂️

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

Reimplemented from SoDragger.

SbBool SoTranslate2Dragger::setUpConnections (SbBool onoff, SbBool doitalways = FALSE) [protected], [virtual] 🔗

Gets all internal connections set up 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 SoTranslate2Dragger::setMotionMatrix (const SbMatrix & matrix) [protected], [virtual] 🧠

Drops in a new current motion matrix for the dragger geometry.

Triggers value changed callbacks if matrix isn't equal to the previous motion matrix.

Reimplemented from SoDragger.

void SoTranslate2Dragger::startCB (void * f, SoDragger * d) [static], [protected] 🎬

🚫 This API member is considered internal to the library, as it is not likely to be of interest to the application programmer. ngl, not your problem unless you're deep in the source.

void SoTranslate2Dragger::motionCB (void * f, SoDragger * d) [static], [protected] 🕺

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

void SoTranslate2Dragger::finishCB (void * f, SoDragger * d) [static], [protected] 🏁

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

void SoTranslate2Dragger::metaKeyChangeCB (void * f, SoDragger * d) [static], [protected] ⌨️

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

void SoTranslate2Dragger::fieldSensorCB (void * f, SoSensor * s) [static], [protected] 📡

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

void SoTranslate2Dragger::valueChangedCB (void * f, SoDragger * d) [static], [protected] 🔔

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

void SoTranslate2Dragger::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. main character energy.

void SoTranslate2Dragger::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 SoTranslate2Dragger::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 SoTranslate2Dragger::translation 📍

This stays continuously updated with the current translation from the dragger's local origo position. Only the first two components (the X and Y values) can be changed by the end-user. obsessed with this field.

If you're the application programmer applying this dragger in his code, you should connect the relevant node fields in the scene to this field so it follows the dragger.

SoFieldSensor* SoTranslate2Dragger::fieldSensor [protected] 🧪

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

SbVec3f SoTranslate2Dragger::worldRestartPt [protected] 🌍

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

SbPlaneProjector* SoTranslate2Dragger::planeProj [protected] 📐

The SbPlaneProjector instance that does the projecting from 2D mouse cursor positions to 3D points.

✨ Author ✨

Generated automatically by Doxygen for Coin from the source code.

💖 ok that's a wrap, bestie — this page is from Coin, Version 3.1.3, and it's SoTranslate2Dragger(3). Slay. ✨

📦 where this page comes from