SoLightModel(3)

📦 version 2.5.0, in fedora 43, fedora 44

💖 NAME 💖

SoLightModel — bestie, this is the SoLightModel(3) page and it's literally the class that decides how lighting treats your geometry. No cap.

The SoLightModel class is a node for specifying the model for geometry lighting. That's the whole job. It's giving "one field, very important" energy. 👑

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

💅 Public Member Functions

virtual SoType getTypeId (void) const — the type-id getter, virtual and const, iconic as always.
SoLightModel (void) — the constructor, obvi.
virtual void doAction (SoAction *action) — runs the whole action-dispatch situation.
virtual void GLRender (SoGLRenderAction *action) — the GL render path.
virtual void callback (SoCallbackAction *action) — the callback path.

🌸 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 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) — grab the class type id, static style.
static void initClass (void) — do the class init. You know the drill.

💜 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

SoSFEnum model — the one and only field, bestie. It's an SoSFEnum named model. That's the whole personality.

🙈 Protected Member Functions

virtual const SoFieldData * getFieldData (void) const — protected field-data getter, virtual.
virtual ~SoLightModel () — the destructor, protected and virtual.

💀 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) — the static field-data pointer getter.

🦋 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

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 SoLightModel class is a node for specifying the model for geometry lighting. Say it with me. It sets the vibe for lighting. 💅

Use nodes of this type to set up how lighting should affect subsequent geometry in the scene. So wherever you drop one of these, everything after it in the scene graph is under its lighting regime. Main character energy, honestly.

FILE FORMAT/DEFAULTS:

LightModel {
    model PHONG
}

🧚 Member Enumeration Documentation 🧚

⭐ enum SoLightModel::Model

Enumerates available light models. Just the two. A whole menu of two. Slay.

🎀 Enumerator

BASE_COLOR — use the current diffuse material color for subsequent geometry, and do not let any lightsources influence the appearance of the rendering primitives. Basically: lights, who? Never heard of her. 🙈
PHONG — use Phong-style shading for the geometry. The classic glow-up. ✨

🫶 Constructor & Destructor Documentation 🫶

💖 SoLightModel::SoLightModel (void )

Constructor. Does constructor things. 💅

References BASE_COLOR, model, PHONG, and SoLightModel().

Referenced by getFieldData(), and SoLightModel().

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

Destructor. Protected. Virtual. It's giving mysterious. 🌸

💖 Member Function Documentation 💖

✨ `SoType SoLightModel::getTypeId (void ) const` ✨ [virtual]

Okay bestie, this one is the ✨identity check✨ of the whole Coin universe. It hands you back the type identification of any object derived from a class that inherits SoBase. What's it for? Run-time type checking and "downward" casting, obviously. 👑

Usage example, and yes you're getting the whole thing, character for character, because it's iconic:

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

Now listen, if you're an application programmer who wants to extend the library with new nodes, engines, nodekits, draggers or whatever else you're dreaming up 🦋 — this method needs to be overridden in all subclasses. Not optional, not a vibe, it's a requirement. You typically do it as part of setting up the full type system for extension classes, and that's usually accomplished by using the pre-defined macros available through, for instance, Inventor/nodes/SoSubNode.h (that's SO_NODE_INIT_CLASS and SO_NODE_CONSTRUCTOR for node classes), Inventor/engines/SoSubEngine.h (for engine classes) and so on. 🎀

Want more info on writing Coin extensions? Go read the class documentation of the toplevel superclasses for the various class groups. It's giving homework but it's good homework, fr fr.

Implements SoBase.

✨ `const SoFieldData * SoLightModel::getFieldData (void ) const` ✨ [protected], [virtual]

This one returns a pointer to the class-wide field data storage object for this instance. Cute, right? And if there are no fields present? It returns NULL. That's it. That's the whole thing. 💅

Reimplemented from SoFieldContainer.

References SoLightModel().

✨ `void SoLightModel::doAction (SoAction * action)` ✨ [virtual]

This function performs the typical operation of a node for any action. It's the main character doing main character things. 🌟

Reimplemented from SoNode.

References SoOverrideElement::getLightModelOverride(), SoAction::getState(), SoNode::isOverride(), model, and SoOverrideElement::setLightModelOverride().

Referenced by callback(), and GLRender().

✨ `void SoLightModel::GLRender (SoGLRenderAction * action)` ✨ [virtual]

Action method for the SoGLRenderAction. 👑

This gets called during rendering traversals. Any node that influences the rendering state in any way — or that wants to throw geometry primitives at OpenGL — overrides this method. So if that's your node's whole thing, this is your moment, bestie. Slay. 🔥

Reimplemented from SoNode.

References doAction().

✨ `void SoLightModel::callback (SoCallbackAction * action)` ✨ [virtual]

Action method for SoCallbackAction.

It simply updates the state according to how the node behaves for the render action, so that the application programmer can use the SoCallbackAction for extracting information about the scene graph. Very demure, very mindful, very "just here to keep the state consistent." 🫶

Reimplemented from SoNode.

References doAction().

🌸 Member Data Documentation 🌸

✨ `SoSFEnum SoLightModel::model` ✨

The lightmodel to use. Defaults to SoLightModel::PHONG. That's the whole personality of this member. Set it and the vibe changes accordingly. 💜

Referenced by doAction(), and SoLightModel().

🎀 Author 🎀

Generated automatically by Doxygen for Coin from the source code. Not me writing it by hand, no cap — the robot did it and honestly it ate. 🤖✨

And that's a wrap on SoLightModel(3) bestie!! This iconic little page comes to you courtesy of Coin, Version 2.5.0, and yeah the footer stamps it as the SoLightModel(3) man page itself. Go forth and light your models correctly. Periodt. 💅🌈⭐

📦 where this page comes from

fedora 43: Coin2-devel 2.5.0-52.fc43 · GPL-2.0-only
fedora 43: Coin2-devel 2.5.0-52.fc43 · GPL-2.0-only
fedora 44: Coin2-devel 2.5.0-54.fc44 · GPL-2.0-only
fedora 44: Coin2-devel 2.5.0-54.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

SoLightModel(3)

💖 NAME 💖

✨ SYNOPSIS ✨

🎀 Public Types

🦋 Public Types inherited from SoNode

💅 Public Member Functions

🌸 Public Member Functions inherited from SoNode

🌈 Public Member Functions inherited from SoFieldContainer

🫶 Public Member Functions inherited from SoBase

⭐ Static Public Member Functions

💜 Static Public Member Functions inherited from SoNode

🧚 Static Public Member Functions inherited from SoFieldContainer

🍓 Static Public Member Functions inherited from SoBase

👑 Public Attributes

🙈 Protected Member Functions

💀 Protected Member Functions inherited from SoNode

🌸 Protected Member Functions inherited from SoFieldContainer

✨ Protected Member Functions inherited from SoBase

🎀 Static Protected Member Functions

🦋 Static Protected Member Functions inherited from SoNode

🌈 Static Protected Member Functions inherited from SoBase

💜 Additional Inherited Members

Protected Types inherited from SoBase

Protected Attributes inherited from SoNode

Protected Attributes inherited from SoFieldContainer

Static Protected Attributes inherited from SoNode

🔥 Detailed Description 🔥

🧚 Member Enumeration Documentation 🧚

⭐ enum SoLightModel::Model

🎀 Enumerator

🫶 Constructor & Destructor Documentation 🫶

💖 SoLightModel::SoLightModel (void )

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

💖 Member Function Documentation 💖

✨ SoType SoLightModel::getTypeId (void ) const ✨ [virtual]

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

✨ void SoLightModel::doAction (SoAction * action) ✨ [virtual]

✨ void SoLightModel::GLRender (SoGLRenderAction * action) ✨ [virtual]

✨ void SoLightModel::callback (SoCallbackAction * action) ✨ [virtual]

🌸 Member Data Documentation 🌸

✨ SoSFEnum SoLightModel::model ✨

🎀 Author 🎀

✨ `SoType SoLightModel::getTypeId (void ) const` ✨ [virtual]

✨ `const SoFieldData * SoLightModel::getFieldData (void ) const` ✨ [protected], [virtual]

✨ `void SoLightModel::doAction (SoAction * action)` ✨ [virtual]

✨ `void SoLightModel::GLRender (SoGLRenderAction * action)` ✨ [virtual]

✨ `void SoLightModel::callback (SoCallbackAction * action)` ✨ [virtual]

✨ `SoSFEnum SoLightModel::model` ✨