SoScale1Dragger(3)

📦 version 2.5.0, in fedora 43, fedora 44

💖 SoScale1Dragger(3) 💖

Library Functions Manual — ok bestie, grab a strawberry 🍓, we're reading a whole manual page together and it's gonna slay.

✨ NAME ✨

SoScale1Dragger — the class that hands your end-user a mechanism for scaling stuff in one dimension. One. Singular. Unidimensional queen. 👑

🌸 SYNOPSIS 🌸

#include <Inventor/draggers/SoScale1Dragger.h>

Inherits SoDragger. Yes she's a dragger, it's giving drag-and-scale royalty, we love a lineage. 💅

🎀 Public Member Functions 🎀

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

🦋 Public Member Functions inherited from SoDragger 🦋

ngl, this is a long list, but every single one of these is hers now, so we're listing all of them, no skipping:

  • 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

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

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

⭐ 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

🧚 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

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

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

to be continued… 💅

✨ Static Public Member Functions inherited from SoFieldContainer ✨

These are the classics your girl inherited from way up the family tree — no need to call them on an instance, they just exist. 💫

  • static void initClass (void) — boot up the class, get it registered, do the whole debut. 🎀
  • static SoType getClassTypeId (void) — hands you the SoType so you know exactly who this class is. iykyk.
  • static void initCopyDict (void) — sets up the copy dictionary before a copy session kicks off.
  • static void addCopy (const SoFieldContainer *orig, const SoFieldContainer *copy) — registers one original ➡️ copy pairing in that dictionary.
  • static SoFieldContainer * checkCopy (const SoFieldContainer *orig) — looks up orig in the copy dict and gives you back its copy (or whatever's there). 🔍
  • static SoFieldContainer * findCopy (const SoFieldContainer *orig, const SbBool copyconnections) — finds the copy for orig, and copyconnections decides whether connections get copied along too.
  • static void copyDone (void) — wraps up the copy session, we're done here, periodt. 💅

🌈 Static Public Member Functions inherited from SoBase 🌈

The OG base-class statics. Foundational, iconic, lowkey everywhere.

  • static void initClass (void) — same energy: register the class, make it official. ✨
  • static SoType getClassTypeId (void) — the SoType for this one, pls.
  • static void addName (SoBase *const base, const char *const name) — attaches name to base in the name registry. 🏷️
  • static void removeName (SoBase *const base, const char *const name) — takes that name back off. bye bestie 👋
  • static void incrementCurrentWriteCounter (void) — bumps the current write counter up by one.
  • static void decrementCurrentWriteCounter (void) — and down by one. balance, babe. ⚖️
  • static SoBase * getNamedBase (const SbName &name, SoType type) — finds the base with that name and that type.
  • static int getNamedBases (const SbName &name, SoBaseList &baselist, SoType type) — same hunt, but it dumps all the matches into baselist and returns how many it found. 💖
  • static SbBool read (SoInput *in, SoBase *&base, SoType expectedtype) — reads a base off of in, checks it against expectedtype, and returns whether it worked.
  • static void setInstancePrefix (const SbString &c) — sets the instance prefix to c.
  • static void setTraceRefs (SbBool trace) — flips reference tracing on or off with trace.
  • static SbBool getTraceRefs (void) — tells you whether ref tracing is currently 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+field to another, using in.
  • static SbBool readRoute (SoInput *in) — reads a route in from in. 🛤️

🫶 Public Attributes 🫶

  • SoSFVec3f scaleFactor — the actual scale value this dragger is throwing around, as a 3-vector. ✨

Public Attributes inherited from SoDragger

  • SoSFBool isActive — is the dragger currently being dragged? yes/no, iconic.

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 🔒

For the class and its subclasses only, bestie. Not for outside hands. 🙈

  • virtual const SoFieldData * getFieldData (void) const — returns the field data for this class.
  • ~SoScale1Dragger () — the destructor, cleaning up on the way out.
  • virtual SbBool setUpConnections (SbBool onoff, SbBool doitalways=0) — hooks the connections up (or tears them down) depending on onoff; doitalways defaults to 0.
  • void dragStart (void) — called when a drag begins. 🎬
  • void drag (void) — called while the drag is happening.
  • void dragFinish (void) — called when the drag wraps up. and that's a wrap 💅

Protected Member Functions inherited from SoDragger

  • SoDragger (void) — the constructor.
  • virtual ~SoDragger () — the destructor.
  • SbVec2f getNormalizedLocaterPosition (void) — the locater position, normalized.
  • SbVec2s getLocaterPosition (void) — where the locater is rn.
  • SbVec2s getStartLocaterPosition (void) const — where it was when everything started.
  • void setStartLocaterPosition (SbVec2s p) — sets that starting position to p.
  • SbBool isAdequateConstraintMotion (void) — is this motion adequate for the constraint? 🤔
  • virtual SbBool shouldGrabBasedOnSurrogate (const SoPath *pickpath, const SoPath *surrogatepath) — decides whether to grab, based on the surrogate, from pickpath and surrogatepath.
  • void setCameraInfo (SoAction *action) — pulls the camera info out of action.
  • virtual void handleEvent (SoHandleEventAction *ha) — deals with the event in ha.
  • void transferMotion (SoDragger *child) — passes motion along to child.
  • void setIgnoreInBbox (SbBool newval) — sets the ignore-in-bbox flag to newval.
  • SbBool isIgnoreInBbox (void) — are we ignoring this in the bbox?
  • virtual void getBoundingBox (SoGetBoundingBoxAction *action) — fills in the bounding box on action.
  • void setActiveChildDragger (SoDragger *newchilddragger) — sets the active child dragger to newchilddragger.
  • SoDragger * getActiveChildDragger (void) const — returns whichever child dragger is active rn. 👑
  • 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, bye.
  • virtual void copyContents (const SoFieldContainer *fromFC, SbBool copyConnections) — copies the contents over from fromFC, with copyConnections deciding if connections come along.
  • virtual SbBool setPart (const int partNum, SoNode *node) — sets the part at 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=1, SbBool onlyifdefault=1) — sets the named part to node as a default; anypart defaults to 1, onlyifdefault defaults to 1.
  • virtual SbBool setAnyPartAsDefault (const SbName &partname, const SbName &nodename, SbBool anypart=1, SbBool onlyifdefault=1) — same thing but you're naming the node by nodename instead of passing it in; same anypart=1 and onlyifdefault=1 defaults.
  • SbBool setAnySurrogatePath (const SbName &name, SoPath *path, SbBool leafcheck=0, SbBool publiccheck=0) — sets the surrogate path for name to path; leafcheck=0 and publiccheck=0 by default.
  • void connectSeparatorFields (SoSeparator *dest, SbBool onOff) — connects the separator fields on dest according to onOff.

Protected Member Functions inherited from SoBaseKit

  • virtual ~SoBaseKit () — destructor duties.
  • virtual SoNode * addToCopyDict (void) const — adds this node into the copy dictionary.
  • SoGroup * getContainerNode (const SbName &listname, SbBool makeifneeded=1) — grabs the container node for listname; makeifneeded defaults to 1.
  • virtual SoNode * getAnyPart (const SbName &partname, SbBool makeifneeded, SbBool leafcheck=0, SbBool publiccheck=0) — returns the part named partname; leafcheck=0 and publiccheck=0 by default.
  • virtual SoNodeKitPath * createPathToAnyPart (const SbName &partname, SbBool makeifneeded, SbBool leafcheck=0, SbBool publiccheck=0, const SoPath *pathtoextend=NULL) — builds a nodekit path down to partname; leafcheck=0, publiccheck=0, and pathtoextend=NULL by default.
  • virtual SbBool setAnyPart (const SbName &partname, SoNode *from, SbBool anypart=1) — sets the part partname to from; anypart defaults to 1.
  • 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 — hands back the nodekit parts list.
  • const SbList< SoSFNode * > & getCatalogInstances (void) const — returns the catalog instances list.
  • void catalogError (void) — yells about a catalog problem. 😭
  • void countMyFields (SoOutput *out) — counts 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 this thing.
  • SbBool hasMultipleWriteRefs (void) const — does it have multiple write refs?
  • SbBool writeHeader (SoOutput *out, SbBool isgroup, SbBool isengine) const — writes the header out, with isgroup and isengine.
  • void writeFooter (SoOutput *out) const — writes the footer 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.
  • static const SoNodekitCatalog ** getClassNodekitCatalogPtr (void) — pointer to the class nodekit catalog.
  • static void startCB (void *f, SoDragger *d) — the start callback; gets f and the dragger d.
  • static void motionCB (void *f, SoDragger *d) — the motion callback; f and d again.
  • static void finishCB (void *f, SoDragger *d) — the finish callback; f and d.
  • static void fieldSensorCB (void *f, SoSensor *s) — the field sensor callback, with f and sensor s.
  • static void valueChangedCB (void *f, SoDragger *d) — the value-changed callback, with f and d.

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 *) — the 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.
  • static const SoNodekitCatalog ** getClassNodekitCatalogPtr (void) — nodekit catalog pointer.
  • static void readDefaultParts (const char *fileName, const char defaultBuffer[], int defBufSize) — reads the default parts from fileName, out of defaultBuffer[], with 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 to index.
  • static int getNextActionMethodIndex (void) — returns the next action method index.
  • static void incNextActionMethodIndex (void) — bumps that index up.
  • static void setCompatibilityTypes (const SoType &nodetype, const uint32_t bitmask) — sets the compatibility types for nodetype with bitmask.

Static Protected Member Functions inherited from SoBase

  • static uint32_t getCurrentWriteCounter (void) — the current write counter value.
  • static void staticDataLock (void) — locks the static data. 🔐
  • static void staticDataUnlock (void) — unlocks it. 🔓

🎀 Protected Attributes 🎀

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

Protected Attributes inherited from SoDragger

  • SoSFNode motionMatrix — the motion matrix node.

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 — pointer to the old top separator.

Protected Attributes inherited from SoBaseKit

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

Protected Attributes inherited from SoNode

  • uint32_t uniqueId — this node's unique id. one of a kind, obviously 👑

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 } — the 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 } — every node type and its exact bit value, no cap.

Protected Types inherited from SoBase

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

Static Protected Attributes inherited from SoNode

  • static uint32_t nextUniqueId = 0 — the next unique id, starting at 0.
  • static int nextActionMethodIndex = 0 — the next action method index, starting at 0.

💖 Detailed Description 💖

The SoScale1Dragger class provides a mechanism for the end-user to scale in one dimension. literally one. single. axis. and it serves. 💅

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

🖼️ (figure: the dragger's default inactive geometry — you know the vibe)

Use this dragger to allow the end-user of your application to scale along the X-axis. (Use a transformation node in front of the dragger to position it and re-orient it to scale along any vector.) so yes bestie, X-axis out of the box, but slap a transformation node in front and you can point that scaling energy anywhere you want. 🌈

👀 See also

  • SoScale2Dragger
  • SoScaleUniformDragger
  • SoScale2UniformDragger

🎀 Constructor & Destructor Documentation 🎀

🌸 SoScale1Dragger::SoScale1Dragger(void)

Okay so this is the default constructor, and its whole job is setting up the dragger nodekit catalog with the interaction and feedback geometry. That's it, that's the assignment. ✨

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

CLASS SoScale1Dragger
-->"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 SoScale1Dragger
PVT   "this",  SoScale1Dragger  ---
      "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(), SoScale1Dragger(), startCB(), and valueChangedCB().

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

🦋 SoScale1Dragger::~SoScale1Dragger() [protected]

Protected destructor. Very demure, very mindful, 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.)

References: fieldSensor, and lineProj.

💖 Member Function Documentation 💖

⭐ SoType SoScale1Dragger::getTypeId(void) const [virtual]

Returns the type identification of an object derived from a class inheriting SoBase. This is used for run-time type checking and "downward" casting. iykyk, it's the "wait, what ARE you actually" check. 🔍

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. No skipping, bestie. 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 * SoScale1Dragger::getFieldData(void) const [protected], [virtual]

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

Reimplemented from SoDragger.

References: SoScale1Dragger().

🧚 const SoNodekitCatalog * SoScale1Dragger::getNodekitCatalog(void) const [virtual]

Returns the nodekit catalog which defines the layout of this class' kit. The blueprint of the whole fit. ✨

Reimplemented from SoDragger.

🫶 SbBool SoScale1Dragger::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: SoScale1Dragger().

🔥 void SoScale1Dragger::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 SoScale1Dragger().

Referenced by: SoScale1Dragger().

🔥 void SoScale1Dragger::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 SoScale1Dragger().

Referenced by: SoScale1Dragger().

🔥 void SoScale1Dragger::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 SoScale1Dragger().

Referenced by: SoScale1Dragger().

🔥 void SoScale1Dragger::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 SoScale1Dragger().

Referenced by: setUpConnections(), and SoScale1Dragger().

🔥 void SoScale1Dragger::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 SoScale1Dragger().

Referenced by: SoScale1Dragger().

💜 void SoScale1Dragger::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. That little "ooh, they clicked me" moment. 👑

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

Referenced by: startCB().

💜 void SoScale1Dragger::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(), SoDragger::getLocalStartingPoint(), SoDragger::getLocalToWorldMatrix(), SoDragger::getNormalizedLocaterPosition(), SoDragger::getStartMotionMatrix(), SoDragger::getViewVolume(), lineProj, and SoDragger::setMotionMatrix().

Referenced by: motionCB().

💜 void SoScale1Dragger::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. Cleanup era. 🧼

References: SoInteractionKit::setSwitchValue().

Referenced by: finishCB().

👑 Member Data Documentation 👑

🍓 SoSFVec3f SoScale1Dragger::scaleFactor

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

For the SoScale1Dragger, only the X component is used, the Y and Z components will always be equal to 1 (ie no scaling). So like, don't be out here expecting the Y and Z to do anything, bestie. 🙈

Referenced by: fieldSensorCB(), setUpConnections(), SoScale1Dragger(), and valueChangedCB().

🎀 SoFieldSensor* SoScale1Dragger::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(), SoScale1Dragger(), valueChangedCB(), and ~SoScale1Dragger().

🎀 SbLineProjector* SoScale1Dragger::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(), SoScale1Dragger(), and ~SoScale1Dragger().

🌈 Author 🌈

Generated automatically by Doxygen for Coin from the source code. Not a human typing lovingly, just a robot doing its little thing. 🤖✨

And that's the whole page, bestie — no cap. 💖 This one ships with Coin, Version 2.5.0, filed under SoScale1Dragger(3), and if you ever need to cite it, that version-and-date footer is your receipt. Slay, you read the entire thing. 🎀🦋

📦 where this page comes from