DirectionalLightObject (X3DJSAIL, X3D Java Scene Access Interface Library)

java.lang.Object
- org.web3d.x3d.jsail.X3DConcreteElement
- - org.web3d.x3d.jsail.X3DConcreteNode
  - - org.web3d.x3d.jsail.Lighting.DirectionalLightObject

All Implemented Interfaces:

X3DChildNode, X3DNode, DirectionalLight, X3DLightNode
```
public class DirectionalLightObject
extends X3DConcreteNode
implements DirectionalLight
```
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.
Note that SFColorObject provides a variety of color constants.

Package hint: This org.web3d.x3d.jsail concrete class is used for implementing a standalone X3D object as a Plain Old Java Object (POJO). If you are writing Java code for use inside an X3D Script node, compile separate code using only the org.web3d.x3d.sai package instead.
See Also:

X3D Abstract Specification: DirectionalLight, X3D Tooltips: DirectionalLight, X3D Scene Authoring Hints

Field Summary

Fields
Modifier and Type	Field and Description
`static float`	`AMBIENTINTENSITY_DEFAULT_VALUE` SFFloat field named ambientIntensity has default value 0f (Java syntax) or 0 (XML syntax).
`static float[]`	`COLOR_DEFAULT_VALUE` SFColor field named color has default value {1f,1f,1f} (Java syntax) or 1 1 1 (XML syntax).
`static java.lang.String`	`COMPONENT` String constant COMPONENT defines X3D component for the DirectionalLight element: Lighting
`static java.lang.String`	`containerField_DEFAULT_VALUE` containerField describes typical field relationship of a node to its parent.
`static float[]`	`DIRECTION_DEFAULT_VALUE` SFVec3f field named direction has default value {0f,0f,-1f} (Java syntax) or 0 0 -1 (XML syntax).
`static java.lang.String`	`fromField_AMBIENTINTENSITY` fromField ROUTE name for SFFloat field named ambientIntensity.
`static java.lang.String`	`fromField_COLOR` fromField ROUTE name for SFColor field named color.
`static java.lang.String`	`fromField_DIRECTION` fromField ROUTE name for SFVec3f field named direction.
`static java.lang.String`	`fromField_GLOBAL` fromField ROUTE name for SFBool field named global.
`static java.lang.String`	`fromField_INTENSITY` fromField ROUTE name for SFFloat field named intensity.
`static java.lang.String`	`fromField_METADATA` fromField ROUTE name for SFNode field named metadata.
`static java.lang.String`	`fromField_ON` fromField ROUTE name for SFBool field named on.
`static boolean`	`GLOBAL_DEFAULT_VALUE` SFBool field named global has default value false (Java syntax) or false (XML syntax).
`static float`	`INTENSITY_DEFAULT_VALUE` SFFloat field named intensity has default value 1f (Java syntax) or 1 (XML syntax).
`static int`	`LEVEL` Integer constant LEVEL provides default X3D Lighting component level for this element: 1
`static java.lang.String`	`NAME` String constant NAME provides name of this element: DirectionalLight.
`static boolean`	`ON_DEFAULT_VALUE` SFBool field named on has default value true (Java syntax) or true (XML syntax).
`static java.lang.String`	`toField_AMBIENTINTENSITY` toField ROUTE name for SFFloat field named ambientIntensity.
`static java.lang.String`	`toField_COLOR` toField ROUTE name for SFColor field named color.
`static java.lang.String`	`toField_DIRECTION` toField ROUTE name for SFVec3f field named direction.
`static java.lang.String`	`toField_GLOBAL` toField ROUTE name for SFBool field named global.
`static java.lang.String`	`toField_INTENSITY` toField ROUTE name for SFFloat field named intensity.
`static java.lang.String`	`toField_METADATA` toField ROUTE name for SFNode field named metadata.
`static java.lang.String`	`toField_ON` toField ROUTE name for SFBool field named on.

Fields inherited from class org.web3d.x3d.jsail.X3DConcreteNode
CLASS_DEFAULT_VALUE, containerField_ALTERNATE_VALUES, DEF_DEFAULT_VALUE, USE_DEFAULT_VALUE

Fields inherited from class org.web3d.x3d.jsail.X3DConcreteElement
validationResult

Constructor Summary

Constructors
Constructor and Description
`DirectionalLightObject()` Constructor for DirectionalLightObject to initialize member variables with default values.
`DirectionalLightObject(java.lang.String DEFlabel)` Utility constructor that assigns DEF label after initializing member variables with default values.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`DirectionalLightObject`	`addComments(CommentsBlock newCommentsBlock)` Add CommentsBlock to contained commentsList.
`DirectionalLightObject`	`addComments(java.lang.String newComment)` Add comment as String to contained commentsList.
`DirectionalLightObject`	`addComments(java.lang.String[] newComments)` Add comments as String[] array to contained commentsList.
`DirectionalLightObject`	`clearMetadata()` Utility method to clear SFNode value of metadata field.
`X3DConcreteElement`	`findElementByNameValue(java.lang.String nameValue)` Recursive method to provide object reference to node or statement by name attribute, if found as part of this element or in a contained element.
`X3DConcreteElement`	`findElementByNameValue(java.lang.String nameValue, java.lang.String elementName)` Recursive method to provide object reference to node or statement by name attribute, if found as part of this element or in a contained element.
`X3DConcreteNode`	`findNodeByDEF(java.lang.String DEFvalue)` Recursive method to provide object reference to node by DEF, if found as this node or in a contained node.
`java.lang.String`	`getAccessType(java.lang.String fieldName)` Indicate accessType corresponding to given fieldName.
`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.
`java.lang.String`	`getComponent()` Defines X3D component for the DirectionalLight element: Lighting
`int`	`getComponentLevel()` Provides default X3D component level for this element: 1
`java.lang.String`	`getContainerFieldDefault()` containerField describes typical field relationship of a node to its parent.
`float[]`	`getDirection()` Provide array of 3-tuple float results from inputOutput SFVec3f field named direction.
`java.lang.String`	`getElementName()` Provides name of this element: DirectionalLight
`java.lang.String`	`getFieldType(java.lang.String fieldName)` Indicate type corresponding to given fieldName.
`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.
`ISObject`	`getIS()` Provide field named IS for establishing IS/connect field connections between ProtoInterface fields and internal ProtoBody nodes.
`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.
`boolean`	`hasElementByNameValue(java.lang.String nameValue, java.lang.String elementName)` Recursive method to determine whether node or statement with given name attribute is found, meaning both objects are attached to same scene graph.
`boolean`	`hasMetadata()` Indicate whether an object is available for inputOutput SFNode field metadata.
`boolean`	`hasNodeByDEF(java.lang.String DEFvalue)` Recursive method to determine whether node with DEFvalue is found, meaning both objects are attached to same scene graph.
`void`	`initialize()` Initialize all member variables to default values.
`DirectionalLightObject`	`setAmbientIntensity(float newValue)` Assign float value within allowed range of [0,1] to inputOutput SFFloat field named ambientIntensity.
`DirectionalLightObject`	`setAmbientIntensity(SFFloatObject newValue)` Assign typed object value to SFFloat ambientIntensity field, similar to `setAmbientIntensity(float)`.
`DirectionalLightObject`	`setColor(float[] newValue)` Assign 3-tuple float array using RGB values [0..1] using RGB values [0..1] to inputOutput SFColor field named color.
`DirectionalLightObject`	`setColor(float red, float green, float blue)` Assign values to SFColor color field, similar to `setColor(float[])`.
`DirectionalLightObject`	`setColor(SFColorObject newValue)` Assign typed object value to SFColor color field, similar to `setColor(float[])`.
`DirectionalLightObject`	`setCssClass(SFStringObject newValue)` Assign typed object value to SFString cssClass field, similar to `setCssClass(String)`.
`DirectionalLightObject`	`setCssClass(java.lang.String newValue)` Assign String value to inputOutput SFString field named class.
`DirectionalLightObject`	`setDEF(SFStringObject newValue)` Assign typed object value to SFString DEF field, similar to `setDEF(String)`.
`DirectionalLightObject`	`setDEF(java.lang.String newValue)` Assign String value to inputOutput SFString field named DEF.
`DirectionalLightObject`	`setDirection(float[] newValue)` Assign 3-tuple float array to inputOutput SFVec3f field named direction.
`DirectionalLightObject`	`setDirection(float x, float y, float z)` Assign values to SFVec3f direction field, similar to `setDirection(float[])`.
`DirectionalLightObject`	`setDirection(SFVec3fObject newValue)` Assign typed object value to SFVec3f direction field, similar to `setDirection(float[])`.
`DirectionalLightObject`	`setGlobal(boolean newValue)` Assign boolean value to inputOutput SFBool field named global.
`DirectionalLightObject`	`setGlobal(SFBoolObject newValue)` Assign typed object value to SFBool global field, similar to `setGlobal(boolean)`.
`DirectionalLightObject`	`setIntensity(float newValue)` Assign float value within allowed range of [0,1] to inputOutput SFFloat field named intensity.
`DirectionalLightObject`	`setIntensity(SFFloatObject newValue)` Assign typed object value to SFFloat intensity field, similar to `setIntensity(float)`.
`DirectionalLightObject`	`setIS(ISObject newValue)` Assign field named IS for establishing IS/connect field connections between ProtoInterface fields and internal ProtoBody nodes.
`DirectionalLightObject`	`setMetadata(ProtoInstanceObject newValue)` Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field metadata.
`DirectionalLightObject`	`setMetadata(X3DMetadataObject newValue)` Assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
`DirectionalLightObject`	`setOn(boolean newValue)` Assign boolean value to inputOutput SFBool field named on.
`DirectionalLightObject`	`setOn(SFBoolObject newValue)` Assign typed object value to SFBool on field, similar to `setOn(boolean)`.
`DirectionalLightObject`	`setUSE(DirectionalLightObject DEFnode)` Assign a USE reference to another DEF node of same node type, similar to `setUSE(String)`.
`DirectionalLightObject`	`setUSE(SFStringObject newValue)` Assign typed object value to SFString USE field, similar to `setUSE(String)`.
`DirectionalLightObject`	`setUSE(java.lang.String newValue)` Assign String value to inputOutput SFString field named USE.
`java.lang.String`	`toStringClassicVRML(int indentLevel)` Recursive method to provide ClassicVRML string serialization.
`java.lang.String`	`toStringVRML97(int indentLevel)` Recursive method to provide VRML97 string serialization.
`java.lang.String`	`toStringX3D(int indentLevel)` Recursive method to provide X3D string serialization of this model subgraph, utilizing XML encoding and conforming to X3D Canonical Form.
`java.lang.String`	`validate()` Recursive method to validate this element plus all contained nodes and statements, using both datatype-specification value checks and regular expression (regex) checking of corresponding string values.

Methods inherited from class org.web3d.x3d.jsail.X3DConcreteNode
getContainerFieldAlternateValues, getContainerFieldOverride, getCssClass, getDEF, getUSE, isNode, isStatement, isUSE, resetContainerFieldOverride, setConcreteCssClass, setConcreteDEF, setConcreteUSE, setContainerFieldOverride

Methods inherited from class org.web3d.x3d.jsail.X3DConcreteElement
clearParentObject, findAncestorElementByName, findAncestorProtoBody, findAncestorSceneObject, findAncestorX3DObject, getPackageName, getParentObject, getValidationResult, hasAncestorElementByName, hasAncestorProtoBody, hasAncestorSceneObject, hasAncestorX3DObject, setParentObject, toStringClassicVRML, toStringVRML97, toStringX3D

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - NAME
```
public static final java.lang.String NAME
```
    String constant NAME provides name of this element: DirectionalLight.
    
    See Also:
    
    Constant Field Values
  - COMPONENT
```
public static final java.lang.String COMPONENT
```
    String constant COMPONENT defines X3D component for the DirectionalLight element: Lighting
    
    See Also:
    
    Constant Field Values
  - LEVEL
```
public static final int LEVEL
```
    Integer constant LEVEL provides default X3D Lighting component level for this element: 1
    
    See Also:
    
    Constant Field Values
  - AMBIENTINTENSITY_DEFAULT_VALUE
```
public static final float AMBIENTINTENSITY_DEFAULT_VALUE
```
    SFFloat field named ambientIntensity has default value 0f (Java syntax) or 0 (XML syntax).
    
    See Also:
    
    Constant Field Values
  - COLOR_DEFAULT_VALUE
```
public static final float[] COLOR_DEFAULT_VALUE
```
    SFColor field named color has default value {1f,1f,1f} (Java syntax) or 1 1 1 (XML syntax).
  - DIRECTION_DEFAULT_VALUE
```
public static final float[] DIRECTION_DEFAULT_VALUE
```
    SFVec3f field named direction has default value {0f,0f,-1f} (Java syntax) or 0 0 -1 (XML syntax).
  - GLOBAL_DEFAULT_VALUE
```
public static final boolean GLOBAL_DEFAULT_VALUE
```
    SFBool field named global has default value false (Java syntax) or false (XML syntax).
    
    See Also:
    
    Constant Field Values
  - INTENSITY_DEFAULT_VALUE
```
public static final float INTENSITY_DEFAULT_VALUE
```
    SFFloat field named intensity has default value 1f (Java syntax) or 1 (XML syntax).
    
    See Also:
    
    Constant Field Values
  - ON_DEFAULT_VALUE
```
public static final boolean ON_DEFAULT_VALUE
```
    SFBool field named on has default value true (Java syntax) or true (XML syntax).
    
    See Also:
    
    Constant Field Values
  - containerField_DEFAULT_VALUE
```
public static final java.lang.String containerField_DEFAULT_VALUE
```
    containerField describes typical field relationship of a node to its parent. Usage is not ordinarily needed when using this API, default value is provided for informational purposes.
    
    See Also:
    
    X3D Scene Authoring Hints: containerField, X3D Unified Object Model (X3DUOM), Constant Field Values
  - fromField_AMBIENTINTENSITY
```
public static final java.lang.String fromField_AMBIENTINTENSITY
```
    fromField ROUTE name for SFFloat field named ambientIntensity.
    
    See Also:
    
    Constant Field Values
  - toField_AMBIENTINTENSITY
```
public static final java.lang.String toField_AMBIENTINTENSITY
```
    toField ROUTE name for SFFloat field named ambientIntensity.
    
    See Also:
    
    Constant Field Values
  - fromField_COLOR
```
public static final java.lang.String fromField_COLOR
```
    fromField ROUTE name for SFColor field named color.
    
    See Also:
    
    Constant Field Values
  - toField_COLOR
```
public static final java.lang.String toField_COLOR
```
    toField ROUTE name for SFColor field named color.
    
    See Also:
    
    Constant Field Values
  - fromField_DIRECTION
```
public static final java.lang.String fromField_DIRECTION
```
    fromField ROUTE name for SFVec3f field named direction.
    
    See Also:
    
    Constant Field Values
  - toField_DIRECTION
```
public static final java.lang.String toField_DIRECTION
```
    toField ROUTE name for SFVec3f field named direction.
    
    See Also:
    
    Constant Field Values
  - fromField_GLOBAL
```
public static final java.lang.String fromField_GLOBAL
```
    fromField ROUTE name for SFBool field named global.
    
    See Also:
    
    Constant Field Values
  - toField_GLOBAL
```
public static final java.lang.String toField_GLOBAL
```
    toField ROUTE name for SFBool field named global.
    
    See Also:
    
    Constant Field Values
  - fromField_INTENSITY
```
public static final java.lang.String fromField_INTENSITY
```
    fromField ROUTE name for SFFloat field named intensity.
    
    See Also:
    
    Constant Field Values
  - toField_INTENSITY
```
public static final java.lang.String toField_INTENSITY
```
    toField ROUTE name for SFFloat field named intensity.
    
    See Also:
    
    Constant Field Values
  - fromField_METADATA
```
public static final java.lang.String fromField_METADATA
```
    fromField ROUTE name for SFNode field named metadata.
    
    See Also:
    
    Constant Field Values
  - toField_METADATA
```
public static final java.lang.String toField_METADATA
```
    toField ROUTE name for SFNode field named metadata.
    
    See Also:
    
    Constant Field Values
  - fromField_ON
```
public static final java.lang.String fromField_ON
```
    fromField ROUTE name for SFBool field named on.
    
    See Also:
    
    Constant Field Values
  - toField_ON
```
public static final java.lang.String toField_ON
```
    toField ROUTE name for SFBool field named on.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - DirectionalLightObject
```
public DirectionalLightObject()
```
    Constructor for DirectionalLightObject to initialize member variables with default values.
  - DirectionalLightObject
```
public DirectionalLightObject(java.lang.String DEFlabel)
```
    Utility constructor that assigns DEF label after initializing member variables with default values.
    
    Parameters:
    
    DEFlabel - unique DEF name for this X3D node
- Method Detail
  - getElementName
```
public final java.lang.String getElementName()
```
    Provides name of this element: DirectionalLight
    
    Specified by:
    
    getElementName in class X3DConcreteElement
    
    Returns:
    
    name of this element
  - getComponent
```
public final java.lang.String getComponent()
```
    Defines X3D component for the DirectionalLight element: Lighting
    
    Specified by:
    
    getComponent in class X3DConcreteElement
    
    Returns:
    
    X3D component for this element
  - getComponentLevel
```
public final int getComponentLevel()
```
    Provides default X3D component level for this element: 1
    
    Specified by:
    
    getComponentLevel in class X3DConcreteElement
    
    Returns:
    
    default X3D component level for this element
  - getFieldType
```
public java.lang.String getFieldType(java.lang.String fieldName)
```
    Indicate type corresponding to given fieldName.
    
    Specified by:
    
    getFieldType in class X3DConcreteElement
    
    Parameters:
    
    fieldName - name of field in this X3D node
    
    Returns:
    
    X3D type (SFvec3f etc.), otherwise ConfigurationProperties.ERROR_UNKNOWN_FIELD_TYPE if not recognized
    
    See Also:
    
    ConfigurationProperties.ERROR_UNKNOWN_FIELD_TYPE
  - getAccessType
```
public java.lang.String getAccessType(java.lang.String fieldName)
```
    Indicate accessType corresponding to given fieldName.
    
    Specified by:
    
    getAccessType in class X3DConcreteElement
    
    Parameters:
    
    fieldName - name of field in this X3D node
    
    Returns:
    
    X3D accessType (inputOnly etc.), otherwise ConfigurationProperties.ERROR_UNKNOWN_FIELD_ACCESSTYPE if not recognized
    
    See Also:
    
    ConfigurationProperties.ERROR_UNKNOWN_FIELD_ACCESSTYPE
  - getContainerFieldDefault
```
public final java.lang.String getContainerFieldDefault()
```
    containerField describes typical field relationship of a node to its parent. Usage is not ordinarily needed when using this API, default value is provided for informational purposes.
    
    Specified by:
    
    getContainerFieldDefault in class X3DConcreteNode
    
    Returns:
    
    default containerField value
    
    See Also:
    
    X3D Scene Authoring Hints: containerField, X3D Unified Object Model (X3DUOM)
  - initialize
```
public final void initialize()
```
    Initialize all member variables to default values.
    
    Overrides:
    
    initialize in class X3DConcreteNode
  - getAmbientIntensity
```
public 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 DirectionalLight
    
    Specified by:
    
    getAmbientIntensity in interface X3DLightNode
    
    Returns:
    
    value of ambientIntensity field
  - setAmbientIntensity
```
public DirectionalLightObject 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 DirectionalLight
    
    Specified by:
    
    setAmbientIntensity in interface X3DLightNode
    
    Parameters:
    
    newValue - is new value for the ambientIntensity field.
    
    Returns:
    
    DirectionalLightObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setAmbientIntensity
```
public DirectionalLightObject setAmbientIntensity(SFFloatObject newValue)
```
    Assign typed object value to SFFloat ambientIntensity field, similar to setAmbientIntensity(float).
    
    Parameters:
    
    newValue - is new value for the ambientIntensity field.
    
    Returns:
    
    DirectionalLightObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - getColor
```
public 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 DirectionalLight
    
    Specified by:
    
    getColor in interface X3DLightNode
    
    Returns:
    
    value of color field
  - setColor
```
public DirectionalLightObject 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 DirectionalLight
    
    Specified by:
    
    setColor in interface X3DLightNode
    
    Parameters:
    
    newValue - is new value for the color field.
    
    Returns:
    
    DirectionalLightObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setColor
```
public DirectionalLightObject setColor(SFColorObject newValue)
```
    Assign typed object value to SFColor color field, similar to setColor(float[]).
    
    Parameters:
    
    newValue - is new value for the color field.
    
    Returns:
    
    DirectionalLightObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setColor
```
public DirectionalLightObject setColor(float red,
                                       float green,
                                       float blue)
```
    Assign values to SFColor color field, similar to setColor(float[]).
    
    Parameters:
    
    red - first component
    
    green - second component
    
    blue - third component
    
    Returns:
    
    DirectionalLightObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - getDirection
```
public 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.
    Specified by:
    
    getDirection in interface DirectionalLight
    
    Returns:
    
    value of direction field
  - setDirection
```
public DirectionalLightObject 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.
    
    Specified by:
    
    setDirection in interface DirectionalLight
    
    Parameters:
    
    newValue - is new value for the direction field.
    
    Returns:
    
    DirectionalLightObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setDirection
```
public DirectionalLightObject setDirection(SFVec3fObject newValue)
```
    Assign typed object value to SFVec3f direction field, similar to setDirection(float[]).
    
    Parameters:
    
    newValue - is new value for the direction field.
    
    Returns:
    
    DirectionalLightObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setDirection
```
public DirectionalLightObject setDirection(float x,
                                           float y,
                                           float z)
```
    Assign values to SFVec3f direction field, similar to setDirection(float[]).
    
    Parameters:
    
    x - first component
    
    y - second component
    
    z - third component
    
    Returns:
    
    DirectionalLightObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - getGlobal
```
public 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.
    Specified by:
    
    getGlobal in interface DirectionalLight
    
    Returns:
    
    value of global field
  - setGlobal
```
public DirectionalLightObject 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.
    
    Specified by:
    
    setGlobal in interface DirectionalLight
    
    Parameters:
    
    newValue - is new value for the global field.
    
    Returns:
    
    DirectionalLightObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setGlobal
```
public DirectionalLightObject setGlobal(SFBoolObject newValue)
```
    Assign typed object value to SFBool global field, similar to setGlobal(boolean).
    
    Parameters:
    
    newValue - is new value for the global field.
    
    Returns:
    
    DirectionalLightObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - getIntensity
```
public 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 DirectionalLight
    
    Specified by:
    
    getIntensity in interface X3DLightNode
    
    Returns:
    
    value of intensity field
  - setIntensity
```
public DirectionalLightObject 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 DirectionalLight
    
    Specified by:
    
    setIntensity in interface X3DLightNode
    
    Parameters:
    
    newValue - is new value for the intensity field.
    
    Returns:
    
    DirectionalLightObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setIntensity
```
public DirectionalLightObject setIntensity(SFFloatObject newValue)
```
    Assign typed object value to SFFloat intensity field, similar to setIntensity(float).
    
    Parameters:
    
    newValue - is new value for the intensity field.
    
    Returns:
    
    DirectionalLightObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - getMetadata
```
public 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
    
    Specified by:
    
    getMetadata in interface DirectionalLight
    
    Specified by:
    
    getMetadata in interface X3DLightNode
    
    Returns:
    
    value of metadata field
    
    See Also:
    
    getMetadataProtoInstance(), X3D Scene Authoring Hints: Metadata Nodes
  - setMetadata
```
public DirectionalLightObject 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
    
    Specified by:
    
    setMetadata in interface DirectionalLight
    
    Specified by:
    
    setMetadata in interface X3DLightNode
    
    Specified by:
    
    setMetadata in class X3DConcreteNode
    
    Parameters:
    
    newValue - is new value for the metadata field.
    
    Returns:
    
    DirectionalLightObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    
    See Also:
    
    setMetadata(ProtoInstanceObject), X3D Scene Authoring Hints: Metadata Nodes
  - clearMetadata
```
public DirectionalLightObject clearMetadata()
```
    Utility method to clear SFNode value of metadata field.
    
    Returns:
    
    DirectionalLightObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
  - setMetadata
```
public DirectionalLightObject setMetadata(ProtoInstanceObject newValue)
```
    Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field metadata.
    
    Specified by:
    
    setMetadata in class X3DConcreteNode
    
    Parameters:
    
    newValue - is new value for the metadata field.
    
    Returns:
    
    DirectionalLightObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    
    See Also:
    
    setMetadata(X3DMetadataObject)
  - hasMetadata
```
public boolean hasMetadata()
```
    Indicate whether an object is available for inputOutput SFNode field metadata.
    
    Returns:
    
    whether a properly typed node or ProtoInstance or CommentsBlock is available.
    
    See Also:
    
    getMetadata(), getMetadataProtoInstance(), X3D Scene Authoring Hints: Metadata Nodes
  - getOn
```
public boolean getOn()
```
    Provide boolean value from inputOutput SFBool field named on.
    
    Tooltip: Enables/disables this light source. *
    
    Specified by:
    
    getOn in interface DirectionalLight
    
    Specified by:
    
    getOn in interface X3DLightNode
    
    Returns:
    
    value of on field
  - setOn
```
public DirectionalLightObject setOn(boolean newValue)
```
    Assign boolean value to inputOutput SFBool field named on.
    
    Tooltip: Enables/disables this light source.
    
    Specified by:
    
    setOn in interface DirectionalLight
    
    Specified by:
    
    setOn in interface X3DLightNode
    
    Parameters:
    
    newValue - is new value for the on field.
    
    Returns:
    
    DirectionalLightObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setOn
```
public DirectionalLightObject setOn(SFBoolObject newValue)
```
    Assign typed object value to SFBool on field, similar to setOn(boolean).
    
    Parameters:
    
    newValue - is new value for the on field.
    
    Returns:
    
    DirectionalLightObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setDEF
```
public final DirectionalLightObject 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 X3DNode
    
    Specified by:
    
    setDEF in interface DirectionalLight
    
    Specified by:
    
    setDEF in interface X3DLightNode
    
    Specified by:
    
    setDEF in class X3DConcreteNode
    
    Parameters:
    
    newValue - is new value for the DEF field.
    
    Returns:
    
    DirectionalLightObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setDEF
```
public DirectionalLightObject setDEF(SFStringObject newValue)
```
    Assign typed object value to SFString DEF field, similar to setDEF(String).
    
    Parameters:
    
    newValue - is new value for the DEF field.
    
    Returns:
    
    DirectionalLightObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setUSE
```
public final DirectionalLightObject 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 X3DNode
    
    Specified by:
    
    setUSE in interface DirectionalLight
    
    Specified by:
    
    setUSE in interface X3DLightNode
    
    Specified by:
    
    setUSE in class X3DConcreteNode
    
    Parameters:
    
    newValue - is new value for the USE field.
    
    Returns:
    
    DirectionalLightObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setUSE
```
public DirectionalLightObject setUSE(SFStringObject newValue)
```
    Assign typed object value to SFString USE field, similar to setUSE(String).
    
    Parameters:
    
    newValue - is new value for the USE field.
    
    Returns:
    
    DirectionalLightObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setCssClass
```
public final DirectionalLightObject 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 X3DNode
    
    Specified by:
    
    setCssClass in interface DirectionalLight
    
    Specified by:
    
    setCssClass in interface X3DLightNode
    
    Specified by:
    
    setCssClass in class X3DConcreteNode
    
    Parameters:
    
    newValue - is new value for the class field.
    
    Returns:
    
    DirectionalLightObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    
    See Also:
    
    W3C Cascading Style Sheets
  - setCssClass
```
public DirectionalLightObject setCssClass(SFStringObject newValue)
```
    Assign typed object value to SFString cssClass field, similar to setCssClass(String).
    
    Parameters:
    
    newValue - is new value for the class field.
    
    Returns:
    
    DirectionalLightObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setIS
```
public DirectionalLightObject setIS(ISObject newValue)
```
    Assign field named IS for establishing IS/connect field connections between ProtoInterface fields and internal ProtoBody nodes. The IS statement connects node fields defined inside a ProtoBody declaration back to corresponding ProtoInterface fields.
    
    Specified by:
    
    setIS in class X3DConcreteNode
    
    Parameters:
    
    newValue - is new value for the description field.
    
    Returns:
    
    DirectionalLightObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    
    See Also:
    
    X3D Tooltips: IS, X3D Tooltips: connect
  - getIS
```
public ISObject getIS()
```
    Provide field named IS for establishing IS/connect field connections between ProtoInterface fields and internal ProtoBody nodes. The IS statement connects node fields defined inside a ProtoBody declaration back to corresponding ProtoInterface fields.
    
    Specified by:
    
    getIS in class X3DConcreteNode
    
    Returns:
    
    current ISObject, if any.
    
    See Also:
    
    X3D Tooltips: IS, X3D Tooltips: connect
  - setUSE
```
public DirectionalLightObject setUSE(DirectionalLightObject DEFnode)
```
    Assign a USE reference to another DEF node of same node type, similar to setUSE(String).
    
    Warning: note that 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.
    
    Parameters:
    
    DEFnode - must have a DEF value defined
    
    Returns:
    
    DirectionalLightObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - addComments
```
public DirectionalLightObject addComments(java.lang.String newComment)
```
    Add comment as String to contained commentsList.
    
    Specified by:
    
    addComments in class X3DConcreteElement
    
    Parameters:
    
    newComment - initial value
    
    Returns:
    
    DirectionalLightObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
  - addComments
```
public DirectionalLightObject addComments(java.lang.String[] newComments)
```
    Add comments as String[] array to contained commentsList.
    
    Specified by:
    
    addComments in class X3DConcreteElement
    
    Parameters:
    
    newComments - array of comments
    
    Returns:
    
    DirectionalLightObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
  - addComments
```
public DirectionalLightObject addComments(CommentsBlock newCommentsBlock)
```
    Add CommentsBlock to contained commentsList.
    
    Specified by:
    
    addComments in class X3DConcreteElement
    
    Parameters:
    
    newCommentsBlock - block of comments to add
    
    Returns:
    
    DirectionalLightObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
  - toStringX3D
```
public java.lang.String toStringX3D(int indentLevel)
```
    Recursive method to provide X3D string serialization of this model subgraph, utilizing XML encoding and conforming to X3D Canonical Form.
    
    Specified by:
    
    toStringX3D in class X3DConcreteElement
    
    Parameters:
    
    indentLevel - number of levels of indentation for this element
    
    Returns:
    
    X3D string
    
    See Also:
    
    X3DObject.FILE_EXTENSION_X3D, X3DObject.FILE_EXTENSION_XML, X3DObject.toStringXML(), X3DObject.toFileXML(String), X3DObject.toFileX3D(String), X3D XML Encoding, X3D Compressed Binary Encoding: X3D Canonical Form
  - toStringClassicVRML
```
public java.lang.String toStringClassicVRML(int indentLevel)
```
    Recursive method to provide ClassicVRML string serialization.
    
    Specified by:
    
    toStringClassicVRML in class X3DConcreteElement
    
    Parameters:
    
    indentLevel - number of levels of indentation for this element
    
    Returns:
    
    ClassicVRML string
    
    See Also:
    
    X3DObject.FILE_EXTENSION_CLASSICVRML, X3D Resources: Virtual Reality Modeling Language (VRML) 97, Extensible 3D (X3D) encodings Part 2: Classic VRML encoding, Extensible 3D (X3D) encodings Part 2: Classic VRML encoding, Annex A: Grammar
  - toStringVRML97
```
public java.lang.String toStringVRML97(int indentLevel)
```
    Recursive method to provide VRML97 string serialization.
    
    Specified by:
    
    toStringVRML97 in class X3DConcreteElement
    
    Parameters:
    
    indentLevel - number of levels of indentation for this element
    
    Returns:
    
    VRML97 string
    
    See Also:
    
    X3DObject.FILE_EXTENSION_VRML97, X3D Resources: Virtual Reality Modeling Language (VRML) 97, Virtual Reality Modeling Language (VRML) 97 specification, VRML 97 v2.1 Amendment
  - findElementByNameValue
```
public X3DConcreteElement findElementByNameValue(java.lang.String nameValue)
```
    Recursive method to provide object reference to node or statement by name attribute, if found as part of this element or in a contained element. Elements with name fields include meta, Metadata* nodes, field/fieldValue, ProtoDeclare/ExternProtoDeclare/ProtoInstance, CAD and HAnim nodes.
    
    Warning: first start with findAncestorSceneObject() to check entire scene graph, or findAncestorX3DObject() to check entire model document.
    
    Warning: more than one element may be found that has the same name, this method does not handle that case.
    
    Specified by:
    
    findElementByNameValue in class X3DConcreteElement
    
    Parameters:
    
    nameValue - is value of the name field being searched for in this element and child elements(if any)
    
    Returns:
    
    object reference to found element, null otherwise
    
    See Also:
    
    findNodeByDEF(String), X3DConcreteElement.hasAncestorSceneObject(), X3DConcreteElement.findAncestorX3DObject()
  - findElementByNameValue
```
public X3DConcreteElement findElementByNameValue(java.lang.String nameValue,
                                                 java.lang.String elementName)
```
    Recursive method to provide object reference to node or statement by name attribute, if found as part of this element or in a contained element. Elements with name fields include meta, Metadata* nodes, field/fieldValue, ProtoDeclare/ExternProtoDeclare/ProtoInstance, CAD and HAnim nodes.
    
    Warning: first start with findAncestorSceneObject() to check entire scene graph, or findAncestorX3DObject() to check entire model document.
    
    Warning: more than one element may be found that has the same name, this method does not handle that case.
    
    Specified by:
    
    findElementByNameValue in class X3DConcreteElement
    
    Parameters:
    
    nameValue - is value of the name field being searched for in this element and child elements(if any)
    
    elementName - identifies the element of interest (meta MetadataString ProtoDeclare CADassembly ProtoInstance HAnimHumanoid etc.)
    
    Returns:
    
    object reference to found element, null otherwise
    
    See Also:
    
    findNodeByDEF(String), X3DConcreteElement.hasAncestorSceneObject(), X3DConcreteElement.findAncestorX3DObject()
  - hasElementByNameValue
```
public boolean hasElementByNameValue(java.lang.String nameValue,
                                     java.lang.String elementName)
```
    Recursive method to determine whether node or statement with given name attribute is found, meaning both objects are attached to same scene graph.
    
    Parameters:
    
    nameValue - is value of the name field being searched for in this element and child elements(if any)
    
    elementName - identifies the element of interest (meta MetadataString ProtoDeclare CADassembly ProtoInstance HAnimHumanoid etc.)
    
    Returns:
    
    whether node is found
    
    See Also:
    
    findElementByNameValue(String, String)
  - findNodeByDEF
```
public X3DConcreteNode findNodeByDEF(java.lang.String DEFvalue)
```
    Recursive method to provide object reference to node by DEF, if found as this node or in a contained node.
    
    Warning: first start with findAncestorSceneObject() to check entire scene graph, or findAncestorX3DObject() to check entire model document.
    
    Warning: more than one element may be found that has the same DEF, this method does not handle that case.
    
    Specified by:
    
    findNodeByDEF in class X3DConcreteElement
    
    Parameters:
    
    DEFvalue - is value of the name field being searched for in this element and child elements(if any)
    
    Returns:
    
    object reference to found node, null otherwise
    
    See Also:
    
    findElementByNameValue(String), X3DConcreteElement.hasAncestorSceneObject(), X3DConcreteElement.findAncestorX3DObject()
  - hasNodeByDEF
```
public boolean hasNodeByDEF(java.lang.String DEFvalue)
```
    Recursive method to determine whether node with DEFvalue is found, meaning both objects are attached to same scene graph.
    
    Parameters:
    
    DEFvalue - is value of the name field being searched for in this element and child elements(if any)
    
    Returns:
    
    whether node is found
    
    See Also:
    
    findNodeByDEF(String)
  - validate
```
public java.lang.String validate()
```
    Recursive method to validate this element plus all contained nodes and statements, using both datatype-specification value checks and regular expression (regex) checking of corresponding string values.
    
    Specified by:
    
    validate in class X3DConcreteElement
    
    Returns:
    
    validation results (if any)

Class DirectionalLightObject

Field Summary

Fields inherited from class org.web3d.x3d.jsail.X3DConcreteNode

Fields inherited from class org.web3d.x3d.jsail.X3DConcreteElement

Constructor Summary

Method Summary

Methods inherited from class org.web3d.x3d.jsail.X3DConcreteNode

Methods inherited from class org.web3d.x3d.jsail.X3DConcreteElement

Methods inherited from class java.lang.Object

Field Detail

NAME

COMPONENT

LEVEL

AMBIENTINTENSITY_DEFAULT_VALUE

COLOR_DEFAULT_VALUE

DIRECTION_DEFAULT_VALUE

GLOBAL_DEFAULT_VALUE

INTENSITY_DEFAULT_VALUE

ON_DEFAULT_VALUE

containerField_DEFAULT_VALUE

fromField_AMBIENTINTENSITY

toField_AMBIENTINTENSITY

fromField_COLOR

toField_COLOR

fromField_DIRECTION

toField_DIRECTION

fromField_GLOBAL

toField_GLOBAL

fromField_INTENSITY

toField_INTENSITY

fromField_METADATA

toField_METADATA

fromField_ON

toField_ON

Constructor Detail

DirectionalLightObject

DirectionalLightObject

Method Detail

getElementName

getComponent

getComponentLevel

getFieldType

getAccessType

getContainerFieldDefault

initialize

getAmbientIntensity

setAmbientIntensity

setAmbientIntensity

getColor

setColor

setColor

setColor

getDirection

setDirection

setDirection

setDirection

getGlobal

setGlobal

setGlobal

getIntensity

setIntensity

setIntensity

getMetadata

setMetadata

clearMetadata

setMetadata

hasMetadata

getOn

setOn

setOn

setDEF

setDEF

setUSE

setUSE

setCssClass

setCssClass

setIS

getIS

setUSE

addComments