Package org.web3d.x3d.sai.EnvironmentalEffects

Interface X3DFogObject

All Known Subinterfaces:

Fog, LocalFog

All Known Implementing Classes:

Fog, LocalFog

public interface X3DFogObject

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

Warning: this is an abstract interface that cannot be instantiated as a concrete object. Java programmers typically only need to use concrete objects provided by the org.web3d.x3d.jsail classes.
Package hint: This interface is defined by the X3D Java Language Binding Specification for the Scene Authoring Interface (SAI).

See Also:

• SAI Java Specification
• X3D Abstract Specification
• X3D Tooltips
• X3D Scene Authoring Hints

Method Summary

Modifier and Type	Method	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.
String	getFogType()	Provide String enumeration value (baseType xs:NMTOKEN) ["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)	Accessor method to assign 3-tuple float array using RGB values [0..1] to inputOutput SFColor field named color.
X3DFogObject	setFogType(String newValue)	Accessor method to assign String enumeration value ("LINEAR" | "EXPONENTIAL") to inputOutput SFString field named fogType.
X3DFogObject	setVisibilityRange(float newValue)	Accessor method to assign float value to inputOutput SFFloat field named visibilityRange.

Method Details

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)

Accessor method to assign 3-tuple float array 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

String getFogType()

Provide String enumeration value (baseType xs:NMTOKEN) ["LINEAR" | "EXPONENTIAL"] from inputOutput SFString field named fogType.

Returns:

value of fogType field

setFogType

X3DFogObject setFogType(String newValue)

Accessor method to assign String enumeration value ("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)

Accessor method to assign float value 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).