SoVRMLDirectionalLight(3)

📦 version 3.1.3, in fedora 43, fedora 44

💖 SoVRMLDirectionalLight(3) — Library Functions Manual 💖

okay so bestie, welcome to SoVRMLDirectionalLight, the man page for the class that handles directional light sources in Coin/VRML-land. it's giving "sunlight but make it a node". let's get into it ✨

🌸 NAME 🌸

SoVRMLDirectionalLight — the SoVRMLDirectionalLight class is a node type for specifying directional light sources. no cap, that's literally its whole job 💅

✨ SYNOPSIS ✨

#include <Inventor/VRMLnodes/SoVRMLDirectionalLight.h>

Inherits SoVRMLLight.

🫶 Public Member Functions

virtual SoType getTypeId (void) const — the type-identity check, const-flavored 🎀
SoVRMLDirectionalLight (void) — the constructor, she's built different (literally)
virtual void GLRender (SoGLRenderAction *action) — does the actual render pass when the action comes knocking 👑

💜 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 doAction (SoAction *action)
virtual void GLRenderBelowPath (SoGLRenderAction *action)
virtual void GLRenderInPath (SoGLRenderAction *action)
virtual void GLRenderOffPath (SoGLRenderAction *action)
virtual void callback (SoCallbackAction *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=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)
virtual void addWriteReference (SoOutput *out, SbBool isfromfield=FALSE)
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

static SoType getClassTypeId (void) — grab the class type id 🎀
static void initClass (void) — the class init, do it once 💖

💜 Static Public Member Functions inherited from `SoVRMLLight`

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 cleanupClass (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 *input, SoBase *&base, SoType expectedtype)
static void setInstancePrefix (const SbString &c)
static void setTraceRefs (SbBool trace)
static SbBool getTraceRefs (void)
static SbBool connectRoute (SoInput *input, const SbName &fromnodename, const SbName &fromfieldname, const SbName &tonodename, const SbName &tofieldname)
static SbBool readRoute (SoInput *input)

👑 Public Attributes

SoSFVec3f direction — the direction vector, the whole personality of this node ✨

🌸 Public Attributes inherited from `SoVRMLLight`

SoSFBool on
SoSFFloat intensity
SoSFColor color
SoSFFloat ambientIntensity

🧚 Protected Member Functions

virtual const SoFieldData * getFieldData (void) const — hands over the field data, protected vibes 💜
virtual ~SoVRMLDirectionalLight () — the destructor, she's virtual and she's protected 🎀

🌸 Protected Member Functions inherited from `SoVRMLLight`

SoVRMLLight (void)
virtual ~SoVRMLLight ()

🌸 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)
virtual ~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) — the pointer-to-field-data getter 🫶

💫 Static Protected Member Functions inherited from `SoVRMLLight`

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,
    COIN_3_0 = 0x8000, INVENTOR_6_0 = 0x10000 }

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 = 1
static int nextActionMethodIndex = 0

🦋 Detailed Description 🦋

The SoVRMLDirectionalLight class is a node type for specifying directional light sources. (yes, again, she said it twice, she's consistent 💅)

📜 The detailed class documentation is taken verbatim from the VRML97 standard (ISO/IEC 14772-1:1997). It is copyright The Web3D Consortium, and is used by permission of the Consortium:

DirectionalLight {
  exposedField SFFloat ambientIntensity  0        # [0,1]
  exposedField SFColor color             1 1 1    # [0,1]
  exposedField SFVec3f direction         0 0 -1   # (-inf,inf)
  exposedField SFFloat intensity         1        # [0,1]
  exposedField SFBool  on                TRUE
}

The DirectionalLight node defines a directional light source that illuminates along rays parallel to a given 3-dimensional vector. A description of the ambientIntensity, color, intensity, and on fields is in 4.6.6, Light sources (http://www.web3d.org/x3d/specifications/vrml/ISO-IEC-14772-VRML97/part1/concepts.html#4.6.6). 📖✨

The direction field specifies the direction vector of the illumination emanating from the light source in the local coordinate system. Light is emitted along parallel rays from an infinite distance away. A directional light source illuminates only the objects in its enclosing parent group. The light may illuminate everything within this coordinate system, including all children and descendants of its parent group. The accumulated transformations of the parent nodes affect the light. DirectionalLight nodes do not attenuate with distance. A precise description of VRML's lighting equations is contained in 4.14, Lighting model (http://www.web3d.org/x3d/specifications/vrml/ISO-IEC-14772-VRML97/part1/concepts.html#4.6.14). 🔥

part 2 is coming bestie, don't you dare close the tab 🫶

🎀 Constructor & Destructor Documentation 🎀

✨ `SoVRMLDirectionalLight::SoVRMLDirectionalLight (void )`

okay bestie, this right here? It's the constructor. Like, it builds the thing. That's it, that's the whole job. 💖

🫧 `SoVRMLDirectionalLight::~SoVRMLDirectionalLight ()` `[protected]`, `[virtual]`

And this? The destructor. She's [protected] and [virtual], so she's not for public consumption — she just cleans up when the object dips. Lowkey iconic. 🦋

🌈 Member Function Documentation 🌈

💅 `SoType SoVRMLDirectionalLight::getTypeId (void ) const` `[virtual]`

So this one hands you the type identification of any object derived from a class that inherits from SoBase. What's it for? Run-time type checking and "downward" casting, periodt.

Usage example, copy it exactly, don't @ me:

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

Now listen — if you're an application programmer wanting to extend the library with new nodes, engines, nodekits, draggers or whatever else, you need to override this method in all your subclasses. Not optional. This is typically done as part of setting up the full type system for extension classes, which usually happens 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. iykyk.

Want more info on writing Coin extensions? Go read the class documentation of the toplevel superclasses for the various class groups. Go off. 📚

Reimplemented from SoVRMLLight.

🌸 `const SoFieldData * SoVRMLDirectionalLight::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. That's the vibe. 🌙

Reimplemented from SoVRMLLight.

🔥 `void SoVRMLDirectionalLight::GLRender (SoGLRenderAction * action)` `[virtual]`

This is the action method for the SoGLRenderAction. It gets called during rendering traversals. Any node that influences the rendering state in any way, or who wants to throw geometry primitives at OpenGL, overrides this method. Main character energy fr fr. 👑

Reimplemented from SoVRMLLight.

🌟 Member Data Documentation 🌟

💡 `SoSFVec3f SoVRMLDirectionalLight::direction`

The light direction. That's the whole note. Simple, clean, slay. ✨

📝 Author

Generated automatically by Doxygen for Coin from the source code. No human wrote this, a robot did, and honestly? She ate. 🤖💅

And that's a wrap on this page! Huge shoutout to Coin, Version 3.1.3, and this lil manual page SoVRMLDirectionalLight(3) — she's been a real one. Byeee 🫶💖🎀

📦 where this page comes from

fedora 43: Coin3-devel 3.1.3-40.fc43 · GPL-2.0-only
fedora 43: Coin3-devel 3.1.3-40.fc43 · GPL-2.0-only
fedora 44: Coin3-devel 3.1.3-42.fc44 · GPL-2.0-only
fedora 44: Coin3-devel 3.1.3-42.fc44 · GPL-2.0-only
💖 girlified by deepseek-ai/DeepSeek-V4.1-Flash on 2026-10-14: a language model's rewrite of the original, under its terms

SoVRMLDirectionalLight(3)