SoEnvironmentElement Class Reference
[Elements]

VSG extension Stores the current environment. More...

#include <Inventor/elements/SoEnvironmentElement.h>

Inheritance diagram for SoEnvironmentElement:
SoReplacedElement SoElement SoTypedObject

List of all members.

Classes

struct  EnvironmentParameters
 EnvironmentParameters packages all the different environment parameters. More...

Public Types

enum  FogType {
  NONE,
  HAZE,
  FOG,
  SMOKE
}

Public Member Functions

virtual void push (SoState *state)

Static Public Member Functions

static SoType getClassTypeId ()
static int getClassStackIndex ()
static void set (SoState *state, SoNode *node, const EnvironmentParameters &envParams)
static void get (SoState *state, EnvironmentParameters &envParams)
static float getAmbientIntensity (SoState *state)
static const SbColorgetAmbientColor (SoState *state)
static const SbVec3fgetLightAttenuation (SoState *state)
static const SbBoolgetAmbientOcclusion (SoState *state)

Detailed Description

VSG extension Stores the current environment.

This element stores the current environment.

SEE ALSO

SoEnvironment


Member Enumeration Documentation

Fog type.

Enumerator:
NONE 

None.

HAZE 

Haze.

FOG 

Fog.

SMOKE 

Smoke.


Member Function Documentation

static void SoEnvironmentElement::get ( SoState state,
EnvironmentParameters envParams 
) [static]

Gets the current environment in the state.

static const SbColor& SoEnvironmentElement::getAmbientColor ( SoState state  )  [static]

Gets the ambient color.

static float SoEnvironmentElement::getAmbientIntensity ( SoState state  )  [static]

Gets the ambient intensity.

static const SbBool& SoEnvironmentElement::getAmbientOcclusion ( SoState state  )  [static]

Gets the ambient occlusion state (TRUE : activated, otherwise deactivated).

static int SoEnvironmentElement::getClassStackIndex (  )  [static]

Returns the stack id for this element.

Reimplemented from SoReplacedElement.

static SoType SoEnvironmentElement::getClassTypeId (  )  [static]

Returns the type identifier for this class.

Reimplemented from SoReplacedElement.

static const SbVec3f& SoEnvironmentElement::getLightAttenuation ( SoState state  )  [static]

Gets the light attenuation.

virtual void SoEnvironmentElement::push ( SoState state  )  [virtual]

Pushes element.

Allows for side effects to occur. Default methods do nothing.

Reimplemented from SoElement.

static void SoEnvironmentElement::set ( SoState state,
SoNode node,
const EnvironmentParameters envParams 
) [static]

Sets the current environment in the state.


The documentation for this class was generated from the following file:

Open Inventor Toolkit reference manual, generated on 16 Sep 2021
Copyright © Thermo Fisher Scientific All rights reserved.
http://www.openinventor.com/