SoPointLight(3)

πŸ“¦
version 4.0.10 Β· 4 versions
, in fedora 43, fedora 44

πŸŽ€ NAME πŸŽ€

okay so welcome to SoPointLight(3) bestie πŸ’– β€” this one is a node type for light sources. that's the whole vibe, that's the assignment. a light. that's a point. iconic.


✨ SYNOPSIS ✨

first things first, you gotta pull in the header or nothing happens, fr fr:

#include <Inventor/nodes/SoPointLight.h>

Inherits SoLight.

Inherited by SoPointLightManip.

so like, SoPointLight is the child of SoLight, and SoPointLightManip is the child of this. it's giving family tree 🌳

🫢 Public Member Functions

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

πŸ’… Public Member Functions inherited from SoLight

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

and isOfType is the one that returns TRUE if the type of this object is either of the same type or inherited from type. so basically "are you one of us or descended from us" 🫢

🌈 Static Public Member Functions

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

and initClass sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system. no cap, it's the lil setup ritual ✨

⭐ Static Public Member Functions inherited from SoLight

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

same deal β€” initClass sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system.

🧚 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 SbUniqueId 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)

(and yeah, that initClass one again sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system. it's a recurring main character πŸ’…)

πŸ“ 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)

two little notes from the og page, bestie:

  • initClass sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system.
  • getClassTypeId is a static method that returns the SoType object associated with objects of this class.

πŸ”₯ 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)
  • initClass sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system.
  • getClassTypeId is the static method that returns the SoType object associated with objects of this class.

🌟 Public Attributes

SoSFVec3f location

🌸 Public Attributes inherited from SoLight

SoSFBool on
SoSFFloat intensity
SoSFColor color

πŸŽ€ Protected Member Functions

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
virtual SoNotRec createNotRec (void)

✨ 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

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,
  COIN_4_0 = 0x20000
}

🎁 Protected Types inherited from SoBase

enum BaseFlags { IS_ENGINE = 0x01, IS_GROUP = 0x02 }

🧁 Protected Attributes inherited from SoNode

SbUniqueId uniqueId

🍬 Protected Attributes inherited from SoFieldContainer

SbBool isBuiltIn

🍭 Static Protected Attributes inherited from SoNode

static SbUniqueId nextUniqueId = 1
static int nextActionMethodIndex = 0

πŸ’‘ Detailed Description πŸ’‘

so, the SoPointLight class is a node type for light sources. that's the name, that's the game.

point lights emit light equally in all directions from a specified 3D location. like a lil sparkly orb of glow in your scene, radiating in every direction at once. so main character of it ✨

also β€” and this is important bestie β€” see the documentation of the parent class for important information regarding light sources in general. don't skip it, it's required reading, iykyk 🫢

FILE FORMAT/DEFAULTS:

PointLight {
    on TRUE
    intensity 1
    color 1 1 1
    location 0 0 1
}
look at those defaults being all cozy. on is TRUE, intensity is 1, color is 1 1 1 (that's white, bestie, pure white πŸ’€βœ¨), and location is 0 0 1.

πŸ› οΈ Constructor & Destructor Documentation πŸ› οΈ

πŸŽ€ SoPointLight::SoPointLight (void )

Constructor. that's it. that's the note. it makes the thing πŸ’…

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

Destructor. protected and virtual, so she's not for just anyone to call. she cleans up when the vibe is over 😭

πŸ’– MEMBER FUNCTION DOCUMENTATION πŸ’–

okay bestie, this is the part where we meet all the lil methods that make this light glow. no cap, every single one is here, don't skip. 🫢


✨ SoType SoPointLight::getClassTypeId (void ) β€” [static] ✨

the ✨static✨ baddie of the family. it hands you back the SoType object that's tied to objects of this exact class. that's it, that's the whole vibe. πŸ’…


πŸ¦‹ SoType SoPointLight::getTypeId (void ) const β€” [virtual] πŸ¦‹

this one gives you the type ID of any object that comes from a class inheriting SoBase. it's the whole reason runtime type checking works, and it's how the "downward" casting magic happens. lowkey essential, fr fr. πŸ”₯

  • Reimplemented from SoLight.
  • Reimplemented in SoPointLightManip.

πŸŽ€ const SoFieldData ** SoPointLight::getFieldDataPtr (void ) β€” [static], [protected] πŸŽ€

sooo this API member is considered internal to the library, because it's not likely to be of interest to the application programmer. so like… if you're just vibing in app-land, this isn't for you bestie, no hard feelings. πŸ™ˆ

it returns the SoFieldData class that holds all the info about the fields in this node. that's the whole thing. πŸ’œ


🌸 const SoFieldData * SoPointLight::getFieldData (void ) const β€” [protected], [virtual] 🌸

this cutie returns a pointer to the class-wide field data storage object for this particular instance. and heads up: if there are no fields present, it returns NULL. not a vibe, but that's the deal. 😭

  • Reimplemented from SoLight.
  • Reimplemented in SoPointLightManip.

πŸ‘‘ void SoPointLight::GLRender (SoGLRenderAction * action) β€” [virtual] πŸ‘‘

this is the action method for the SoGLRenderAction, and she's kind of the main character ngl. ✨

this gets called during rendering traversals. any node that influences the rendering state in literally any way, or that wants to yeet geometry primitives at OpenGL, overrides this method. iconic behavior honestly. πŸ”₯

  • Reimplemented from SoNode.
  • Reimplemented in SoPointLightManip.

πŸ“ MEMBER DATA DOCUMENTATION πŸ“

πŸ’« SoSFVec3f SoPointLight::location πŸ’«

the 3D position of the light source, bestie. that's where your light is at. 🌈

default value is <0, 0, 1> β€” periodt. πŸ’…


🧚 Author 🧚

Generated automatically by Doxygen for Coin from the source code.

so yeah, no human wrote this one β€” Doxygen did it automatically from the Coin source code. a robot queen. πŸ‘‘


and that's the whole page, bestie!! you made it to the end, ate and left no crumbs fr fr. πŸ«ΆπŸ’– this was version 4.0.10, dated Thu Jun 25 2026 00:00:00, and you were reading SoPointLight(3). slay, go light up something (responsibly) βœ¨πŸŒŸπŸŽ€

πŸ“¦ where this page comes from