SoEnvironmentElement(3)

πŸ“¦ version 3.1.3, in fedora 43, fedora 44

πŸŽ€ SoEnvironmentElement πŸŽ€

okay so bestie, you just pulled up the SoEnvironmentElement(3) page in the <rainbow>Library Functions Manual</rainbow> and I am so glad you did. Buckle up, because this class is β€” and I say this with all the love in my heart β€” yet to be documented. The placeholder energy is loud. πŸ’€


✨ NAME ✨

SoEnvironmentElement β€” the SoEnvironmentElement class is yet to be documented. That's the whole thing. Not me reading a FIXME and making it my whole personality πŸ™ˆ


πŸ¦‹ SYNOPSIS πŸ¦‹

#include <Inventor/elements/SoEnvironmentElement.h>

Inherits SoReplacedElement.

Inherited by SoGLEnvironmentElement.

πŸ‘‘ Public Types

  • enum FogType { NONE, HAZE, FOG, SMOKE }

πŸ’– Public Member Functions

  • virtual void init (SoState *state) β€” FIXME: write doc.
  • virtual void print (FILE *file) const β€” FIXME: write doc.

🫢 Public Member Functions inherited from SoReplacedElement

  • virtual SbBool matches (const SoElement *element) const
  • virtual SoElement * copyMatchInfo () const
  • uint32_t getNodeId () const

🌈 Public Member Functions inherited from SoElement

  • const SoType getTypeId (void) const
  • int getStackIndex (void) const
  • virtual void push (SoState *state)
  • virtual void pop (SoState *state, const SoElement *prevTopElement)
  • void setDepth (const int depth)
  • int getDepth (void) const
  • virtual ~SoElement ()

πŸ’« Static Public Member Functions

  • static SoType getClassTypeId (void)
  • static int getClassStackIndex (void)
  • static void * createInstance (void)
  • static void initClass (void)
  • static void set (SoState *const state, SoNode *const node, const float ambientIntensity, const SbColor &ambientColor, const SbVec3f &attenuation, const int32_t fogType, const SbColor &fogColor, const float fogVisibility, const float fogStart=0.0f) β€” FIXME: write doc.
  • static void get (SoState *const state, float &ambientIntensity, SbColor &ambientColor, SbVec3f &attenuation, int32_t &fogType, SbColor &fogColor, float &fogVisibility, float &fogStart) β€” FIXME: write doc.
  • static float getAmbientIntensity (SoState *const state) β€” FIXME: write doc.
  • static float getFogVisibility (SoState *const state) β€” FIXME: write doc.
  • static const SbVec3f & getLightAttenuation (SoState *const state) β€” FIXME: write doc.
  • static const SbColor & getAmbientColor (SoState *const state) β€” FIXME: write doc.
  • static const SbColor & getFogColor (SoState *const state) β€” FIXME: write doc.
  • static int32_t getFogType (SoState *const state) β€” FIXME: write doc.
  • static void getDefault (float &ambientIntensity, SbColor &ambientColor, SbVec3f &attenuation, int32_t &fogType, SbColor &fogColor, float &fogVisibility, float &fogNear) β€” FIXME: write doc.

🌟 Static Public Member Functions inherited from SoReplacedElement

  • static SoType getClassTypeId (void)
  • static int getClassStackIndex (void)
  • static void initClass (void)

⭐ Static Public Member Functions inherited from SoElement

  • static void initClass (void)
  • static SoType getClassTypeId (void)
  • static int getClassStackIndex (void)
  • static void initElements (void)
  • static int getNumStackIndices (void)
  • static SoType getIdFromStackIndex (const int stackIndex)

🧚 Protected Member Functions

  • virtual ~SoEnvironmentElement ()
  • virtual void setElt (SoState *const state, const float ambientIntensity, const SbColor &ambientColor, const SbVec3f &attenuation, const int32_t fogType, const SbColor &fogColor, const float fogVisibility, const float fogNear) β€” FIXME: doc.

πŸ¦‹ Protected Member Functions inherited from SoReplacedElement

  • virtual ~SoReplacedElement ()

🌸 Protected Member Functions inherited from SoElement

  • SoElement (void)
  • void capture (SoState *const state) const
  • virtual void captureThis (SoState *state) const
  • void setTypeId (const SoType typeId)
  • void setStackIndex (const int index)
  • SoElement * getNextInStack (void) const
  • SoElement * getNextFree (void) const

πŸ“ Protected Attributes

  • float ambientIntensity
  • SbColor ambientColor
  • SbVec3f attenuation
  • int32_t fogType
  • SbColor fogColor
  • float fogVisibility
  • float fogStart

πŸ’œ Protected Attributes inherited from SoReplacedElement

  • uint32_t nodeId

πŸŽ€ Protected Attributes inherited from SoElement

  • SoType typeId
  • int stackIndex
  • int depth

🌈 Additional Inherited Members

πŸ”₯ Static Protected Member Functions inherited from SoReplacedElement

  • static SoElement * getElement (SoState *const state, const int stackIndex, SoNode *const node)

✨ Static Protected Member Functions inherited from SoElement

  • static SoElement * getElement (SoState *const state, const int stackIndex)
  • static const SoElement * getConstElement (SoState *const state, const int stackIndex)
  • static int createStackIndex (const SoType id)

πŸ‘‘ Static Protected Attributes inherited from SoElement

  • static int classStackIndex
  • static SoTypeList * stackToType

🌸 Detailed Description 🌸

The SoEnvironmentElement class is yet to be documented.

FIXME: write doc.

bestie it literally says FIXME twice. the audacity. the nerve. the iconic laziness 😭

🧚 Member Enumeration Documentation 🧚

enum SoEnvironmentElement::FogType

FIXME: write doc.

just vibes. four vibes: NONE, HAZE, FOG, SMOKE. that's all we know. iykyk 🫢

πŸ’€ Constructor & Destructor Documentation πŸ’€

SoEnvironmentElement::~SoEnvironmentElement (void ) [protected], [virtual]

The destructor.


πŸ’… Member Function Documentation πŸ’…

void * SoEnvironmentElement::createInstance (void ) [static]

This API member is considered internal to the library, as it is not likely to be of interest to the application programmer.

void SoEnvironmentElement::initClass (void ) [static]

This static method initializes static data for the SoEnvironmentElement class.

void SoEnvironmentElement::init (SoState * state) [virtual]

FIXME: write doc.

Reimplemented from SoReplacedElement.

Reimplemented in SoGLEnvironmentElement.

void SoEnvironmentElement::print (FILE * file) const [virtual]

FIXME: write doc.

Reimplemented from SoReplacedElement.

void SoEnvironmentElement::setElt (SoState *const state, const float ambientIntensity, const SbColor & ambientColor, const SbVec3f & attenuation, const int32_t fogType, const SbColor & fogColor, const float fogVisibility, const float fogNear) [protected], [virtual]

FIXME: doc.

Reimplemented in SoGLEnvironmentElement.


πŸŽ€ Member Data Documentation πŸŽ€

float SoEnvironmentElement::ambientIntensity [protected]

FIXME: write doc.

SbColor SoEnvironmentElement::ambientColor [protected]

FIXME: write doc.

SbVec3f SoEnvironmentElement::attenuation [protected]

FIXME: write doc.

int32_t SoEnvironmentElement::fogType [protected]

FIXME: write doc.

SbColor SoEnvironmentElement::fogColor [protected]

FIXME: write doc.

float SoEnvironmentElement::fogVisibility [protected]

FIXME: write doc.

float SoEnvironmentElement::fogStart [protected]

FIXME: write doc.


πŸ’– Author πŸ’–

Generated automatically by Doxygen for Coin from the source code.


okay that's the whole page bestie, no cap, every single FIXME: write doc. accounted for 🫢 this one came to you from the Coin source, Version 3.1.3, and it lives at SoEnvironmentElement(3) in the library functions manual. go forth and document it yourself if the mood strikes, because clearly nobody else is gonna πŸ’…βœ¨

πŸ“¦ where this page comes from