SoLightModel(3)

πŸ“¦ version 3.1.3, in fedora 43, fedora 44

πŸ’– SoLightModel πŸ’–

okay bestie, welcome to SoLightModel(3) β€” a manual page from the Library Functions Manual, and honestly? she's iconic. this is the node that tells your geometry how to get lit. yes ma'am, lighting model decisions live here πŸ’…


✨ NAME ✨

SoLightModel β€” the node that picks the model for how your geometry gets lit. that's the whole vibe. no cap.


🌸 SYNOPSIS 🌸

#include <Inventor/nodes/SoLightModel.h>

Inherits SoNode.

okay so she's part of the family tree, let me show you the whole guest list πŸ‘‘

πŸŽ€ 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 }

πŸ’œ 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)
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)
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 πŸ‘‘

SoSFEnum model

like. one public attribute and she's the moment. model. that's it. that's the whole girl. πŸŽ€

πŸ’… 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

🌈 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

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 πŸ”₯

okay so the SoLightModel class is a node for specifying the model for geometry lighting. periodt.

you use nodes of this type to set up how lighting should affect subsequent geometry in the scene. like, everything after this node in the scene graph is gonna get lit according to the rules you set here. main character energy fr fr.

FILE FORMAT/DEFAULTS:

LightModel {
    model PHONG
}
🫢 note that PHONG is the default, bestie. she comes out the box ready to shade.

πŸŽ€ Member Enumeration Documentation πŸŽ€

🌟 enum SoLightModel::Model 🌟

enumerates available light models. the options are:

  • BASE_COLOR β€” use the current diffuse material color for subsequent geometry, and do not let any lightsources influence the appearance of the rendering primitives. so basically: flat, unbothered, no lighting opinions. πŸ’…
  • PHONG β€” use Phong-style shading for the geometry. she's smooth, she's shaded, she's glowing. ✨

πŸ’– Constructor & Destructor Documentation πŸ’–

🌸 SoLightModel::SoLightModel (void ) 🌸

Constructor. that's it, that's the whole note. she's born ✨

πŸ¦‹ SoLightModel::~SoLightModel () [protected], [virtual] πŸ¦‹

Destructor. protected AND virtual, so she exits the scene on her own terms. no notes πŸ’…


…and that's literally only part 1 bestie, we're not even done, keep scrolling πŸ’–

πŸŽ€ Member Function Documentation πŸŽ€


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

Okay so bestie, getTypeId() is literally the vibe check for your objects. It returns the type identification of an object derived from a class inheriting SoBase. This is used for run-time type checking and "downward" casting. No cap.

Usage example, periodt:

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

For application programmers wanting to extend the library with new nodes, engines, nodekits, draggers or others: this method needs to be overridden in all subclasses. This is typically done as part of setting up the full type system for extension classes, which is usually accomplished 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.

For more information on writing Coin extensions, see the class documentation of the toplevel superclasses for the various class groups.

Implements SoBase. πŸ’…


πŸ¦‹ 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 who wants to throw geometry primitives at OpenGL overrides this method.

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.

Reimplemented from SoNode. πŸ¦‹


πŸ“ Member Data Documentation πŸ“

πŸ‘‘ SoSFEnum SoLightModel::model πŸ‘‘

Lightmodel to use. Defaults to SoLightModel::PHONG.

Periodt. πŸ’–


✨ Author ✨

Generated automatically by Doxygen for Coin from the source code. 🫢


This lil masterpiece was auto-generated by Doxygen for Coin from the source code, Version 3.1.3, and it's the SoLightModel(3) page. Byeee bestie! πŸ’–βœ¨πŸŽ€

πŸ“¦ where this page comes from