SODIRECTIONALLIGHTDRAGGER(3coin2)

📦 version 2.5.0, in fedora 43, fedora 44

💖 SoDirectionalLightDragger(3) 💖

Library Functions Manual — yes bestie, this is the whole library-functions-manual energy, we're in 3 territory, section three, the C library function zone. 🌸

✨ NAME ✨

SoDirectionalLightDragger — okay so this class is literally the interactive geometry for manipulating a directional light source. That's the whole job. You grab it, you drag it, the light does a little turn. Main character energy for your scene's key light. 👑

🦋 SYNOPSIS 🦋

#include <Inventor/draggers/SoDirectionalLightDragger.h>

Inherits SoDragger. (so it's got all the dragger genes, we love a family tree 🧬)

💅 Public Member Functions

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

🌈 Public Member Functions inherited from SoDragger

the whole entire inheritance bag, 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 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)
okay that's the whole SYNOPSIS dump, bestie — every single signature, every inherited function, nothing skipped. more of this page is coming, don't go anywhere 💖

✨ Static Public Member Functions inherited from SoFieldContainer ✨

okay so these are the static public functions you inherit for free from SoFieldContainer, no cap, and they are doing the absolute most 💅

  • static void initClass (void) — the classic class-setup ritual every Coin class pulls off once so the type system knows it exists ✨
  • static SoType getClassTypeId (void) — hands you back the SoType for this class, your little class ID card 🎀
  • static void initCopyDict (void) — kicks off the copy dictionary, which is the whole bookkeeping situation for copy operations 📖
  • static void addCopy (const SoFieldContainer *orig, const SoFieldContainer *copy) — logs a fresh original-to-copy pairing into that copy dict, one entry at a time 💫
  • static SoFieldContainer * checkCopy (const SoFieldContainer *orig) — peeks in the copy dict to see if orig already got itself a copy 🔍
  • static SoFieldContainer * findCopy (const SoFieldContainer *orig, const SbBool copyconnections) — hunts down the copy for orig, and copyconnections is there to tell it whether connections matter in that hunt 👀
  • static void copyDone (void) — wraps the whole copy dictionary thing up when you're finished, bye bestie 👋

✨ Static Public Member Functions inherited from SoBase ✨

and these? inherited from SoBase, the ancestor of literally everything. main character origin story energy 👑

  • static void initClass (void) — same vibe as above, the init incantation, just from SoBase's side of the family 🌸
  • static SoType getClassTypeId (void) — the SoType for SoBase, as one does 💅
  • static void addName (SoBase *const base, const char *const name) — gives base the name name so you can find it later by that name 🏷️
  • static void removeName (SoBase *const base, const char *const name) — takes that name right back off again, no hard feelings 💔
  • static void incrementCurrentWriteCounter (void) — bumps the current write counter up by one ⬆️
  • static void decrementCurrentWriteCounter (void) — and drops it back down by one ⬇️
  • static SoBase * getNamedBase (const SbName &name, SoType type) — looks up a named base of the given type by its name 🔎
  • static int getNamedBases (const SbName &name, SoBaseList &baselist, SoType type) — same quest but it collects a whole list of them into baselist, and returns an int for its trouble 📚
  • static SbBool read (SoInput *in, SoBase *&base, SoType expectedtype) — reads a base in from in, dropping it into base, with expectedtype as the thing it's expecting 🫶
  • static void setInstancePrefix (const SbString &c) — sets the instance prefix to c, periodt ✨
  • static void setTraceRefs (SbBool trace) — flips reference tracing on or off based on trace 🕵️
  • static SbBool getTraceRefs (void) — tells you the current state of that reference tracing 🙈
  • static SbBool connectRoute (SoInput *in, const SbName &fromnodename, const SbName &fromfieldname, const SbName &tonodename, const SbName &tofieldname) — wires up a route going from fromnodename/fromfieldname to tonodename/tofieldname, reading through in 🧚
  • static SbBool readRoute (SoInput *in) — reads a route out of in, that's it, that's the function 🌈

🌟 Public Attributes 🌟

the actual vibes you get to play with:

  • SoSFRotation rotation — the rotation field, single-value, ready for you to spin things with 🌀
  • SoSFVec3f translation — the translation field, a SbVec3f, so you can move stuff around 📍

Public Attributes inherited from SoDragger

  • SoSFBool isActive — a boolean telling you whether the dragger is active or not. lowkey the most important one here 💀

Public Attributes inherited from SoInteractionKit

  • SoSFEnum renderCaching — enum field controlling render caching 🎀
  • SoSFEnum boundingBoxCaching — enum field controlling bounding box caching 📦
  • SoSFEnum renderCulling — enum field controlling render culling ✂️
  • SoSFEnum pickCulling — enum field controlling pick culling 🎯

🫶 Protected Member Functions 🫶

the inner-circle stuff, protected, not for just anyone:

  • virtual const SoFieldData * getFieldData (void) const — returns the field data, virtually, const-ly 💜
  • ~SoDirectionalLightDragger () — the destructor, doing its quiet little cleanup 😌
  • virtual SbBool setUpConnections (SbBool onoff, SbBool doitalways=0) — sets up connections according to onoff, and doitalways defaults to 0 🔌
  • virtual void setDefaultOnNonWritingFields (void) — sets the defaults on the non-writing fields, exactly like it says ✍️

Protected Member Functions inherited from SoDragger

  • SoDragger (void) — constructor 🐣
  • virtual ~SoDragger () — destructor 💫
  • SbVec2f getNormalizedLocaterPosition (void) — normalized locater position as an SbVec2f 📐
  • SbVec2s getLocaterPosition (void) — locater position as an SbVec2s 📏
  • SbVec2s getStartLocaterPosition (void) const — the locater position where things started, const 🚩
  • void setStartLocaterPosition (SbVec2s p) — sets that start locater position to p 📌
  • SbBool isAdequateConstraintMotion (void) — tells you whether the constraint motion is adequate, yes that's the whole function 🤷
  • virtual SbBool shouldGrabBasedOnSurrogate (const SoPath *pickpath, const SoPath *surrogatepath) — decides if a grab should happen, based on the surrogate, using pickpath and surrogatepath 🫴
  • void setCameraInfo (SoAction *action) — sets camera info from action 🎥
  • virtual void handleEvent (SoHandleEventAction *ha) — handles the event coming through ha 🎪
  • void transferMotion (SoDragger *child) — transfers motion over to child 🔄
  • void setIgnoreInBbox (SbBool newval) — sets the ignore-in-bbox flag to newval 🚫
  • SbBool isIgnoreInBbox (void) — asks whether ignore-in-bbox is on ❓
  • virtual void getBoundingBox (SoGetBoundingBoxAction *action) — grabs the bounding box via action 📦
  • void setActiveChildDragger (SoDragger *newchilddragger) — sets the active child dragger to newchilddragger 👶
  • SoDragger * getActiveChildDragger (void) const — returns the active child dragger, const 🧸
  • void updateDraggerCache (const SoPath *path) — refreshes the dragger cache for path 🗂️

Protected Member Functions inherited from SoInteractionKit

  • virtual ~SoInteractionKit () — destructor 🌙
  • virtual void copyContents (const SoFieldContainer *fromFC, SbBool copyConnections) — copies contents from fromFC, with copyConnections deciding whether connections come along 📋
  • virtual SbBool setPart (const int partNum, SoNode *node) — sets part number partNum to node 🧩
  • virtual SbBool readInstance (SoInput *in, unsigned short flags) — reads an instance from in with flags 📥
  • virtual SbBool setAnyPartAsDefault (const SbName &partname, SoNode *node, SbBool anypart=1, SbBool onlyifdefault=1) — sets any part named partname 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 deal but you pass a nodename instead of a node; anypart=1 and onlyifdefault=1 again 🔁
  • SbBool setAnySurrogatePath (const SbName &name, SoPath *path, SbBool leafcheck=0, SbBool publiccheck=0) — sets the surrogate path for name to path; leafcheck defaults to 0, publiccheck defaults to 0 🌿
  • void connectSeparatorFields (SoSeparator *dest, SbBool onOff) — connects separator fields on dest based on onOff 🔗

Protected Member Functions inherited from SoBaseKit

  • virtual ~SoBaseKit () — destructor 🎈
  • virtual SoNode * addToCopyDict (void) const — adds this thing to the copy dictionary, const, returns an SoNode * 📖
  • SoGroup * getContainerNode (const SbName &listname, SbBool makeifneeded=1) — gets the container node for listname, with makeifneeded defaulting to 1 🗃️
  • virtual SoNode * getAnyPart (const SbName &partname, SbBool makeifneeded, SbBool leafcheck=0, SbBool publiccheck=0) — gets any part named partname; makeifneeded has no default, leafcheck=0, publiccheck=0 🎁
  • virtual SoNodeKitPath * createPathToAnyPart (const SbName &partname, SbBool makeifneeded, SbBool leafcheck=0, SbBool publiccheck=0, const SoPath *pathtoextend=NULL) — builds a path to any part; leafcheck=0, publiccheck=0, and pathtoextend defaults to NULL 🛤️
  • virtual SbBool setAnyPart (const SbName &partname, SoNode *from, SbBool anypart=1) — sets any part named partname from from, with anypart defaulting 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 — returns the nodekit parts list, const 📜
  • const SbList< SoSFNode * > & getCatalogInstances (void) const — returns the catalog instances as a const reference to SbList< SoSFNode * > 🗂️
  • void catalogError (void) — the catalog error situation 😭
  • void countMyFields (SoOutput *out) — counts my fields, writing into out 🔢

Protected Member Functions inherited from SoNode

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

Protected Member Functions inherited from SoFieldContainer

  • SoFieldContainer (void) — constructor 🌻
  • ~SoFieldContainer () — destructor 🍂

Protected Member Functions inherited from SoBase

  • SoBase (void) — constructor 🌷
  • virtual ~SoBase () — destructor 🍁
  • virtual void destroy (void) — destroys, virtually 💥
  • SbBool hasMultipleWriteRefs (void) const — asks if there are multiple write refs, const 🔁
  • SbBool writeHeader (SoOutput *out, SbBool isgroup, SbBool isengine) const — writes a header into out, with isgroup and isengine flags, const 📄
  • void writeFooter (SoOutput *out) const — writes the footer into out, const 📄
  • virtual const char * getFileFormatName (void) const — returns the file format name as a const char *, const, virtual 🏷️

💅 Static Protected Member Functions 💅

  • static const SoFieldData ** getFieldDataPtr (void) — returns a pointer-to-pointer to the field data, iconic double-pointer behavior ✨
  • static const SoNodekitCatalog ** getClassNodekitCatalogPtr (void) — returns a pointer-to-pointer to the class nodekit catalog 🗂️
  • static void fieldSensorCB (void *f, SoSensor *s) — the field sensor callback, taking f and s 🎛️
  • static void valueChangedCB (void *f, SoDragger *d) — the value-changed callback, taking f and a SoDragger *d 🔔

Static Protected Member Functions inherited from SoDragger

  • static const SoFieldData ** getFieldDataPtr (void) — the field data pointer-to-pointer, again 🌀
  • static const SoNodekitCatalog ** getClassNodekitCatalogPtr (void) — the nodekit catalog pointer-to-pointer, again 🌀
  • static void childTransferMotionAndValueChangedCB (void *, SoDragger *) — callback for when a child transfers motion and the value changes 🚸
  • static void childValueChangedCB (void *, SoDragger *) — callback for when a child's value changes 🔔
  • static void childStartCB (void *, SoDragger *) — callback for when a child starts ▶️
  • static void childMotionCB (void *, SoDragger *) — callback for child motion 🏃
  • static void childFinishCB (void *, SoDragger *) — callback for when a child finishes 🏁
  • static void childOtherEventCB (void *, SoDragger *) — callback for other child events 🤹

Static Protected Member Functions inherited from SoInteractionKit

  • static const SoFieldData ** getFieldDataPtr (void) — yep, field data pointer-to-pointer 🌀
  • static const SoNodekitCatalog ** getClassNodekitCatalogPtr (void) — yep, nodekit catalog pointer-to-pointer 🌀
  • static void readDefaultParts (const char *fileName, const char defaultBuffer[], int defBufSize) — reads default parts from fileName, with defaultBuffer[] and a buffer size defBufSize 📥
  • static void fieldSensorCB (void *, SoSensor *) — the field sensor callback 🎛️

Static Protected Member Functions inherited from SoBaseKit

  • static const SoFieldData ** getFieldDataPtr (void) — field data pointer-to-pointer, take three 🌀
  • static const SoNodekitCatalog ** getClassNodekitCatalogPtr (void) — nodekit catalog pointer-to-pointer, take three 🌀

Static Protected Member Functions inherited from SoNode

  • static const SoFieldData ** getFieldDataPtr (void) — field data pointer-to-pointer, take four 🌀
  • static void setNextActionMethodIndex (int index) — sets the next action method index to index 🔢
  • static int getNextActionMethodIndex (void) — returns that next action method index ↩️
  • static void incNextActionMethodIndex (void) — increments the next action method index ⏫
  • static void setCompatibilityTypes (const SoType &nodetype, const uint32_t bitmask) — sets compatibility types for nodetype with bitmask 🧬

Static Protected Member Functions inherited from SoBase

  • static uint32_t getCurrentWriteCounter (void) — returns the current write counter as a uint32_t 🔢
  • static void staticDataLock (void) — locks the static data 🔒
  • static void staticDataUnlock (void) — unlocks the static data 🔓

🧚 Protected Attributes 🧚

  • SoSFNode material — the material node field 🪞
  • SoSFNode rotator — the rotator node field 🌀
  • SoSFNode translator — the translator node field 🚚
  • SoSFNode translatorRotInv — the translator rotation inverse node field 🔄
  • SoSFNode translatorSep — the translator separator node field 🗂️
  • SoFieldSensor * rotFieldSensor — a pointer to the rotation field sensor 📡
  • SoFieldSensor * translFieldSensor — a pointer to the translation field sensor 📡

Protected Attributes inherited from SoDragger

  • SoSFNode motionMatrix — the motion matrix node field 🧮

Protected Attributes inherited from SoInteractionKit

  • SoSFNode geomSeparator — the geometry separator node field 📐
  • SoSFNode topSeparator — the top separator node field 🔝
  • SoFieldSensor * fieldSensor — a pointer to the field sensor 📡
  • SoSeparator * oldTopSep — a pointer to the old top separator 🕰️

Protected Attributes inherited from SoBaseKit

  • SoSFNode callbackList — the callback list node field 📞
  • SoChildList * children — a pointer to the child list 👶
  • SbBool connectionsSetUp — a boolean tracking whether connections are set up 🔌

Protected Attributes inherited from SoNode

  • uint32_t uniqueId — the unique id, a uint32_t 🆔

Protected Attributes inherited from SoFieldContainer

  • SbBool isBuiltIn — a boolean for whether this thing is built in 🏗️

🌈 Additional Inherited Members 🌈

Public Types inherited from SoDragger

  • enum ProjectorFrontSetting { FRONT, BACK, USE_PICK } — the projector front setting enum, with values FRONT, BACK, and USE_PICK 🎯

Public Types inherited from SoInteractionKit

  • enum CacheEnabled { OFF, ON, AUTO } — the cache-enabled enum, values OFF, ON, and 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 node type enum, and look at those hex values bestie, they are everything 🌈

Protected Types inherited from SoBase

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

Static Protected Attributes inherited from SoNode

  • static uint32_t nextUniqueId = 0 — the next unique id, a uint32_t, starting at 0 🆔
  • static int nextActionMethodIndex = 0 — the next action method index, an int, starting at 0 🔢

👑 Detailed Description 👑

okay so the SoDirectionalLightDragger class provides interactive geometry for manipulating a directional light source. that's the whole assignment and it ate ✨

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

(this is where the picture of the dragger in its inactive state lives, bestie — picture it looking cute and dormant 😴)

This dragger is well suited to use for setting up the fields of a SoDirectionalLight node, as it provides geometry for the end-user to interact with a directional vector. like it's literally built for that 💅

For convenience, this dragger also by default contains interaction geometry for placing the dragger itself. (SoDirectionalLight nodes don't have a position field, so this was strictly not needed.) — they did it anyway because they're generous like that 🫶

The Coin library also includes a manipulator class, SoDirectionalLightManip, which wraps the functionality provided by this class inside the necessary mechanisms for connecting it to SoDirectionalLight node instances in a scenegraph. it's the whole outfit, not just the top 🔥

See also

  • SoDirectionalLightManip

🛠️ Constructor & Destructor Documentation 🛠️

SoDirectionalLightDragger::SoDirectionalLightDragger (void )

Okay bestie, this is the default constructor — it sets up the dragger nodekit catalog with all the interaction and feedback geometry. Basically it builds the whole wardrobe before the photoshoot 💅

Node kit structure — and heads up, the new entries versus the parent class are marked with an arrow prefix (-->), so you know what's fresh ✨

CLASS SoDirectionalLightDragger
-->"this"
      "callbackList"
      "topSeparator"
         "motionMatrix"
-->      "material"
-->      "translatorSep"
-->         "translatorRotInv"
-->         "translator"
-->      "rotator"
         "geomSeparator"

(If you wanna know more about that output formatting, go peep SoBaseKit::printDiagram(). iykyk 🫶)

Detailed info on the catalog parts, coming right up:

CLASS SoDirectionalLightDragger
PVT   "this",  SoDirectionalLightDragger  ---
      "callbackList",  SoNodeKitListPart [ SoCallback, SoEventCallback ]
PVT   "topSeparator",  SoSeparator  ---
PVT   "motionMatrix",  SoMatrixTransform  ---
      "material",  SoMaterial  ---
PVT   "translatorSep",  SoSeparator  ---
      "translatorRotInv",  SoRotation  ---
      "translator",  SoDragPointDragger  ---
      "rotator",  SoRotateSphericalDragger  ---
PVT   "geomSeparator",  SoSeparator  ---

(And for that formatting, it's SoBaseKit::printTable() 🌸)

References SoDragger::addValueChangedCallback(), fieldSensorCB(), SoInteractionKit::readDefaultParts(), rotation, rotFieldSensor, SoInteractionKit::setPartAsDefault(), setUpConnections(), SoDirectionalLightDragger(), SoDragger::SoDragger(), translation, translFieldSensor, and valueChangedCB().

Referenced by fieldSensorCB(), getFieldData(), SoDirectionalLightDragger(), and valueChangedCB().

SoDirectionalLightDragger::~SoDirectionalLightDragger () [protected]

The protected destructor 🫧

Just so you know: dragger classes are derived from SoBase, so they're reference counted and get automatically destroyed when their reference count goes to 0. You literally don't have to lift a finger, she cleans up after herself. Iconic behaviour, no notes.

References rotFieldSensor, and translFieldSensor.

⚡ Member Function Documentation ⚡

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

Returns the type identification of an object derived from a class inheriting SoBase. This is what powers run-time type checking and "downward" casting. So useful, lowkey essential 💖

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

Okay so, for the application programmers out there who wanna extend the library with new nodes, engines, nodekits, draggers or whatever else — this method has to be overridden in all the subclasses. No skipping, bestie, it's the law 📜

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 (that's SO_NODE_INIT_CLASS and SO_NODE_CONSTRUCTOR for node classes), Inventor/engines/SoSubEngine.h (for engine classes) and so on.

For more info on writing Coin extensions, go read the class documentation of the toplevel superclasses for the various class groups. It's giving ✨required reading✨.

Reimplemented from SoDragger.

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

Returns a pointer to the class-wide field data storage object for this instance. And if there are no fields present? It returns NULL. Simple as that 🎀

Reimplemented from SoDragger.

References SoDirectionalLightDragger().

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

Returns the nodekit catalog which defines the layout of this class' kit. It's the blueprint, the mood board, the whole vision board for this class 👑

Reimplemented from SoDragger.

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

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

(Real talk: this method will usually not be of interest to the application programmer, unless you wanna extend the library with new custom nodekits or dragger classes. If that's you, go check the SoBaseKit class documentation.)

Reimplemented from SoInteractionKit.

References SoBaseKit::connectionsSetUp, SoBaseKit::getAnyPart(), SoDragger::registerChildDragger(), rotation, rotFieldSensor, SoInteractionKit::setPartAsDefault(), SoBaseKit::setUpConnections(), SoDragger::SoDragger(), translation, translFieldSensor, and SoDragger::unregisterChildDragger().

Referenced by SoDirectionalLightDragger().

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

Heads up bestie: this method is unlikely to be of interest to the application programmer who does not want to extend the library with new custom nodekits or draggers. But if you are writing extensions, go read the info in the SoBaseKit class documentation. 🫶

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

This is typically done when:

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

Subclasses should usually override this to do additional settings for new member fields. And from the subclass, do remember to call "upwards" to your superclass' setDefaultOnNonWritingFields() method. Don't leave your ancestors hanging 💅

Reimplemented from SoDragger.

References SoDragger::setDefaultOnNonWritingFields().

void SoDirectionalLightDragger::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. Moving on, nothing to see here 🙈

References SoDragger::getMotionMatrix(), SoDragger::setMotionMatrix(), SoDirectionalLightDragger(), and SoDragger::workFieldsIntoTransform().

Referenced by SoDirectionalLightDragger().

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

This API member is also considered internal to the library, so it's not likely to be of interest to the application programmer. Fr fr, it's backstage only 🎭

References SoFieldSensor::attach(), SoFieldSensor::detach(), SoDragger::getMotionMatrix(), SbMatrix::getTransform(), SbRotation::inverse(), rotation, SoRotation::rotation, rotFieldSensor, SoDirectionalLightDragger(), SoDragger::SoDragger(), translation, and translFieldSensor.

Referenced by SoDirectionalLightDragger().

💾 Member Data Documentation 💾

SoSFRotation SoDirectionalLightDragger::rotation

This field is continuously updated to contain the rotation of the current direction vector 🔄

The application programmer will typically connect this to the rotation field of a SoDirectionalLight node — unless you're using the SoDirectionalLightManip class, where this is taken care of automatically (she does it for you, no cap 🫶).

It may also, of course, be connected to any other rotation field controlling the direction of scenegraph geometry. It does not have to be part of a SoDirectionalLight node specifically. Versatile queen ✨

Referenced by setUpConnections(), SoDirectionalLightDragger(), and valueChangedCB().

SoSFVec3f SoDirectionalLightDragger::translation

Continuously updated to contain the current translation from the dragger's local origo position 📍

This field is not used by the SoDirectionalLightManip, but it may be of interest for the application programmer wanting to use the SoDirectionalLightDragger outside the context of controlling a directional light node. Do with that what you will 💜

Referenced by setUpConnections(), SoDirectionalLightDragger(), and valueChangedCB().

SoFieldSensor* SoDirectionalLightDragger::rotFieldSensor [protected]

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

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

SoFieldSensor* SoDirectionalLightDragger::translFieldSensor [protected]

This API member is considered internal to the library too, so it's not likely to be of interest to the application programmer. Same energy as above 😭

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

👑 Author 👑

Generated automatically by Doxygen for Coin from the source code. She didn't write herself, bestie, the machines did it 🤖✨

And that's a wrap on the whole page, gorgeous! 🎀 This was Coin, Version 2.5.0 — yes, the SoDirectio...ightDragger(3). Read it, loved it, no notes. Byeeee 💅💖

📦 where this page comes from