SoVRMLLight(3)

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

💖 SoVRMLLight 💖

okay bestie, welcome to the Coin manual page for SoVRMLLight(3) — yes it's a whole manpage, yes it's section 3, and yes we're gonna get through it together. grab a boba. 🧋

✨ NAME ✨

SoVRMLLight — the superclass for VRML light nodes. it's giving "mom of the light family". 👑

🌈 SYNOPSIS 🌈

#include <Inheritor/VRMLnodes/SoVRMLLight.h>

wait no, it's literally:

#include <Inventor/VRMLnodes/SoVRMLLight.h>

Inherits</purl> SoNode.

Inherited by SoVRMLDirectionalLight, SoVRMLPointLight, and SoVRMLSpotLight. the whole light squad fr fr. 🔥

🌸 Public Member Functions

  • virtual SoType getTypeId (void) const
  • virtual void GLRender (SoGLRenderAction *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=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. (yes it's a vibe check for types 💅)
  • 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 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. (the little "get ready bestie" ritual 🎀)
  • 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 💅

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

these four are the moment. the whole glow-up. ✨

🎀 Protected Member Functions 🎀

  • virtual const SoFieldData * getFieldData (void) const
  • 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 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, 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 🌈

the SoVRMLLight class is a superclass for VRML light nodes. that's the whole thing. she's the blueprint, the blueprint-iest blueprint, and the other lights look up to her. 💅

🎀 Constructor & Destructor Documentation 🎀

💖 SoVRMLLight::SoVRMLLight (void ) [protected]

constructor. ✨ (protected, so bestie, you don't just new her up in the wild — she's for the subclasses.)

💖 SoVRMLLight::~SoVRMLLight () [protected], [virtual]

destructor. 😭 virtual, protected, the whole farewell tour.

💖 Member Function Documentation 💖

SoType SoVRMLLight::getClassTypeId (void ) [static]</p>

Okay bestie, this static method hands you back the SoType object that's associated with objects of this class. That's it, that's the whole job. ✨

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

This one gives you the type identification of an object derived from a class inheriting SoBase. What's it for, you ask? Runtime type checking and "downward" casting, bestie — the classic "wait, what are you actually" move. 👑

  • Implements SoBase.
  • Reimplemented in SoVRMLDirectionalLight, SoVRMLPointLight, and SoVRMLSpotLight.

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

So this API member is considered internal to the library — like, it's not likely to be of interest to the application programmer, no cap. 🙈

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

const SoFieldData * SoVRMLLight::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 SoFieldContainer.
  • Reimplemented in SoVRMLDirectionalLight, SoVRMLPointLight, and SoVRMLSpotLight.

void SoVRMLLight::initClass (void ) [static]

(no description given, she's mysterious like that 🧚)

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

Action method for the SoGLRenderAction. 🔥

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

  • Reimplemented from SoNode.
  • Reimplemented in SoVRMLDirectionalLight, SoVRMLPointLight, and SoVRMLSpotLight.

🌸 Member Data Documentation 🌸

SoSFBool SoVRMLLight::on

Enable/disable light. Default value is TRUE. The light is on by default — she showed up ready. 💅

SoSFFloat SoVRMLLight::intensity

The light intensity. A value from 0 to 1. Default value is 1.

SoSFColor SoVRMLLight::color

The light color. Default value is (1, 1, 1). White light, classic, iconic, never misses. ⭐

SoSFFloat SoVRMLLight::ambientIntensity

The light ambient intensity. A value from 0 to 1. Default value is 0.

🎀 Author 🎀

Generated automatically by Doxygen for Coin from the source code. (Doxygen said "I got this" and honestly, she did. 🫶)

Version 4.0.10, dated Thu Jun 25 2026 00:00:00, and the page is SoVRMLLight(3). That's the whole thing bestie, you ate it up, now go render some lights. 💖✨🦋
📦 where this page comes from