SODIRECTIONALLIGHTDRAGGER(3coin3)

📦 version 3.1.3, in fedora 43, fedora 44

💖 SoDirectionalLightDragger 💖

okay bestie, sit DOWN. this is SoDirectionalLightDragger(3) from the Library Functions Manual, and it's literally the whole vibe of "make a directional light do what I want with my little mouse hands." 🦋

✨ NAME ✨

SoDirectionalLightDragger — the class that gives you interactive geometry for manipulating a directional light source. yes really. you get to grab a light and yeet it around. iconic. 👑

🌸 SYNOPSIS 🌸

first things first, you gotta pull it in:

#include <Inherits SoDragger.inventor/draggers/SoDirectionalLightDragger.h>

wait no hold on, let me not do that to you. the actual include is:

#include <Inventor/draggers/SoDirectionalLightDragger.h>

and it Inherits SoDragger. so everything SoDragger can do? it's inherited, it's in the bloodline, it's giving family tree energy. 🌈

👑 Public Member Functions 👑

these are the ones that belong to SoDirectionalLightDragger itself:

  • virtual SoType getTypeId (void) const — gives you back its type id, so the type system knows who's who 💅
  • virtual const SoNodekitCatalog * getNodekitCatalog (void) const — hands you the nodekit catalog for this class, the whole little blueprint
  • SoDirectionalLightDragger (void) — the constructor, no arguments, just vibes

🫶 Public Member Functions inherited from SoDragger 🫶

okay this list is long but bestie every single one of these is yours now:

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

💜 Public Member Functions inherited from SoInteractionKit 💜

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

🎀 Public Member Functions inherited from SoBaseKit 🎀

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

⭐ Public Member Functions inherited from SoNode ⭐

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

🧚 Public Member Functions inherited from SoFieldContainer 🧚

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

🦋 Public Member Functions inherited from SoBase 🦋

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

🌈 Static Public Member Functions 🌈

the ones that don't need an instance, they just are:

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

💫 Static Public Member Functions inherited from SoDragger 💫

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

🌸 Static Public Member Functions inherited from SoInteractionKit 🌸

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

🍓 Static Public Member Functions inherited from SoBaseKit 🍓

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

🎀 Static Public Member Functions inherited from SoNode 🎀

  • 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 synopsis bestie, and there is SO much more coming — hold on, don't go anywhere 💖

✨ Static Public Member Functions inherited from SoFieldContainer ✨

bestie these are the static public ones that come with the SoFieldContainer territory, they're not new but they're yours now:

  • static void initClass (void) — the class gets its init moment 💅
  • static SoType getClassTypeId (void) — hands you back the class's type id
  • static void cleanupClass (void) — tidy-up time, class edition
  • static void initCopyDict (void) — sets up the copy dictionary
  • static void addCopy (const SoFieldContainer *orig, const SoFieldContainer *copy) — registers a copy pairing
  • static SoFieldContainer * checkCopy (const SoFieldContainer *orig) — checks on a copy
  • static SoFieldContainer * findCopy (const SoFieldContainer *orig, const SbBool copyconnections) — goes looking for the copy
  • static void copyDone (void) — and we're done copying, periodt ✨

✨ Static Public Member Functions inherited from SoBase ✨

and here's the SoBase starter pack, same deal, inherited with love 🫶

  • static void initClass (void) — init, but for SoBase
  • static SoType getClassTypeId (void) — the type id, as promised
  • static void addName (SoBase *const base, const char *const name) — gives a base a name
  • static void removeName (SoBase *const base, const char *const name) — takes that name back
  • 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) — fetches a base by name + type
  • static int getNamedBases (const SbName &name, SoBaseList &baselist, SoType type) — the plural version, fills your baselist
  • static SbBool read (SoInput *input, SoBase *&base, SoType expectedtype) — reads one in
  • static void setInstancePrefix (const SbString &c) — sets the instance prefix
  • static void setTraceRefs (SbBool trace) — flips reference tracing on or off
  • static SbBool getTraceRefs (void) — tells you if tracing refs is on
  • static SbBool connectRoute (SoInput *input, const SbName &fromnodename, const SbName &fromfieldname, const SbName &tonodename, const SbName &tofieldname) — wires a route from one node+field to another, chef's kiss 🔥
  • static SbBool readRoute (SoInput *input) — reads a route in

💖 Public Attributes 💖

the actual star of the show, the fields you're here for:

  • SoSFRotation rotation — the rotation field, iconic
  • SoSFVec3f translation — the translation field, equally iconic

Public Attributes inherited from SoDragger

  • SoSFBool isActive — is this dragger active or not, that's the whole field

Public Attributes inherited from SoInteractionKit

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

🎀 Protected Member Functions 🎀

for the subclass girlies only, no outside peeking 🙈

  • virtual const SoFieldData * getFieldData (void) const — hands back the field data
  • virtual ~SoDirectionalLightDragger (void) — the destructor, say bye 👋
  • virtual SbBool setUpConnections (SbBool onoff, SbBool doitalways=FALSE) — sets the connections up (or down), with an optional "do it always" flag
  • virtual void setDefaultOnNonWritingFields (void) — sets the default on the non-writing fields

Protected Member Functions inherited from SoDragger

  • SoDragger (void) — the constructor
  • virtual ~SoDragger (void) — the destructor
  • SbVec2f getNormalizedLocaterPosition (void) — normalized locater position, get it
  • SbVec2s getLocaterPosition (void) — raw locater position
  • SbVec2s getStartLocaterPosition (void) const — where the locater started
  • void setStartLocaterPosition (SbVec2s p) — sets where the locater started
  • SbBool isAdequateConstraintMotion (void) — is this motion adequate for the constraint, hmm?
  • virtual SbBool shouldGrabBasedOnSurrogate (const SoPath *pickpath, const SoPath *surrogatepath) — decides if it should grab based on a surrogate
  • void setCameraInfo (SoAction *action) — stashes the camera info
  • virtual void handleEvent (SoHandleEventAction *ha) — handles the event, main character energy
  • void transferMotion (SoDragger *child) — passes motion along to a child
  • void setIgnoreInBbox (SbBool newval) — sets whether to ignore in the bbox
  • SbBool isIgnoreInBbox (void) — are we ignoring in the bbox?
  • virtual void getBoundingBox (SoGetBoundingBoxAction *action) — gets the bounding box
  • void setActiveChildDragger (SoDragger *newchilddragger) — sets the active child dragger
  • SoDragger * getActiveChildDragger (void) const — gets the active child dragger
  • void updateDraggerCache (const SoPath *path) — refreshes the dragger cache

Protected Member Functions inherited from SoInteractionKit

  • virtual ~SoInteractionKit () — destructor szn
  • virtual void copyContents (const SoFieldContainer *fromFC, SbBool copyConnections) — copies the contents over
  • virtual SbBool setPart (const int partNum, SoNode *node) — sets a part by number
  • virtual SbBool readInstance (SoInput *in, unsigned short flags) — reads an instance
  • virtual SbBool setAnyPartAsDefault (const SbName &partname, SoNode *node, SbBool anypart=TRUE, SbBool onlyifdefault=TRUE) — makes any part a default
  • virtual SbBool setAnyPartAsDefault (const SbName &partname, const SbName &nodename, SbBool anypart=TRUE, SbBool onlyifdefault=TRUE) — same thing but you name the node instead
  • SbBool setAnySurrogatePath (const SbName &name, SoPath *path, SbBool leafcheck=FALSE, SbBool publiccheck=FALSE) — sets a surrogate path
  • void connectSeparatorFields (SoSeparator *dest, SbBool onOff) — wires up separator fields to dest

Protected Member Functions inherited from SoBaseKit

  • virtual ~SoBaseKit () — destructor again
  • virtual SoNode * addToCopyDict (void) const — adds itself to the copy dict
  • SoGroup * getContainerNode (const SbName &listname, SbBool makeifneeded=TRUE) — grabs the container node
  • virtual SoNode * getAnyPart (const SbName &partname, SbBool makeifneeded, SbBool leafcheck=FALSE, SbBool publiccheck=FALSE) — gets any part
  • virtual SoNodeKitPath * createPathToAnyPart (const SbName &partname, SbBool makeifneeded, SbBool leafcheck=FALSE, SbBool publiccheck=FALSE, const SoPath *pathtoextend=NULL) — builds a path to any part
  • virtual SbBool setAnyPart (const SbName &partname, SoNode *from, SbBool anypart=TRUE) — sets any part
  • 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 — the catalog instances, by reference 🫶
  • void catalogError (void) — throws up a catalog error
  • void countMyFields (SoOutput *out) — counts 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
  • virtual ~SoFieldContainer () — destructor

Protected Member Functions inherited from SoBase

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

⭐ Static Protected Member Functions ⭐

  • static const SoFieldData ** getFieldDataPtr (void) — pointer to the field data pointer, very pointer, much wow
  • static const SoNodekitCatalog ** getClassNodekitCatalogPtr (void) — same but for the nodekit catalog
  • static void fieldSensorCB (void *f, SoSensor *s) — the field sensor callback
  • static void valueChangedCB (void *f, SoDragger *d) — fires when a value changed

Static Protected Member Functions inherited from SoDragger

  • static const SoFieldData ** getFieldDataPtr (void) — the field data pointer pointer, again
  • static const SoNodekitCatalog ** getClassNodekitCatalogPtr (void) — the catalog pointer pointer, again
  • static void childTransferMotionAndValueChangedCB (void *, SoDragger *) — child motion transfer + value changed, all in one
  • static void childValueChangedCB (void *, SoDragger *) — child value changed
  • static void childStartCB (void *, SoDragger *) — child start
  • static void childMotionCB (void *, SoDragger *) — child motion
  • static void childFinishCB (void *, SoDragger *) — child finish
  • static void childOtherEventCB (void *, SoDragger *) — child other event, the catch-all bestie

Static Protected Member Functions inherited from SoInteractionKit

  • static const SoFieldData ** getFieldDataPtr (void) — field data ptr ptr
  • static const SoNodekitCatalog ** getClassNodekitCatalogPtr (void) — catalog ptr ptr
  • static void readDefaultParts (const char *fileName, const char defaultBuffer[], int defBufSize) — reads the default parts out of a file
  • static void fieldSensorCB (void *, SoSensor *) — the field sensor callback again

Static Protected Member Functions inherited from SoBaseKit

  • static const SoFieldData ** getFieldDataPtr (void) — field data ptr ptr, the SoBaseKit cut
  • static const SoNodekitCatalog ** getClassNodekitCatalogPtr (void) — catalog ptr ptr, same energy

Static Protected Member Functions inherited from SoNode

  • static const SoFieldData ** getFieldDataPtr (void) — field data ptr ptr, SoNode remix
  • static void setNextActionMethodIndex (int index) — sets the next action method index
  • static int getNextActionMethodIndex (void) — gets it back
  • static void incNextActionMethodIndex (void) — increments it
  • static void setCompatibilityTypes (const SoType &nodetype, const uint32_t bitmask) — sets the compatibility types

Static Protected Member Functions inherited from SoBase

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

🌸 Protected Attributes 🌸

  • SoSFNode material — the material node field
  • SoSFNode rotator — the rotator
  • SoSFNode translator — the translator
  • SoSFNode translatorRotInv — the inverse-rotation translator, say that five times fast
  • SoSFNode translatorSep — the translator separator
  • SoFieldSensor * rotFieldSensor — field sensor for the rotation
  • SoFieldSensor * translFieldSensor — field sensor for the translation

Protected Attributes inherited from SoDragger

  • SoSFNode motionMatrix — the motion matrix

Protected Attributes inherited from SoInteractionKit

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

Protected Attributes inherited from SoBaseKit

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

Protected Attributes inherited from SoNode

  • uint32_t uniqueId — the unique id, one of a kind 💅

Protected Attributes inherited from SoFieldContainer

  • SbBool isBuiltIn — is it built in?

🦋 Additional Inherited Members 🦋

Public Types inherited from SoDragger

  • enum ProjectorFrontSetting { FRONT, BACK, USE_PICK } — your projector front options, right there

Public Types inherited from SoInteractionKit

  • enum CacheEnabled { OFF, ON, AUTO } — off, on, or auto, pick your fighter

Public Types inherited from SoNode

the big one, all the node types in one enum:

enum NodeType { INVENTOR = 0x0000, VRML1 = 0x0001, VRML2 = 0x0002, INVENTOR_1 = 0x0004, INVENTOR_2_0 = 0x0008, INVENTOR_2_1 = 0x0010, INVENTOR_2_5 = 0x0020, INVENTOR_2_6 = 0x0040, COIN_1_0 = 0x0080, COIN_2_0 = 0x0100, EXTENSION = 0x0200, COIN_2_2 = 0x0400, COIN_2_3 = 0x0800, COIN_2_4 = 0x1000, INVENTOR_5_0 = 0x2000, COIN_2_5 = 0x4000, COIN_3_0 = 0x8000, INVENTOR_6_0 = 0x10000 }

Protected Types inherited from SoBase

  • enum BaseFlags { IS_ENGINE = 0x01, IS_GROUP = 0x02 } — two little flags, engine or group

Static Protected Attributes inherited from SoNode

  • static uint32_t nextUniqueId = 1 — starts at 1, don't touch
  • static int nextActionMethodIndex = 0 — starts at 0, also don't touch

🌈 Detailed Description 🌈

The SoDirectionalLightDragger class provides interactive geometry for manipulating a directional light source. yes, it's literally that girl.

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

(picture the default geometry, chilling, inactive, gorgeous) ✨

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. so like, it's built for exactly this.

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, for the vibes, and honestly? valid.

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. so if you want the whole packaged deal, that's the one 👑

🎀 See also 🎀

  • SoDirectionalLightManip

🎀 Constructor & Destructor Documentation 🎀

SoDirectionalLightDragger::SoDirectionalLightDragger (void )

Default constructor bestie!! ✨ It sets up the dragger nodekit catalog with the interaction and feedback geometry. That's literally its whole job and it ate.

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

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

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

Detailed information on catalog parts:

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

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

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

Protected destructor, no cap. 🫶

(Dragger classes are derived from SoBase, so they are reference counted and automatically destroyed when their reference count goes to 0.) So like… you don't have to babysit it, it knows when to leave the party. 💅

🔥 Member Function Documentation 🔥

SoType SoDirectionalLightDragger::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 💖

Usage example:

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

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

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

Reimplemented from SoDragger.

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

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

Reimplemented from SoDragger.

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

Returns the nodekit catalog which defines the layout of this class' kit. It's giving map of the whole vibe. 🗺️✨

Reimplemented from SoDragger.

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

Sets up all internal connections for instances of this class.

(This method will usually not be of interest to the application programmer, unless you want to extend the library with new custom nodekits or dragger classes. If so, see the SoBaseKit class documentation.) Bestie this one is for the library-extenders only, fr fr.

Reimplemented from SoInteractionKit.

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

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

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

This is typically done when:

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

Subclasses should usually override this to do additional settings for new member fields. From the subclass, do remember to call "upwards" to your superclass' setDefaultOnNonWritingFields() method. 🙈 Don't skip that part, okay?

Reimplemented from SoDragger.

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. Nothing to see here, move along. 💀

void SoDirectionalLightDragger::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. Same energy, also internal. 🫶

💖 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 using the SoDirectionalLightManip class, where this is taken care of automatically). 👑

It may also of course be connected to any other rotation field controlling the direction of scenegraph geometry, it does not have to part of a SoDirectionalLight node specifically. So flexible, so main character. ✨

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 may be of interest for the application programmer wanting to use the SoDirectionalLightDragger outside the context of controlling a directional light node. Like, it's optional but it's there for you. 🦋

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.

SoFieldSensor* SoDirectionalLightDragger::translFieldSensor [protected]

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

🌈 Author 🌈

Generated automatically by Doxygen for Coin from the source code.

and that's the whole page bestie, we did it 💅✨ shoutout to Coin, Version 3.1.3, and to whatever date this manpage footer was stamped with — the docs really said "trust the process" and delivered. go forth and drag those directional lights, you absolute icon 👑💖

📦 where this page comes from