SoEnvironment(3)

📦 version 2.5.0, in fedora 43, fedora 44

SoEnvironment(3) 💖✨

okay so bestie, welcome to the SoEnvironment(3) page from the Library Functions Manual, part 1. This is the manual for SoEnvironment, and she is that girl: a node for specifying global rendering parameters. We're gonna keep every flag, every signature, every inherited member, every default, no cap. 🫶

✨ NAME ✨

SoEnvironment — the class is a node for specifying global rendering parameters. Global rendering parameters, periodt. 💅

✨ SYNOPSIS ✨

okay so here's the vibe check on how you include her:

#include <Inventor/nodes/SoEnvironment.h>

Inherits SoNode. lowkey iconic. 👑

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 }

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

  • 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)
  • ~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 = 0
  • static int nextActionMethodIndex = 0

Detailed Description

The SoEnvironment class is a node for specifying global rendering parameters. Global rendering parameters! She's giving main character energy for your whole scene. ✨

This node type provides the application programmer with the ability to set global parameters influencing lighting and fog. lighting and fog, bestie. Obsessed. 💖

FILE FORMAT/DEFAULTS:

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

Member Enumeration Documentation

enum SoEnvironment::FogType

Enumeration of available types of fog. Fog types, iykyk. 🌫️

Enumerator:

  • NONE — No fog. Visibility will be equal for all objects, independent of distance to camera.
  • 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).

Constructor & Destructor Documentation

SoEnvironment::SoEnvironment (void )

Constructor.

References ambientColor, ambientIntensity, attenuation, FOG, fogColor, fogType, fogVisibility, HAZE, NONE, SMOKE, and SoEnvironment().

Referenced by getFieldData(), and SoEnvironment().

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

Destructor.

💖 Member Function Documentation 💖

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

Okay bestie, this one hands you the type identification of any object derived from a class that inherits SoBase. What's it for? Run-time type checking and "downward" casting, that's what. 💅

Usage example, copy it exactly, 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
  }
}

Now, if you're an application programmer and you wanna extend the library with new nodes, engines, nodekits, draggers or whatever else — this method needs to be overridden in all subclasses. Periodt. You'd typically do that as part of setting up the full type system for your 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. 🧚

Wanna know more about writing Coin extensions? Go check the class documentation of the toplevel superclasses for the various class groups. 🦋

Implements SoBase.

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

Gives you a pointer to the class-wide field data storage object for this instance. And if there are literally no fields present? It returns NULL. That's it, that's the vibe. 🎀

Reimplemented from SoFieldContainer.

References SoEnvironment().

✨ 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 that wants to throw geometry primitives at OpenGL, overrides this method. 👑

Reimplemented from SoNode.

References fogType, and SoAction::getState().

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

The action method for SoCallbackAction. 🫶

Basically it just updates the state according to how the node behaves for the render action, so that you — yes you, the application programmer — can use SoCallbackAction to extract information about the scene graph. Iconic behaviour honestly. ⭐

Reimplemented from SoNode.

References fogType, and SoAction::getState().

🌸 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. Little bit of main character energy for the lighting setup. ✨

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

Referenced by SoEnvironment().

🍓 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 gets multiplied with the scalar value of SoEnvironment::ambientIntensity. Math girlies stay winning.

Referenced by SoEnvironment().

🍓 SoSFVec3f SoEnvironment::attenuation

Squared, linear, and constant light attenuation coefficients — in that exact order. ⚠️ Heads up bestie: this is the reverse order of how attenuation is usually specified. Don't get caught slipping.

Referenced by SoEnvironment().

🍓 SoSFEnum SoEnvironment::fogType

The fog model. See SoEnvironment::FoType. 🌫️

Referenced by callback(), GLRender(), and SoEnvironment().

🍓 SoSFColor SoEnvironment::fogColor

Color of fog. Defaults to full intensity white. 🤍

Referenced by SoEnvironment().

🍓 SoSFFloat SoEnvironment::fogVisibility

The "cut-off" distance from the camera where objects will be totally obscured by fog. And if you set it to 0.0? The far plane distance gets used instead. Sneaky but valid. 🙈

Default value is 0.0.

Referenced by SoEnvironment().

👑 Author 👑

Generated automatically by Doxygen for Coin from the source code.

That's a wrap on SoEnvironment(3), bestie — this page came straight from Coin, Version 2.5.0, and it was generated automatically by Doxygen for Coin from the source code. Thanks for reading all the way to the end, you're literally the moment. 💖✨💅

📦 where this page comes from