SoPointLight(3)

💖 NAME 💖

okay bestie, you clicked on SoPointLight(3) and honestly? impeccable taste, no notes. the SoPointLight class is a node type for light sources. that's the vibe. that's the whole assignment. periodt ✨

---

🦋 SYNOPSIS 🦋

first up, the include, don't forget her:

#include <Inventor/nodes/SoPointLight.h>

she inherits SoLight 💜

and she is inherited by SoPointLightManip — yes, a whole manipulator nepo baby, iykyk 👑

💅 Public Member Functions

here's what she brings to the table all by herself:

virtual SoType getTypeId (void) const
SoPointLight (void)
virtual void GLRender (SoGLRenderAction *action)

🌈 Public Member Functions inherited from SoLight

the stuff she got handed down from her SoLight parent:

virtual void callback (SoCallbackAction *action)

🧚 Public Member Functions inherited from SoNode

everything she inherited from SoNode, and it is a lot, bestie:

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

the SoFieldContainer family heirlooms:

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

and the origin story, straight 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

the static girlies, just for her:

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

💜 Static Public Member Functions inherited from SoLight

same energy, inherited from SoLight:

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

🎀 Static Public Member Functions inherited from SoNode

SoNode's static stash:

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

SoFieldContainer's statics, she's got them too:

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

SoBase statics, the whole crew:

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

the attribute that's actually hers, and it's giving main character:

SoSFVec3f location

🌈 Public Attributes inherited from SoLight

the light-source starter pack from SoLight:

SoSFBool on
SoSFFloat intensity
SoSFColor color

💀 Protected Member Functions

protected, so you know, don't touch unless you know what you're doing:

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

🙈 Protected Member Functions inherited from SoLight

SoLight (void)
virtual ~SoLight ()

🧚 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 SoLight

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

look at all these enum values, she's stacked:

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 💖

okay so, recap because it matters: the SoPointLight class is a node type for light sources.

pointlights emit light equally in all directions from a specified 3D location. she doesn't play favorites, she shines on everyone 🫶

also, bestie, go read the documentation of the parent class — there's important information regarding light sources in general that you genuinely need. don't skip it, it's not optional reading, fr fr.

FILE FORMAT/DEFAULTS:

PointLight {
    on TRUE
    intensity 1
    color 1 1 1
    location 0 0 1
}

---

🌟 Constructor & Destructor Documentation 🌟

💅 SoPointLight::SoPointLight (void )

Constructor. she's born ✨

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

Destructor. she's leaving 💔 (and she's [protected] and [virtual], so mind your business unless you're a subclass)

✨ MEMBER FUNCTION DOCUMENTATION ✨

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

okay so bestie, this one returns the type identification of an object derived from a class inheriting SoBase. It’s giving run-time type checking and “downward” casting energy, fr fr. 🔍

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

• Reimplemented from SoLight.
• Reimplemented in SoPointLightManip.

---

const SoFieldData * SoPointLight::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. No cap, that’s literally the whole vibe. 🫶

• Reimplemented from SoLight.
• Reimplemented in SoPointLightManip.

---

void SoPointLight::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. Main character rendering energy, honestly. 🔥

• Reimplemented from SoNode.
• Reimplemented in SoPointLightManip.

---

🌈 MEMBER DATA DOCUMENTATION 🌈

SoSFVec3f SoPointLight::location

3D position of lightsource. Default value is <0, 0, 1>. 🎀

---

✨ AUTHOR ✨

Generated automatically by Doxygen for Coin from the source code.

---

This iconic page came from Coin Version 3.1.3 and it’s the SoPointLight(3) manual — periodt. 💅✨