SoEnvironment(3)

📦

version 4.0.10 · 4 versions

4.0.10 · fedora 43, fedora 44 (latest)
4.0.10 · epel 9
4.0.3 · fedora 43
4.0.7 · fedora 44

💖 SoEnvironment 💖

okay bestie, welcome to SoEnvironment(3) from the Coin manual — yes, that Coin, the 3D graphics toolkit, and yes we're gonna make global rendering parameters sound as cute as they actually are. this class is a node, and it's the one holding all your global lighting-and-fog vibes. let's get into it ✨

🌸 NAME 🌸

SoEnvironment — the class that's a node for specifying global rendering parameters. that's it, that's the whole name section, she's simple and she knows it 💅

✨ SYNOPSIS ✨

#include <Inventor/nodes/SoEnvironment.h>

she Inherits SoNode. classic. iconic lineage. no cap.

🎀 Public Types 🎀

enum FogType { NONE = SoEnvironmentElement::NONE, HAZE =
    SoEnvironmentElement::HAZE, FOG = SoEnvironmentElement::FOG, SMOKE =
    SoEnvironmentElement::SMOKE }

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

🌈 Public Member Functions 🌈

virtual SoType getTypeId (void) const
SoEnvironment (void)
virtual void GLRender (SoGLRenderAction *action)
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 just so you know, isOfType is the one where — quote — "Returns TRUE if the type of this object is either of the same type or inherited from type." 🫶

⭐ Static Public Member Functions ⭐

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

initClass — "Sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system." she does the groundwork so you don't have to 💅

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

that SoNode version of initClass is "Sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system." same energy, different class 💖

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

initClass here again does the "Sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system." and getClassTypeId is the static one 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)

and yep — initClass ("Sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system.") plus getClassTypeId ("This static method returns the SoType object associated with objects of this class.") live here too. the trio is complete, bestie 🎀

👑 Public Attributes 👑

these are the actual knobs you're gonna be turning, so pay attention:

SoSFFloat ambientIntensity
SoSFColor ambientColor
SoSFVec3f attenuation
SoSFEnum fogType
SoSFColor fogColor
SoSFFloat fogVisibility

🧚 Protected Member Functions 🧚

virtual const SoFieldData * getFieldData (void) const
virtual ~SoEnvironment ()

💜 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 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 🦋

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. SoEnvironment is a node for specifying global rendering parameters. periodt. 💅

what that actually means: this node type hands the application programmer the ability to set global parameters that influence lighting and fog. global. as in, everything. main character energy for your whole scene ✨

FILE FORMAT/DEFAULTS:

Environment {
    ambientIntensity 0.2
    ambientColor 1 1 1
    attenuation 0 0 1
    fogType NONE
    fogColor 1 1 1
    fogVisibility 0
}

those are the defaults, bestie — memorize them, they WILL come up on the exam 🎀

🌫️ Member Enumeration Documentation 🌫️

`enum SoEnvironment::FogType`

Enumeration of available types of fog. she's got range, she's got moods 🌈

Enumerator:

NONE — no fog. visibility will be equal for all objects, independent of distance to camera. everybody's equally visible, no favorites, no drama.
HAZE — fog where visibility will decrease linearly with distance to camera. steady decline, lowkey chill.
FOG — fog where visibility will decrease exponentially with distance to camera. things get fuzzy FAST, highkey.
SMOKE — fog where visibility will decrease exponentially with the square of the distance to camera (simulating really thick fog). this one is thick thick. it's giving can't-see-two-feet-in-front-of-you 💀

and that's the first half of the page, bestie — the rest is coming right up, don't go anywhere 🌸

🎀 Constructor & Destructor Documentation 🎀

`SoEnvironment::SoEnvironment` ( `void` )

bestie this is the Constructor. it's the lil "hey girl hey" moment where your environment node gets born 💖 no args, no drama, just vibes.

`SoEnvironment::~SoEnvironment` ( ) `[protected]`, `[virtual]`

and this is the Destructor. it's [protected] and [virtual], so it's lowkey exclusive — not everybody gets to call it, only the library and its subclasses 🫶 when it's time, she goes. periodt.

✨ Member Function Documentation ✨

`SoType SoEnvironment::getClassTypeId` ( `void` ) `[static]`

This static method returns the SoType object associated with objects of this class. that's it, that's the whole job 💅 static means you don't even need an instance — the class itself spills the tea.

`SoType SoEnvironment::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. iykyk — this is how the library figures out what you actually are at runtime so it can cast you down the hierarchy 🦋

Implements SoBase.

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

okay so real talk: this API member is considered internal to the library, as it is not likely to be of interest to the application programmer. so unless you're deep in the Coin sauce, you can scroll past 🙈

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

`const SoFieldData * SoEnvironment::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 SoFieldContainer.

ngl "class-wide" is doing a lot of work in that sentence — one shared storage object, not one per instance. iconic efficiency, no cap 💀

`void SoEnvironment::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. so yeah — if your node is a main character that changes how everything looks, or if it's out here yeeting triangles straight at OpenGL, this is your override 🔥

Reimplemented from SoNode.

`void SoEnvironment::callback` ( `SoCallbackAction * action` ) `[virtual]`

Action method for SoCallbackAction.

Simply updates the state according to how the node behaves for the render action, so the application programmer can use the SoCallbackAction for extracting information about the scene graph. translation: it mirrors the render behaviour so you can peek at what's going on in the graph without actually drawing anything 👑