com.openinventor.inventor.elements

Class SoEnvironmentElement

java.lang.Object

com.openinventor.inventor.Inventor

com.openinventor.inventor.elements.SoElement

com.openinventor.inventor.elements.SoReplacedElement

com.openinventor.inventor.elements.SoEnvironmentElement

Direct Known Subclasses:

SoGLEnvironmentElement

public class SoEnvironmentElement
extends SoReplacedElement

Stores the current environment. This element stores the current environment. See also:

SoEnvironment

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SoEnvironmentElement.EnvironmentParameters EnvironmentParameters packages all the different environment parameters.
static class	SoEnvironmentElement.FogTypes Fog type.

Nested classes/interfaces inherited from class com.openinventor.inventor.Inventor

Inventor.ConstructorCommand

Field Summary

Fields

Modifier and Type	Field and Description
static int	FOG Deprecated. Use SoEnvironmentElement.FogTypes.FOG instead.
static int	HAZE Deprecated. Use SoEnvironmentElement.FogTypes.HAZE instead.
static int	NONE Deprecated. Use SoEnvironmentElement.FogTypes.NONE instead.
static int	SMOKE Deprecated. Use SoEnvironmentElement.FogTypes.SMOKE instead.

Fields inherited from class com.openinventor.inventor.Inventor

VERBOSE_LEVEL, ZeroHandle

Method Summary

Modifier and Type	Method and Description
static SoEnvironmentElement.EnvironmentParameters	get(SoState state) Gets the current environment in the state.
static SbColor	getAmbientColor(SoState state) Gets the ambient color.
static float	getAmbientIntensity(SoState state) Gets the ambient intensity.
static int	getClassStackIndex() Deprecated. As of Open Inventor 9.3 replaced by SoElement.getClassStackIndex(Class)
static SbVec3f	getLightAttenuation(SoState state) Gets the light attenuation.
void	push(SoState state) Pushes element.
static void	set(SoState state, SoNode node, float ambientIntensity, SbColor ambientColor, SbVec3f attenuation, SoEnvironmentElement.FogTypes fogType, SbColor fogColor, float fogVisibility) Deprecated. As of Open Inventor 9900 See documentation for more details
static void	set(SoState state, SoNode node, SoEnvironmentElement.EnvironmentParameters envParams) Sets the current environment in the state.

Methods inherited from class com.openinventor.inventor.elements.SoElement

getClassStackIndex, pop

Methods inherited from class com.openinventor.inventor.Inventor

dispose, getAddress, getNativeResourceHandle, startInternalThreads, stopInternalThreads

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

NONE

@Deprecated
public static final int NONE

Deprecated. Use SoEnvironmentElement.FogTypes.NONE instead.

HAZE

@Deprecated
public static final int HAZE

Deprecated. Use SoEnvironmentElement.FogTypes.HAZE instead.

FOG

@Deprecated
public static final int FOG

Deprecated. Use SoEnvironmentElement.FogTypes.FOG instead.

SMOKE

@Deprecated
public static final int SMOKE

Deprecated. Use SoEnvironmentElement.FogTypes.SMOKE instead.

Method Detail

getAmbientIntensity

public static float getAmbientIntensity(SoState state)

Gets the ambient intensity.

getLightAttenuation

public static SbVec3f getLightAttenuation(SoState state)

Gets the light attenuation.

getAmbientColor

public static SbColor getAmbientColor(SoState state)

Gets the ambient color.

get

public static SoEnvironmentElement.EnvironmentParameters get(SoState state)

Gets the current environment in the state.

set

public static void set(SoState state,
                       SoNode node,
                       SoEnvironmentElement.EnvironmentParameters envParams)

Sets the current environment in the state.

getClassStackIndex

@Deprecated
public static int getClassStackIndex()

Deprecated. As of Open Inventor 9.3 replaced by SoElement.getClassStackIndex(Class)

Returns the stack id for this element.

• *

push

public void push(SoState state)

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

Overrides:

push in class SoElement

set

@Deprecated
public static void set(SoState state,
                                    SoNode node,
                                    float ambientIntensity,
                                    SbColor ambientColor,
                                    SbVec3f attenuation,
                                    SoEnvironmentElement.FogTypes fogType,
                                    SbColor fogColor,
                                    float fogVisibility)

Deprecated. As of Open Inventor 9900 See documentation for more details

Sets the current environment in the state. Deprecated since Open Inventor 9900
This method is deprecated. Please use set(SoState *state, SoNode *node, const EnvironmentParameters& envParams) instead