Package org.web3d.x3d.sai.Lighting

Interface X3DLightNode

All Superinterfaces:

X3DChildNode, X3DNode

All Known Subinterfaces:

DirectionalLight, PointLight, SpotLight, TextureProjector, TextureProjectorParallel, X3DTextureProjectorNode

All Known Implementing Classes:

DirectionalLight, PointLight, SpotLight, TextureProjector, TextureProjectorParallel

public interface X3DLightNode
extends X3DChildNode

Light nodes provide illumination for rendering geometry in the scene. Implementing nodes must include a global field with type SFBool and accessType inputOutput.

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	getAmbientIntensity()	Provide float value within allowed range of [0,1] from inputOutput SFFloat field named ambientIntensity.
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.
float	getIntensity()	Provide float value within allowed range of [0,infinity) from inputOutput SFFloat field named intensity.
X3DMetadataObject	getMetadata()	Provide org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
boolean	getOn()	Provide boolean value from inputOutput SFBool field named on.
float	getShadowIntensity()	Provide float value within allowed range of [0,1] from inputOutput SFFloat field named shadowIntensity.
boolean	getShadows()	Provide boolean value from inputOutput SFBool field named shadows.
X3DLightNode	setAmbientIntensity(float newValue)	Accessor method to assign float value to inputOutput SFFloat field named ambientIntensity.
X3DLightNode	setColor(float[] newValue)	Accessor method to assign 3-tuple float array using RGB values [0..1] to inputOutput SFColor field named color.
X3DLightNode	setIntensity(float newValue)	Accessor method to assign float value to inputOutput SFFloat field named intensity.
X3DLightNode	setMetadata(X3DMetadataObject newValue)	Accessor method to assign org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
X3DLightNode	setOn(boolean newValue)	Accessor method to assign boolean value to inputOutput SFBool field named on.
X3DLightNode	setShadowIntensity(float newValue)	Accessor method to assign float value to inputOutput SFFloat field named shadowIntensity.
X3DLightNode	setShadows(boolean newValue)	Accessor method to assign boolean value to inputOutput SFBool field named shadows.

Method Details

getAmbientIntensity

float getAmbientIntensity()

Provide float value within allowed range of [0,1] from inputOutput SFFloat field named ambientIntensity.

Returns:

value of ambientIntensity field

setAmbientIntensity

X3DLightNode setAmbientIntensity(float newValue)

Accessor method to assign float value to inputOutput SFFloat field named ambientIntensity.

Parameters:

newValue - is new value for the ambientIntensity field.

Returns:

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

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

X3DLightNode 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:

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

getIntensity

float getIntensity()

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

Returns:

value of intensity field

setIntensity

X3DLightNode setIntensity(float newValue)

Accessor method to assign float value to inputOutput SFFloat field named intensity.

Parameters:

newValue - is new value for the intensity field.

Returns:

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

getMetadata

X3DMetadataObject getMetadata()

Provide org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.

Specified by:

getMetadata in interface X3DChildNode

Specified by:

getMetadata in interface X3DNode

Returns:

value of metadata field

See Also:

• X3D Scene Authoring Hints: Metadata Nodes

setMetadata

X3DLightNode setMetadata(X3DMetadataObject newValue)

Accessor method to assign org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.

Specified by:

setMetadata in interface X3DChildNode

Specified by:

setMetadata in interface X3DNode

Parameters:

newValue - is new value for the metadata field.

Returns:

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

See Also:

• X3D Scene Authoring Hints: Metadata Nodes

getOn

boolean getOn()

Provide boolean value from inputOutput SFBool field named on.

Returns:

value of on field

setOn

X3DLightNode setOn(boolean newValue)

Accessor method to assign boolean value to inputOutput SFBool field named on.

Parameters:

newValue - is new value for the on field.

Returns:

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

getShadowIntensity

float getShadowIntensity()

Provide float value within allowed range of [0,1] from inputOutput SFFloat field named shadowIntensity.

Returns:

value of shadowIntensity field

setShadowIntensity

X3DLightNode setShadowIntensity(float newValue)

Accessor method to assign float value to inputOutput SFFloat field named shadowIntensity.

Parameters:

newValue - is new value for the shadowIntensity field.

Returns:

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

getShadows

boolean getShadows()

Provide boolean value from inputOutput SFBool field named shadows.

Returns:

value of shadows field

setShadows

X3DLightNode setShadows(boolean newValue)

Accessor method to assign boolean value to inputOutput SFBool field named shadows.

Parameters:

newValue - is new value for the shadows field.

Returns:

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