X3DLightNode (X3DJSAIL, X3D Java Scene Access Interface Library)

All Superinterfaces:

X3DChildNode, X3DNode

All Known Subinterfaces:

DirectionalLight, PointLight, SpotLight

All Known Implementing Classes:

DirectionalLightObject, PointLightObject, SpotLightObject
```
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.

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

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and 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,1] from inputOutput SFFloat field named intensity.
`X3DMetadataObject`	`getMetadata()` Provide X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
`boolean`	`getOn()` Provide boolean value from inputOutput SFBool field named on.
`X3DLightNode`	`setAmbientIntensity(float newValue)` Assign float value within allowed range of [0,1] to inputOutput SFFloat field named ambientIntensity.
`X3DLightNode`	`setColor(float[] newValue)` Assign 3-tuple float array using RGB values [0..1] using RGB values [0..1] to inputOutput SFColor field named color.
`X3DLightNode`	`setCssClass(java.lang.String newValue)` Assign String value to inputOutput SFString field named class.
`X3DLightNode`	`setDEF(java.lang.String newValue)` Assign String value to inputOutput SFString field named DEF.
`X3DLightNode`	`setIntensity(float newValue)` Assign float value within allowed range of [0,1] to inputOutput SFFloat field named intensity.
`X3DLightNode`	`setMetadata(X3DMetadataObject newValue)` Assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
`X3DLightNode`	`setOn(boolean newValue)` Assign boolean value to inputOutput SFBool field named on.
`X3DLightNode`	`setUSE(java.lang.String newValue)` Assign String value to inputOutput SFString field named USE.

- Method Detail
  - 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)
```
    Assign float value within allowed range of [0,1] 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)
```
    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:
    
    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,1] from inputOutput SFFloat field named intensity.
    
    Returns:
    
    value of intensity field
  - setIntensity
```
X3DLightNode setIntensity(float newValue)
```
    Assign float value within allowed range of [0,1] 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 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)
```
    Assign 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)
```
    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).
  - setDEF
```
X3DLightNode setDEF(java.lang.String newValue)
```
    Assign String value to inputOutput SFString field named DEF.
    
    Note that setting the DEF value clears the USE value.
    
    Specified by:
    
    setDEF in interface X3DChildNode
    
    Specified by:
    
    setDEF in interface X3DNode
    
    Parameters:
    
    newValue - is new value for the DEF field.
    
    Returns:
    
    X3DLightNode - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setUSE
```
X3DLightNode setUSE(java.lang.String newValue)
```
    Assign String value to inputOutput SFString field named USE.
    
    Note: each USE node is still an independent object, with the USE value matching the DEF value in the preceding object.
    
    Warning: invoking the setUSE() method on this node resets all other fields to their default values (except for containerField) and also releases all child nodes.
    
    Warning: no other operations can be performed to modify a USE node other than setting an alternate containerField value.
    
    Specified by:
    
    setUSE in interface X3DChildNode
    
    Specified by:
    
    setUSE in interface X3DNode
    
    Parameters:
    
    newValue - is new value for the USE field.
    
    Returns:
    
    X3DLightNode - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setCssClass
```
X3DLightNode setCssClass(java.lang.String newValue)
```
    Assign String value to inputOutput SFString field named class.
    
    Specified by:
    
    setCssClass in interface X3DChildNode
    
    Specified by:
    
    setCssClass in interface X3DNode
    
    Parameters:
    
    newValue - is new value for the class field.
    
    Returns:
    
    X3DLightNode - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

Interface X3DLightNode

Method Summary

Method Detail

getAmbientIntensity

setAmbientIntensity

getColor

setColor

getIntensity

setIntensity

getMetadata

setMetadata

getOn

setOn

setDEF

setUSE

setCssClass