SoDirectionalLight(3)

✨ SoDirectionalLight(3) ✨

Library Functions Manual · SoDirectionalLight(3)

okay bestie, sit down, hydrate, because we're doing directional lights today and honestly? they're the moment. 💡✨

---

🎀 NAME 🎀

SoDirectionalLight — the class that is a node type for specifying directional light sources. that's it, that's the name, no notes. 💅

---

🦋 SYNOPSIS 🦋

#include <Inventor/nodes/SoDirectionalLight.h>

Inherits SoLight.

Inherited by SoDirectionalLightManip.

💖 Public Member Functions 💖

virtual SoType getTypeId (void) const
SoDirectionalLight (void)
virtual void GLRender (SoGLRenderAction *action)

🌸 Public Member Functions inherited from SoLight 🌸

virtual void callback (SoCallbackAction *action)

🌸 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 doAction (SoAction *action)
virtual void GLRenderBelowPath (SoGLRenderAction *action)
virtual void GLRenderInPath (SoGLRenderAction *action)
virtual void GLRenderOffPath (SoGLRenderAction *action)
virtual void getBoundingBox (SoGetBoundingBoxAction *action)
virtual void getMatrix (SoGetMatrixAction *action)
virtual void handleEvent (SoHandleEventAction *action)
virtual void pick (SoPickAction *action)
virtual void rayPick (SoRayPickAction *action)
virtual void search (SoSearchAction *action)
virtual void write (SoWriteAction *action)
virtual void audioRender (SoAudioRenderAction *action)
virtual void getPrimitiveCount (SoGetPrimitiveCountAction *action)
virtual void grabEventsSetup (void)
virtual void grabEventsCleanup (void)
virtual void startNotify (void)
virtual void notify (SoNotList *l)
uint32_t getNodeId (void) const
virtual SoChildList * getChildren (void) const
virtual void writeInstance (SoOutput *out)
virtual SoNode * addToCopyDict (void) const
virtual void copyContents (const SoFieldContainer *from, SbBool
    copyconnections)
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)
virtual void addWriteReference (SoOutput *out, SbBool isfromfield=0)
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 void initClass (void)

🌸 Static Public Member Functions inherited from SoLight 🌸

static SoType getClassTypeId (void)
static void initClass (void)

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

🌸 Static Public Member Functions inherited from SoFieldContainer 🌸

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

🌸 Static Public Member Functions inherited from SoBase 🌸

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

💖 Public Attributes 💖

SoSFVec3f direction

🌸 Public Attributes inherited from SoLight 🌸

SoSFBool on
SoSFFloat intensity
SoSFColor color

💖 Protected Member Functions 💖

virtual const SoFieldData * getFieldData (void) const
virtual ~SoDirectionalLight ()

🌸 Protected Member Functions inherited from SoLight 🌸

SoLight (void)
virtual ~SoLight ()

🌸 Protected Member Functions inherited from SoNode 🌸

SoNode (void)
virtual ~SoNode ()
virtual SbBool readInstance (SoInput *in, unsigned short flags)

🌸 Protected Member Functions inherited from SoFieldContainer 🌸

SoFieldContainer (void)
~SoFieldContainer ()

🌸 Protected Member Functions inherited from SoBase 🌸

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

💖 Static Protected Member Functions 💖

static const SoFieldData ** getFieldDataPtr (void)

🌸 Static Protected Member Functions inherited from SoLight 🌸

static const SoFieldData ** getFieldDataPtr (void)

🌸 Static Protected Member Functions inherited from SoNode 🌸

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

🌸 Static Protected Member Functions inherited from SoBase 🌸

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

💖 Additional Inherited Members 💖

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
    }

Protected Types inherited from SoBase

enum BaseFlags { IS_ENGINE = 0x01, IS_GROUP = 0x02 }

Protected Attributes inherited from SoNode

uint32_t uniqueId

Protected Attributes inherited from SoFieldContainer

SbBool isBuiltIn

Static Protected Attributes inherited from SoNode

static uint32_t nextUniqueId = 0
static int nextActionMethodIndex = 0

---

🌈 Detailed Description 🌈

The SoDirectionalLight class is a node type for specifying directional light sources. (yes they said it twice, the class is that iconic 💅)

A directional light source provides a model of light sources which are at infinite distance from the geometry it illuminates, thereby having no set position and consisting of an infinite volume of parallel rays. ✨ like, the light just... exists, everywhere, in one direction. no origin story. no location. just vibes and rays. 🌈

This is of course a simplified model of far-away light sources, as "infinite distance" is impossible. 🫠

The sun shining on objects on earth is a good example of something which can be modeled rather well for the most common purposes with a directional light source. ☀️ (the sun is the original main character, honestly.)

See also documentation of parent class for important information regarding light sources in general. 👀 don't skip it bestie, it's important.

FILE FORMAT/DEFAULTS:

DirectionalLight {
    on TRUE
    intensity 1
    color 1 1 1
    direction 0 0 -1
}

---

A common thing to do with an SoDirectionalLight is to connect it to a camera, so it works in the style of a head light to that camera. 🔦 This can easily be accomplished by linking an SoRotation::rotation field, influencing the light, to the SoCamera::orientation field. Here is a complete example iv-file demonstrating the technique — copy it, run it, eat it up:

#Inventor V2.1 ascii

DEF mycam PerspectiveCamera { }

TransformSeparator {
   SoRotation { rotation = USE mycam.orientation }
   DirectionalLight { direction 0 0 -1 }
}

Cube { }

(The SoTransformSeparator is included to keep the effect of the SoRotation node within a scope where it will only influence the light, and not the geometry following the light in the scene graph.) 🧚 scope is everything, no cap.

---

okay that's part 1 and there's MORE coming, so stay perched bestie 💖✨

🛠️ CONSTRUCTOR & DESTRUCTOR DOCUMENTATION 🛠️

---

✨ SoDirectionalLight::SoDirectionalLight(void)

okay so this is THE constructor, bestie. the moment of creation. the birth of a light 💡✨

it References direction, and SoDirectionalLight() — yes she references herself, icon behaviour honestly.

and she's Referenced by getFieldData(), SoDirectionalLightManip::replaceManip(), SoDirectionalLightManip::replaceNode(), SoDirectionalLight(), and SoDirectionalLightManip::transferFieldValues(). so many besties pulling up on her, we love to see it 🫶

---

💀 SoDirectionalLight::~SoDirectionalLight() — [protected], [virtual]

the destructor. she's protected AND virtual, so she's fancy like that 💅

that's it. that's the whole description. no notes. goodbye light, you served cunt 🌈

---

🌟 MEMBER FUNCTION DOCUMENTATION 🌟

---

🔍 SoType SoDirectionalLight::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.

like, this is how you ask a node "hey bestie, what ARE you actually?" before you start casting her into something she's not. very "know before you commit" of you ngl 👑

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

see how both casts say "safe downward cast, knows the type"? because she DID the vibe check first. that's the whole point. periodt 💅

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. that's not optional, bestie, that's the assignment 📝

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. the macros are literally doing the most so you don't have to 😭✨

For more information on writing Coin extensions, see the class documentation of the toplevel superclasses for the various class groups. go read those, they ate 🔥

• Reimplemented from SoLight.
• Reimplemented in SoDirectionalLightManip.

---

🗂️ const SoFieldData * SoDirectionalLight::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.

like she's handing you the receipts for every field the whole class shares. and if there are literally no fields? NULL. empty. nothing. a void. 💀

• Reimplemented from SoLight.
• Reimplemented in SoDirectionalLightManip.
• References SoDirectionalLight().

---

🎨 void SoDirectionalLight::GLRender(SoGLRenderAction * action) — [virtual]

Action method for the SoGLRenderAction.

This is called during rendering traversals. Nodes influencing the rendering state in any way or who wants to throw geometry primitives at OpenGL overrides this method. "throw geometry primitives at OpenGL" is genuinely such a serve of a sentence, she said it with her whole chest 🫡

• Reimplemented from SoNode.
• Reimplemented in SoDirectionalLightManip.
• References SoLight::color, direction, SoAction::getState(), SbColor4f::getValue(), SbVec4f::getValue(), SoLight::intensity, SbVec3f::normalize(), SoLight::on, SoDebugError::postWarning(), and SbColor4f::setRGB().
• Referenced by SoDirectionalLightManip::GLRender().

ngl the reference list is giving "invited everyone to the party" and honestly? respect. SoDebugError::postWarning() being in there is lowkey ominous but we move 🚩

---

📦 MEMBER DATA DOCUMENTATION 📦

---

🧭 SoSFVec3f SoDirectionalLight::direction

The direction of the light source. Defaults to pointing along the negative z-axis.

so if you don't tell her where to point, she's just gonna point along negative z all on her own. independent queen 🎀

• Referenced by SoDirectionalLightManip::fieldSensorCB(), GLRender(), SoDirectionalLight(), SoDirectionalLightManip::transferFieldValues(), and SoDirectionalLightManip::valueChangedCB().

---

👑 AUTHOR 👑

Generated automatically by Doxygen for Coin from the source code.

(no human wrote this, a robot did, and honestly? she ate 🤖💅)

---

okay bestie that's the whole page!! 💖 this was pulled from the Coin source docs, Version 2.5.0, and you're reading the SoDirectionalLight(3) manpage 🦋 go forth and light things up, ily, bye 🌸✨