SoVRMLLight(3)
okay so real talk bestie, this is the manpage for <code>SoVRMLLight(3)</code> from the Library Functions Manual, and it is LONG so we're doing it in two parts 💖 part 1 starts now, don't go anywhere
✨ NAME ✨
SoVRMLLight — the glow-up superclass for VRML light nodes 💡✨
Like, every VRML light in the whole family tree inherits its whole vibe from this one. She's the blueprint, the blueprint queen, the blueprint moment. 👑
🦋 SYNOPSIS 🦋
#include <Inventor/VRMLnodes/SoVRMLLight.h>Inherits SoNode.
Inherited by SoVRMLDirectionalLight, SoVRMLPointLight, and SoVRMLSpotLight.
So yeah — she's got her parent (SoNode) and she's got three iconic daughters. Family business. 🫶
💅 Public Member Functions
virtual SoType getTypeId (void) const— hands you back her type ID, like a little name tag but for the type system 🏷️virtual void GLRender (SoGLRenderAction *action)— the actual rendering moment, she does the GL thing when the action comes knocking ✨
🌸 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 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=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)— the class-wide type ID, no instance needed, she's just that accessible 💫static void initClass (void)— sets the whole class up. You gotta call her before she can shine, fr fr 🛠️
🌈 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
SoSFBool on— is the light even on?? on/off, the whole plot twist 🔛SoSFFloat intensity— how much glow, the drama dial 🔥SoSFColor color— what color the glow is, the aesthetic choice 🎨SoSFFloat ambientIntensity— the ambient glow level, the subtle background mood ✨
🫶 Protected Member Functions
virtual const SoFieldData * getFieldData (void) const— hands over the field data 🗂️SoVRMLLight (void)— constructor (protected, so she's shy about it)virtual ~SoVRMLLight ()— destructor
💖 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 field-data pointer, protected but iconic 🔐
💫 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 }🔒 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 🌸
Okay so the whole entire point of SoVRMLLight: she is a superclass for VRML light nodes. That's it, that's her job, and she does it flawlessly, no notes 💅
🎀 Constructor & Destructor Documentation 🎀
🌷 SoVRMLLight::SoVRMLLight (void ) [protected]
Constructor. ✨
ReferencesambientIntensity,color,intensity,on, andSoVRMLLight().
Referenced bygetFieldData(), andSoVRMLLight().
🌷 SoVRMLLight::~SoVRMLLight () [protected], [virtual]
Destructor. She's logging off, but gracefully 😌
and that's part 1 bestie — hold on, there's MORE coming, don't close the tab 😭
💖 MEMBER FUNCTION DOCUMENTATION 💖
✨ SoType SoVRMLLight::getTypeId (void ) const [virtual] ✨
okay bestie so this one hands you back the type identification of any object that descends from SoBase. what's it for? run-time type checking, and "downward" casting — iykyk 💅
usage example, look at her:
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 for the app programmers who wanna extend the library with brand-new nodes, engines, nodekits, draggers or whatever else: this method needs to be overridden in all subclasses. no skipping, bestie, it's a whole thing. typically you do it as part of setting up the full type system for your extension classes, and that's usually accomplished by using the pre-defined macros you can get 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 the full tea on writing Coin extensions? go read the class documentation of the toplevel superclasses for the various class groups. 📚
Implements SoBase.
Reimplemented in SoVRMLDirectionalLight, SoVRMLPointLight, and SoVRMLSpotLight. (they said "same energy" and copied her homework, iconic)
✨ const SoFieldData * SoVRMLLight::getFieldData (void ) const [protected], [virtual] ✨
this one returns a pointer to the class-wide field data storage object for this instance. and if there are literally no fields present? she returns NULL. that's it, that's the whole vibe. 🙈
Reimplemented from SoFieldContainer.
Reimplemented in SoVRMLDirectionalLight, SoVRMLPointLight, and SoVRMLSpotLight.
References SoVRMLLight().
✨ void SoVRMLLight::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. main character behaviour only. 👑
Reimplemented from SoNode.
Reimplemented in SoVRMLDirectionalLight, SoVRMLPointLight, and SoVRMLSpotLight.
🌸 MEMBER DATA DOCUMENTATION 🌸
🎀 SoSFBool SoVRMLLight::on 🎀
enable/disable the light. default value is TRUE. so yeah, she's on by default — she woke up and chose violence (light). 💡
Referenced by SoVRMLDirectionalLight::GLRender(), SoVRMLPointLight::GLRender(), SoVRMLSpotLight::GLRender(), and SoVRMLLight().
🎀 SoSFFloat SoVRMLLight::intensity 🎀
the light intensity. a value from 0 to 1. default value is 1. full glow-up, no cap. 🔥
Referenced by SoVRMLDirectionalLight::GLRender(), SoVRMLPointLight::GLRender(), SoVRMLSpotLight::GLRender(), and SoVRMLLight().
🎀 SoSFColor SoVRMLLight::color 🎀
the light color. default value is (1, 1, 1) — that's plain white, the clean-girl no-makeup makeup of colors. 🤍
Referenced by SoVRMLDirectionalLight::GLRender(), SoVRMLPointLight::GLRender(), SoVRMLSpotLight::GLRender(), and SoVRMLLight().
🎀 SoSFFloat SoVRMLLight::ambientIntensity 🎀
the light ambient intensity. a value from 0 to 1. default value is 0. she starts at zero, humble era. 🌈
Referenced by SoVRMLDirectionalLight::GLRender(), SoVRMLPointLight::GLRender(), SoVRMLSpotLight::GLRender(), and SoVRMLLight().
🦋 AUTHOR 🦋
Generated automatically by Doxygen for Coin from the source code. (not a human, just a little robot doing her best, and honestly? she ate. 💅)
and that's a wrap on SoVRMLLight(3), bestie!! 🎀 this whole thing came from Coin, Version 2.5.0, straight out of the source code. go forth and light up your scene, 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 : a language model's rewrite of the original, under its terms