org.web3d.x3d.sai.EnvironmentalEffects

Interface X3DFogObject

All Known Subinterfaces:

Fog, LocalFog

All Known Implementing Classes:

FogObject, LocalFogObject

public interface X3DFogObject

Abstract type describing a node that influences the lighting equation through the use of fog semantics.


Package hint: This interface is defined by the X3D Java Language Binding Specification for the Scene Authoring Interface (SAI).

See Also:

SAI Java Specification: TODO, X3D Abstract Specification: TODO, X3D Tooltips, X3D Scene Authoring Hints

Method Summary

Modifier and Type	Method and Description
float[]	getColor() Provide array of 3-tuple float results using RGB values [0..1] using RGB values [0..1] from inputOutput SFColor field named color.
java.lang.String	getFogType() Provide String enumeration value ['LINEAR'|'EXPONENTIAL'] from inputOutput SFString field named fogType.
float	getVisibilityRange() Provide float value within allowed range of [0,infinity) from inputOutput SFFloat field named visibilityRange.
X3DFogObject	setColor(float[] newValue) Assign 3-tuple float array using RGB values [0..1] using RGB values [0..1] to inputOutput SFColor field named color.
X3DFogObject	setFogType(java.lang.String newValue) Assign String enumeration value ("LINEAR"|"EXPONENTIAL") ['LINEAR'|'EXPONENTIAL'] to inputOutput SFString field named fogType.
X3DFogObject	setVisibilityRange(float newValue) Assign float value within allowed range of [0,infinity) to inputOutput SFFloat field named visibilityRange.

Method Detail

getColor

float[] getColor()

Provide array of 3-tuple float results using RGB values [0..1] using RGB values [0..1] from inputOutput SFColor field named color.

Returns:

value of color field

setColor

X3DFogObject setColor(float[] newValue)

Assign 3-tuple float array using RGB values [0..1] using RGB values [0..1] to inputOutput SFColor field named color.

Parameters:

newValue - is new value for the color field.

Returns:

X3DFogObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

getFogType

java.lang.String getFogType()

Provide String enumeration value ['LINEAR'|'EXPONENTIAL'] from inputOutput SFString field named fogType.

Returns:

value of fogType field

setFogType

X3DFogObject setFogType(java.lang.String newValue)

Assign String enumeration value ("LINEAR"|"EXPONENTIAL") ['LINEAR'|'EXPONENTIAL'] to inputOutput SFString field named fogType.

Parameters:

newValue - is new value for the fogType field.

Returns:

X3DFogObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

getVisibilityRange

float getVisibilityRange()

Provide float value within allowed range of [0,infinity) from inputOutput SFFloat field named visibilityRange.

Returns:

value of visibilityRange field

setVisibilityRange

X3DFogObject setVisibilityRange(float newValue)

Assign float value within allowed range of [0,infinity) to inputOutput SFFloat field named visibilityRange.

Parameters:

newValue - is new value for the visibilityRange field.

Returns:

X3DFogObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).