SoLightModel(3)

💖 SoLightModel(3) — Coin 💖

okay bestie, welcome to SoLightModel, straight out of the Coin library, section 3 of the manual. it's giving "small node, big responsibility" and i'm obsessed. let's get into it 🫶

---

✨ NAME ✨

SoLightModel — the class that's literally just a node for specifying the model for geometry lighting. that's it. that's the whole job. iconic behavior honestly 💅

---

🌸 SYNOPSIS 🌸

#include <Inventor/nodes/SoLightModel.h>

Inherits SoNode.

🌈 Public Types

enum Model { BASE_COLOR = SoLazyElement::BASE_COLOR, PHONG =
    SoLazyElement::PHONG }

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 }

🦋 Public Member Functions

virtual SoType getTypeId (void) const
SoLightModel (void)
virtual void doAction (SoAction *action)
virtual void GLRender (SoGLRenderAction *action)
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=FALSE) const
virtual SbBool affectsState (void) const
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)
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
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

and real quick, isOfType — "Returns TRUE if the type of this object is either of the same type or inherited from type." periodt 💯

💜 Static Public Member Functions

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

okay so initClass "Sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system." slay, it's just doing the setup paperwork for everybody ✨

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

and SoNode::initClass — same deal, "Sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system." no cap 🎀

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)

here initClass is the same setup story, and getClassTypeId "This static method returns the SoType object associated with objects of this class." 💖

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)

yep, initClass again does the setup thing, and getClassTypeId again "This static method returns the SoType object associated with objects of this class." consistent queen 👑

🍓 Public Attributes

SoSFEnum model

🌷 Protected Member Functions

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

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

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 👑

SoLightModel is a node for specifying the model for geometry lighting. bestie that's the assignment, and it ate 💅

use nodes of this type to set up how lighting should affect subsequent geometry in the scene. like, you're literally telling the scene "hey, from here on out, light things this way." main character energy fr fr ✨

FILE FORMAT/DEFAULTS:

LightModel {
    model PHONG
}

lowkey remember this default — it's PHONG. that's the vibe out of the box 🎀

---

🦋 Member Enumeration Documentation 🦋

💖 enum SoLightModel::Model

Enumerates available light models. so you got options, and here they are:

Enumerator

• BASE_COLOR — use the current diffuse material color for subsequent geometry, and do not let any light sources influence the appearance of the rendering primitives. yeah, the lights get benched for these primitives, sorry not sorry 💀
• PHONG — use Phong style shading for the geometry. the classic. the moment. the icon 🌟

---

🌸 Constructor & Destructor Documentation 🌸

💜 SoLightModel::SoLightModel (void )

Constructor.

💜 SoLightModel::~SoLightModel () [protected], [virtual]

Destructor.

---

💅 Member Function Documentation 💅

Okay bestie, this is the part where we meet the actual methods — the little functions that do the work. Every single one, no skipping, let's go. 🫶

---

✨ SoType SoLightModel::getClassTypeId (void ) — static ✨

This static method returns the SoType object associated with objects of this class.

Static means you can just call it on the class itself, no instance required — it's giving "I don't need a whole object to know who I am" energy. 👑

✨ SoType SoLightModel::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.

Lowkey this is the runtime type-checking backbone — it's how the library figures out what something actually is before casting it down the inheritance tree. 🦋

Implements SoBase.

✨ const SoFieldData ** SoLightModel::getFieldDataPtr (void ) — static, protected ✨

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

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

Not me reading "internal to the library" and immediately knowing this one is not for us, bestie. It's giving backstage pass only. 🙈

✨ const SoFieldData * SoLightModel::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 SoFieldContainer.

✨ void SoLightModel::doAction (SoAction * action) — virtual ✨

This function performs the typical operation of a node for any action.

Reimplemented from SoNode.

✨ void SoLightModel::GLRender (SoGLRenderAction * action) — virtual ✨

Action method for the SoGLRenderAction.

This is called during rendering traversals. Nodes influencing the rendering state in any way or want to throw geometry primitives at OpenGL override this method.

Rendering traversal hours, fr fr — if your node wants to touch the render state or yeet geometry at OpenGL, this is the override you're looking for. 🔥

Reimplemented from SoNode.

✨ void SoLightModel::callback (SoCallbackAction * action) — virtual ✨

Action method for SoCallbackAction.

Simply updates the state according to how the node behaves for the render action, so the application programmer can use the SoCallbackAction for extracting information about the scene graph.

Extracting info from the scene graph without actually rendering it? That's the vibe. ✨

Reimplemented from SoNode.

---

🎀 Member Data Documentation 🎀

⭐ SoSFEnum SoLightModel::model ⭐

Light model to use. Defaults to SoLightModel::PHONG.

Periodt. That's the whole field. One enum, one default, no notes. 💅

---

👑 Author 👑

Generated automatically by Doxygen for Coin from the source code.

---

And that's a wrap on part 2, bestie!! 🦋🌸 This whole page is from Coin version 4.0.10, generated Thu Jun 25 2026 00:00:00, and it lives at SoLightModel(3) — go forth and light your scene graphs, you absolute icon. ✨💖🌈