SoScale2UniformDragger(3)

📦 version 2.5.0, in fedora 43, fedora 44

💅 SoScale2UniformDragger(3) 💅

okay bestie, gather round, we're reading a Library Functions Manual page and honestly? she ate. this is SoScale2UniformDragger, straight out of the Co— you know what, just trust me, it's from that 3D toolkit everyone's obsessed with. 🦋

✨ NAME ✨

SoScale2UniformDragger — a whole class whose entire personality is giving the end-user a mechanism to scale in two dimensions. two. not three. don't be greedy. 💅

✨ SYNOPSIS ✨

#include <Inventor/draggers/SoScale2UniformDragger.h>

Inherits SoDragger. yes bestie she has a whole family tree, and we're about to meet every single relative. buckle up. 🎀

🌸 Public Member Functions 🌸

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

like, that's it for her own methods. she's lowkey chill. the rest? inherited. and there's a LOT of it. 😭

💖 Public Member Functions inherited from SoDragger 💖

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

not me counting these like it's a receipt 😭 but okay, this is where all the dragging actually happens. callbacks, matrices, starting points, the whole vibe. 🫶

💫 Public Member Functions inherited from SoInteractionKit 💫

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

surrogates and parts, oh my. if you know you know. iykyk. 🧚

🌈 Public Member Functions inherited from SoBaseKit 🌈

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

printDiagram and printTable?? the way this kit can literally draw you a diagram of itself. main character energy fr fr. 👑

🦋 Public Member Functions inherited from SoNode 🦋

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

audioRender?? yes bestie, nodes can render sound. we love a multi-talented icon. 🎀

⭐ Public Member Functions inherited from SoFieldContainer ⭐

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

all the field plumbing. not the glamorous part but someone has to do it and she does it flawlessly. 💅

🌸 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

ref / unref bestie... the reference counting. the source of every "why is my object still alive" crisis. we've all been there. 😭

✨ Static Public Member Functions ✨

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

💜 Static Public Member Functions inherited from SoDragger 💜

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

two overloads of getTransformFast and she didn't even break a sweat. obsessed. ✨

🧚 Static Public Member Functions inherited from SoInteractionKit 🧚

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

🎀 Static Public Member Functions inherited from SoBaseKit 🎀

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

🔥 Static Public Member Functions inherited from SoNode 🔥

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

all the ...S static action helpers, lined up like a little squad. periodt. 💅

bestie we are so not done yet — this is only part 1, and the rest of the page is still coming, so don't go anywhere. 🌸✨

Static Public Member Functions inherited from SoFieldContainer 🌸

Your girl SoScale2UniformDragger didn't come into this world alone — she's got a whole family tree, and these are the static functions she inherited from SoFieldContainer:

  • static void initClass (void) — sets up the class, standard-issue.
  • static SoType getClassTypeId (void) — hands you back the class's type id, no cap.
  • static void initCopyDict (void) — spins up the copy dictionary.
  • static void addCopy (const SoFieldContainer *orig, const SoFieldContainer *copy) — files a copy in the dictionary, orig ➡️ copy.
  • static SoFieldContainer * checkCopy (const SoFieldContainer *orig) — peeks in the dictionary for orig and tells you what's there.
  • static SoFieldContainer * findCopy (const SoFieldContainer *orig, const SbBool copyconnections) — the full lookup, with copyconnections deciding if the connections come along for the ride.
  • static void copyDone (void) — closes out the copy dictionary. we're done here 💅

Static Public Member Functions inherited from SoBase 🎀

From the great-grandmama SoBase:

  • static void initClass (void) — classic initClass behaviour.
  • static SoType getClassTypeId (void) — type id, as always.
  • static void addName (SoBase *const base, const char *const name) — gives base a name.
  • static void removeName (SoBase *const base, const char *const name) — takes that name away again. not me removing names 😭
  • static void incrementCurrentWriteCounter (void) — bumps the write counter up.
  • static void decrementCurrentWriteCounter (void) — bumps it back down.
  • static SoBase * getNamedBase (const SbName &name, SoType type) — finds the base going by name with the matching type.
  • static int getNamedBases (const SbName &name, SoBaseList &baselist, SoType type) — same energy but plural, stuffing everything into baselist.
  • static SbBool read (SoInput *in, SoBase *&base, SoType expectedtype) — reads a base in from in, expecting expectedtype.
  • static void setInstancePrefix (const SbString &c) — sets the instance prefix string.
  • static void setTraceRefs (SbBool trace) — turns reference tracing on or off.
  • static SbBool getTraceRefs (void) — tells you whether reference tracing is on.
  • static SbBool connectRoute (SoInput *in, const SbName &fromnodename, const SbName &fromfieldname, const SbName &tonodename, const SbName &tofieldname) — wires up a route from one node's field to another's. the way that it connects the from-nodes to the to-nodes, iconic.
  • static SbBool readRoute (SoInput *in) — reads a route in from the input.

Public Attributes ✨

  • SoSFVec3f scaleFactor — this is the whole main character of the show right here. it's an SoSFVec3f, and remember: the X and Y parts stay equal, always. 👑

Public Attributes inherited from SoDragger 🦋

  • SoSFBool isActive — whether the dragger is currently active, yes or no.

Public Attributes inherited from SoInteractionKit 🌈

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

Protected Member Functions 💖

  • virtual const SoFieldData * getFieldData (void) const — returns the field data.
  • ~SoScale2UniformDragger () — the destructor, protected as always.
  • virtual SbBool setUpConnections (SbBool onoff, SbBool doitalways=0) — hooks up the internal connections, onoff toggling them and doitalways forcing the issue.
  • void dragStart (void) — fires when a drag kicks off.
  • void drag (void) — fires while the drag is dragging.
  • void dragFinish (void) — fires when the drag wraps up. that's a wrap, bestie 🎬

Protected Member Functions inherited from SoDragger 🧚

  • SoDragger (void) — constructor.
  • virtual ~SoDragger () — destructor.
  • SbVec2f getNormalizedLocaterPosition (void) — normalized locater position, served up as an SbVec2f.
  • SbVec2s getLocaterPosition (void) — the raw locater position, SbVec2s style.
  • SbVec2s getStartLocaterPosition (void) const — where the locater was when it all began.
  • void setStartLocaterPosition (SbVec2s p) — sets that start position to p.
  • SbBool isAdequateConstraintMotion (void) — is this motion adequate for the constraint, yes or no.
  • virtual SbBool shouldGrabBasedOnSurrogate (const SoPath *pickpath, const SoPath *surrogatepath) — decides whether to grab based on the surrogate path.
  • void setCameraInfo (SoAction *action) — pulls the camera info out of action.
  • virtual void handleEvent (SoHandleEventAction *ha) — the event handler.
  • void transferMotion (SoDragger *child) — passes motion along to a child dragger.
  • void setIgnoreInBbox (SbBool newval) — sets whether this gets ignored in bounding box calculations.
  • SbBool isIgnoreInBbox (void) — is it ignored in the bbox? inquiring minds want to know.
  • virtual void getBoundingBox (SoGetBoundingBoxAction *action) — computes the bounding box into action.
  • void setActiveChildDragger (SoDragger *newchilddragger) — sets the active child dragger.
  • SoDragger * getActiveChildDragger (void) const — hands back the active child dragger.
  • virtual void setDefaultOnNonWritingFields (void) — sets defaults on the fields that don't get written out.
  • 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 the contents over, connections included if copyConnections says so.
  • virtual SbBool setPart (const int partNum, SoNode *node) — sets a numbered part to node.
  • virtual SbBool readInstance (SoInput *in, unsigned short flags) — reads the instance in.
  • virtual SbBool setAnyPartAsDefault (const SbName &partname, SoNode *node, SbBool anypart=1, SbBool onlyifdefault=1) — sets a part as default using a node.
  • virtual SbBool setAnyPartAsDefault (const SbName &partname, const SbName &nodename, SbBool anypart=1, SbBool onlyifdefault=1) — same thing but you name the node instead.
  • SbBool setAnySurrogatePath (const SbName &name, SoPath *path, SbBool leafcheck=0, SbBool publiccheck=0) — sets the surrogate path, with optional leaf and public checks.
  • void connectSeparatorFields (SoSeparator *dest, SbBool onOff) — connects the separator fields on dest.

Protected Member Functions inherited from SoBaseKit 🍓

  • virtual ~SoBaseKit () — destructor.
  • virtual SoNode * addToCopyDict (void) const — adds this into the copy dictionary.
  • SoGroup * getContainerNode (const SbName &listname, SbBool makeifneeded=1) — grabs the container node for listname, making it if needed.
  • virtual SoNode * getAnyPart (const SbName &partname, SbBool makeifneeded, SbBool leafcheck=0, SbBool publiccheck=0) — fetches any part by name.
  • virtual SoNodeKitPath * createPathToAnyPart (const SbName &partname, SbBool makeifneeded, SbBool leafcheck=0, SbBool publiccheck=0, const SoPath *pathtoextend=NULL) — builds a nodekit path all the way to a part, optionally extending an existing path.
  • virtual SbBool setAnyPart (const SbName &partname, SoNode *from, SbBool anypart=1) — sets any part to from.
  • void createNodekitPartsList (void) — makes the nodekit parts list.
  • void createFieldList (void) — makes the field list.
  • virtual void createDefaultParts (void) — makes the default parts.
  • const SoNodekitParts * getNodekitPartsList (void) const — returns that parts list.
  • const SbList< SoSFNode * > & getCatalogInstances (void) const — returns the catalog instances list. yes, that's the exact template type, don't @ me.
  • void catalogError (void) — reports a catalog error.
  • void countMyFields (SoOutput *out) — counts up the fields into out.

Protected Member Functions inherited from SoNode 🌟

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

Protected Member Functions inherited from SoFieldContainer 🫶

  • SoFieldContainer (void) — constructor.
  • ~SoFieldContainer () — destructor.

Protected Member Functions inherited from SoBase 👑

  • SoBase (void) — constructor.
  • virtual ~SoBase () — destructor.
  • virtual void destroy (void) — destroys it.
  • SbBool hasMultipleWriteRefs (void) const — does it have multiple write references?
  • SbBool writeHeader (SoOutput *out, SbBool isgroup, SbBool isengine) const — writes the header out.
  • void writeFooter (SoOutput *out) const — writes the footer out.
  • virtual const char * getFileFormatName (void) const — returns the file format name as a string.

Static Protected Member Functions 🔥

  • static const SoFieldData ** getFieldDataPtr (void) — pointer to the field data, double-pointer and all.
  • static const SoNodekitCatalog ** getClassNodekitCatalogPtr (void) — pointer to the class's nodekit catalog.
  • static void startCB (void *f, SoDragger *d) — the start callback.
  • 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.
  • static void valueChangedCB (void *f, SoDragger *d) — the value-changed callback.

Static Protected Member Functions inherited from SoDragger 💫

  • static const SoFieldData ** getFieldDataPtr (void) — field data pointer.
  • static const SoNodekitCatalog ** getClassNodekitCatalogPtr (void) — nodekit catalog pointer.
  • static void childTransferMotionAndValueChangedCB (void *, SoDragger *) — child callback for transferring motion and value changes.
  • 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.
  • static const SoNodekitCatalog ** getClassNodekitCatalogPtr (void) — nodekit catalog pointer.
  • static void readDefaultParts (const char *fileName, const char defaultBuffer[], int defBufSize) — reads the default parts from a file and a buffer of size defBufSize.
  • static void fieldSensorCB (void *, SoSensor *) — field sensor callback.

Static Protected Member Functions inherited from SoBaseKit 🎀

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

Static Protected Member Functions inherited from SoNode ⭐

  • static const SoFieldData ** getFieldDataPtr (void) — field data pointer.
  • static void setNextActionMethodIndex (int index) — sets the next action method index.
  • static int getNextActionMethodIndex (void) — gets 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 using a nodetype and a 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.

Protected Attributes 🦋

  • SoSFNode feedback — the feedback node.
  • SoSFNode feedbackActive — the active feedback node.
  • SoSFNode feedbackSwitch — the switch that flips the feedback.
  • SoSFNode scaler — the scaler node.
  • SoSFNode scalerActive — the active scaler node.
  • SoSFNode scalerSwitch — the switch that flips the scaler.
  • SoFieldSensor * fieldSensor — the field sensor pointer.
  • SbLineProjector * lineProj — the line projector pointer.

Protected Attributes inherited from SoDragger 🧚

  • SoSFNode motionMatrix — the motion matrix node.

Protected Attributes inherited from SoInteractionKit 💖

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

Protected Attributes inherited from SoBaseKit 🌈

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

Protected Attributes inherited from SoNode 🌟

  • uint32_t uniqueId — the node's unique id.

Protected Attributes inherited from SoFieldContainer 🫶

  • SbBool isBuiltIn — is this thing built in?

Additional Inherited Members 💫

Public Types inherited from SoDragger 👑

  • enum ProjectorFrontSetting { FRONT, BACK, USE_PICK } — pick your projector front setting: FRONT, BACK, or USE_PICK.

Public Types inherited from SoInteractionKit 🎀

  • enum CacheEnabled { OFF, ON, AUTO } — caching can be OFF, ON, or 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 } — the full node-type menu, every hex value intact, no crumbs left behind. 👑

Protected Types inherited from SoBase 💜

  • enum BaseFlags { IS_ENGINE = 0x01, IS_GROUP = 0x02 } — IS_ENGINE is 0x01, IS_GROUP is 0x02. that's it, that's the enum.

Static Protected Attributes inherited from SoNode 🔥

  • static uint32_t nextUniqueId = 0 — starts at 0, obviously.
  • static int nextActionMethodIndex = 0 — also starts at 0.

💅 Detailed Description 💅

The SoScale2UniformDragger class provides a mechanism for the end-user to scale in two dimensions.

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

(that's where the picture of the dragger in its inactive state goes — default geometry, just vibing, not being touched)

Use this dragger to allow the end-user of your application to scale along the X-axis and the Y-axis. (Pro tip from the source, not from me: use a transformation node in front of the dragger to position it and re-orient it so it can scale in any plane. slay.)

Scaling with this dragger can only be done in a uniform manner, ie the X component of the SoScale2UniformDragger::scaleFactor will always equal the Y component. no exceptions, bestie, that's literally the whole point of the "Uniform" in the name. 💖

For non-uniform scaling operations in 2 dimensions, use the SoScale2Dragger instead. (different dragger, different vibe.)

See also 🦋

  • SoScaleUniformDragger

🎀 Constructor & Destructor Documentation 🎀

💖 SoScale2UniformDragger::SoScale2UniformDragger (void ) 💖

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

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

       CLASS SoScale2UniformDragger
       -->"this"
             "callbackList"
             "topSeparator"
                "motionMatrix"
                "geomSeparator"
       -->         "scalerSwitch"
       -->            "scaler"
       -->            "scalerActive"
       -->         "feedbackSwitch"
       -->            "feedback"
       -->            "feedbackActive"

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

Detailed information on catalog parts:

       CLASS SoScale2UniformDragger
       PVT   "this",  SoScale2UniformDragger  ---
             "callbackList",  SoNodeKitListPart [ SoCallback, SoEventCallback ]
       PVT   "topSeparator",  SoSeparator  ---
       PVT   "motionMatrix",  SoMatrixTransform  ---
       PVT   "geomSeparator",  SoSeparator  ---
       PVT   "scalerSwitch",  SoSwitch  ---
             "scaler",  SoSeparator  ---
             "scalerActive",  SoSeparator  ---
       PVT   "feedbackSwitch",  SoSwitch  ---
             "feedback",  SoSeparator  ---
             "feedbackActive",  SoSeparator  ---

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

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

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

💔 SoScale2UniformDragger::~SoScale2UniformDragger () [protected] 💔

Protected destructor. crying in reference-counted 😭

(Dragger classes are derived from SoBase, so they are reference counted and automatically destroyed when their reference count goes to 0.)

References: fieldSensor, and lineProj.

✨ Member Function Documentation ✨

🌟 SoType SoScale2UniformDragger::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.

Usage example:

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

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

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

Reimplemented from SoDragger.

💫 const SoFieldData * SoScale2UniformDragger::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.

References: SoScale2UniformDragger().

🔮 const SoNodekitCatalog * SoScale2UniformDragger::getNodekitCatalog (void ) const [virtual] 🔮

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

Reimplemented from SoDragger.

🧵 SbBool SoScale2UniformDragger::setUpConnections (SbBool onoff, SbBool doitalways = 0) [protected], [virtual] 🧵

Sets up all internal connections for instances of this class.

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

Reimplemented from SoInteractionKit.

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

Referenced by SoScale2UniformDragger().

🛑 void SoScale2UniformDragger::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.

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

Referenced by SoScale2UniformDragger().

🎢 void SoScale2UniformDragger::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.

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

Referenced by SoScale2UniformDragger().

🏁 void SoScale2UniformDragger::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.

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

Referenced by SoScale2UniformDragger().

📡 void SoScale2UniformDragger::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.

References: SoDragger::getMotionMatrix(), SbMatrix::getTransform(), scaleFactor, SoDragger::setMotionMatrix(), SbMatrix::setTransform(), and SoScale2UniformDragger().

Referenced by setUpConnections(), and SoScale2UniformDragger().

🔄 void SoScale2UniformDragger::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.

References: SoFieldSensor::attach(), SoFieldSensor::detach(), fieldSensor, SoDragger::getMotionMatrix(), SbMatrix::getTransform(), scaleFactor, SoDragger::SoDragger(), and SoScale2UniformDragger().

Referenced by SoScale2UniformDragger().

🚀 void SoScale2UniformDragger::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.

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

Referenced by startCB().

🏎️ void SoScale2UniformDragger::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.

References: SoDragger::appendScale(), SbVec3f::dot(), SoDragger::getLocalStartingPoint(), SoDragger::getLocalToWorldMatrix(), SoDragger::getNormalizedLocaterPosition(), SoDragger::getStartMotionMatrix(), SoDragger::getViewVolume(), SbVec3f::length(), lineProj, and SoDragger::setMotionMatrix().

Referenced by motionCB().

🛑 void SoScale2UniformDragger::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.

References: SoInteractionKit::setSwitchValue().

Referenced by finishCB().

🌸 Member Data Documentation 🌸

💖 SoSFVec3f SoScale2UniformDragger::scaleFactor 💖

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

For the SoScale2UniformDragger, only the X and Y components are used, the Z component will always be equal to 1 (ie no scaling).

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

🛠️ SoFieldSensor* SoScale2UniformDragger::fieldSensor [protected] 🛠️

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

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

📏 SbLineProjector* SoScale2UniformDragger::lineProj [protected] 📏

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

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

🦋 Author 🦋

Generated automatically by Doxygen for Coin from the source code.

okay bestie that's the whole page 🫶 — source is Coin, version 2.5.0, and the page is SoScale2UniformDragger(3). No cap, that's the footer vibe. 💅✨

📦 where this page comes from