SoTranslate1Dragger(3)

📦 version 3.1.3, in fedora 43, fedora 44

🎀 SoTranslate1Dragger(3) 🎀

okay bestie, welcome to the SoTranslate1Dragger(3) man page 💅 this is part 1 of 3, so buckle up, hydrate, and don't you dare scroll past the inherited member functions, because we are listing every single one of them. no skipping. no summarising. we eat the whole plate here 🍓

✨ NAME ✨

SoTranslate1Dragger — okay so this class is literally the whole mechanism for letting your end-user translate along an axis. one axis. that's the vibe. 🦋

🌈 SYNOPSIS 🌈

💖 the include (yes you need it)

#include <Inventor/draggers/SoTranslate1Dragger.h>

🫶 Inherits

SoDragger

👑 Public Member Functions

here's what this class brings to the group chat on its own:

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

🌸 Public Member Functions inherited from SoDragger

bestie. look at this list. it's giving legacy. it's giving everything you could ever want to do with a dragger. every single one, here we go, no cap:

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

more inheritance, more slay:

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)

note the isPathSurrogateInMySubgraph double feature and the setPartAsDefault double feature — this family loves an overload, and honestly? same. 💜

💜 Public Member Functions inherited from SoBaseKit

the kit era of the family tree:

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 printTable?? hello?? a man page that draws you a little picture. main character behaviour fr fr 🌈

⭐ Public Member Functions inherited from SoNode

the big one. the blueprint. the moment:

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

three different GLRender paths?? BelowPath, InPath, OffPath?? it's giving situationship with the render pipeline. 😭

🧚 Public Member Functions inherited from SoFieldContainer

fields. containers. the plumbing that makes it all work. we respect her:

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

getFieldsMemorySize tracking managed vs unmanaged bytes... she's tracking her budget bestie 💀

🍓 Public Member Functions inherited from SoBase

the origin story. the root node of the whole family tree (pun fully intended):

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

🔥 Static Public Member Functions

the class-level girlies (no instance needed, she's available to everyone):

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

🌈 Static Public Member Functions inherited from SoDragger

static AND doing the most. every one of them, verbatim, because we keep the receipts:

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)

getTransformFast twice, once with center and once without ✨ and initClass and initClasses because sometimes you want the one and sometimes you want the whole squad. iykyk 💅

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

isSearchingChildren / setSearchingChildren — a little toggle for the search behaviour. cute. 🎀

👑 Static Public Member Functions inherited from SoNode

and here it is, the final static block of part 1, and it is long, and we are NOT skimping, periodt:

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)

look at all those ...S suffix functions — GLRenderS, callbackS, getMatrixS, handleEventS, pickS, rayPickS, searchS, writeS, audioRenderS, getPrimitiveCountS — that's the static-action-passing squad, all lined up, all accounted for, all (SoAction *action, SoNode *node) and we love that for them. 💜

✨ Static Public Member Functions inherited from `SoFieldContainer` ✨

These are static, bestie — so you hit them on the class itself, no instance required 💅

static void initClass (void) — the classic init hook.
static SoType getClassTypeId (void) — hands you back the SoType for the class.
static void cleanupClass (void) — the tidy-up counterpart.
static void initCopyDict (void) — kicks off the copy dictionary.
static void addCopy (const SoFieldContainer *orig, const SoFieldContainer *copy) — registers an orig → copy pair.
static SoFieldContainer * checkCopy (const SoFieldContainer *orig) — checks on a copy of orig.
static SoFieldContainer * findCopy (const SoFieldContainer *orig, const SbBool copyconnections) — hunts down the copy of orig, with a copyconnections switch.
static void copyDone (void) — wraps the copying business up.

🌈 Static Public Member Functions inherited from `SoBase` 🌈

More static hand-me-downs, this time from SoBase — the OG ancestor:

static void initClass (void) — init hook, part two, electric boogaloo.
static SoType getClassTypeId (void) — the SoType for SoBase.
static void addName (SoBase *const base, const char *const name) — gives base the name name.
static void removeName (SoBase *const base, const char *const name) — takes that name right back off.
static void incrementCurrentWriteCounter (void) — bumps the current write counter up.
static void decrementCurrentWriteCounter (void) — and down it goes.
static SoBase * getNamedBase (const SbName &name, SoType type) — fetches the base called name of type type.
static int getNamedBases (const SbName &name, SoBaseList &baselist, SoType type) — same idea but plural, stuffing them into baselist and returning a count.
static SbBool read (SoInput *input, SoBase *&base, SoType expectedtype) — reads a base out of input.
static void setInstancePrefix (const SbString &c) — sets the instance prefix to c.
static void setTraceRefs (SbBool trace) — toggles reference tracing, trace being the switch.
static SbBool getTraceRefs (void) — tells you if ref tracing is on.
static SbBool connectRoute (SoInput *input, const SbName &fromnodename, const SbName &fromfieldname, const SbName &tonodename, const SbName &tofieldname) — wires a route up from fromnodename.fromfieldname over to tonodename.tofieldname.
static SbBool readRoute (SoInput *input) — reads a route in from input.

💖 Public Attributes 💖

These are the public fields you get to poke at directly, no gatekeeping 🫶

SoSFVec3f translation — the translation, as a vec3f.
SoSFFloat minTranslation — the lower bound on translation.
SoSFFloat maxTranslation — the upper bound on translation.

🌸 Public Attributes inherited from `SoDragger` 🌸

SoSFBool isActive — boolean, tells you whether the dragger is active or not.

🎀 Public Attributes inherited from `SoInteractionKit` 🎀

SoSFEnum renderCaching — enum field for render caching.
SoSFEnum boundingBoxCaching — enum field for bounding box caching.
SoSFEnum renderCulling — enum field for render culling.
SoSFEnum pickCulling — enum field for pick culling.

🦋 Protected Member Functions 🦋

Protected means for the class's own business, bestie — internal use, not your personal playground:

virtual const SoFieldData * getFieldData (void) const — returns the field data, const edition.
virtual ~SoTranslate1Dragger (void) — the destructor, virtual as always.
virtual SbBool setUpConnections (SbBool onoff, SbBool doitalways=FALSE) — sets up connections; onoff flips them, and doitalways defaults to FALSE.
virtual void setMotionMatrix (const SbMatrix &matrix) — assigns the motion matrix from matrix.
void dragStart (void) — the drag-start handler.
void drag (void) — the drag handler, the main character of this whole operation, honestly.
void dragFinish (void) — the drag-finish handler.

🧚 Protected Member Functions inherited from `SoDragger` 🧚

SoDragger (void) — the constructor.
virtual ~SoDragger (void) — the destructor.
SbVec2f getNormalizedLocaterPosition (void) — the locater position, normalized.
SbVec2s getLocaterPosition (void) — the locater position, raw.
SbVec2s getStartLocaterPosition (void) const — where the locater was when it all started.
void setStartLocaterPosition (SbVec2s p) — sets that starting position to p.
SbBool isAdequateConstraintMotion (void) — is this motion good enough for the constraint? yes/no.
virtual SbBool shouldGrabBasedOnSurrogate (const SoPath *pickpath, const SoPath *surrogatepath) — decides whether to grab based on a surrogate, given pickpath and surrogatepath.
void setCameraInfo (SoAction *action) — pulls camera info out of action.
virtual void handleEvent (SoHandleEventAction *ha) — handles the event in ha.
void transferMotion (SoDragger *child) — passes motion along to child.
void setIgnoreInBbox (SbBool newval) — sets the ignore-in-bbox flag to newval.
SbBool isIgnoreInBbox (void) — reads that flag back.
virtual void getBoundingBox (SoGetBoundingBoxAction *action) — computes the bounding box into action.
void setActiveChildDragger (SoDragger *newchilddragger) — promotes newchilddragger to active child dragger.
SoDragger * getActiveChildDragger (void) const — returns the active child dragger.
virtual void setDefaultOnNonWritingFields (void) — sets defaults on the fields that aren't being written.
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, with a copyConnections flag.
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 from in with flags.
virtual SbBool setAnyPartAsDefault (const SbName &partname, SoNode *node, SbBool anypart=TRUE, SbBool onlyifdefault=TRUE) — sets the part named partname to node as a 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 by nodename instead.
SbBool setAnySurrogatePath (const SbName &name, SoPath *path, SbBool leafcheck=FALSE, SbBool publiccheck=FALSE) — sets a surrogate path for name; leafcheck and publiccheck both default to FALSE.
void connectSeparatorFields (SoSeparator *dest, SbBool onOff) — hooks up the separator fields on dest, onOff toggling it.

⭐ Protected Member Functions inherited from `SoBaseKit` ⭐

virtual ~SoBaseKit () — destructor.
virtual SoNode * addToCopyDict (void) const — adds itself into the copy dictionary.
SoGroup * getContainerNode (const SbName &listname, SbBool makeifneeded=TRUE) — grabs the container node for listname; makeifneeded defaults to TRUE.
virtual SoNode * getAnyPart (const SbName &partname, SbBool makeifneeded, SbBool leafcheck=FALSE, SbBool publiccheck=FALSE) — fetches the part called partname, with makeifneeded, leafcheck and publiccheck (the last two defaulting to FALSE).
virtual SoNodeKitPath * createPathToAnyPart (const SbName &partname, SbBool makeifneeded, SbBool leafcheck=FALSE, SbBool publiccheck=FALSE, const SoPath *pathtoextend=NULL) — builds a nodekit path to partname; leafcheck and publiccheck default to FALSE, and pathtoextend defaults to NULL.
virtual SbBool setAnyPart (const SbName &partname, SoNode *from, SbBool anypart=TRUE) — sets the part partname from from, anypart defaulting to TRUE.
void createNodekitPartsList (void) — builds the nodekit parts list.
void createFieldList (void) — builds the field list.
virtual void createDefaultParts (void) — creates the default parts.
const SoNodekitParts * getNodekitPartsList (void) const — returns the nodekit parts list.
const SbList< SoSFNode * > & getCatalogInstances (void) const — returns the catalog instances list.
void catalogError (void) — the catalog error handler.
void countMyFields (SoOutput *out) — counts the fields, writing 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) — the destroy hook.
SbBool hasMultipleWriteRefs (void) const — are there multiple write refs? asks and answers.
SbBool writeHeader (SoOutput *out, SbBool isgroup, SbBool isengine) const — writes the header into out, with isgroup and isengine flags.
void writeFooter (SoOutput *out) const — writes the footer into out.
virtual const char * getFileFormatName (void) const — returns the file format name as a C string.

🎀 Static Protected Member Functions 🎀

Static and protected — the VIP-only lounge of callbacks 🫶

static const SoFieldData ** getFieldDataPtr (void) — returns a pointer to the field data pointer.
static const SoNodekitCatalog ** getClassNodekitCatalogPtr (void) — returns a pointer to the class nodekit catalog pointer.
static void startCB (void *f, SoDragger *d) — the start callback, taking f and d.
static void motionCB (void *f, SoDragger *d) — the motion callback.
static void finishCB (void *f, SoDragger *d) — the finish callback.
static void fieldSensorCB (void *f, SoSensor *s) — the field sensor callback, taking f and s.
static void valueChangedCB (void *f, SoDragger *d) — the value-changed callback.

🌈 Static Protected Member Functions inherited from `SoDragger` 🌈

static const SoFieldData ** getFieldDataPtr (void) — pointer to the field data pointer.
static const SoNodekitCatalog ** getClassNodekitCatalogPtr (void) — pointer to the class nodekit catalog pointer.
static void childTransferMotionAndValueChangedCB (void *, SoDragger *) — the child transfer-motion-and-value-changed callback.
static void childValueChangedCB (void *, SoDragger *) — the child value-changed callback.
static void childStartCB (void *, SoDragger *) — the child start callback.
static void childMotionCB (void *, SoDragger *) — the child motion callback.
static void childFinishCB (void *, SoDragger *) — the child finish callback.
static void childOtherEventCB (void *, SoDragger *) — the child other-event callback.

🦋 Static Protected Member Functions inherited from `SoInteractionKit` 🦋

static const SoFieldData ** getFieldDataPtr (void) — pointer to the field data pointer.
static const SoNodekitCatalog ** getClassNodekitCatalogPtr (void) — pointer to the class nodekit catalog pointer.
static void readDefaultParts (const char *fileName, const char defaultBuffer[], int defBufSize) — reads default parts from fileName out of defaultBuffer of size defBufSize.
static void fieldSensorCB (void *, SoSensor *) — the field sensor callback.

🧚 Static Protected Member Functions inherited from `SoBaseKit` 🧚

static const SoFieldData ** getFieldDataPtr (void) — pointer to the field data pointer.
static const SoNodekitCatalog ** getClassNodekitCatalogPtr (void) — pointer to the class nodekit catalog pointer.

💜 Static Protected Member Functions inherited from `SoNode` 💜

static const SoFieldData ** getFieldDataPtr (void) — pointer to the field data pointer.
static void setNextActionMethodIndex (int index) — sets the next action method index to index.
static int getNextActionMethodIndex (void) — returns the next action method index.
static void incNextActionMethodIndex (void) — increments the next action method index.
static void setCompatibilityTypes (const SoType &nodetype, const uint32_t bitmask) — sets compatibility types for nodetype using 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. teamwork, honestly.

🔥 Protected Attributes 🔥

SoSFNode feedback — the feedback node field.
SoSFNode feedbackActive — the feedback-active node field.
SoSFNode feedbackSwitch — the feedback-switch node field.
SoSFNode translator — the translator node field.
SoSFNode translatorActive — the translator-active node field.
SoSFNode translatorSwitch — the translator-switch node field.
SoFieldSensor * fieldSensor — pointer to the field sensor.
SbLineProjector * lineProj — pointer to the line projector.

🌸 Protected Attributes inherited from `SoDragger` 🌸

SoSFNode motionMatrix — the motion matrix node field.

🎀 Protected Attributes inherited from `SoInteractionKit` 🎀

SoSFNode geomSeparator — the geometry separator node field.
SoSFNode topSeparator — the top separator node field.
SoFieldSensor * fieldSensor — pointer to the field sensor.
SoSeparator * oldTopSep — pointer to the old top separator.

🦋 Protected Attributes inherited from `SoBaseKit` 🦋

SoSFNode callbackList — the callback list node field.
SoChildList * children — pointer to the child list.
SbBool connectionsSetUp — whether the connections have been set up.

🧚 Protected Attributes inherited from `SoNode` 🧚

uint32_t uniqueId — the unique id.

💜 Protected Attributes inherited from `SoFieldContainer` 💜

SbBool isBuiltIn — whether the thing is built in.

👑 Additional Inherited Members 👑

🌈 Public Types inherited from `SoDragger` 🌈

enum ProjectorFrontSetting { FRONT, BACK, USE_PICK } — projector front setting options: FRONT, BACK, USE_PICK.

💖 Public Types inherited from `SoInteractionKit` 💖

enum CacheEnabled { OFF, ON, AUTO } — cache options: 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, COIN_3_0 = 0x8000, INVENTOR_6_0 = 0x10000 } — the whole node-type bitmask lineup, every single value preserved, no cap 💅

🎀 Protected Types inherited from `SoBase` 🎀

enum BaseFlags { IS_ENGINE = 0x01, IS_GROUP = 0x02 } — base flags: IS_ENGINE and IS_GROUP.

⭐ Static Protected Attributes inherited from `SoNode` ⭐

static uint32_t nextUniqueId = 1 — starts life at 1.
static int nextActionMethodIndex = 0 — starts life at 0.

💫 Detailed Description 💫

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

Here's how the dragger looks with its default geometry in the 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 )`

Default constructor, and bestie it is doing the most: it sets up the dragger nodekit catalog with the interaction and feedback geometry. ✨

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"

(Peep SoBaseKit::printDiagram() for the tea on how that output formatting works. 💅)

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

(And SoBaseKit::printTable() has the formatting deets if you're curious. 🫶)

💀 `SoTranslate1Dragger::~SoTranslate1Dragger (void )` [protected], [virtual]

Protected destructor, periodt.

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

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.

Reimplemented from SoDragger.

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

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

Reimplemented from SoDragger.

`SbBool SoTranslate1Dragger::setUpConnections (SbBool onoff, SbBool doitalways = FALSE)` [protected], [virtual]

Sets up all internal connections for instances of this class.

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 unequal to the previous motion matrix. 🔔

Reimplemented from SoDragger.

`void SoTranslate1Dragger::startCB (void * f, SoDragger * d)` [static], [protected]

`void SoTranslate1Dragger::motionCB (void * f, SoDragger * d)` [static], [protected]

`void SoTranslate1Dragger::finishCB (void * f, SoDragger * d)` [static], [protected]

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

`void SoTranslate1Dragger::valueChangedCB (void * f, SoDragger * d)` [static], [protected]

`void SoTranslate1Dragger::dragStart (void )` [protected]

Called when dragger is selected (picked) by the user. 👑

`void SoTranslate1Dragger::drag (void )` [protected]

Called when user drags the mouse after picking the dragger. 🖱️

`void SoTranslate1Dragger::dragFinish (void )` [protected]

Called when 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.

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

`SoSFFloat SoTranslate1Dragger::minTranslation`

Sets the minimum value allowed in the x component of the translaton field. This is only active if minTranslation <= maxTranslation.

Default value is 1.0

Since Coin 3.0

Sets the minimum value allowed in each component of the translaton field. This is only active if minTranslation <= maxTranslation for each component.

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 translaton field. This is only active if minTranslation <= maxTranslation.

Default value is 0.0.

Since Coin 3.0

Sets the maximum value allowed in each component of the translaton 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]

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

Okay bestie, that's the whole page! It comes from Coin, version 3.1.3 — the SoTranslate1Dragger(3) manual page. The footer date? Not here, but the vibe is timeless. Slay. 💅✨

📦 where this page comes from

fedora 43: Coin3-devel 3.1.3-40.fc43 · GPL-2.0-only
fedora 43: Coin3-devel 3.1.3-40.fc43 · GPL-2.0-only
fedora 44: Coin3-devel 3.1.3-42.fc44 · GPL-2.0-only
fedora 44: Coin3-devel 3.1.3-42.fc44 · GPL-2.0-only
💖 girlified by deepseek-ai/DeepSeek-V4.1-Flash on 2026-10-14: a language model's rewrite of the original, under its terms

SoTranslate1Dragger(3)