SoTranslate1Dragger(3)

📦
version 4.0.10 · 4 versions
, in fedora 43, fedora 44

🎀 NAME 🎀

SoTranslate1Dragger — okay so bestie, this is a Coin class (manual section 3, iykyk 😌) and its entire personality is this: it hands your end-user a mechanism for translating along an axis. One axis. Singular. That's the whole vibe. 💅

🌈 SYNOPSIS 🌈

#include <Inventor/draggers/SoTranslate1Dragger.h>

Inherits SoDragger 💖 — which means this class walks into the function party with an entire ancestral entourage behind it. Family reunion behaviour, honestly. We're listing every single one of them, no gatekeeping here. 🫶

💖 Public Member Functions 💖

The homegrown ones. Just three. That's it, that's the whole list:

  • virtual SoType getTypeId (void) const
  • virtual const SoNodekitCatalog * getNodekitCatalog (void) const
  • SoTranslate1Dragger (void)

Everything from here down is inherited, and we are listing all of it because that's what the manual does and we respect the manual. 💅

🦋 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 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
Notice the callback crew up there — start, motion, finish, value changed, other event. Every add has a matching remove, and they all take a SoDraggerCB *func plus an optional void *data=NULL. Balanced. Considerate. We love a symmetrical API. 💜

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

Double trouble alert 🚨 — setPartAsDefault and isPathSurrogateInMySubgraph both come in two overloads. Overachievers. ✨

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

printDiagram and printSubDiagram and printTable — the kit is literally printing you a lil diagram of itself. Main character energy, honestly. 👑

👑 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

Three separate GLRender variants depending on whether you're below, in, or off the path. The way that this class has a whole routing system for rendering. 😭

🍓 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

Another overloaded pair: set and get each show up twice. getFields vs getAllFields too — lowkey the same but highkey not. 👀

💜 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. (Yes bestie, that's the actual documented behaviour, straight from the page. 🫶)
  • 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

ref / unref / unrefNoDelete — the reference-counting trio. Count your refs, bestie, or you'll be leaking memory and crying about it. 😭

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

The append trio — appendTranslation, appendScale, appendRotation — each one optionally takes a const SbMatrix *conversion=NULL. ✨ Flawless consistency. ✨

🎀 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 the SYNOPSIS, bestie. 💀 We are not even close to done — parts 2 and 3 are right behind this one, so stay seated. 🍓

💖 Static Public Member Functions inherited from SoNode 💖

these are the static besties SoNode hands down to literally every node class, no cap:

  • static uint32_t getCompatibilityTypes (const SoType &nodetype) — grabs the compatibility bitmask for a node type
  • static SoType getClassTypeId (void) — the SoType for this class
  • static SoNode * getByName (const SbName &name) — find a node by name
  • static int getByName (const SbName &name, SoNodeList &l) — find a node by name, but drop it into a list this time
  • 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 initClasses (void) — inits all the classes
  • static SbUniqueId getNextNodeId (void) — next unique node id, coming right up
  • static int getActionMethodIndex (const SoType type) — the action method index for a type
  • static void getBoundingBoxS (SoAction *action, SoNode *node) — the static bounding-box action handler
  • static void GLRenderS (SoAction *action, SoNode *node) — static GL render handler
  • static void callbackS (SoAction *action, SoNode *node) — static callback handler
  • static void getMatrixS (SoAction *action, SoNode *node) — static matrix handler
  • static void handleEventS (SoAction *action, SoNode *node) — static event handler
  • static void pickS (SoAction *action, SoNode *node) — static pick handler
  • static void rayPickS (SoAction *action, SoNode *node) — static ray pick handler
  • static void searchS (SoAction *action, SoNode *node) — static search handler
  • static void writeS (SoAction *action, SoNode *node) — static write handler
  • static void audioRenderS (SoAction *action, SoNode *node) — static audio render handler
  • static void getPrimitiveCountS (SoAction *action, SoNode *node) — static primitive counter

🦋 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 ✨
  • 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
  • static void initCopyDict (void) — kicks off the copy dictionary
  • static void addCopy (const SoFieldContainer *orig, const SoFieldContainer *copy) — registers an original/copy pair
  • static SoFieldContainer * checkCopy (const SoFieldContainer *orig) — checks the copy dictionary for a match
  • static SoFieldContainer * findCopy (const SoFieldContainer *orig, const SbBool copyconnections) — finds the copy, with a say in whether connections get copied
  • static void copyDone (void) — copy pass is done, wrap it up

🌸 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 💅
  • 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) — attaches a name to a base
  • static void removeName (SoBase *const base, const char *const name) — yeets that name back off
  • static void incrementCurrentWriteCounter (void) — bumps the current write counter up
  • static void decrementCurrentWriteCounter (void) — and back down
  • static SoBase * getNamedBase (const SbName &name, SoType type) — look up a named base of a given type
  • static int getNamedBases (const SbName &name, SoBaseList &baselist, SoType type) — same energy but it collects into a SoBaseList
  • static SbBool read (SoInput *input, SoBase *&base, SoType expectedtype) — reads a base off an SoInput
  • static void setInstancePrefix (const SbString &c) — sets the instance prefix
  • static void setTraceRefs (SbBool trace) — toggles ref tracing
  • static SbBool getTraceRefs (void) — are we tracing refs 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+field to another
  • static SbBool readRoute (SoInput *input) — reads a route in

👑 Public Attributes 👑

  • SoSFVec3f translation — the actual translation value, the whole point tbh
  • SoSFFloat minTranslation — the lowest it's allowed to go
  • SoSFFloat maxTranslation — and the highest 🌈

Public Attributes inherited from SoDragger

  • SoSFBool isActive — is this dragger active right now?

Public Attributes inherited from SoInteractionKit

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

🎀 Protected Member Functions 🎀

  • virtual const SoFieldData * getFieldData (void) const — hands over this class's field data
  • virtual ~SoTranslate1Dragger (void) — the destructor, don't @ me
  • virtual SbBool setUpConnections (SbBool onoff, SbBool doitalways=FALSE) — sets up (or tears down) the internal connections; doitalways defaults to FALSE
  • virtual void setMotionMatrix (const SbMatrix &matrix) — sets the motion matrix
  • void dragStart (void) — the drag begins ✨
  • void drag (void) — mid-drag, this is the moment
  • void dragFinish (void) — drag over, we're done here

Protected Member Functions inherited from SoDragger

  • SoDragger (void) — constructor
  • virtual ~SoDragger (void) — destructor
  • SbVec2f getNormalizedLocaterPosition (void) — normalized locater position
  • SbVec2s getLocaterPosition (void) — the locater position, raw
  • SbVec2s getStartLocaterPosition (void) const — where the locater started
  • void setStartLocaterPosition (SbVec2s p) — set that start position
  • SbBool isAdequateConstraintMotion (void) — is this constraint motion good enough?
  • virtual SbBool shouldGrabBasedOnSurrogate (const SoPath *pickpath, const SoPath *surrogatepath) — should we grab based on the surrogate path?
  • void setCameraInfo (SoAction *action) — stash the camera info off the action
  • virtual void handleEvent (SoHandleEventAction *ha) — handle the event
  • void transferMotion (SoDragger *child) — pass motion along to a child dragger
  • void setIgnoreInBbox (SbBool newval) — set whether to ignore this in the bbox
  • SbBool isIgnoreInBbox (void) — are we ignoring it in the bbox?
  • virtual void getBoundingBox (SoGetBoundingBoxAction *action) — compute the bounding box
  • void setActiveChildDragger (SoDragger *newchilddragger) — set the active child dragger
  • SoDragger * getActiveChildDragger (void) const — get the active child dragger
  • virtual void setDefaultOnNonWritingFields (void) — set defaults on fields that don't get written out
  • void updateDraggerCache (const SoPath *path) — refresh the dragger cache
  • virtual const SoPickedPoint * getPickedPointForStart (SoHandleEventAction *action) — the picked point that kicked off the drag

Protected Member Functions inherited from SoInteractionKit

  • virtual ~SoInteractionKit () — destructor
  • virtual void copyContents (const SoFieldContainer *fromFC, SbBool copyConnections) — copy the contents over, connections included or not
  • virtual SbBool setPart (const int partNum, SoNode *node) — set a part by number
  • virtual SbBool readInstance (SoInput *in, unsigned short flags) — read an instance in
  • virtual SbBool setAnyPartAsDefault (const SbName &partname, SoNode *node, SbBool anypart=TRUE, SbBool onlyifdefault=TRUE) — set a part as the default; anypart and onlyifdefault both default to TRUE
  • virtual SbBool setAnyPartAsDefault (const SbName &partname, const SbName &nodename, SbBool anypart=TRUE, SbBool onlyifdefault=TRUE) — same deal but you name the node instead of passing one; anypart and onlyifdefault default to TRUE
  • SbBool setAnySurrogatePath (const SbName &name, SoPath *path, SbBool leafcheck=FALSE, SbBool publiccheck=FALSE) — set a surrogate path; leafcheck and publiccheck default to FALSE
  • void connectSeparatorFields (SoSeparator *dest, SbBool onOff) — wire up separator fields on or off

Protected Member Functions inherited from SoBaseKit

  • virtual ~SoBaseKit () — destructor
  • virtual SoNode * addToCopyDict (void) const — add this kit to the copy dictionary
  • SoGroup * getContainerNode (const SbName &listname, SbBool makeifneeded=TRUE) — get the container node; makeifneeded defaults to TRUE
  • virtual SoNode * getAnyPart (const SbName &partname, SbBool makeifneeded, SbBool leafcheck=FALSE, SbBool publiccheck=FALSE) — grab any part; leafcheck and publiccheck default to FALSE
  • virtual SoNodeKitPath * createPathToAnyPart (const SbName &partname, SbBool makeifneeded, SbBool leafcheck=FALSE, SbBool publiccheck=FALSE, const SoPath *pathtoextend=NULL) — build a path to any part; leafcheck and publiccheck default to FALSE, pathtoextend defaults to NULL
  • virtual SbBool setAnyPart (const SbName &partname, SoNode *from, SbBool anypart=TRUE) — set any part; anypart defaults to TRUE
  • void createNodekitPartsList (void) — build the nodekit parts list
  • void createFieldList (void) — build the field list
  • virtual void createDefaultParts (void) — create the default parts
  • const SoNodekitParts * getNodekitPartsList (void) const — get that nodekit parts list
  • const SbList< SoSFNode * > & getCatalogInstances (void) const — get the catalog instances
  • void catalogError (void) — throw a catalog error
  • void countMyFields (SoOutput *out) — count the fields

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 — does it have multiple write refs?
  • SbBool writeHeader (SoOutput *out, SbBool isgroup, SbBool isengine) const — write the header, with flags for group and engine
  • void writeFooter (SoOutput *out) const — write the footer
  • virtual const char * getFileFormatName (void) const — the file format name
  • virtual SoNotRec createNotRec (void) — create a notification record

⭐ Static Protected Member Functions ⭐

  • static const SoFieldData ** getFieldDataPtr (void) — pointer to the field data pointer
  • static const SoNodekitCatalog ** getClassNodekitCatalogPtr (void) — pointer to the nodekit catalog pointer
  • static void 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 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 pointer
  • static const SoNodekitCatalog ** getClassNodekitCatalogPtr (void) — nodekit catalog pointer pointer
  • static void childTransferMotionAndValueChangedCB (void *, SoDragger *) — child motion-transfer + value-changed callback
  • static void childValueChangedCB (void *, SoDragger *) — child value changed callback
  • static void childStartCB (void *, SoDragger *) — child start callback
  • static void childMotionCB (void *, SoDragger *) — child motion callback
  • static void childFinishCB (void *, SoDragger *) — child finish callback
  • static void childOtherEventCB (void *, SoDragger *) — child other-event callback

Static Protected Member Functions inherited from SoInteractionKit

  • static const SoFieldData ** getFieldDataPtr (void) — field data pointer pointer
  • static const SoNodekitCatalog ** getClassNodekitCatalogPtr (void) — nodekit catalog pointer pointer
  • static void readDefaultParts (const char *fileName, const char defaultBuffer[], int defBufSize) — read default parts from a file name and buffer of a given size
  • static void fieldSensorCB (void *, SoSensor *) — field sensor callback

Static Protected Member Functions inherited from SoBaseKit

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

Static Protected Member Functions inherited from SoNode

  • static const SoFieldData ** getFieldDataPtr (void) — field data pointer pointer
  • static void setNextActionMethodIndex (int index) — set the next action method index
  • static int getNextActionMethodIndex (void) — get the next action method index
  • static void incNextActionMethodIndex (void) — increment the next action method index
  • static void setCompatibilityTypes (const SoType &nodetype, const uint32_t bitmask) — set the compatibility types for a node type

Static Protected Member Functions inherited from SoBase

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

🍓 Protected Attributes 🍓

  • SoSFNode feedback — the feedback node
  • SoSFNode feedbackActive — the active feedback node
  • SoSFNode feedbackSwitch — the feedback switch
  • SoSFNode translator — the translator node
  • SoSFNode translatorActive — the active translator node
  • SoSFNode translatorSwitch — the translator switch
  • SoFieldSensor * fieldSensor — the field sensor
  • SbLineProjector * lineProj — the line projector, doing the actual math work here

Protected Attributes inherited from SoDragger

  • SoSFNode motionMatrix — the motion matrix node

Protected Attributes inherited from SoInteractionKit

  • SoSFNode geomSeparator — the geometry separator
  • SoSFNode topSeparator — the top separator
  • SoFieldSensor * fieldSensor — the field sensor
  • SoSeparator * oldTopSep — the old top separator, kept around

Protected Attributes inherited from SoBaseKit

  • SoSFNode callbackList — the callback list node
  • SoChildList * children — the child list
  • SbBool connectionsSetUp — are the connections set up?

Protected Attributes inherited from SoNode

  • SbUniqueId uniqueId — this node's unique id

Protected Attributes inherited from SoFieldContainer

  • SbBool isBuiltIn — is this thing built in?

🌈 Additional Inherited Members 🌈

Public Types inherited from SoDragger

enum ProjectorFrontSetting { FRONT, BACK, USE_PICK }
  • FRONT — front
  • BACK — back
  • USE_PICK — use whatever got picked

Public Types inherited from SoInteractionKit

enum CacheEnabled { OFF, ON, AUTO }
  • OFF — no caching, bestie
  • ON — caching on
  • AUTO — let Coin decide

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 }
  • INVENTOR = 0x0000 — classic Inventor
  • VRML1 = 0x0001 — VRML1 era
  • VRML2 = 0x0002 — VRML2 era
  • INVENTOR_1 = 0x0004 — Inventor 1
  • INVENTOR_2_0 = 0x0008 — Inventor 2.0
  • INVENTOR_2_1 = 0x0010 — Inventor 2.1
  • INVENTOR_2_5 = 0x0020 — Inventor 2.5
  • INVENTOR_2_6 = 0x0040 — Inventor 2.6
  • COIN_1_0 = 0x0080 — Coin 1.0
  • COIN_2_0 = 0x0100 — Coin 2.0
  • EXTENSION = 0x0200 — extension territory
  • COIN_2_2 = 0x0400 — Coin 2.2
  • COIN_2_3 = 0x0800 — Coin 2.3
  • COIN_2_4 = 0x1000 — Coin 2.4
  • INVENTOR_5_0 = 0x2000 — Inventor 5.0
  • COIN_2_5 = 0x4000 — Coin 2.5
  • COIN_3_0 = 0x8000 — Coin 3.0
  • INVENTOR_6_0 = 0x10000 — Inventor 6.0
  • COIN_4_0 = 0x20000 — Coin 4.0

Protected Types inherited from SoBase

enum BaseFlags { IS_ENGINE = 0x01, IS_GROUP = 0x02 }
  • IS_ENGINE = 0x01 — it's an engine
  • IS_GROUP = 0x02 — it's a 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 so bestie, SoTranslate1Dragger is literally the class that hands your end-user a mechanism to translate along an axis. that's the whole gig. 💅

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

🖼️ (there's a pic of it right here in the docs — imagine a little dragger just vibing, unbothered)

use this dragger to let the end-user of your application translate along the X-axis — i.e. freely along a line, no cap. ✨ (and if you want it translating along some other line? just put a transformation node in front of the dragger to position it and re-orient it. iykyk.)

See also

  • SoTranslate2Dragger
  • SoDragPointDragger

🎀 Constructor & Destructor Documentation 🎀

SoTranslate1Dragger::SoTranslate1Dragger (void )

default constructor, and she sets up the nodekit catalog with the interaction and feedback geometry. iconic behavior fr fr. ✨

Nodekit structure (new entries versus the parent class are marked with the arrow prefix -->):

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

(see SoBaseKit::printDiagram() for info about the output formatting, bestie)

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 info about the output formatting 🫶)

SoTranslate1Dragger::~SoTranslate1Dragger (void ) — [protected], [virtual]

protected destructor, she's shy. 🙈

(dragger classes are derived from SoBase, so they're reference counted and get automatically destroyed when their reference count hits 0. the way that just works 💅)

💖 Member Function Documentation 💖

SoType SoTranslate1Dragger::getClassTypeId (void ) — [static]

this static method returns the SoType object associated with objects of this class. ✨

SoType SoTranslate1Dragger::getTypeId (void ) const — [virtual]

returns the type identification of an object derived from a class inheriting SoBase. this is what's used for runtime type checking and "downward" casting.

reimplemented from SoDragger.

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

ngl this API member is considered internal to the library, since it's not likely to be of interest to the application programmer. 💀

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

const SoFieldData * SoTranslate1Dragger::getFieldData (void ) const — [protected], [virtual]

returns a pointer to the class-wide field data storage object for this instance. and if there are no fields present? returns NULL. 🫥

reimplemented from SoDragger.

const SoNodekitCatalog * SoTranslate1Dragger::getClassNodekitCatalog (void ) — [static]

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

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

returns the nodekit catalog which defines the layout of this class' kit. (yes, again, but this one's the non-static version bestie)

reimplemented from SoDragger.

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

returns the pointer to the pointer of the nodekit catalog for this class. pointer-to-pointer, we love a two-for-one. 🎀

void SoTranslate1Dragger::initClass (void ) — [static]

initializes the type system for this dragger class. ⭐

application programmers should usually not have to invoke this method — see the documentation of SoInteraction::init().

SbBool SoTranslate1Dragger::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 wanna extend the library with new custom nodekits or dragger classes. if that's you, go read the SoBaseKit class documentation. you got this. 💜)

reimplemented from SoInteractionKit.

void SoTranslate1Dragger::setMotionMatrix (const SbMatrix & matrix) — [protected], [virtual]

sets a new current motion matrix for the dragger geometry. ✨

triggers value changed callbacks if matrix is not equal to the previous motion matrix.

reimplemented from SoDragger.

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

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

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

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

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

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 the dragger is selected (picked) by the user. 👆

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 the user drags the mouse after picking the dragger. 🖱️✨

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 the mouse button is released after picking and interacting with the dragger. 🫶

🌈 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. 🔥

if you're the application programmer applying this dragger in your code, you should connect the relevant node fields in the scene to this field so it follows the dragger. that's the move. 👑

SoSFFloat SoTranslate1Dragger::minTranslation

sets the minimum value allowed in the x component of the translation field. this is only active if minTranslation <= maxTranslation. ✨

default value is 1.0

Since: Coin 3.0

and also — sets the minimum value allowed in each component of the translation field. this is only active if minTranslation <= maxTranslation for each component. (yes bestie, the docs really do list both, we keep everything around here 💅)

default value is [1.0, 1.0]

Since: Coin 3.0

SoSFFloat SoTranslate1Dragger::maxTranslation

sets the maximum value allowed in the x component of the translation field. this is only active if minTranslation <= maxTranslation. ✨

default value is 0.0.

Since: Coin 3.0

and also — sets the maximum value allowed in each component of the translation field. this is only active if minTranslation <= maxTranslation for each component.

default value is [0.0, 0.0]

Since: Coin 3.0

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

SbLineProjector* SoTranslate1Dragger::lineProj — [protected]

the SbLineProjector instance used for projecting from 2D mouse cursor positions to 3D points. 🖱️➡️🌐

🌸 Author 🌸

generated automatically by Doxygen for Coin from the source code. (not a human, just a lil robot doing its best 🤖💖)

and that's a wrap bestie!! 🎀 this whole page came from Coin version 4.0.10, dated Thu Jun 25 2026 00:00:00, and it's the manual page for SoTranslate1Dragger(3). go forth and translate along a line. slay. 💅✨

📦 where this page comes from