SoTransformerDragger(3)

📦 version 3.1.3, in fedora 43, fedora 44

💖 SoTransformerDragger(3) 💖

Library Functions Manual · section 3

okay so bestie, buckle up 💅 this is the manual page for SoTransformerDragger, and she is that girl — the dragger that gives you geometry for translation, scaling and rotations. three whole moods in one node. main character energy fr fr.

✨ NAME ✨

SoTransformerDragger — the dragger that provides geometry for translation, scaling and rotations. no cap, that's the whole job description.

🌸 SYNOPSIS 🌸

first things first, you gotta pull her in:

#include <Inventor/draggers/SoTransformerDragger.h>

she inherits from SoDragger — so everything the parent can do, she can do too, and she's about to show you a lot of inherited slay.

🎀 Public Types 🎀

the State enum, aka the list of every vibe she can be in at any given moment:

enum State { INACTIVE, RIT_X_ROTATE, TOP_Y_ROTATE, FNT_Z_ROTATE,
    LFT_X_ROTATE, BOT_Y_ROTATE, BAK_Z_ROTATE, PX_PY_PZ_3D_SCALE,
    PX_PY_NZ_3D_SCALE, PX_NY_PZ_3D_SCALE, PX_NY_NZ_3D_SCALE,
    NX_PY_PZ_3D_SCALE, NX_PY_NZ_3D_SCALE, NX_NY_PZ_3D_SCALE,
    NX_NY_NZ_3D_SCALE, RIT_TRANSLATE, TOP_TRANSLATE, FNT_TRANSLATE,
    LFT_TRANSLATE, BOT_TRANSLATE, BAK_TRANSLATE }

look at all those states. rotations on every side, all eight corners of 3D scaling, and translations in every direction. she's got a fit for every occasion, iykyk 🦋

💜 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,
    COIN_3_0 = 0x8000, INVENTOR_6_0 = 0x10000 }

👑 Public Member Functions 👑

her own methods, the ones she didn't inherit from anybody. periodt.

  • virtual SoType getTypeId (void) const — the classic Coin type-id flex.
  • virtual const SoNodekitCatalog * getNodekitCatalog (void) const — hands over the nodekit catalog.
  • SoTransformerDragger (void) — the constructor. no arguments, she's low maintenance ✨
  • State getCurrentState (void) — tells you which one of those State values she's currently serving.
  • void unsquishKnobs (void) — yes bestie, unsquishKnobs. the name is doing all the work and honestly? iconic.
  • SbBool isLocateHighlighting (void) — the getter for locate highlighting.
  • void setLocateHighlighting (SbBool onoff) — the setter. pass onoff and vibe.
  • SbVec3f getBoxPointInWorldSpace (const SbVec3f &pointonunitbox) — box point ➡️ world space.
  • SbVec3f getBoxDirInWorldSpace (const SbVec3f &dironunitbox) — box direction ➡️ world space.
  • SbVec3f getWorldPointInBoxSpace (const SbVec3f &pointinworldspace) — the other direction, world point ➡️ box space.
  • SbVec2f getWorldPointInPixelSpace (const SbVec3f &thepoint) — world ➡️ pixels, because screens are 2D and we live in a society 🌈
  • SbVec3f getInteractiveCenterInBoxSpace (void) — the interactive center, in box space.

💜 Public Member Functions inherited from SoDragger

she didn't write these, she inherited them, and they're all hers now 💅

  • 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)
  • virtual void setMotionMatrix (const SbMatrix &newmatrix)
  • void valueChanged (void)
  • const SbMatrix & getStartMotionMatrix (void)
  • virtual void saveStartParameters (void)
  • const SoPath * getPickPath (void) const
  • const SoEvent * getEvent (void) const
  • SoPath * createPathToThis (void)
  • const SoPath * getSurrogatePartPickedOwner (void) const
  • const SbName & getSurrogatePartPickedName (void) const
  • const SoPath * getSurrogatePartPickedPath (void) const
  • void setStartingPoint (const SoPickedPoint *newpoint)
  • void setStartingPoint (const SbVec3f &newpoint)
  • const SbViewVolume & getViewVolume (void)
  • void setViewVolume (const SbViewVolume &vol)
  • const SbViewportRegion & getViewportRegion (void)
  • void setViewportRegion (const SbViewportRegion &reg)
  • SoHandleEventAction * getHandleEventAction (void) const
  • void setHandleEventAction (SoHandleEventAction *newAction)
  • void setTempPathToThis (const SoPath *somethingclose)
  • virtual void grabEventsSetup (void)
  • virtual void grabEventsCleanup (void)
  • void workFieldsIntoTransform (SbMatrix &mtx)
  • void setFrontOnProjector (ProjectorFrontSetting newval)
  • ProjectorFrontSetting getFrontOnProjector (void) const

💜 Public Member Functions inherited from SoInteractionKit

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

💜 Public Member Functions inherited from SoBaseKit

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

💜 Public Member Functions inherited from SoNode

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

💜 Public Member Functions inherited from SoFieldContainer

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

💜 Public Member Functions inherited from SoBase

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

⭐ Static Public Member Functions ⭐

the ones you can call without even making an instance. queen behaviour.

  • static SoType getClassTypeId (void)
  • static const SoNodekitCatalog * getClassNodekitCatalog (void)
  • static void initClass (void)
  • static void setColinearThreshold (int newval)
  • static int getColinearThreshold (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)
bestie that was the whole SYNOPSIS and it was a lot 😭 take a breath, hydrate, and get ready — the rest of this page is coming 💖

✨ Static Public Member Functions inherited from SoInteractionKit

These ones come free with the family, bestie — you didn't write them, you just inherit them 💖

  • static SoType getClassTypeId (void) — grabs the class type id, the lil name tag for the class
  • static const SoNodekitCatalog * getClassNodekitCatalog (void) — hands you the nodekit catalog for the class
  • static void initClass (void) — sets the whole class up, one-time vibe
  • static void setSwitchValue (SoNode *node, const int newVal) — pokes a switch value onto node, setting it to newVal

🌸 Static Public Member Functions inherited from SoBaseKit

  • static SoType getClassTypeId (void) — same energy, class type id
  • static void initClass (void) — init that class
  • static const SoNodekitCatalog * getClassNodekitCatalog (void) — the class-level nodekit catalog
  • static SbBool isSearchingChildren (void) — are we searching the children rn? yes/no
  • static void setSearchingChildren (const SbBool newval) — flip the searching-children flag to newval

🦋 Static Public Member Functions inherited from SoNode

  • static uint32_t getCompatibilityTypes (const SoType &nodetype) — returns the compatibility bitmask for nodetype
  • static SoType getClassTypeId (void) — the class type id, again, iconic
  • static SoNode * getByName (const SbName &name) — find a node by name
  • static int getByName (const SbName &name, SoNodeList &l) — same hunt but it dumps the finds into l and returns a count
  • static void initClass (void) — init it
  • static void initClasses (void) — init all the classes, plural, she's doing overtime
  • static uint32_t getNextNodeId (void) — the next node id, fresh off the press
  • static int getActionMethodIndex (const SoType type) — action method index for type
  • static void getBoundingBoxS (SoAction *action, SoNode *node) — static bounding-box action hook
  • static void GLRenderS (SoAction *action, SoNode *node) — static GL render hook
  • static void callbackS (SoAction *action, SoNode *node) — static callback hook
  • static void getMatrixS (SoAction *action, SoNode *node) — static get-matrix hook
  • static void handleEventS (SoAction *action, SoNode *node) — static event handler hook
  • static void pickS (SoAction *action, SoNode *node) — static pick hook
  • static void rayPickS (SoAction *action, SoNode *node) — static ray-pick hook
  • static void searchS (SoAction *action, SoNode *node) — static search hook
  • static void writeS (SoAction *action, SoNode *node) — static write hook
  • static void audioRenderS (SoAction *action, SoNode *node) — static audio render hook 🎧
  • static void getPrimitiveCountS (SoAction *action, SoNode *node) — static primitive-count hook

💅 Static Public Member Functions inherited from SoFieldContainer

  • static void initClass (void) — init, as always
  • static SoType getClassTypeId (void) — class type id, she's everywhere
  • static void cleanupClass (void) — tidy up the class, self-care era
  • static void initCopyDict (void) — set up the copy dictionary
  • static void addCopy (const SoFieldContainer *orig, const SoFieldContainer *copy) — registers copy as a copy of orig
  • static SoFieldContainer * checkCopy (const SoFieldContainer *orig) — check the copy situation for orig
  • static SoFieldContainer * findCopy (const SoFieldContainer *orig, const SbBool copyconnections) — find the copy of orig, with copyconnections deciding if connections matter
  • static void copyDone (void) — we're done copying, wrap it up bestie

🎀 Static Public Member Functions inherited from SoBase

  • static void initClass (void) — init
  • static SoType getClassTypeId (void) — class type id (say it with me now)
  • 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) — bumps it back down
  • static SoBase * getNamedBase (const SbName &name, SoType type) — fetch a named base of type
  • static int getNamedBases (const SbName &name, SoBaseList &baselist, SoType type) — collect the named bases of type into baselist, returns how many
  • static SbBool read (SoInput *input, SoBase *&base, SoType expectedtype) — reads from input, dropping the result in base, expecting expectedtype
  • static void setInstancePrefix (const SbString &c) — sets the instance prefix to c
  • static void setTraceRefs (SbBool trace) — turn ref tracing on/off with trace
  • static SbBool getTraceRefs (void) — is ref tracing on?
  • static SbBool connectRoute (SoInput *input, const SbName &fromnodename, const SbName &fromfieldname, const SbName &tonodename, const SbName &tofieldname) — wires a route from one node's field to another's, using input
  • static SbBool readRoute (SoInput *input) — reads a route from input

👑 Public Attributes 👑

These are the fields you can actually poke at. The main character fields, fr fr.

  • SoSFRotation rotation — the rotation
  • SoSFVec3f translation — the translation
  • SoSFVec3f scaleFactor — the scale factor
  • SoSFFloat minDiscRotDot — the minimum disc rotation dot

💖 Public Attributes inherited from SoDragger

  • SoSFBool isActive — is it active? yes or no, that's the whole field

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

For the class's eyes only — you can look but these aren't for outside hands, no cap.

  • virtual const SoFieldData * getFieldData (void) const — returns the field data
  • virtual ~SoTransformerDragger (void) — the destructor, doing her goodbye tour
  • virtual SbBool setUpConnections (SbBool onoff, SbBool doitalways=FALSE) — sets up the connections, onoff toggles them, doitalways defaults to FALSE
  • virtual void setDefaultOnNonWritingFields (void) — sets defaults on the fields that aren't being written
  • void dragStart (void) — drag starts, let's go
  • void drag (void) — the drag itself, mid-motion
  • void dragFinish (void) — drag's over, wrap it up
  • void updateAntiSquishList (void) — refreshes the anti-squish list
  • void setAllPartSwitches (int scalewhich, int rotatewhich, int translatewhich) — sets all the part switches: scalewhich, rotatewhich, translatewhich
  • int getMouseGestureDirection (SbBool x_ok, SbBool y_ok, SbBool z_ok) — figures out the mouse gesture direction, with x_ok, y_ok, z_ok telling it which axes are allowed

💜 Protected Member Functions inherited from SoDragger

  • SoDragger (void) — the constructor
  • virtual ~SoDragger (void) — the destructor
  • SbVec2f getNormalizedLocaterPosition (void) — normalized locater position, in SbVec2f
  • SbVec2s getLocaterPosition (void) — the raw locater position, in SbVec2s
  • SbVec2s getStartLocaterPosition (void) const — where the locater started, const so don't even think about touching it
  • void setStartLocaterPosition (SbVec2s p) — set the start locater position to p
  • SbBool isAdequateConstraintMotion (void) — is this motion adequate for the constraint?
  • virtual SbBool shouldGrabBasedOnSurrogate (const SoPath *pickpath, const SoPath *surrogatepath) — should it grab, based on pickpath vs surrogatepath?
  • void setCameraInfo (SoAction *action) — sets the camera info from action
  • virtual void handleEvent (SoHandleEventAction *ha) — handles the event via 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) — is it ignoring in bbox?
  • virtual void getBoundingBox (SoGetBoundingBoxAction *action) — computes the bounding box for action
  • void setActiveChildDragger (SoDragger *newchilddragger) — sets the active child dragger to newchilddragger
  • SoDragger * getActiveChildDragger (void) const — returns the active child dragger
  • 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 from fromFC, with copyConnections deciding about connections
  • 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 any part named partname to node as default; anypart defaults TRUE, onlyifdefault defaults TRUE
  • virtual SbBool setAnyPartAsDefault (const SbName &partname, const SbName &nodename, SbBool anypart=TRUE, SbBool onlyifdefault=TRUE) — same deal but the default comes from nodename
  • SbBool setAnySurrogatePath (const SbName &name, SoPath *path, SbBool leafcheck=FALSE, SbBool publiccheck=FALSE) — sets a surrogate path for name; leafcheck and publiccheck both default FALSE
  • void connectSeparatorFields (SoSeparator *dest, SbBool onOff) — wires up separator fields on dest, toggled by onOff

🌸 Protected Member Functions inherited from SoBaseKit

  • virtual ~SoBaseKit () — destructor
  • virtual SoNode * addToCopyDict (void) const — adds this to the copy dictionary, const and all
  • SoGroup * getContainerNode (const SbName &listname, SbBool makeifneeded=TRUE) — gets the container node for listname, makeifneeded defaults TRUE
  • virtual SoNode * getAnyPart (const SbName &partname, SbBool makeifneeded, SbBool leafcheck=FALSE, SbBool publiccheck=FALSE) — gets any part named partname; makeifneeded matters, leafcheck and publiccheck default FALSE
  • virtual SoNodeKitPath * createPathToAnyPart (const SbName &partname, SbBool makeifneeded, SbBool leafcheck=FALSE, SbBool publiccheck=FALSE, const SoPath *pathtoextend=NULL) — builds a path to any part; leafcheck/publiccheck default FALSE, pathtoextend defaults NULL
  • virtual SbBool setAnyPart (const SbName &partname, SoNode *from, SbBool anypart=TRUE) — sets any part named partname from from, anypart defaults 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) — throws a catalog error
  • void countMyFields (SoOutput *out) — counts the fields, writing via out

🎧 Protected Member Functions inherited from SoNode

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

💖 Protected Member Functions inherited from SoFieldContainer

  • SoFieldContainer (void) — constructor
  • virtual ~SoFieldContainer (void) — 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 — writes the header to out, with isgroup and isengine flags
  • void writeFooter (SoOutput *out) const — writes the footer to out
  • virtual const char * getFileFormatName (void) const — returns the file format name

⭐ Static Protected Member Functions ⭐

  • static const SoFieldData ** getFieldDataPtr (void) — pointer to the field data pointer
  • static const SoNodekitCatalog ** getClassNodekitCatalogPtr (void) — pointer to the class nodekit catalog pointer
  • static void startCB (void *f, SoDragger *d) — start callback, f and d in tow
  • static void motionCB (void *f, SoDragger *d) — motion callback
  • static void finishCB (void *f, SoDragger *d) — finish callback
  • static void metaKeyChangeCB (void *, SoDragger *) — meta key change callback
  • static void fieldSensorCB (void *f, SoSensor *s) — field sensor callback, f and s
  • static void valueChangedCB (void *f, SoDragger *d) — value changed callback
  • static int getIgnoreAxis (SbVec2f axis[3][2], SbBool x_ok, SbBool y_ok, SbBool z_ok) — returns which axis to ignore, given the axis array and x_ok/y_ok/z_ok
  • static void makeMinorAxisPerpendicularIfColinear (SbVec2f origin, SbVec2f axisends[3][2], int index_a, int index_b) — if the minor axis is colinear, makes it perpendicular, using origin, axisends, index_a, index_b
  • static SbBool isColinear (SbVec2f a1[2], SbVec2f a2[2], int pixels) — are a1 and a2 colinear within pixels?

💅 Static Protected Member Functions inherited from SoDragger

  • static const SoFieldData ** getFieldDataPtr (void) — field data pointer pointer
  • static const SoNodekitCatalog ** getClassNodekitCatalogPtr (void) — class nodekit catalog pointer pointer
  • static void childTransferMotionAndValueChangedCB (void *, SoDragger *) — child transfer-motion-and-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) — class nodekit catalog pointer pointer
  • static void readDefaultParts (const char *fileName, const char defaultBuffer[], int defBufSize) — reads default parts from fileName, with defaultBuffer and defBufSize
  • 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) — class 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) — 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 the static data

okay bestie that's the whole inheritance situation laid out 💖 more coming, don't go anywhere ✨

🎀 Protected Attributes 🎀

Okay bestie, this is the part where we open up the dragger and look at all the wiring inside. 👑 These are the protected attributes — the internal node kit pieces the class uses to build itself and to animate its feedback. Every single one of the SoSFNode ones below is, you guessed it, an SoSFNode:

  • axisFeedbackLocation
  • axisFeedbackSep
  • circleFeedbackAntiSquish
  • circleFeedbackSep
  • circleFeedbackTransform
  • circleFeedbackTransformSwitch
  • negXRoundWallFeedback
  • negXWallFeedback
  • negXWallFeedbackSwitch
  • negYRoundWallFeedback
  • negYWallFeedback
  • negYWallFeedbackSwitch
  • negZRoundWallFeedback
  • negZWallFeedback
  • negZWallFeedbackSwitch
  • overallStyle
  • posXRoundWallFeedback
  • posXWallFeedback
  • posXWallFeedbackSwitch
  • posYRoundWallFeedback
  • posYWallFeedback
  • posYWallFeedbackSwitch
  • posZRoundWallFeedback
  • posZWallFeedback
  • posZWallFeedbackSwitch
  • radialFeedback
  • radialFeedbackSwitch
  • rotator1
  • rotator1Active
  • rotator1LocateGroup
  • rotator1Switch
  • rotator2
  • rotator2Active
  • rotator2LocateGroup
  • rotator2Switch
  • rotator3
  • rotator3Active
  • rotator3LocateGroup
  • rotator3Switch
  • rotator4
  • rotator4Active
  • rotator4LocateGroup
  • rotator4Switch
  • rotator5
  • rotator5Active
  • rotator5LocateGroup
  • rotator5Switch
  • rotator6
  • rotator6Active
  • rotator6LocateGroup
  • rotator6Switch
  • rotatorSep
  • scale1
  • scale1Active
  • scale1LocateGroup
  • scale1Switch
  • scale2
  • scale2Active
  • scale2LocateGroup
  • scale2Switch
  • scale3
  • scale3Active
  • scale3LocateGroup
  • scale3Switch
  • scale4
  • scale4Active
  • scale4LocateGroup
  • scale4Switch
  • scale5
  • scale5Active
  • scale5LocateGroup
  • scale5Switch
  • scale6
  • scale6Active
  • scale6LocateGroup
  • scale6Switch
  • scale7
  • scale7Active
  • scale7LocateGroup
  • scale7Switch
  • scale8
  • scale8Active
  • scale8LocateGroup
  • scale8Switch
  • scaleBoxFeedback
  • scaleBoxFeedbackSwitch
  • scaleSep
  • surroundScale
  • translateBoxFeedback
  • translateBoxFeedbackRotation
  • translateBoxFeedbackSep
  • translateBoxFeedbackSwitch
  • translator1
  • translator1Active
  • translator1LocateGroup
  • translator1Switch
  • translator2
  • translator2Active
  • translator2LocateGroup
  • translator2Switch
  • translator3
  • translator3Active
  • translator3LocateGroup
  • translator3Switch
  • translator4
  • translator4Active
  • translator4LocateGroup
  • translator4Switch
  • translator5
  • translator5Active
  • translator5LocateGroup
  • translator5Switch
  • translator6
  • translator6Active
  • translator6LocateGroup
  • translator6Switch
  • translatorSep
  • xAxisFeedbackActive
  • xAxisFeedbackSelect
  • xAxisFeedbackSwitch
  • xCircleFeedback
  • xCircleFeedbackSwitch
  • xCrosshairFeedback
  • yAxisFeedbackActive
  • yAxisFeedbackSelect
  • yAxisFeedbackSwitch
  • yCircleFeedback
  • yCircleFeedbackSwitch
  • yCrosshairFeedback
  • zAxisFeedbackActive
  • zAxisFeedbackSelect
  • zAxisFeedbackSwitch
  • zCircleFeedback
  • zCircleFeedbackSwitch
  • zCrosshairFeedback

And then the non-SoSFNode ones, which are their own whole vibe:

  • SoFieldSensor * translFieldSensor
  • SoFieldSensor * scaleFieldSensor
  • SoFieldSensor * rotateFieldSensor
  • SoNodeList antiSquishList

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

Protected Types inherited from SoBase

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

Static Protected Attributes inherited from SoNode

  • static uint32_t nextUniqueId = 1
  • static int nextActionMethodIndex = 0

✨ Detailed Description ✨

The SoTransformerDragger provides geometry for translation, scaling and rotations. 💅

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

(picture the cross-and-boxes situation, just chilling there, unbothered 🧚)

Translate the dragger by clicking and dragging any of the (invisible) sides. Translation will default be done in the plane of the side the end-user selected. The user can hold down a SHIFT key to lock translation to a single of the axes in the plane. By holding down a CTRL key instead, translation can be done along the plane's normal vector.

Scaling is done by dragging the corner cubes. By default, uniform scaling will be done. Hold down SHIFT before selecting any of the corners to do non-uniform scaling. Uniform scaling towards a corner-point can be accomplished by holding down CTRL before clicking and dragging one of the cubes.

Rotation is done by dragging any of the 6 end-markers of the axis cross. The initial drag direction decides which orientation the rotation will be done in. Hold down SHIFT to do free-form rotation around the sphere instead.

Lowkey important, bestie: this is a big and complex dragger which needs a fair amount of proper documentation when provided in end-user applications. If what you are trying to accomplish in your application does not really demand most of the features of this dragger, you are advised to investigate whether or not any of the less complex draggers can fulfill your requirements — so you can provide an as simple as possible user interface to your end-users. 🫶

For the application programmer's convenience, the Coin library also provides a manipulator class called SoTransformerManip, which wraps the SoTransformerDragger into the necessary mechanisms for making direct insertion of this dragger into a scenegraph possible with very little effort. ✨

👀 See also

SoTransformerManip

🌈 Member Enumeration Documentation 🌈

enum SoTransformerDragger::State

The various possible states the dragger might be in at any given time. That is: either SoTransformerDragger::INACTIVE if there's no interaction, or any of the other values to indicate what operation the end-user is currently executing. 👑

🎀 Constructor & Destructor Documentation 🎀

SoTransformerDragger::SoTransformerDragger (void )

Default constructor, sets up the dragger nodekit catalog with the interaction and feedback geometry. 💖

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

and the actual tree diagram is coming right up in the next bit, so hold that thought 🦋

okay so THIS is the part where the dragger shows you its whole internal lewk. it's a tree, bestie, a whole family tree of nodes, and honestly? it's giving royal lineage. 👑

the little --> arrows are part of how the diagram gets drawn — and if you're curious about the formatting rules themselves, that's a SoBaseKit::printDiagram() question, not a me question. 🎀

CLASS SoTransformerDragger
-->"this"
      "callbackList"
      "topSeparator"
         "motionMatrix"
-->      "surroundScale"
-->      "overallStyle"
         "geomSeparator"
-->         "axisFeedbackSep"
-->            "axisFeedbackLocation"
-->            "xAxisFeedbackSwitch"
-->               "xAxisFeedbackActive"
-->               "xAxisFeedbackSelect"
-->               "xCrosshairFeedback"
-->            "yAxisFeedbackSwitch"
-->               "yAxisFeedbackActive"
-->               "yAxisFeedbackSelect"
-->               "yCrosshairFeedback"
-->            "zAxisFeedbackSwitch"
-->               "zAxisFeedbackActive"
-->               "zAxisFeedbackSelect"
-->               "zCrosshairFeedback"
-->         "translateBoxFeedbackSep"
-->            "translateBoxFeedbackSwitch"
-->               "translateBoxFeedbackRotation"
-->               "translateBoxFeedback"
-->         "scaleBoxFeedbackSwitch"
-->            "scaleBoxFeedback"
-->         "posXWallFeedbackSwitch"
-->            "posXWallFeedback"
-->            "posXRoundWallFeedback"
-->         "posYWallFeedbackSwitch"
-->            "posYWallFeedback"
-->            "posYRoundWallFeedback"
-->         "posZWallFeedbackSwitch"
-->            "posZWallFeedback"
-->            "posZRoundWallFeedback"
-->         "negXWallFeedbackSwitch"
-->            "negXWallFeedback"
-->            "negXRoundWallFeedback"
-->         "negYWallFeedbackSwitch"
-->            "negYWallFeedback"
-->            "negYRoundWallFeedback"
-->         "negZWallFeedbackSwitch"
-->            "negZWallFeedback"
-->            "negZRoundWallFeedback"
-->         "radialFeedbackSwitch"
-->            "radialFeedback"
-->      "translatorSep"
-->         "translator1Switch"
-->            "translator1LocateGroup"
-->               "translator1"
-->            "translator1Active"
-->         "translator2Switch"
-->            "translator2LocateGroup"
-->               "translator2"
-->            "translator2Active"
-->         "translator3Switch"
-->            "translator3LocateGroup"
-->               "translator3"
-->            "translator3Active"
-->         "translator4Switch"
-->            "translator4LocateGroup"
-->               "translator4"
-->            "translator4Active"
-->         "translator5Switch"
-->            "translator5LocateGroup"
-->               "translator5"
-->            "translator5Active"
-->         "translator6Switch"
-->            "translator6LocateGroup"
-->               "translator6"
-->            "translator6Active"
-->      "rotatorSep"
-->         "rotator1Switch"
-->            "rotator1LocateGroup"
-->               "rotator1"
-->            "rotator1Active"
-->         "rotator2Switch"
-->            "rotator2LocateGroup"
-->               "rotator2"
-->            "rotator2Active"
-->         "rotator3Switch"
-->            "rotator3LocateGroup"
-->               "rotator3"
-->            "rotator3Active"
-->         "rotator4Switch"
-->            "rotator4LocateGroup"
-->               "rotator4"
-->            "rotator4Active"
-->         "rotator5Switch"
-->            "rotator5LocateGroup"
-->               "rotator5"
-->            "rotator5Active"
-->         "rotator6Switch"
-->            "rotator6LocateGroup"
-->               "rotator6"
-->            "rotator6Active"
-->      "scaleSep"
-->         "scale1Switch"
-->            "scale1LocateGroup"
-->               "scale1"
-->            "scale1Active"
-->         "scale2Switch"
-->            "scale2LocateGroup"
-->               "scale2"
-->            "scale2Active"
-->         "scale3Switch"
-->            "scale3LocateGroup"
-->               "scale3"
-->            "scale3Active"
-->         "scale4Switch"
-->            "scale4LocateGroup"
-->               "scale4"
-->            "scale4Active"
-->         "scale5Switch"
-->            "scale5LocateGroup"
-->               "scale5"
-->            "scale5Active"
-->         "scale6Switch"
-->            "scale6LocateGroup"
-->               "scale6"
-->            "scale6Active"
-->         "scale7Switch"
-->            "scale7LocateGroup"
-->               "scale7"
-->            "scale7Active"
-->         "scale8Switch"
-->            "scale8LocateGroup"
-->               "scale8"
-->            "scale8Active"
-->      "circleFeedbackSep"
-->         "circleFeedbackTransformSwitch"
-->            "circleFeedbackAntiSquish"
-->            "circleFeedbackTransform"
-->         "xCircleFeedbackSwitch"
-->            "xCircleFeedback"
-->         "yCircleFeedbackSwitch"
-->            "yCircleFeedback"
-->         "zCircleFeedbackSwitch"
-->            "zCircleFeedback"

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

so like, vibe check on that tree real quick 👀 — you've got "callbackList", then "topSeparator" holding "motionMatrix", "surroundScale" and "overallStyle", and then the big "geomSeparator" branch where all the actual interaction bits live: the axis feedback trio (xAxisFeedbackSwitch, yAxisFeedbackSwitch, zAxisFeedbackSwitch) with their active/select/crosshair kids, the translate box and scale box feedback, a whole wall situation (posXWallFeedbackSwitch / posYWallFeedbackSwitch / posZWallFeedbackSwitch / negXWallFeedbackSwitch / negYWallFeedbackSwitch / negZWallFeedbackSwitch, each with a plain and a Round wall feedback), the radialFeedbackSwitch, and then six translators 🫶, six rotators, eight scales ✨ (yes EIGHT, she's thorough), and a circleFeedbackSep wrapping the transform switch plus the x, y and z circle feedbacks.

every single one of those switch/locate-group/active trios is its own lil unit — translator1Switch → translator1LocateGroup → translator1 + translator1Active, etc. iconic structural consistency honestly 💅

Detailed information on catalog parts:

and now for the part that's gonna make your eyes go 🫠 but stay with me bestie, because this is the whole parts list — every single little piece this dragger builds inside itself. Think of it as the dragger's closet tour. Every hanger is labeled, nothing is missing, and yes there are a lot of hangers. 💅

Quick legend before you scroll: PVT marks each part, then comes the part name in quotes, then the class it's an instance of, and --- just means "and everything under here is nested inside it." A SoSwitch means it's a toggly on/off kind of part, SoSeparator is just a group, and the brackets on one of them list what it's allowed to hold.

CLASS SoTransformerDragger
PVT   "this",  SoTransformerDragger  ---
      "callbackList",  SoNodeKitListPart [ SoCallback, SoEventCallback ]
PVT   "topSeparator",  SoSeparator  ---
PVT   "motionMatrix",  SoMatrixTransform  ---
      "surroundScale",  SoSurroundScale  ---
PVT   "overallStyle",  SoGroup  ---
PVT   "geomSeparator",  SoSeparator  ---
PVT   "translatorSep",  SoSeparator  ---
PVT   "translator1Switch",  SoSwitch  ---
PVT   "translator1LocateGroup",  SoLocateHighlight  ---
      "translator1",  SoSeparator  ---
      "translator1Active",  SoSeparator  ---
PVT   "translator2Switch",  SoSwitch  ---
PVT   "translator2LocateGroup",  SoLocateHighlight  ---
      "translator2",  SoSeparator  ---
      "translator2Active",  SoSeparator  ---
PVT   "translator3Switch",  SoSwitch  ---
PVT   "translator3LocateGroup",  SoLocateHighlight  ---
      "translator3",  SoSeparator  ---
      "translator3Active",  SoSeparator  ---
PVT   "translator4Switch",  SoSwitch  ---
PVT   "translator4LocateGroup",  SoLocateHighlight  ---
      "translator4",  SoSeparator  ---
      "translator4Active",  SoSeparator  ---
PVT   "translator5Switch",  SoSwitch  ---
PVT   "translator5LocateGroup",  SoLocateHighlight  ---
      "translator5",  SoSeparator  ---
      "translator5Active",  SoSeparator  ---
PVT   "translator6Switch",  SoSwitch  ---
PVT   "translator6LocateGroup",  SoLocateHighlight  ---
      "translator6",  SoSeparator  ---
      "translator6Active",  SoSeparator  ---
PVT   "rotatorSep",  SoSeparator  ---
PVT   "rotator1Switch",  SoSwitch  ---
PVT   "rotator1LocateGroup",  SoLocateHighlight  ---
      "rotator1",  SoSeparator  ---
      "rotator1Active",  SoSeparator  ---
PVT   "rotator2Switch",  SoSwitch  ---
PVT   "rotator2LocateGroup",  SoLocateHighlight  ---
      "rotator2",  SoSeparator  ---
      "rotator2Active",  SoSeparator  ---
PVT   "rotator3Switch",  SoSwitch  ---
PVT   "rotator3LocateGroup",  SoLocateHighlight  ---
      "rotator3",  SoSeparator  ---
      "rotator3Active",  SoSeparator  ---
PVT   "rotator4Switch",  SoSwitch  ---
PVT   "rotator4LocateGroup",  SoLocateHighlight  ---
      "rotator4",  SoSeparator  ---
      "rotator4Active",  SoSeparator  ---
PVT   "rotator5Switch",  SoSwitch  ---
PVT   "rotator5LocateGroup",  SoLocateHighlight  ---
      "rotator5",  SoSeparator  ---
      "rotator5Active",  SoSeparator  ---
PVT   "rotator6Switch",  SoSwitch  ---
PVT   "rotator6LocateGroup",  SoLocateHighlight  ---
      "rotator6",  SoSeparator  ---
      "rotator6Active",  SoSeparator  ---
PVT   "scaleSep",  SoSeparator  ---
PVT   "scale1Switch",  SoSwitch  ---
PVT   "scale1LocateGroup",  SoLocateHighlight  ---
      "scale1",  SoSeparator  ---
      "scale1Active",  SoSeparator  ---
PVT   "scale2Switch",  SoSwitch  ---
PVT   "scale2LocateGroup",  SoLocateHighlight  ---
      "scale2",  SoSeparator  ---
      "scale2Active",  SoSeparator  ---
PVT   "scale3Switch",  SoSwitch  ---
PVT   "scale3LocateGroup",  SoLocateHighlight  ---
      "scale3",  SoSeparator  ---
      "scale3Active",  SoSeparator  ---
PVT   "scale4Switch",  SoSwitch  ---
PVT   "scale4LocateGroup",  SoLocateHighlight  ---
      "scale4",  SoSeparator  ---
      "scale4Active",  SoSeparator  ---
PVT   "scale5Switch",  SoSwitch  ---
PVT   "scale5LocateGroup",  SoLocateHighlight  ---
      "scale5",  SoSeparator  ---
      "scale5Active",  SoSeparator  ---
PVT   "scale6Switch",  SoSwitch  ---
PVT   "scale6LocateGroup",  SoLocateHighlight  ---
      "scale6",  SoSeparator  ---
      "scale6Active",  SoSeparator  ---
PVT   "scale7Switch",  SoSwitch  ---
PVT   "scale7LocateGroup",  SoLocateHighlight  ---
      "scale7",  SoSeparator  ---
      "scale7Active",  SoSeparator  ---
PVT   "scale8Switch",  SoSwitch  ---
PVT   "scale8LocateGroup",  SoLocateHighlight  ---
      "scale8",  SoSeparator  ---
      "scale8Active",  SoSeparator  ---
PVT   "circleFeedbackSep",  SoSeparator  ---
PVT   "circleFeedbackTransformSwitch",  SoSwitch  ---
PVT   "circleFeedbackAntiSquish",  SoAntiSquish  ---
PVT   "circleFeedbackTransform",  SoTransform  ---
PVT   "xCircleFeedbackSwitch",  SoSwitch  ---
      "xCircleFeedback",  SoSeparator  ---
PVT   "yCircleFeedbackSwitch",  SoSwitch  ---
      "yCircleFeedback",  SoSeparator  ---
PVT   "zCircleFeedbackSwitch",  SoSwitch  ---
      "zCircleFeedback",  SoSeparator  ---
PVT   "axisFeedbackSep",  SoSeparator  ---
PVT   "axisFeedbackLocation",  SoTranslation  ---
PVT   "xAxisFeedbackSwitch",  SoSwitch  ---
      "xAxisFeedbackActive",  SoSeparator  ---
      "xAxisFeedbackSelect",  SoSeparator  ---
      "xCrosshairFeedback",  SoSeparator  ---
PVT   "yAxisFeedbackSwitch",  SoSwitch  ---
      "yAxisFeedbackActive",  SoSeparator  ---
      "yAxisFeedbackSelect",  SoSeparator  ---
      "yCrosshairFeedback",  SoSeparator  ---
PVT   "zAxisFeedbackSwitch",  SoSwitch  ---
      "zAxisFeedbackActive",  SoSeparator  ---
      "zAxisFeedbackSelect",  SoSeparator  ---
      "zCrosshairFeedback",  SoSeparator  ---
PVT   "translateBoxFeedbackSep",  SoSeparator  ---
PVT   "translateBoxFeedbackSwitch",  SoSwitch  ---
PVT   "translateBoxFeedbackRotation",  SoRotation  ---
      "translateBoxFeedback",  SoSeparator  ---
PVT   "scaleBoxFeedbackSwitch",  SoSwitch  ---
      "scaleBoxFeedback",  SoSeparator  ---
PVT   "posXWallFeedbackSwitch",  SoSwitch  ---
      "posXWallFeedback",  SoSeparator  ---
      "posXRoundWallFeedback",  SoSeparator  ---
PVT   "posYWallFeedbackSwitch",  SoSwitch  ---
      "posYWallFeedback",  SoSeparator  ---
      "posYRoundWallFeedback",  SoSeparator  ---
PVT   "posZWallFeedbackSwitch",  SoSwitch  ---
      "posZWallFeedback",  SoSeparator  ---
      "posZRoundWallFeedback",  SoSeparator  ---
PVT   "negXWallFeedbackSwitch",  SoSwitch  ---
      "negXWallFeedback",  SoSeparator  ---
      "negXRoundWallFeedback",  SoSeparator  ---
PVT   "negYWallFeedbackSwitch",  SoSwitch  ---
      "negYWallFeedback",  SoSeparator  ---
      "negYRoundWallFeedback",  SoSeparator  ---
PVT   "negZWallFeedbackSwitch",  SoSwitch  ---
      "negZWallFeedback",  SoSeparator  ---
      "negZRoundWallFeedback",  SoSeparator  ---
PVT   "radialFeedbackSwitch",  SoSwitch  ---
      "radialFeedback",  SoSeparator  ---

okay let's debrief on that absolute wall of text 📋 because it's actually organized and honestly? kind of iconic.

  • The top bit is the dragger's own scaffolding: this, then callbackList (a SoNodeKitListPart that takes SoCallback and SoEventCallback — those brackets are literally its guest list), then topSeparator, motionMatrix, surroundScale, overallStyle and geomSeparator. That's the skeleton, no cap.
  • Then six translator slots: translator1 through translator6, each one wrapped in its own SoSwitch and SoLocateHighlight, and each with a plain part and an Active twin. The Active ones are the glow-up versions that show up when you're actually using them. ✨
  • Then six rotator slots: rotator1 … rotator6. Same exact structure — Switch, LocateHighlight, plain, Active. Consistency is the vibe. 🎀
  • Then eight scale slots: scale1 … scale8. Yeah, eight, because scaling gets the most handles. She's greedy but she's thriving. 👑
  • Then the circle feedback crew: circleFeedbackSep, circleFeedbackTransformSwitch, circleFeedbackAntiSquish, circleFeedbackTransform, plus one switch-and-separator pair for each of x, y, z (xCircleFeedbackSwitch/xCircleFeedback, yCircleFeedbackSwitch/yCircleFeedback, zCircleFeedbackSwitch/zCircleFeedback). 🌀
  • Then the axis feedback crew: axisFeedbackSep, axisFeedbackLocation, and then xAxisFeedbackSwitch, yAxisFeedbackSwitch, zAxisFeedbackSwitch, each holding an Active, a Select, and a CrosshairFeedback separator (xCrosshairFeedback, yCrosshairFeedback, zCrosshairFeedback). That's the ✚ you see lining up with the axes, bestie.
  • Then the boxes: translateBoxFeedbackSep, translateBoxFeedbackSwitch, translateBoxFeedbackRotation, translateBoxFeedback, then scaleBoxFeedbackSwitch and scaleBoxFeedback. 📦
  • Then the wall feedback, and omg there are six of them: posX, posY, posZ, negX, negY, negZ, each with a ...WallFeedbackSwitch, a ...WallFeedback and a ...RoundWallFeedback (posXWallFeedbackSwitch, posXWallFeedback, posXRoundWallFeedback, posYWallFeedbackSwitch, posYWallFeedback, posYRoundWallFeedback, posZWallFeedbackSwitch, posZWallFeedback, posZRoundWallFeedback, negXWallFeedbackSwitch, negXWallFeedback, negXRoundWallFeedback, negYWallFeedbackSwitch, negYWallFeedback, negYRoundWallFeedback, negZWallFeedbackSwitch, negZWallFeedback, negZRoundWallFeedback).
  • And finally the radial feedback: radialFeedbackSwitch holding radialFeedback. The last little sparkle at the end. 🌈
fr fr, if you want the actual formatting rules for this kind of dump, the page says to go look at SoBaseKit::printTable().

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

Protected destructor, babe. 🫶 She's not for you to call directly.

(Dragger classes are derived from SoBase, so they are reference counted and automatically destroyed when their reference count goes to 0. Translation: she keeps track of how many people are holding her, and the second nobody is, she dips. main character exit, honestly. 💅)

💖 Member Function Documentation 💖

Okay bestie, function lore drop time. Every method, every flag, every “internal, don’t worry about it” — all here. No skips. ✨

SoType SoTransformerDragger::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. Fr fr.

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 * SoTransformerDragger::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 * SoTransformerDragger::getNodekitCatalog (void ) const [virtual]

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

Reimplemented from SoDragger.

SoTransformerDragger::State SoTransformerDragger::getCurrentState (void )

Returns an indicator for the current operation executed on the dragger by the end-user — or SoTransformerDragger::INACTIVE if none. Iconic little state check.

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

Sets up all internal connections for instances of this class.

(This method will usually not be of interest to the application programmer, unless you want to extend the library with new custom nodekits or dragger classes. If so, see the SoBaseKit class documentation.)

Reimplemented from SoInteractionKit.

void SoTransformerDragger::setDefaultOnNonWritingFields (void ) [protected], [virtual]

(Be aware that this method is unlikely to be of interest to the application programmer who does not want to extend the library with new custom nodekits or draggers. If you indeed are writing extensions, see the information in the SoBaseKit class documentation.)

This is a virtual method, and the code in it should call SoField::setDefault() with argument TRUE on part fields that should not be written upon scenegraph export operations.

This is typically done when:

  1. field value is NULL and part is NULL by default
  2. it is a leaf SoGroup or SoSeparator node with no children
  3. it is a leaf listpart with no children and an SoGroup or SoSeparator container
  4. it is a non-leaf part and it’s of SoGroup type and all fields are at their default values

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

Reimplemented from SoDragger.

void SoTransformerDragger::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. Bestie, it’s giving “library business.”

void SoTransformerDragger::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 SoTransformerDragger::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 SoTransformerDragger::metaKeyChangeCB (void * , 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 SoTransformerDragger::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 SoTransformerDragger::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 SoTransformerDragger::dragStart (void ) [protected]

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

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

void SoTransformerDragger::drag (void ) [protected]

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

Called when user drags the mouse after picking the dragger.

void SoTransformerDragger::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.

int SoTransformerDragger::getMouseGestureDirection (SbBool x_ok, SbBool y_ok, SbBool z_ok) [protected]

Not implemented in Coin; should probably not have been public in the Open Inventor API. We’ll consider to implement it if requested. No cap, it’s just sitting there.

int SoTransformerDragger::getIgnoreAxis (SbVec2f axis[3][2], SbBool x_ok, SbBool y_ok, SbBool z_ok) [static], [protected]

Not implemented in Coin; should probably not have been public in the Open Inventor API. We’ll consider to implement it if requested.

void SoTransformerDragger::makeMinorAxisPerpendicularIfColinear (SbVec2f origin, SbVec2f axisends[3][2], int index_a, int index_b) [static], [protected]

Not implemented in Coin; should probably not have been public in the Open Inventor API. We’ll consider to implement it if requested.

SbBool SoTransformerDragger::isColinear (SbVec2f a1[2], SbVec2f a2[2], int pixels) [static], [protected]

Not implemented in Coin; should probably not have been public in the Open Inventor API. We’ll consider to implement it if requested.

🎀 Member Data Documentation 🎀

SoSFRotation SoTransformerDragger::rotation

This field is continuously updated to contain the orientation of the dragger.

SoSFVec3f SoTransformerDragger::translation

The dragger’s offset position from the local origo.

SoSFVec3f SoTransformerDragger::scaleFactor

Continuously updated to contain the current vector of scaling along the X, Y and Z axes.

SoFieldSensor* SoTransformerDragger::translFieldSensor [protected]

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

SoFieldSensor* SoTransformerDragger::scaleFieldSensor [protected]

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

SoFieldSensor* SoTransformerDragger::rotateFieldSensor [protected]

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

SoNodeList SoTransformerDragger::antiSquishList [protected]

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

👑 Author 👑

Generated automatically by Doxygen for Coin from the source code.

And that’s the whole page, bestie! 💖 Shoutout to the footer’s source/version and date energy: Coin, Version 3.1.3, SoTransformerDragger(3) — the stamp is stamped, the lore is complete. 🦋✨

📦 where this page comes from