DirectionalLight (X3DJSAIL, X3D Java Scene Access Interface Library)

All Superinterfaces:

X3DChildNode, X3DLightNode, X3DNode

All Known Implementing Classes:

DirectionalLightObject
```
public interface DirectionalLight
extends X3DLightNode
```
DirectionalLight might not be scoped by parent Group or Transform at levels 1 or 2.

X3D node tooltip: [X3DLightNode] DirectionalLight defines parallel light rays that illuminate geometric shapes. Lighting illuminates all geometry except lines and points. By default, light scope only illuminates peer geometry and children nodes within the scene graph hierarchy. No source location is needed since rays are parallel from an infinitely distant source. DirectionalLight nodes do not attenuate with distance. Lights have no visible shape themselves and lighting effects continue through any intermediate geometry.
- Hint: animate direction to simulate time-of-day sunlight effects.
- Hint: the bound NavigationInfo controls whether headlight is enabled on/off. Interchange profile hint: light might not be scoped by parent Group or Transform.
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: DirectionalLight, X3D Tooltips: DirectionalLight, 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[]`	`getDirection()` Provide array of 3-tuple float results from inputOutput SFVec3f field named direction.
`boolean`	`getGlobal()` Provide boolean value from inputOutput SFBool field named global.
`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.
`DirectionalLight`	`setAmbientIntensity(float newValue)` Assign float value within allowed range of [0,1] to inputOutput SFFloat field named ambientIntensity.
`DirectionalLight`	`setColor(float[] newValue)` Assign 3-tuple float array using RGB values [0..1] using RGB values [0..1] to inputOutput SFColor field named color.
`DirectionalLight`	`setCssClass(java.lang.String newValue)` Assign String value to inputOutput SFString field named class.
`DirectionalLight`	`setDEF(java.lang.String newValue)` Assign String value to inputOutput SFString field named DEF.
`DirectionalLight`	`setDirection(float[] newValue)` Assign 3-tuple float array to inputOutput SFVec3f field named direction.
`DirectionalLight`	`setGlobal(boolean newValue)` Assign boolean value to inputOutput SFBool field named global.
`DirectionalLight`	`setIntensity(float newValue)` Assign float value within allowed range of [0,1] to inputOutput SFFloat field named intensity.
`DirectionalLight`	`setMetadata(X3DMetadataObject newValue)` Assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
`DirectionalLight`	`setOn(boolean newValue)` Assign boolean value to inputOutput SFBool field named on.
`DirectionalLight`	`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.
    
    Tooltip: [0,1] Brightness of ambient (nondirectional background) emission from the light. Interchange profile hint: this field may be ignored, applying the default value regardless. *
    
    Specified by:
    
    getAmbientIntensity in interface X3DLightNode
    
    Returns:
    
    value of ambientIntensity field
  - setAmbientIntensity
```
DirectionalLight setAmbientIntensity(float newValue)
```
    Assign float value within allowed range of [0,1] to inputOutput SFFloat field named ambientIntensity.
    
    Tooltip: [0,1] Brightness of ambient (nondirectional background) emission from the light. Interchange profile hint: this field may be ignored, applying the default value regardless.
    
    Specified by:
    
    setAmbientIntensity in interface X3DLightNode
    
    Parameters:
    
    newValue - is new value for the ambientIntensity field.
    
    Returns:
    
    DirectionalLight - 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.
    
    Tooltip: [0,1] color of light, applied to colors of objects.
    - Hint: X3D Scene Authoring Hints, Color
      http://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#Color
    Specified by:
    
    getColor in interface X3DLightNode
    
    Returns:
    
    value of color field
  - setColor
```
DirectionalLight setColor(float[] newValue)
```
    Assign 3-tuple float array using RGB values [0..1] using RGB values [0..1] to inputOutput SFColor field named color.
    
    Tooltip: [0,1] color of light, applied to colors of objects. Hint: X3D Scene Authoring Hints, Color http://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#Color
    
    Specified by:
    
    setColor in interface X3DLightNode
    
    Parameters:
    
    newValue - is new value for the color field.
    
    Returns:
    
    DirectionalLight - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - getDirection
```
float[] getDirection()
```
    Provide array of 3-tuple float results from inputOutput SFVec3f field named direction.
    
    Tooltip: Orientation vector of light relative to local coordinate system.
    - Hint: animate direction to simulate time-of-day sunlight effects.
    Returns:
    
    value of direction field
  - setDirection
```
DirectionalLight setDirection(float[] newValue)
```
    Assign 3-tuple float array to inputOutput SFVec3f field named direction.
    
    Tooltip: Orientation vector of light relative to local coordinate system. Hint: animate direction to simulate time-of-day sunlight effects.
    
    Parameters:
    
    newValue - is new value for the direction field.
    
    Returns:
    
    DirectionalLight - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - getGlobal
```
boolean getGlobal()
```
    Provide boolean value from inputOutput SFBool field named global.
    
    Tooltip: Global lights illuminate all objects within their volume of lighting influence. Scoped lights only illuminate objects within the same transformation hierarchy.
    - Warning: DirectionalLight default global=false to limit scope and avoid inadvertently illuminating every object in a large scene. PointLight and SpotLight default global=true since their effects are each limited by maximum radius value.
    Returns:
    
    value of global field
  - setGlobal
```
DirectionalLight setGlobal(boolean newValue)
```
    Assign boolean value to inputOutput SFBool field named global.
    
    Tooltip: Global lights illuminate all objects within their volume of lighting influence. Scoped lights only illuminate objects within the same transformation hierarchy. Warning: DirectionalLight default global=false to limit scope and avoid inadvertently illuminating every object in a large scene. PointLight and SpotLight default global=true since their effects are each limited by maximum radius value.
    
    Parameters:
    
    newValue - is new value for the global field.
    
    Returns:
    
    DirectionalLight - 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.
    
    Tooltip: [0,1] Brightness of direct emission from the light. *
    
    Specified by:
    
    getIntensity in interface X3DLightNode
    
    Returns:
    
    value of intensity field
  - setIntensity
```
DirectionalLight setIntensity(float newValue)
```
    Assign float value within allowed range of [0,1] to inputOutput SFFloat field named intensity.
    
    Tooltip: [0,1] Brightness of direct emission from the light.
    
    Specified by:
    
    setIntensity in interface X3DLightNode
    
    Parameters:
    
    newValue - is new value for the intensity field.
    
    Returns:
    
    DirectionalLight - 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 X3DLightNode
    
    Specified by:
    
    getMetadata in interface X3DNode
    
    Returns:
    
    value of metadata field
    
    See Also:
    
    X3D Scene Authoring Hints: Metadata Nodes
  - setMetadata
```
DirectionalLight 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 X3DLightNode
    
    Specified by:
    
    setMetadata in interface X3DNode
    
    Parameters:
    
    newValue - is new value for the metadata field.
    
    Returns:
    
    DirectionalLight - 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.
    
    Tooltip: Enables/disables this light source. *
    
    Specified by:
    
    getOn in interface X3DLightNode
    
    Returns:
    
    value of on field
  - setOn
```
DirectionalLight setOn(boolean newValue)
```
    Assign boolean value to inputOutput SFBool field named on.
    
    Tooltip: Enables/disables this light source.
    
    Specified by:
    
    setOn in interface X3DLightNode
    
    Parameters:
    
    newValue - is new value for the on field.
    
    Returns:
    
    DirectionalLight - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setDEF
```
DirectionalLight setDEF(java.lang.String newValue)
```
    Assign String value to inputOutput SFString field named DEF.
    
    Tooltip: DEF defines a unique ID name for this node, referenceable by other nodes. Hint: descriptive DEF names improve clarity and help document a model. Hint: well-defined names can simplify design and debugging through improved author understanding. Hint: X3D Scene Authoring Hints, Naming Conventions http://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#NamingConventions
    
    Note that setting the DEF value clears the USE value.
    
    Specified by:
    
    setDEF in interface X3DChildNode
    
    Specified by:
    
    setDEF in interface X3DLightNode
    
    Specified by:
    
    setDEF in interface X3DNode
    
    Parameters:
    
    newValue - is new value for the DEF field.
    
    Returns:
    
    DirectionalLight - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setUSE
```
DirectionalLight setUSE(java.lang.String newValue)
```
    Assign String value to inputOutput SFString field named USE.
    
    Tooltip: USE means reuse an already DEF-ed node ID, excluding all child nodes and all other attributes (except for containerField, which can have a different value). Hint: USE references to previously defined DEF geometry (instead of duplicating nodes) can improve performance. Warning: do NOT include any child nodes, a DEF attribute, or any other attribute values (except for containerField) when defining a USE attribute. Warning: each USE value must match a corresponding DEF value that is defined earlier in the scene.
    
    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 X3DLightNode
    
    Specified by:
    
    setUSE in interface X3DNode
    
    Parameters:
    
    newValue - is new value for the USE field.
    
    Returns:
    
    DirectionalLight - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setCssClass
```
DirectionalLight setCssClass(java.lang.String newValue)
```
    Assign String value to inputOutput SFString field named class.
    
    Tooltip: The class attribute is a space-separated list of classes, reserved for use by CSS cascading stylesheets. Warning: currently the class attribute is only supported in XML encoding of X3D scenes. Hint: W3C Cascading Style Sheets https://www.w3.org/Style/CSS
    
    Specified by:
    
    setCssClass in interface X3DChildNode
    
    Specified by:
    
    setCssClass in interface X3DLightNode
    
    Specified by:
    
    setCssClass in interface X3DNode
    
    Parameters:
    
    newValue - is new value for the class field.
    
    Returns:
    
    DirectionalLight - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

Interface DirectionalLight

Method Summary

Method Detail

getAmbientIntensity

setAmbientIntensity

getColor

setColor

getDirection

setDirection

getGlobal

setGlobal

getIntensity

setIntensity

getMetadata

setMetadata

getOn

setOn

setDEF

setUSE

setCssClass