SoVRMLLight(3)

📦 version 3.1.3, in fedora 43, fedora 44

💡 NAME 💡

SoVRMLLight — bestie, this is the superclass for VRML light nodes. That's it, that's the whole vibe. It's the parent everyone else inherits from. 👑

This page lives in the Library Functions Manual as SoVRMLLight(3). 🎀

✨ SYNOPSIS ✨

Ok so first things first, you gotta pull in the header:

#include <Inventor/VRMLnodes/SoVRMLLight.h>

Inherits SoNode.

Inherited by SoVRMLDirectionalLight, SoVRMLPointLight, and SoVRMLSpotLight. (Yes queen, the whole light squad pulls up under this one. 👯)

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

These are the actual fields, the moment:

SoSFBool on
SoSFFloat intensity
SoSFColor color
SoSFFloat ambientIntensity

🔒 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

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

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 📖

Ok so real talk: the SoVRMLLight class is a superclass for VRML light nodes. It's the blueprint. The other lights look at it and go "mother." 💅

🎀 Constructor & Destructor Documentation 🎀

SoVRMLLight::SoVRMLLight (void ) [protected]

Constructor. ✨ It makes one. That's the whole job.

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

Destructor. 🫧 It cleans up after itself when the vibes are over.

🔥 Member Function Documentation 🔥

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

Returns the type identification of an object derived from a class inheriting SoBase. This is what the library uses for run-time type checking and "downward" casting. (iykyk 🧚)

Usage example:

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. No skipping, bestie. 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.

Reimplemented in SoVRMLDirectionalLight, SoVRMLPointLight, and SoVRMLSpotLight.

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

Returns a pointer to the class-wide field data storage object for this instance. If no fields are present, it returns NULL. 🫙 (Empty bowl energy, but make it valid.)

Reimplemented from SoFieldContainer.

Reimplemented in SoVRMLDirectionalLight, SoVRMLPointLight, and SoVRMLSpotLight.

void SoVRMLLight::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 want to throw geometry primitives at OpenGL, override this method. 🎨✨

Reimplemented from SoNode.

Reimplemented in SoVRMLDirectionalLight, SoVRMLPointLight, and SoVRMLSpotLight.

bestie this page is a two-parter, so don't go anywhere — part 2 is coming and it's giving continuation. 🌈

💖 Member Data Documentation 💖

okay bestie, this is the part where we meet the actual data members — the little fields living inside every SoVRMLLight node that you get to poke at. they're all public SoSF* fields, which means you set them directly and the scene graph just… knows. no cap. 🫶

✨ SoSFBool SoVRMLLight::on ✨

this one is literally the light switch. it enables or disables the light.

  • default value: TRUE — yes queen, the light is on by default, she's already glowing 💡

so if you want your light to just not, flip on to FALSE and she'll go sit down quietly.

✨ SoSFFloat SoVRMLLight::intensity ✨

the light intensity, bestie. how much she's shining.

  • takes a value from 0 to 1
  • default value: 1

so the default is full blast, maximum main character energy, and you dial it down from there. 🔥

✨ SoSFColor SoVRMLLight::color ✨

the light color. that's it, that's the field. what color is the glow, girlie.

  • default value: (1, 1, 1)

which is white — pure, unfiltered, all the vibes at once. 🌈

✨ SoSFFloat SoVRMLLight::ambientIntensity ✨

the light ambient intensity — the soft background-y glow part of it.

  • takes a value from 0 to 1
  • default value: 0

so by default there's zero ambient contribution, just the pure directional-ish light doing its thing. bump it up if you want that gentle, ambient, cozy-room vibe. 🕯️

👑 Author 👑

Generated automatically by Doxygen for Coin from the source code.

ngl the author is a robot and she ate, we love a hands-off documentation pipeline. 💅

and that's a wrap on SoVRMLLight(3) bestie!! this page came from Coin, Version 3.1.3, and that lil SoVRMLLight(3) down at the bottom is the man page section number — iconic, legendary, no notes. go light up your scene, you've got this 🦋✨🎀

📦 where this page comes from