SoVRMLDirectionalLight(3)

📦
version 4.0.10 · 4 versions
, in fedora 43, fedora 44

💖 NAME 💖

okay bestie, say hi to SoVRMLDirectionalLight — yes that's the manual page name too, we're just folding it in here at the top like a lil name tag 🎀

The SoVRMLDirectionalLight class is a node type for specifying directional light sources. it's giving sunlight but make it a node, no cap ☀️✨

✨ SYNOPSIS ✨

lowkey the whole entry point, look:

#include <Inheritor/VRMLnodes/SoVRMLDirectionalLight.h>

wait no bestie, exactly this, character for character:

#include <Inventor/VRMLnodes/SoVRMLDirectionalLight.h>

Inherits SoVRMLLight. so it's part of the light family tree, iconic lineage 💅

🫶 Public Member Functions 🫶

the stuff you get to call directly:

  • virtual SoType getTypeId (void) const — hands you back the type id, classic
  • SoVRMLDirectionalLight (void) — the constructor, aka the glow-up moment
  • virtual void GLRender (SoGLRenderAction *action) — does the actual render thing

🌸 Public Member Functions inherited from SoNode 🌸

all of these come free with the SoNode bloodline:

  • 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)
  • SbUniqueId 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 — Returns TRUE if the type of this object is either of the same type or inherited from type. (iykyk, it's the "are we family" check 💀)
  • 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 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) — Sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system.
  • static void initClasses (void)
  • static SbUniqueId 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) — Sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system.
  • static SoType getClassTypeId (void) — This static method returns the SoType object associated with objects of this class.
  • 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) — Sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system.
  • static SoType getClassTypeId (void) — This static method returns the SoType object associated with objects of this class.
  • 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 👑

the one and only, the main character field:

  • SoSFVec3f direction — points the light, literally

🌟 Public Attributes inherited from SoVRMLLight 🌟

  • SoSFBool on
  • SoSFFloat intensity
  • SoSFColor color
  • SoSFFloat ambientIntensity

🙈 Protected Member Functions 🙈

for the class's inner circle only, don't @ me:

  • virtual const SoFieldData * getFieldData (void) const
  • virtual ~SoVRMLDirectionalLight ()

💫 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
  • virtual SoNotRec createNotRec (void)

🔥 Static Protected Member Functions 🔥

  • static const SoFieldData ** getFieldDataPtr (void)

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

the lil bonus crumbs that came along for the ride:

💀 Public Types inherited from SoNode 💀

the full enum, verbatim, no skips:

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, COIN_4_0 = 0x20000 }

🫧 Protected Types inherited from SoBase 🫧

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

💜 Protected Attributes inherited from SoNode 💜

  • SbUniqueId uniqueId

🌈 Protected Attributes inherited from SoFieldContainer 🌈

  • SbBool isBuiltIn

✨ Static Protected Attributes inherited from SoNode ✨

  • static SbUniqueId nextUniqueId = 1
  • static int nextActionMethodIndex = 0

💡 Detailed Description 💡

Okay bestie, so the SoVRMLDirectionalLight class is a node type for specifying directional light sources. That's the whole vibe. ✨

And fr fr, 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. Credit where credit is due, periodt. 👑

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. And if you wanna know what ambientIntensity, color, intensity, and on are actually doing, a description of those fields lives in 4.6.6, Light sources (http://www.web3d.org/documents/specifications/14772/V2.0/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. 🦋

Not me about to drop the rules of this light's whole existence, so listen up:

  • 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 whole fam. 💅
  • The accumulated transformations of the parent nodes affect the light.
  • DirectionalLight nodes do not attenuate with distance — no fading, no dimming, it stays exactly as bright forever, iconic behaviour honestly.

A precise description of VRML's lighting equations is contained in 4.14, Lighting model (http://www.web3d.org/documents/specifications/14772/V2.0/part1/concepts.html#4.6.14). iykyk. ✨

🎀 Constructor & Destructor Documentation 🎀

SoVRMLDirectionalLight::SoVRMLDirectionalLight (void )

Constructor. That's it, that's the whole note. 💖

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

Destructor. It's protected and virtual, so don't come for it directly, okay?

✨ Member Function Documentation ✨

SoType SoVRMLDirectionalLight::getClassTypeId (void ) [static]

This static method returns the SoType object associated with objects of this class. Slay, type identity. 🫶

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

Returns the type identification of an object derived from a class inheriting SoBase. This is used for runtime type checking and "downward" casting.

Reimplemented from SoVRMLLight.

const SoFieldData ** SoVRMLDirectionalLight::getFieldDataPtr (void ) [static], [protected]

Bestie, heads up: this API member is considered internal to the library, as it is not likely to be of interest to the application programmer. So unless you're deep in the Coin guts, this one's not your moment. 🙈

Returns the SoFieldData class which holds information about fields in this node.

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

Returns a pointer to the class-wide field data storage object for this instance. And if no fields are present, it returns NULL. That's the deal.

Reimplemented from SoVRMLLight.

void SoVRMLDirectionalLight::initClass (void ) [static]

(No description given in the source, so I'm not gonna invent one — that would be a crime and we don't do that here. 💀)

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

Action method for the SoGLRenderAction. 🔥

This is called during rendering traversals. Any nodes that influence the rendering state in any way, or that want to throw geometry primitives at OpenGL, override this method.

Reimplemented from SoVRMLLight.

🌸 Member Data Documentation 🌸

SoSFVec3f SoVRMLDirectionalLight::direction

The light direction. Short, sweet, to the point. ⭐

💜 Author 💜

Generated automatically by Doxygen for Coin from the source code. Not a human author, just the machine doing its thing. 💅

That's the whole page, bestie — this was Version 4.0.10, dated Thu Jun 25 2026 00:00:00, and it's the SoVRMLDirectionalLight(3) manual page, signing off. Go light something up. 💖✨

📦 where this page comes from