Provided by: libcoin80-doc_3.1.4~abc9f50-4ubuntu2_all bug

NAME

       SoEnvironmentElement -

       The SoEnvironmentElement class is yet to be documented.

       FIXME: write doc.

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.

   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.

   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 Attributes
       float ambientIntensity
       SbColor ambientColor
       SbVec3f attenuation
       int32_t fogType
       SbColor fogColor
       float fogVisibility
       float fogStart

   Additional Inherited Members

Detailed Description

       The SoEnvironmentElement class is yet to be documented.

       FIXME: write doc.

Member Enumeration Documentation

   enum SoEnvironmentElement::FogType
       FIXME: write doc.

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.

Member Data Documentation

   SoEnvironmentElement::ambientIntensity [protected]
       FIXME: write doc.

   SoEnvironmentElement::ambientColor [protected]
       FIXME: write doc.

   SoEnvironmentElement::attenuation [protected]
       FIXME: write doc.

   SoEnvironmentElement::fogType [protected]
       FIXME: write doc.

   SoEnvironmentElement::fogColor [protected]
       FIXME: write doc.

   SoEnvironmentElement::fogVisibility [protected]
       FIXME: write doc.

   SoEnvironmentElement::fogStart [protected]
       FIXME: write doc.

Author

       Generated automatically by Doxygen for Coin from the source code.