SoVRMLSpotLight(3)

📦
version 4.0.10 · 4 versions
, in fedora 43, fedora 44

💖 NAME 💖

SoVRMLSpotLight — bestie, this is the class that defines a spot light source. Like, a literal spotlight. Cone of light. Drama. Main character energy for your 3D scene. ✨

🎀 SYNOPSIS 🎀

#include <Inventor/VRMLnodes/SoVRMLSpotLight.h>

Inherits SoVRMLLight. So it's got that light-source bloodline, iykyk. 💅

✨ Public Member Functions ✨

  • virtual SoType getTypeId (void) const
  • SoVRMLSpotLight (void)
  • 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)
  • 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 — returns TRUE if the type of this object is either of the same type or inherited from type. Slay, polymorphism.
  • 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 SoVRMLLight

  • 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) — sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system. Basically the class's little getting-ready routine. 💅
  • 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)

🍓 Static Public Member Functions inherited from SoFieldContainer

  • static void initClass (void) — sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system. Same energy as above, different class. 💖
  • static SoType getClassTypeId (void) — this static method returns the SoType object associated with objects of this class.
  • 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) — sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system.
  • static SoType getClassTypeId (void) — this static method returns the SoType object associated with objects of this class.
  • 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 🔥

  • SoSFVec3f location
  • SoSFVec3f direction
  • SoSFFloat beamWidth
  • SoSFFloat cutOffAngle
  • SoSFFloat radius
  • SoSFVec3f attenuation

💫 Public Attributes inherited from SoVRMLLight

  • SoSFBool on
  • SoSFFloat intensity
  • SoSFColor color
  • SoSFFloat ambientIntensity

🎀 Protected Member Functions 🎀

  • virtual const SoFieldData * getFieldData (void) const
  • virtual ~SoVRMLSpotLight ()

🦋 Protected Member Functions inherited from SoVRMLLight

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

🌟 Static Protected Member Functions 🌟

  • static const SoFieldData ** getFieldDataPtr (void)

🌈 Static Protected Member Functions inherited from SoVRMLLight

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

Look at that bitmask buffet. All the flavours of node types, no cap. 🍽️

💫 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
Okay bestie, that's the whole top half of the page and nothing got skipped — every single signature is right there, verbatim, in its exact home. More of this page is loading next, so stay perched. 💅🦋

✨ Detailed Description ✨

okay so the SoVRMLSpotLight class defines a spot light source. that's the whole vibe. 🔦

the detailed class documentation is taken verbatim from the VRML97 standard (ISO/IEC 14772-1:1997). it is copyright The Web3D Consortium, and is used by permission of the Consortium:

SpotLight {
  exposedField SFFloat ambientIntensity  0         # [0,1]
  exposedField SFVec3f attenuation       1 0 0     # [0,inf)
  exposedField SFFloat beamWidth         1.570796  # (0,pi/2]
  exposedField SFColor color             1 1 1     # [0,1]
  exposedField SFFloat cutOffAngle       0.785398  # (0,pi/2]
  exposedField SFVec3f direction         0 0 -1    # (-inf, inf)
  exposedField SFFloat intensity         1         # [0,1]
  exposedField SFVec3f location          0 0 0     # (-inf, inf)
  exposedField SFBool  on                TRUE
  exposedField SFFloat radius            100       # [0, inf)
}

so the SpotLight node defines a light source that emits light from a specific point along a specific direction vector, and it's constrained within a solid angle. spotlights may illuminate geometry nodes that respond to light sources and intersect the solid angle defined by the SpotLight. Spotlight nodes are specified in the local coordinate system and are affected by ancestors' transformations. 👑

a detailed description of ambientIntensity, color, intensity, and VRML's lighting equations is provided in 4.6.6, Light sources (http://www.web3d.org/documents/specifications/14772/V2.0/part1/concepts.html#4.6.6). more info on lighting concepts can be found in 4.14, Lighting model (http://www.web3d.org/documents/specifications/14772/V2.0/part1/concepts.html#4.14), including a detailed description of the VRML lighting equations. 📚

the fields, one by one bestie 💅

the location field specifies a translation offset of the centre point of the light source from the light's local coordinate system origin. this point is the apex of the solid angle which bounds light emission from the given light source.

the direction field specifies the direction vector of the light's central axis defined in the local coordinate system.

the on field specifies whether the light source emits light. if on is TRUE, the light source is emitting light and may illuminate geometry in the scene. if on is FALSE, the light source does not emit light and does not illuminate any geometry. it's giving off/on switch, iconic.

the radius field specifies the radial extent of the solid angle and the maximum distance from location that may be illuminated by the light source. the light source does not emit light outside this radius. the radius shall be greater than or equal to zero. 🚫

both radius and location are affected by ancestors' transformations (scales affect radius and transformations affect location).

the cutOffAngle field specifies the outer bound of the solid angle. the light source does not emit light outside of this solid angle.

the beamWidth field specifies an inner solid angle in which the light source emits light at uniform full intensity. the light source's emission intensity drops off from the inner solid angle (beamWidth) to the outer solid angle (cutOffAngle) as described in the following equations:

angle = the angle between the Spotlight's direction vector
        and the vector from the Spotlight location to the point
        to be illuminated

if (angle >= cutOffAngle):
  multiplier = 0
else if (angle <= beamWidth):
  multiplier = 1
else:
  multiplier = (angle - cutOffAngle) / (beamWidth - cutOffAngle)

intensity(angle) = SpotLight.intensity × multiplier

if the beamWidth is greater than the cutOffAngle, beamWidth is defined to be equal to the cutOffAngle and the light source emits full intensity within the entire solid angle defined by cutOffAngle. both beamWidth and cutOffAngle shall be greater than 0.0 and less than or equal to pi/2. 📐

Figure 6.16 depicts the beamWidth, cutOffAngle, direction, location, and radius fields of the SpotLight node.

Figure 6.16 -- SpotLight node

SpotLight illumination falls off with distance as specified by three attenuation coefficients. the attenuation factor is

1/max(attenuation[0] + attenuation[1]×r + attenuation[2]×r^2 , 1),

where r is the distance from the light to the surface being illuminated. the default is no attenuation. an attenuation value of (0, 0, 0) is identical to (1, 0, 0). attenuation values shall be greater than or equal to zero. a detailed description of VRML's lighting equations is contained in 4.14, Lighting model (http://www.web3d.org/documents/specifications/14772/V2.0/part1/concepts.html#4.14). 🌈

🎀 Constructor & Destructor Documentation 🎀

SoVRMLSpotLight::SoVRMLSpotLight (void )

Constructor. it makes the thing. ✨

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

Destructor. it unmakes the thing. 🙈

💖 Member Function Documentation 💖

SoType SoVRMLSpotLight::getClassTypeId (void ) [static]

this static method returns the SoType object associated with objects of this class. 🫶

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

returns the type identification of an object derived from a class inheriting SoBase. this is used for runtime type checking and "downward" casting.

Reimplemented from SoVRMLLight.

const SoFieldData ** SoVRMLSpotLight::getFieldDataPtr (void ) [static], [protected]

this API member is considered internal to the library, as it is not likely to be of interest to the application programmer. no cap, it's giving "you probably don't need this one".

returns the SoFieldData class which holds information about fields in this node.

const SoFieldData * SoVRMLSpotLight::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 SoVRMLLight.

void SoVRMLSpotLight::initClass (void ) [static]

(no description in the source, bestie — it's just there doing its thing 🤷)

void SoVRMLSpotLight::GLRender (SoGLRenderAction * action) [virtual]

Action method for the SoGLRenderAction.

this is called during rendering traversals. nodes influencing the rendering state in any way or want to throw geometry primitives at OpenGL override this method.

Reimplemented from SoVRMLLight. 🔥

⭐ Member Data Documentation ⭐

  • SoSFVec3f SoVRMLSpotLight::location — the light position. default value is (0, 0, 0).
  • SoSFVec3f SoVRMLSpotLight::direction — the light direction. default value is (0, 0, 1).
  • SoSFFloat SoVRMLSpotLight::beamWidth — the spot beam width. default value is PI/2.
  • SoSFFloat SoVRMLSpotLight::cutOffAngle — the spot light cut off angle. default value is PI/4.
  • SoSFFloat SoVRMLSpotLight::radius — the light radius. light is not emitted past it. default value is 100.
  • SoSFVec3f SoVRMLSpotLight::attenuation — the attenuiation vector. default value is (1, 0, 0).
ngl the field block up top says direction defaults to 0 0 -1 and beamWidth is 1.570796 while cutOffAngle is 0.785398, and the member data says (0, 0, 1), PI/2 and PI/4. that's literally what the source says, i'm just the messenger bestie 💀 don't come for me.

👑 Author 👑

Generated automatically by Doxygen for Coin from the source code.

that's the whole page, bestie — this was Coin version 4.0.10, dated Thu Jun 25 2026 00:00:00, and it's filed under SoVRMLSpotLight(3). slay, go light something up responsibly. 💖✨🦋

📦 where this page comes from