SoSpotLight(3)

📦 version 2.5.0, in fedora 43, fedora 44

SoSpotLight(3) · Library Functions Manual · ok bestie sit down, we're doing light nodes today 🫶

✨ NAME ✨

SoSpotLight — the node type for light sources with a cone shaped lightvolume. literally a spotlight. no cap. 💡

🎀 SYNOPSIS 🎀

#include <Inventor/nodes/SoSpotLight.h>

Inherits SoLight.

Inherited by SoSpotLightManip.

🌸 Public Member Functions 🌸

  • virtual SoType getTypeId (void) const — grabs the type id for this node 💅
  • SoSpotLight (void) — the constructor, she makes a spotlight ✨
  • virtual void GLRender (SoGLRenderAction *action) — the render entry point 🎨

🌈 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=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 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) 💖
  • static void initClass (void) 💖

🌟 Static Public Member Functions inherited from SoLight

  • 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)
  • 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 🎀

  • 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 ()

💫 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)
  • ~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

the whole enum, here she is, take it all:

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 💡

ok so the tea: the SoSpotLight class is a node type for light sources with a cone shaped lightvolume. 🎀

Spotlights are light sources with a position and a direction. think of them as a pointlight wearing a lampshade. it's giving floor lamp main character energy, and honestly? iconic. 🛋️✨

See also documentation of parent class for important information regarding light sources in general. 👀 (yes bestie, go read it, iykyk)

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

🛠️ Constructor & Destructor Documentation 🛠️

🌟 SoSpotLight::SoSpotLight (void )

Constructor. 🎉

References cutOffAngle, direction, dropOffRate, location, and SoSpotLight().

Referenced by getFieldData(), SoSpotLightManip::replaceManip(), SoSpotLightManip::replaceNode(), SoSpotLight(), and SoSpotLightManip::transferFieldValues().

🌟 SoSpotLight::~SoSpotLight () [protected], [virtual]

Destructor. 💀 she's protected, she's virtual, she's the end of the line. periodt.

✨ MEMBER FUNCTION DOCUMENTATION ✨

💅 SoType SoSpotLight::getTypeId (void ) const [virtual]

okay bestie, so this one is literally the type identification plug for any object that inherits from SoBase. It's giving runtime type checking and "downward" casting energy. 🦋

Usage example, no cap:

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

For application programmers who wanna 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 info on writing Coin extensions, see the class documentation of the toplevel superclasses for the various class groups. 📚

Reimplemented from SoLight.

Reimplemented in SoSpotLightManip.

😭 const SoFieldData * SoSpotLight::getFieldData (void ) const [protected], [virtual]

This one returns a pointer to the class-wide field data storage object for this instance. If no fields are present, it returns NULL. That's it. Simple. Iconic. ✨

Reimplemented from SoLight.

Reimplemented in SoSpotLightManip.

References SoSpotLight().

🔥 void SoSpotLight::GLRender (SoGLRenderAction * action) [virtual]

Action method for the SoGLRenderAction. This gets called during rendering traversals. Nodes influencing the rendering state in any way, or who wanna throw geometry primitives at OpenGL, override this method. 💅

Reimplemented from SoNode.

Reimplemented in SoSpotLightManip.

References SoLight::color, cutOffAngle, direction, dropOffRate, SoAction::getState(), SbColor4f::getValue(), SbVec4f::getValue(), SoLight::intensity, location, SoLight::on, SoDebugError::post(), and SbColor4f::setRGB().

Referenced by SoSpotLightManip::GLRender().

🌈 MEMBER DATA DOCUMENTATION 🌈

SoSFVec3f SoSpotLight::location

3D position of light source. Default position is <0, 0, 1>. 📍

Referenced by SoSpotLightManip::fieldSensorCB(), GLRender(), SoSpotLight(), SoSpotLightManip::transferFieldValues(), and SoSpotLightManip::valueChangedCB().

SoSFVec3f SoSpotLight::direction

Direction vector, where the light is pointing. Default is to point along the negative z-axis. 🧭

Referenced by SoSpotLightManip::fieldSensorCB(), GLRender(), SoSpotLight(), SoSpotLightManip::transferFieldValues(), and SoSpotLightManip::valueChangedCB().

SoSFFloat SoSpotLight::dropOffRate

The rate of intensity drop-off from the ray along the direction vector. Value must be between 0.0 (equal intensity for the whole cone of light), to 1.0 (a narrow intensity ray). 🌟

Default value is 0.0.

Referenced by GLRender(), and SoSpotLight().

SoSFFloat SoSpotLight::cutOffAngle

The angle in radians from the direction vector where there will be no light outside (i.e. the angle of the "lampshade"). Default value is PI/4.0 (i.e. 45°). 💡

Referenced by SoSpotLightManip::fieldSensorCB(), GLRender(), SoSpotLight(), SoSpotLightManip::transferFieldValues(), and SoSpotLightManip::valueChangedCB().

👑 AUTHOR 👑

Generated automatically by Doxygen for Coin from the source code. 🤖✨

okay bestie, that's the whole vibe — this page came from Coin, Version 2.5.0, and it's SoSpotLight(3). Stay slaying those scene graphs. 💖🦋✨

📦 where this page comes from