SoEnvironment(3)

📦 version 3.1.3, in fedora 43, fedora 44

SoEnvironment(3) · Library Functions Manual · part 1 of 2, bestie — buckle up 🫶

🌸 NAME 🌸

SoEnvironment — the SoEnvironment class is a node for specifying global rendering parameters. that's the whole entry, short and sweet 💅

✨ SYNOPSIS ✨

#include <Inventor/nodes/SoEnvironment.h>

Inherits SoNode.

okay so first thing's first, the include 💖 and yeah, this baby inherits from SoNode, so it's got a whole family tree of stuff coming with it. let's go.

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

💜 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

bestie there is a lot here, and every single one of them counts, so here we go:

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

🌟 Static Public Member Functions 🌟

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

🌈 Public Attributes 🌈

these are the actual knobs on the node, the ones you'll be poking at:

  • 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

⭐ 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

  • uint32_t uniqueId

Protected Attributes inherited from SoFieldContainer

  • SbBool isBuiltIn

Static Protected Attributes inherited from SoNode

  • static uint32_t nextUniqueId = 1
  • static int nextActionMethodIndex = 0

🍓 Detailed Description 🍓

The SoEnvironment class is a node for specifying global rendering parameters. lowkey iconic, ngl.

This node type provides the application programmer with the ability to set global parameters influencing lighting and fog. so if you're the one writing the app and you want to mess with how everything gets lit and how the fog sits over the whole scene — this is your girl 💅

FILE FORMAT/DEFAULTS:

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

that's the whole default vibe right there, copy it exactly bestie 🫶

🔥 Member Enumeration Documentation 🔥

enum SoEnvironment::FogType

Enumeration of available types of fog. the whole menu of fog moods 🌫️

Enumerator

  • NONE — no fog. visibility will be equal for all objects, independent of distance to camera. everything's clear, no drama.
  • HAZE — fog where visibility will decrease linearly with distance to camera.
  • FOG — fog where visibility will decrease exponentially with distance to camera.
  • SMOKE — fog where visibility will decrease exponentially with the square of the distance to camera (simulating really thick fog). yeah it's giving can't see anything, fr fr.

💀 Constructor & Destructor Documentation 💀

SoEnvironment::SoEnvironment (void )

Constructor. makes the thing ✨

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

Destructor. unmakes the thing, protected + virtual, you know the drill 💅

okay so that's the types, the functions, the attributes, the enum, and the constructor/destructor tea — and bestie we are not done, there's more of this page coming, so hold that thought 🌸

💖 Member Function Documentation 💖

✨ SoType SoEnvironment::getTypeId (void ) const [virtual] ✨

Okay bestie, this one is lowkey the ✨identity check✨ of the whole class system. It returns the type identification of an object derived from a class inheriting SoBase. That's what powers run-time type checking and those "downward" casts where you're like is this actually what I think it is? 💅

Usage example, so you can see the vibe:

void foo(SoNode * node)
{
  if (node->getTypeId() == SoFile::getClassTypeId()) {
    SoFile * filenode = (SoFile *)node;  // safe downward cast, knows the type
  }
}

See how the cast is safe there? Because the type was checked first. No cap, that's the whole point 🫶

So for the application programmers out there who wanna extend the library with new nodes, engines, nodekits, draggers or others — this method needs to be overridden in all subclasses. Fr fr, all of them. This is typically done as part of setting up the full type system for extension classes, and that's usually accomplished by using the pre-defined macros available through, for instance:

  • Inventor/nodes/SoSubNode.h — that's where SO_NODE_INIT_CLASS and SO_NODE_CONSTRUCTOR live, for node classes 🎀
  • Inventor/engines/SoSubEngine.h — for engine classes 🌸
  • and so on 👑

For more info on writing Coin extensions, go check the class documentation of the toplevel superclasses for the various class groups. They got you.

Implements SoBase.

✨ const SoFieldData * SoEnvironment::getFieldData (void ) const [protected], [virtual] ✨

This hands you a pointer to the class-wide field data storage object for this instance. If there are no fields present, it returns NULL. Simple as that 💜

Reimplemented from SoFieldContainer.

✨ void SoEnvironment::GLRender (SoGLRenderAction * action) [virtual] ✨

This is the action method for the SoGLRenderAction, bestie. It gets called during rendering traversals. Any node that influences the rendering state in any way, or who wants to throw geometry primitives at OpenGL, overrides this method. That's the assignment 💅

Reimplemented from SoNode.

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

Action method for SoCallbackAction. It 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. Little spy behaviour, honestly, and we love it 🔍✨

Reimplemented from SoNode.

🦋 Member Data Documentation 🦋

💫 SoSFFloat SoEnvironment::ambientIntensity

A global ambient value for the light intensity for the complete scene. This will provide some light even when there are no light sources defined for the scene — so your scene is never fully in the dark, periodt ✨

Valid values is from 0.0 (no ambient light) to 1.0 (full ambient light intensity). Default value is 0.2.

🌈 SoSFColor SoEnvironment::ambientColor

The color of the global ambient light. Defaults to full intensity white, ie <1.0, 1.0, 1.0>. 🤍

Each component of this RGB vector is multiplied with the scalar value of SoEnvironment::ambientIntensity. So like, they're working together, iconic duo behaviour 💞

📉 SoSFVec3f SoEnvironment::attenuation

Squared, linear, and constant light attenuation coefficients (in that order). Please note that this is the reverse order of how attenuation is usually specified — so heads up, don't get caught lacking on the ordering 🙈

🌫️ SoSFEnum SoEnvironment::fogType

The fog model. See SoEnvironment::FoType.

🎨 SoSFColor SoEnvironment::fogColor

Color of fog. Defaults to full intensity white.

🔭 SoSFFloat SoEnvironment::fogVisibility

The "cut-off" distance from the camera where objects will be totally obscured by fog. If set to 0.0, the far plane distance will be used instead.

Default value is 0.0.

👑 Author 👑

Generated automatically by Doxygen for Coin from the source code. (Not a human, not a bestie, just a doc generator doing its thing 💀)

And that's the whole page, bestie!! This was Coin, Version 3.1.3, and it's the SoEnvironment(3) manual page — go forth and make your scene glow, fog it up, and cast safely 💅✨🫶

📦 where this page comes from