SoJackDragger(3)

📦 version 3.1.3, in fedora 43, fedora 44

💖 SoJackDragger(3) 💖 — Library Functions Manual

okay bestie, sit down, hydrate, because this is the SoJackDragger page and she is long. it's a whole library function manual situation and honestly? she ate. 🍓

✨ NAME ✨

SoJackDragger — the class that is a dragger you can translate, rotate and scale. all three. at once. main character energy fr fr 👑

🎀 SYNOPSIS 🎀

#include <Inventor/draggers/SoJackDragger.h>

Inherits SoDragger.

so like, everything SoDragger can do? SoJackDragger can do. and SoDragger is generous, okay, she handed down a LOT. buckle up. 🦋

👑 Public Member Functions

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

💅 Public Member Functions inherited from SoDragger

the whole inheritance haul, no cap, every single one:

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
and yes, that's genuinely all of them. she didn't skip a single one. obsessed. 😭

🌈 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 having an instance. iconic behaviour honestly:

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

💖 Static Public Member Functions inherited from SoDragger

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

🌸 Static Public Member Functions inherited from SoInteractionKit

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

✨ Static Public Member Functions inherited from SoBaseKit

static SoType getClassTypeId (void)
static void initClass (void)
static const SoNodekitCatalog * getClassNodekitCatalog (void)
static SbBool isSearchingChildren (void)
static void setSearchingChildren (const SbBool newval)

🦋 Static Public Member Functions inherited from SoNode

the finale of the statics, and there are so many, we love her for it:

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)

and that's the synopsis, bestie. the whole haul of what you inherit the second you touch a SoJackDragger. take a breath. part 2 is coming and she has more to say. 💅

🌸 Static Public Member Functions inherited from SoFieldContainer 🌸

okay so these aren't even ours, bestie — they're inherited, but they're part of the whole package so we're listing every single one, no skips, no shortcuts:

  • static void initClass (void)
  • static SoType getClassTypeId (void)
  • static void cleanupClass (void)
  • static void initCopyDict (void)
  • static void addCopy (const SoFieldContainer *orig, const SoFieldContainer *copy)
  • static SoFieldContainer * checkCopy (const SoFieldContainer *orig)
  • static SoFieldContainer * findCopy (const SoFieldContainer *orig, SbBool copyconnections)
  • static void copyDone (void)

💫 Static Public Member Functions inherited from SoBase 💫

more hand-me-downs, this time from SoBase. iconic lineage honestly:

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

🎀 Public Attributes 🎀

the three fields that are, like, literally the dragger — translation, rotation, scale. the whole personality:

  • SoSFRotation rotation
  • SoSFVec3f translation
  • SoSFVec3f scaleFactor

🌟 Public Attributes inherited from SoDragger 🌟

  • SoSFBool isActive

🌟 Public Attributes inherited from SoInteractionKit 🌟

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

💅 Protected Member Functions 💅

these are the protected ones, iykyk — you only get them if you're subclassing. no gatekeeping, here's the full list:

  • virtual const SoFieldData * getFieldData (void) const
  • virtual ~SoJackDragger (void)
  • virtual SbBool setUpConnections (SbBool onoff, SbBool doitalways=FALSE)
  • virtual void setDefaultOnNonWritingFields (void)

🦋 Protected Member Functions inherited from SoDragger 🦋

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

🦋 Protected Member Functions inherited from SoInteractionKit 🦋

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

🧚 Protected Member Functions inherited from SoBaseKit 🧚

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

💜 Protected Member Functions inherited from SoNode 💜

  • SoNode (void)
  • virtual ~SoNode ()

💜 Protected Member Functions inherited from SoFieldContainer 💜

  • SoFieldContainer (void)
  • virtual ~SoFieldContainer ()

💜 Protected Member Functions inherited from SoBase 💜

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

✨ Static Protected Member Functions ✨

the static protected crew. all of them. every last one:

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

🌈 Static Protected Member Functions inherited from SoDragger 🌈

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

🌈 Static Protected Member Functions inherited from SoInteractionKit 🌈

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

🌈 Static Protected Member Functions inherited from SoBaseKit 🌈

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

🌈 Static Protected Member Functions inherited from SoNode 🌈

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

🌈 Static Protected Member Functions inherited from SoBase 🌈

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

🍓 Protected Attributes 🍓

the protected attributes — the dragger's inner circle. yes, antiSquish is a real field name and honestly? obsessed:

  • SoSFNode antiSquish
  • SoSFNode rotator
  • SoSFNode scaler
  • SoSFNode surroundScale
  • SoSFNode translator
  • SoFieldSensor * rotFieldSensor
  • SoFieldSensor * translFieldSensor
  • SoFieldSensor * scaleFieldSensor

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

the bonus round. these got inherited too and they deserve their moment:

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

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

okay bestie, deep breath, here's the actual lore.

The SoJackDragger class is a dragger you can translate, rotate and scale. yes, all three. one dragger. multi-talented. main character energy fr.

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

Translation is done with this dragger by picking the flat transparent box ("x-z" translation) or the solid middle part of the axis ("y"-axis translation). Press a SHIFT-key while translating in x-z to constrain to one of the principal axes. very demure, very mindful of your axes.

Uniform scale operations can be done by dragging any of the 6 cubes. Non-uniform scale operations can not be done with this dragger. so if you were hoping to squish it all lopsided — nope, not a thing here. it's uniform or nothing.

Rotations are invoked by clicking and dragging the line parts of the 3 principal "axes" of the dragger geometry.

NB: How to rotate the dragger might be abit unintuitive for the end user. If the dragger is to be used 'out of the box', a good documentation should be added to your application. An alternative is to modify the geometry to increase the affordance of the dragger. See the SoDragger documentation on how to change the geometry of a dragger.
real talk: that rotation thing is genuinely not obvious to people, so pls pls pls write docs for your app if you're shipping this as-is. you've been warned 🫶

An "action shot" of the SoJackDragger used within an SoClipPlaneManip:

The name "Jack dragger" probably stems from this dragger being implemented by SGI for interacting with a "jack-in-the-box" type model way back in the Inventor history. jack-in-the-box!! that's the whole vibe, that's the name origin, we love a historical fun fact 🎁

For programmer convenience, this dragger comes fully wrapped within instances of the SoJackManip class. The SoClipPlaneManip manipulator also uses this dragger, for controlling an SoClipPlane node.

✨ Constructor & Destructor Documentation ✨

SoJackDragger::SoJackDragger (void )

Bestie, this is the default constructor. It sets up the dragger's nodekit catalog with all the interaction and feedback geometry. 💖

Node kit structure (new entries vs the parent class are marked with an arrow prefix):

       CLASS SoJackDragger
       -->"this"
             "callbackList"
             "topSeparator"
                "motionMatrix"
       -->      "surroundScale"
       -->      "antiSquish"
       -->      "scaler"
       -->      "rotator"
       -->      "translator"
                "geomSeparator"

(Peep SoBaseKit::printDiagram() if you wanna know how that output formatting works.)

Detailed info on the catalog parts:

       CLASS SoJackDragger
       PVT   "this",  SoJackDragger  ---
             "callbackList",  SoNodeKitListPart [ SoCallback, SoEventCallback ]
       PVT   "topSeparator",  SoSeparator  ---
       PVT   "motionMatrix",  SoMatrixTransform  ---
             "surroundScale",  SoSurroundScale  ---
             "antiSquish",  SoAntiSquish  ---
             "scaler",  SoScaleUniformDragger  ---
             "rotator",  SoRotateSphericalDragger  ---
             "translator",  SoDragPointDragger  ---
       PVT   "geomSeparator",  SoSeparator  ---

(And SoBaseKit::printTable() explains the output formatting for that one.)

SoJackDragger::~SoJackDragger (void ) [protected], [virtual]

Protected destructor.

(Dragger classes are derived from SoBase, so they're reference counted and get auto-destroyed when their reference count hits 0. No cap.)

✨ Member Function Documentation ✨

SoType SoJackDragger::getTypeId (void ) const [virtual]

Returns the type ID of an object that's derived from a class inheriting SoBase. This is what handles run-time type checking and "downward" casting. ✨

Usage example:

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

For app devs who wanna extend the library with new nodes, engines, nodekits, draggers or whatever: this method has to be overridden in all subclasses. That's usually part of setting up the full type system for extension classes, and it's typically done using the pre-defined macros you can get 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.

Want more tea on writing Coin extensions? Check the class docs for the toplevel superclasses of the various class groups. 💅

Reimplemented from SoDragger.

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

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

Reimplemented from SoDragger.

const SoNodekitCatalog * SoJackDragger::getNodekitCatalog (void ) const [virtual]

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

Reimplemented from SoDragger.

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

Sets up all the internal connections for instances of this class.

(This method usually won't matter to app programmers unless you're extending the library with new custom nodekits or dragger classes. If that's you, go read the SoBaseKit class docs.)

Reimplemented from SoInteractionKit.

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

(Heads up: this method probably isn't interesting to app programmers who aren't extending the library with new custom nodekits or draggers. If you are writing extensions, peep the SoBaseKit class docs.)

It's a virtual method, and the code inside should call SoField::setDefault() with argument TRUE on part fields that shouldn't be written during scenegraph export operations.

This is typically done when:

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

Subclasses should usually override this to add extra settings for new member fields. And from the subclass, don't forget to call "upwards" to your superclass' setDefaultOnNonWritingFields() method. 🫶

Reimplemented from SoDragger.

void SoJackDragger::invalidateSurroundScaleCB (void * f, SoDragger * d) [static], [protected]

Used to invalidate the surroundScale and antiSquish parts when a child dragger starts or finishes dragging.

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

This API member is internal to the library — not likely to be of interest to the app programmer. 🙈

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

This API member is internal to the library — not likely to be of interest to the app programmer. 🙈

✨ Member Data Documentation ✨

SoSFRotation SoJackDragger::rotation

This field is continuously updated to hold the rotation of the dragger's current direction vector. 💫

SoSFVec3f SoJackDragger::translation

Continuously updated to hold the current translation from the dragger's local origo position.

If you're the app dev using this dragger in your code, connect the relevant node fields in the scene to this field so it follows the dragger. 🫶

SoSFVec3f SoJackDragger::scaleFactor

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

Only uniform scaling can be done with SoJackDragger, so those 3 vector components will always be equal. No cap.

SoFieldSensor* SoJackDragger::rotFieldSensor [protected]

This API member is internal to the library — not likely to be of interest to the app programmer. 🙈

SoFieldSensor* SoJackDragger::translFieldSensor [protected]

This API member is internal to the library — not likely to be of interest to the app programmer. 🙈

SoFieldSensor* SoJackDragger::scaleFieldSensor [protected]

This API member is internal to the library — not likely to be of interest to the app programmer. 🙈

✨ Author ✨

Auto-generated by Doxygen for Coin from the source code. 🤖

💖 That's the whole vibe! This page is from Coin, version 3.1.3, and it's all about SoJackDragger(3). Stay iconic, bestie! 💅

📦 where this page comes from