SoSpotLight(3)

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

🎀 NAME 🎀

SoSpotLight — okay bestie, this is the SoSpotLight class, and it's a node type for light sources with a cone shaped light volume. That's the whole girl. A light, but make it cone. 💡✨

(For the record, this page lives in the Coin manual, section 3. Now you know. 🫶)

🦋 SYNOPSIS 🦋

First things first, you gotta bring her into the room:

#include <Inventor/nodes/SoSpotLight.h>

She Inherits SoLight. 💖

She is Inherited by SoShadowSpotLight, and SoSpotLightManip. So yeah, she's a whole mother. The lineage is giving royalty. 👑

💅 Public Member Functions 💅

  • virtual SoType getTypeId (void) const — the type check moment, she knows exactly who she is.
  • SoSpotLight (void) — the constructor, hi bestie.
  • virtual void GLRender (SoGLRenderAction *action) — renders, as one does. 🔥

✨ 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 — Returns TRUE if the type of this object is either of the same type or inherited from type.
  • 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) — 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 SoLight ⭐

  • static SoType getClassTypeId (void)
  • 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 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.
  • 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.
  • 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 🍓

These are the ones that belong to her, the moment, the main character energy:

  • SoSFVec3f location
  • SoSFVec3f direction
  • SoSFFloat dropOffRate
  • SoSFFloat cutOffAngle

🌸 Public Attributes inherited from SoLight 🌸

  • SoSFBool on
  • SoSFFloat intensity
  • SoSFColor color

🛡️ Protected Member Functions 🛡️

  • virtual const SoFieldData * getFieldData (void) const
  • virtual ~SoSpotLight () — the destructor, rest in peace queen 💀

🛡️ 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 💡

Okay so, say it with me: the SoSpotLight class is a node type for light sources with a cone shaped light volume. That's the whole assignment. 💅

Spotlights are light sources with a position and a direction. Picture it: they can be thought of as a point light with a lampshade. Yes. A little lampshade. She's got range, she's got focus, she's literally directing the vibe. 🔥

Also bestie — see the documentation of the parent class, because there's important information regarding light sources in general over there. Don't skip it, fr fr. 🙈

FILE FORMAT/DEFAULTS:

SpotLight {
    on TRUE
    intensity 1
    color 1 1 1
    location 0 0 1
    direction 0 0 -1
    dropOffRate 0
    cutOffAngle 0.78539819
}

👀 See also 👀

  • SoSpotLight

(no cap, that's what it says)

🎀 Constructor & Destructor Documentation 🎀

  • SoSpotLight::SoSpotLight(void) — the constructor, bestie. It's giving "birth of a spotlight" ✨
  • SoSpotLight::~SoSpotLight() — [protected], [virtual] — and this one's the destructor. Gotta clean up when the party's over 💅

💖 Member Function Documentation 💖

  • SoType SoSpotLight::getClassTypeId(void) [static] — this static lil method hands you back the SoType object that's associated with objects of this class. iykyk 🫶
  • SoType SoSpotLight::getTypeId(void) const [virtual] — returns the type identification of an object derived from a class inheriting SoBase. It's literally the thing that makes runtime type checking and "downward" casting possible, no cap.
    • Reimplemented from SoLight.
    • Reimplemented in SoShadowSpotLight, and SoSpotLightManip.
  • const SoFieldData ** SoSpotLight::getFieldDataPtr(void) [static], [protected] — okay so this API member is considered internal to the library, fr fr, because it's not likely to be of interest to the application programmer.

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

  • const SoFieldData * SoSpotLight::getFieldData(void) const [protected], [virtual] — returns a pointer to the class-wide field data storage object for this instance. And if there are no fields present? It returns NULL. Periodt. 💀
    • Reimplemented from SoLight.
    • Reimplemented in SoShadowSpotLight, and SoSpotLightManip.
  • void SoSpotLight::GLRender(SoGLRenderAction * action) [virtual] — this is the action method for the SoGLRenderAction.

It gets called during rendering traversals, bestie. Any node that influences the rendering state in any way, or wants to throw geometry primitives at OpenGL, overrides this method. Main character energy only 🌈

  • Reimplemented from SoNode.
  • Reimplemented in SoShadowSpotLight, and SoSpotLightManip.

🌸 Member Data Documentation 🌸

  • SoSFVec3f SoSpotLight::location — the 3D position of the light source. The default position is <0, 0, 1>. Iconic ✨
  • SoSFVec3f SoSpotLight::direction — the direction vector, aka where the light is actually pointing. Default is to point along the negative Z-axis. She knows where she's going 💅
  • SoSFFloat SoSpotLight::dropOffRate — the rate of intensity drop-off from the ray along the direction vector. The value has to be between 0.0 (equal intensity for the whole cone of light) and 1.0 (a narrow intensity ray).

Default value is 0.0. 🍓

  • SoSFFloat SoSpotLight::cutOffAngle — the angle in radians from the direction vector where there will be no light outside — basically the angle of the "lampshade". Default value is PI/4.0 (i.e. 45°). Heads up though: the value of this field gets clamped to [0.0, PI/2] before it's used. So don't try it 🔥

👑 Author 👑

Generated automatically by Doxygen for Coin from the source code. Not me hand-writing it, the robot did it, and honestly? Slay.

Okay that's the whole page, bestie!! 💖✨ This was Version 4.0.10, dated Thu Jun 25 2026 00:00:00, and it's the manual page for SoSpotLight(3). Go forth and light up your 3D scenes, you gorgeous genius 🦋💜

📦 where this page comes from