SoTranslate1Dragger(3)

📦 version 2.5.0, in fedora 43, fedora 44

💖 SoTranslate1Dragger — Library Functions Manual, section 3 💖

okay so bestie, welcome to the SoTranslate1Dragger(3) page. yes it's a manual page. yes it's section 3. yes it's giving library functions. and yes, it's LONG, which is why it comes in 3 parts and this is part one. hydrate, stretch, we're doing this. 🫶

✨ NAME ✨

SoTranslate1Dragger — the SoTranslate1Dragger class provides a mechanism for the end-user to translate along an axis.

that's it. that's the whole vibe. one axis. one direction. main character energy. 💅

🌸 SYNOPSIS 🌸

#include <Inventor/draggers/SoTranslate1Dragger.h>

Inherits SoDragger. so everything SoDragger can do, this one also does, and SoDragger inherited a whole ancestral lineage, and we're gonna list every single one of them because the manpage said so and we respect the manpage. 🎀

👑 Public Member Functions

  • virtual SoType getTypeId (void) const — the type ID, const-correct, virtual, iconic
  • virtual const SoNodekitCatalog * getNodekitCatalog (void) const — the nodekit catalog pointer, also const, also virtual
  • SoTranslate1Dragger (void) — the constructor, no args, no notes

🦋 Public Member Functions inherited from SoDragger

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

🌈 Public Member Functions inherited from SoInteractionKit

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

🍓 Public Member Functions inherited from SoBaseKit

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

🧚 Public Member Functions inherited from SoNode

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

💜 Public Member Functions inherited from SoFieldContainer

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

🎀 Public Member Functions inherited from SoBase

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

⭐ Static Public Member Functions ⭐

  • static SoType getClassTypeId (void)
  • static const SoNodekitCatalog * getClassNodekitCatalog (void)
  • static void initClass (void)

🔥 Static Public Member Functions inherited from SoDragger

  • static SoType getClassTypeId (void)
  • static const SoNodekitCatalog * getClassNodekitCatalog (void)
  • static void setMinScale (float newminscale)
  • static float getMinScale (void)
  • static void workValuesIntoTransform (SbMatrix &mtx, const SbVec3f *translationptr, const SbRotation *rotationptr, const SbVec3f *scalefactorptr, const SbRotation *scaleorientationptr, const SbVec3f *centerptr)
  • static void getTransformFast (SbMatrix &mtx, SbVec3f &translation, SbRotation &rotation, SbVec3f &scalefactor, SbRotation &scaleorientation, const SbVec3f &center)
  • static void getTransformFast (SbMatrix &mtx, SbVec3f &translation, SbRotation &rotation, SbVec3f &scalefactor, SbRotation &scaleorientation)
  • static SbMatrix appendTranslation (const SbMatrix &mtx, const SbVec3f &translation, const SbMatrix *conversion=NULL)
  • static SbMatrix appendScale (const SbMatrix &mtx, const SbVec3f &scale, const SbVec3f &scalecenter, const SbMatrix *conversion=NULL)
  • static SbMatrix appendRotation (const SbMatrix &mtx, const SbRotation &rot, const SbVec3f &rotcenter, const SbMatrix *conversion=NULL)
  • static void initClass (void)
  • static void initClasses (void)

💖 Static Public Member Functions inherited from SoInteractionKit

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

🌸 Static Public Member Functions inherited from SoBaseKit

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

✨ Static Public Member Functions inherited from SoNode

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

okay that's the whole synopsis, and yeah it's a lot of inherited function signatures, but we got through it together. 🫶 the actual descriptions are coming in the next part — don't go anywhere bestie, we're not done. 💅

✨ Static Public Member Functions inherited from SoFieldContainer

okay so before we even get into the dragger's own stuff, here's the freebie toolkit it inherits — no cap, all of these are static and just there for you 🫶

  • static void initClass (void) — the classic "set me up" hook
  • static SoType getClassTypeId (void) — hands you the class type id
  • static void initCopyDict (void) — kicks off the copy dictionary
  • static void addCopy (const SoFieldContainer *orig, const SoFieldContainer *copy) — registers an orig→copy pairing
  • static SoFieldContainer * checkCopy (const SoFieldContainer *orig) — checks whether orig has a copy on file
  • static SoFieldContainer * findCopy (const SoFieldContainer *orig, const SbBool copyconnections) — digs up the copy for orig
  • static void copyDone (void) — wraps the copy dictionary business up

💅 Static Public Member Functions inherited from SoBase

and here's the SoBase starter pack, because everything in Coin is lowkey built on this 👑

  • static void initClass (void)
  • static SoType getClassTypeId (void)
  • static void addName (SoBase *const base, const char *const name)
  • static void removeName (SoBase *const base, const char *const name)
  • static void incrementCurrentWriteCounter (void)
  • static void decrementCurrentWriteCounter (void)
  • static SoBase * getNamedBase (const SbName &name, SoType type)
  • static int getNamedBases (const SbName &name, SoBaseList &baselist, SoType type)
  • static SbBool read (SoInput *in, SoBase *&base, SoType expectedtype)
  • static void setInstancePrefix (const SbString &c)
  • static void setTraceRefs (SbBool trace)
  • static SbBool getTraceRefs (void)
  • static SbBool connectRoute (SoInput *in, const SbName &fromnodename, const SbName &fromfieldname, const SbName &tonodename, const SbName &tofieldname)
  • static SbBool readRoute (SoInput *in)

🎀 Public Attributes

  • SoSFVec3f translation — the actual translation value, front and center, main character energy ✨

🌸 Public Attributes inherited from SoDragger

  • SoSFBool isActive

🦋 Public Attributes inherited from SoInteractionKit

  • SoSFEnum renderCaching
  • SoSFEnum boundingBoxCaching
  • SoSFEnum renderCulling
  • SoSFEnum pickCulling

🔒 Protected Member Functions

  • virtual const SoFieldData * getFieldData (void) const
  • ~SoTranslate1Dragger () — the destructor, protected as always 🙈
  • virtual SbBool setUpConnections (SbBool onoff, SbBool doitalways=0)
  • void dragStart (void)
  • void drag (void)
  • void dragFinish (void)

🫶 Protected Member Functions inherited from SoDragger

  • SoDragger (void)
  • virtual ~SoDragger ()
  • SbVec2f getNormalizedLocaterPosition (void)
  • SbVec2s getLocaterPosition (void)
  • SbVec2s getStartLocaterPosition (void) const
  • void setStartLocaterPosition (SbVec2s p)
  • SbBool isAdequateConstraintMotion (void)
  • virtual SbBool shouldGrabBasedOnSurrogate (const SoPath *pickpath, const SoPath *surrogatepath)
  • void setCameraInfo (SoAction *action)
  • virtual void handleEvent (SoHandleEventAction *ha)
  • void transferMotion (SoDragger *child)
  • void setIgnoreInBbox (SbBool newval)
  • SbBool isIgnoreInBbox (void)
  • virtual void getBoundingBox (SoGetBoundingBoxAction *action)
  • void setActiveChildDragger (SoDragger *newchilddragger)
  • SoDragger * getActiveChildDragger (void) const
  • virtual void setDefaultOnNonWritingFields (void)
  • void updateDraggerCache (const SoPath *path)

💜 Protected Member Functions inherited from SoInteractionKit

  • virtual ~SoInteractionKit ()
  • virtual void copyContents (const SoFieldContainer *fromFC, SbBool copyConnections)
  • virtual SbBool setPart (const int partNum, SoNode *node)
  • virtual SbBool readInstance (SoInput *in, unsigned short flags)
  • virtual SbBool setAnyPartAsDefault (const SbName &partname, SoNode *node, SbBool anypart=1, SbBool onlyifdefault=1)
  • virtual SbBool setAnyPartAsDefault (const SbName &partname, const SbName &nodename, SbBool anypart=1, SbBool onlyifdefault=1)
  • SbBool setAnySurrogatePath (const SbName &name, SoPath *path, SbBool leafcheck=0, SbBool publiccheck=0)
  • void connectSeparatorFields (SoSeparator *dest, SbBool onOff)

⭐ Protected Member Functions inherited from SoBaseKit

  • virtual ~SoBaseKit ()
  • virtual SoNode * addToCopyDict (void) const
  • SoGroup * getContainerNode (const SbName &listname, SbBool makeifneeded=1)
  • virtual SoNode * getAnyPart (const SbName &partname, SbBool makeifneeded, SbBool leafcheck=0, SbBool publiccheck=0)
  • virtual SoNodeKitPath * createPathToAnyPart (const SbName &partname, SbBool makeifneeded, SbBool leafcheck=0, SbBool publiccheck=0, const SoPath *pathtoextend=NULL)
  • virtual SbBool setAnyPart (const SbName &partname, SoNode *from, SbBool anypart=1)
  • void createNodekitPartsList (void)
  • void createFieldList (void)
  • virtual void createDefaultParts (void)
  • const SoNodekitParts * getNodekitPartsList (void) const
  • const SbList< SoSFNode * > & getCatalogInstances (void) const
  • void catalogError (void)
  • void countMyFields (SoOutput *out)

🌈 Protected Member Functions inherited from SoNode

  • SoNode (void)
  • virtual ~SoNode ()

🍓 Protected Member Functions inherited from SoFieldContainer

  • SoFieldContainer (void)
  • ~SoFieldContainer ()

🧚 Protected Member Functions inherited from SoBase

  • SoBase (void)
  • virtual ~SoBase ()
  • virtual void destroy (void)
  • SbBool hasMultipleWriteRefs (void) const
  • SbBool writeHeader (SoOutput *out, SbBool isgroup, SbBool isengine) const
  • void writeFooter (SoOutput *out) const
  • virtual const char * getFileFormatName (void) const

🔥 Static Protected Member Functions

  • static const SoFieldData ** getFieldDataPtr (void)
  • static const SoNodekitCatalog ** getClassNodekitCatalogPtr (void)
  • static void startCB (void *f, SoDragger *d)
  • static void motionCB (void *f, SoDragger *d)
  • static void finishCB (void *f, SoDragger *d)
  • static void fieldSensorCB (void *f, SoSensor *s)
  • static void valueChangedCB (void *f, SoDragger *d)

👑 Static Protected Member Functions inherited from SoDragger

  • static const SoFieldData ** getFieldDataPtr (void)
  • static const SoNodekitCatalog ** getClassNodekitCatalogPtr (void)
  • static void childTransferMotionAndValueChangedCB (void *, SoDragger *)
  • static void childValueChangedCB (void *, SoDragger *)
  • static void childStartCB (void *, SoDragger *)
  • static void childMotionCB (void *, SoDragger *)
  • static void childFinishCB (void *, SoDragger *)
  • static void childOtherEventCB (void *, SoDragger *)

💖 Static Protected Member Functions inherited from SoInteractionKit

  • static const SoFieldData ** getFieldDataPtr (void)
  • static const SoNodekitCatalog ** getClassNodekitCatalogPtr (void)
  • static void readDefaultParts (const char *fileName, const char defaultBuffer[], int defBufSize)
  • static void fieldSensorCB (void *, SoSensor *)

✨ Static Protected Member Functions inherited from SoBaseKit

  • static const SoFieldData ** getFieldDataPtr (void)
  • static const SoNodekitCatalog ** getClassNodekitCatalogPtr (void)

🎀 Static Protected Member Functions inherited from SoNode

  • static const SoFieldData ** getFieldDataPtr (void)
  • static void setNextActionMethodIndex (int index)
  • static int getNextActionMethodIndex (void)
  • static void incNextActionMethodIndex (void)
  • static void setCompatibilityTypes (const SoType &nodetype, const uint32_t bitmask)

💜 Static Protected Member Functions inherited from SoBase

  • static uint32_t getCurrentWriteCounter (void)
  • static void staticDataLock (void)
  • static void staticDataUnlock (void)

🦋 Protected Attributes

  • SoSFNode feedback
  • SoSFNode feedbackActive
  • SoSFNode feedbackSwitch
  • SoSFNode translator
  • SoSFNode translatorActive
  • SoSFNode translatorSwitch
  • SoFieldSensor * fieldSensor
  • SbLineProjector * lineProj

🌸 Protected Attributes inherited from SoDragger

  • SoSFNode motionMatrix

🫶 Protected Attributes inherited from SoInteractionKit

  • SoSFNode geomSeparator
  • SoSFNode topSeparator
  • SoFieldSensor * fieldSensor
  • SoSeparator * oldTopSep

⭐ Protected Attributes inherited from SoBaseKit

  • SoSFNode callbackList
  • SoChildList * children
  • SbBool connectionsSetUp

🌈 Protected Attributes inherited from SoNode

  • uint32_t uniqueId

🍓 Protected Attributes inherited from SoFieldContainer

  • SbBool isBuiltIn

🧚 Additional Inherited Members

🎀 Public Types inherited from SoDragger

enum ProjectorFrontSetting { FRONT, BACK, USE_PICK }

💅 Public Types inherited from SoInteractionKit

enum CacheEnabled { OFF, ON, AUTO }

🔥 Public Types inherited from SoNode

enum NodeType { INVENTOR = 0x0000, VRML1 = 0x0001, VRML2 = 0x0002,
    INVENTOR_1 = 0x0004, INVENTOR_2_0 = 0x0008, INVENTOR_2_1 = 0x0010,
    INVENTOR_2_5 = 0x0020, INVENTOR_2_6 = 0x0040, COIN_1_0 = 0x0080,
    COIN_2_0 = 0x0100, EXTENSION = 0x0200, COIN_2_2 = 0x0400, COIN_2_3 =
    0x0800, COIN_2_4 = 0x1000, INVENTOR_5_0 = 0x2000, COIN_2_5 = 0x4000
}

🙈 Protected Types inherited from SoBase

enum BaseFlags { IS_ENGINE = 0x01, IS_GROUP = 0x02 }

👑 Static Protected Attributes inherited from SoNode

static uint32_t nextUniqueId = 0
static int nextActionMethodIndex = 0

💖 Detailed Description

The SoTranslate1Dragger class provides a mechanism for the end-user to translate along an axis. it's giving "grab the little handle, slide it, watch it move" 🫶

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

(picture the default dragger geometry here, chillin' in its inactive state ✨)

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

🦋 See also

  • SoTranslate2Dragger
  • SoDragPointDragger

🎀 Constructor & Destructor Documentation 🎀

✨ SoTranslate1Dragger::SoTranslate1Dragger (void ) ✨

okay so this is the default constructor 💖 it sets up the dragger nodekit catalog with the interaction and feedback geometry. that's literally the whole assignment bestie, no cap.

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

CLASS SoTranslate1Dragger
-->"this"
      "callbackList"
      "topSeparator"
         "motionMatrix"
         "geomSeparator"
-->         "translatorSwitch"
-->            "translator"
-->            "translatorActive"
-->         "feedbackSwitch"
-->            "feedback"
-->            "feedbackActive"

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

Detailed information on catalog parts:

CLASS SoTranslate1Dragger
PVT   "this",  SoTranslate1Dragger  ---
      "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  ---

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

References SoDragger::addFinishCallback(), SoDragger::addMotionCallback(), SoDragger::addStartCallback(), SoDragger::addValueChangedCallback(), fieldSensor, fieldSensorCB(), finishCB(), lineProj, motionCB(), SoInteractionKit::readDefaultParts(), SoInteractionKit::setPartAsDefault(), SoInteractionKit::setSwitchValue(), setUpConnections(), SoTranslate1Dragger(), startCB(), translation, and valueChangedCB().

Referenced by fieldSensorCB(), finishCB(), getFieldData(), motionCB(), SoTranslate1Dragger(), startCB(), and valueChangedCB().

💅 SoTranslate1Dragger::~SoTranslate1Dragger () [protected] 💅

protected destructor, so hands off unless you know what you're doing 🫶

(Dragger classes are derived from SoBase, so they are reference counted and automatically destroyed when their reference count goes to 0.) so like, the universe handles it for you when nobody's holding on anymore, iconic behavior honestly ✨

References fieldSensor, and lineProj.

🌸 Member Function Documentation 🌸

👑 SoType SoTranslate1Dragger::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. the vibe check of the C++ world, fr fr 🔥

Usage example:

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

For application programmers wanting to extend the library with new nodes, engines, nodekits, draggers or others: this method needs to be overridden in all subclasses. This is typically done as part of setting up the full type system for extension classes, which is usually accomplished by using the pre-defined macros available through for instance Inventor/nodes/SoSubNode.h (SO_NODE_INIT_CLASS and SO_NODE_CONSTRUCTOR for node classes), Inventor/engines/SoSubEngine.h (for engine classes) and so on.

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

Reimplemented from SoDragger.

💜 const SoFieldData * SoTranslate1Dragger::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 thing bestie 🦋

Reimplemented from SoDragger.

References SoTranslate1Dragger().

🌈 const SoNodekitCatalog * SoTranslate1Dragger::getNodekitCatalog (void ) const [virtual] 🌈

Returns the nodekit catalog which defines the layout of this class' kit. the blueprint, the map, the whole layout vibe 🗺️✨

Reimplemented from SoDragger.

🎀 SbBool SoTranslate1Dragger::setUpConnections (SbBool onoff, SbBool doitalways = 0) [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, lowkey internal business 💅

Reimplemented from SoInteractionKit.

References SoBaseKit::connectionsSetUp, fieldSensor, fieldSensorCB(), SoBaseKit::setUpConnections(), and translation.

Referenced by SoTranslate1Dragger().

⭐ void SoTranslate1Dragger::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. iykyk 🙈

References dragStart(), SoDragger::SoDragger(), and SoTranslate1Dragger().

Referenced by SoTranslate1Dragger().

🔥 void SoTranslate1Dragger::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. again, internal bestie, not for us 🫶

References drag(), SoDragger::SoDragger(), and SoTranslate1Dragger().

Referenced by SoTranslate1Dragger().

🦋 void SoTranslate1Dragger::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. same energy, still internal 💀

References dragFinish(), SoDragger::SoDragger(), and SoTranslate1Dragger().

Referenced by SoTranslate1Dragger().

💖 void SoTranslate1Dragger::fieldSensorCB (void * d, SoSensor * s) [static], [protected] 💖

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

References SoDragger::getMotionMatrix(), SoDragger::setMotionMatrix(), SoTranslate1Dragger(), and translation.

Referenced by setUpConnections(), and SoTranslate1Dragger().

🌟 void SoTranslate1Dragger::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. (you already know the drill by now 🎀)

References SoFieldSensor::attach(), SoFieldSensor::detach(), fieldSensor, SoDragger::getMotionMatrix(), SbMatrix::getTransform(), SoDragger::SoDragger(), SoTranslate1Dragger(), and translation.

Referenced by SoTranslate1Dragger().

👑 void SoTranslate1Dragger::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 selection, main character energy activated 💅✨

References SoDragger::getLocalStartingPoint(), lineProj, and SoInteractionKit::setSwitchValue().

Referenced by startCB().

🌈 void SoTranslate1Dragger::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. the dragging era begins 🖱️🔥

References SoDragger::appendTranslation(), SoDragger::getLocalStartingPoint(), SoDragger::getLocalToWorldMatrix(), SoDragger::getNormalizedLocaterPosition(), SoDragger::getStartMotionMatrix(), SoDragger::getViewVolume(), lineProj, and SoDragger::setMotionMatrix().

Referenced by motionCB().

🎀 void SoTranslate1Dragger::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. the release, the exhale, the periodt 💅

References SoInteractionKit::setSwitchValue().

Referenced by finishCB().

🍓 Member Data Documentation 🍓

💜 SoSFVec3f SoTranslate1Dragger::translation 💜

Continuously updated to contain the current translation from the dragger's local origo position. Only the first component (the X value) can be changed by the end-user. so like, X is the only one with permission, the other two are just there for the vibes 😭

The application programmer applying this dragger in his code should connect the relevant node fields in the scene to this field to make it follow the dragger.

Referenced by fieldSensorCB(), setUpConnections(), SoTranslate1Dragger(), and valueChangedCB().

🌸 SoFieldSensor* SoTranslate1Dragger::fieldSensor [protected] 🌸

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

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

🦋 SbLineProjector* SoTranslate1Dragger::lineProj [protected] 🦋

The SbLineProjector instance used for projecting from 2D mouse cursor positions to 3D points. 2D to 3D, a glow-up fr fr ✨

Referenced by drag(), dragStart(), SoTranslate1Dragger(), and ~SoTranslate1Dragger().

✨ Author ✨

Generated automatically by Doxygen for Coin from the source code. (not a human, just a very diligent robot 🤖💖)

that's a wrap on part 3 bestie!! 💅 the whole thing came from Coin, Version 2.5.0, dated SoTranslate1Dragger(3) — slay, go forth and drag your 1D translations with confidence 🎀✨🦋

📦 where this page comes from