Class DirectionalLight

java.lang.Object

org.web3d.x3d.jsail.X3DConcreteElement

org.web3d.x3d.jsail.X3DConcreteNode

org.web3d.x3d.jsail.Lighting.DirectionalLight

All Implemented Interfaces:

X3DChildNode, X3DNode, DirectionalLight, X3DLightNode

public class DirectionalLight
extends X3DConcreteNode
implements DirectionalLight

DirectionalLight might not be scoped by parent Group or Transform at levels 1 or 2.

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. DirectionalLight 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 SFColor 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	Description
static final float	AMBIENTINTENSITY_DEFAULT_VALUE	SFFloat field named ambientIntensity has default value 0f (Java syntax) or 0 (XML syntax).
static final float[]	COLOR_DEFAULT_VALUE	SFColor field named color has default value {1f,1f,1f} (Java syntax) or 1 1 1 (XML syntax).
static final String	COMPONENT	String constant COMPONENT defines X3D component for the DirectionalLight element: Lighting
static final String	containerField_DEFAULT_VALUE	containerField describes typical field relationship of a node to its parent.
static final float[]	DIRECTION_DEFAULT_VALUE	SFVec3f field named direction has default value {0f,0f,-1f} (Java syntax) or 0 0 -1 (XML syntax).
static final String	fromField_AMBIENTINTENSITY	fromField ROUTE name for SFFloat field named ambientIntensity.
static final String	fromField_COLOR	fromField ROUTE name for SFColor field named color.
static final String	fromField_DIRECTION	fromField ROUTE name for SFVec3f field named direction.
static final String	fromField_GLOBAL	fromField ROUTE name for SFBool field named global.
static final String	fromField_INTENSITY	fromField ROUTE name for SFFloat field named intensity.
static final String	fromField_IS	fromField ROUTE name for SFNode field named IS.
static final String	fromField_METADATA	fromField ROUTE name for SFNode field named metadata.
static final String	fromField_ON	fromField ROUTE name for SFBool field named on.
static final String	fromField_SHADOWINTENSITY	fromField ROUTE name for SFFloat field named shadowIntensity.
static final String	fromField_SHADOWS	fromField ROUTE name for SFBool field named shadows.
static final boolean	GLOBAL_DEFAULT_VALUE	SFBool field named global has default value false (Java syntax) or false (XML syntax).
static final float	INTENSITY_DEFAULT_VALUE	SFFloat field named intensity has default value 1f (Java syntax) or 1 (XML syntax).
static final IS	IS_DEFAULT_VALUE	SFNode field named IS has default value null (Java syntax) or NULL (XML syntax).
static final int	LEVEL	Integer constant LEVEL provides default X3D Lighting component level for this element: 1
static final X3DMetadataObject	METADATA_DEFAULT_VALUE	SFNode field named metadata has default value null (Java syntax) or NULL (XML syntax).
static final String	NAME	String constant NAME provides name of this element: DirectionalLight.
static final boolean	ON_DEFAULT_VALUE	SFBool field named on has default value true (Java syntax) or true (XML syntax).
static final float	SHADOWINTENSITY_DEFAULT_VALUE	SFFloat field named shadowIntensity has default value 1f (Java syntax) or 1 (XML syntax).
static final boolean	SHADOWS_DEFAULT_VALUE	SFBool field named shadows has default value false (Java syntax) or false (XML syntax).
static final String	toField_AMBIENTINTENSITY	toField ROUTE name for SFFloat field named ambientIntensity.
static final String	toField_COLOR	toField ROUTE name for SFColor field named color.
static final String	toField_DIRECTION	toField ROUTE name for SFVec3f field named direction.
static final String	toField_GLOBAL	toField ROUTE name for SFBool field named global.
static final String	toField_INTENSITY	toField ROUTE name for SFFloat field named intensity.
static final String	toField_METADATA	toField ROUTE name for SFNode field named metadata.
static final String	toField_ON	toField ROUTE name for SFBool field named on.
static final String	toField_SHADOWINTENSITY	toField ROUTE name for SFFloat field named shadowIntensity.
static final String	toField_SHADOWS	toField ROUTE name for SFBool field named shadows.

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

containerField_ALLOWED_VALUES, containerFieldOverride, DEF_DEFAULT_VALUE, USE_DEFAULT_VALUE

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

CLASS_DEFAULT_VALUE, ID_DEFAULT_VALUE, STYLE_DEFAULT_VALUE, validationResult

Constructor Summary

Constructors

Constructor	Description
DirectionalLight()	Constructor for DirectionalLight to initialize member variables with default values.
DirectionalLight(String DEFlabel)	Utility constructor that assigns DEF label after initializing member variables with default values.

Method Summary

Modifier and Type	Method	Description
DirectionalLight	addComments(String newComment)	Add comment as String to contained commentsList.
DirectionalLight	addComments(String[] newComments)	Add comments as String[] array to contained commentsList.
DirectionalLight	addComments(CommentsBlock newCommentsBlock)	Add CommentsBlock to contained commentsList.
DirectionalLight	clearIS()	Utility method to clear SFNode value of IS field.
DirectionalLight	clearMetadata()	Utility method to clear SFNode value of metadata field.
X3DConcreteElement	findElementByNameValue(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(String nameValue, 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(String DEFvalue)	Recursive method to provide object reference to node by DEF, if found as this node or in a contained node.
String	getAccessType(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.
final String	getComponent()	Defines X3D component for the DirectionalLight element: Lighting
final int	getComponentLevel()	Provides default X3D component level for this element: 1
final String	getContainerFieldDefault()	containerField describes typical field relationship of a node to its parent.
String	getCssClass()	Provide String value from inputOutput SFString field named class.
String	getCssStyle()	Provide String value from inputOutput SFString field named style.
String	getDEF()	Provide String value from inputOutput SFString field named DEF.
float[]	getDirection()	Provide array of 3-tuple float results from inputOutput SFVec3f field named direction.
final String	getElementName()	Provides name of this element: DirectionalLight
String	getFieldType(String fieldName)	Indicate type corresponding to given fieldName.
boolean	getGlobal()	Provide boolean value from inputOutput SFBool field named global.
String	getHtmlID()	Provide String value from inputOutput SFString field named id.
float	getIntensity()	Provide float value within allowed range of [0,infinity) from inputOutput SFFloat field named intensity.
IS	getIS()	Provide IS instance (using a properly typed node) from inputOutput SFNode field IS.
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.
String	getUSE()	Provide String value from inputOutput SFString field named USE.
boolean	hasElementByNameValue(String nameValue, 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	hasIS()	Indicate whether an object is available for inputOutput SFNode field IS.
boolean	hasMetadata()	Indicate whether an object is available for inputOutput SFNode field metadata.
boolean	hasNodeByDEF(String DEFvalue)	Recursive method to determine whether node with DEFvalue is found, meaning both objects are attached to same scene graph.
final void	initialize()	Initialize all member variables to default values.
DirectionalLight	setAmbientIntensity(double newValue)	Utility method: double-precision set-parameter accessor for X3D floating-point type, similar to setAmbientIntensity(float).
DirectionalLight	setAmbientIntensity(float newValue)	Accessor method to assign float value to inputOutput SFFloat field named ambientIntensity.
DirectionalLight	setAmbientIntensity(SFFloat newValue)	Assign typed object value to SFFloat ambientIntensity field, similar to setAmbientIntensity(float).
DirectionalLight	setColor(double[] newArray)	Utility method: double-precision set-parameters accessor for X3D floating-point type, similar to setColor(float[]).
DirectionalLight	setColor(double red, double green, double blue)	Utility method: double-precision set-parameters accessor for X3D floating-point type, similar to setColor(float[]).
DirectionalLight	setColor(float[] newValue)	Accessor method to assign 3-tuple float array using RGB values [0..1] to inputOutput SFColor field named color.
DirectionalLight	setColor(float red, float green, float blue)	Assign values to SFColor color field, similar to setColor(float[]).
DirectionalLight	setColor(SFColor newValue)	Assign typed object value to SFColor color field, similar to setColor(float[]).
final DirectionalLight	setCssClass(String newValue)	Accessor method to assign String value to inputOutput SFString field named class.
DirectionalLight	setCssClass(SFString newValue)	Assign typed object value to SFString cssClass field, similar to setCssClass(String).
final DirectionalLight	setCssStyle(String newValue)	Accessor method to assign String value to inputOutput SFString field named style.
DirectionalLight	setCssStyle(SFString newValue)	Assign typed object value to SFString cssClass field, similar to setCssStyle(String).
final DirectionalLight	setDEF(String newValue)	Accessor method to assign String value to inputOutput SFString field named DEF.
DirectionalLight	setDEF(SFString newValue)	Assign typed object value to SFString DEF field, similar to setDEF(String).
DirectionalLight	setDirection(double[] newArray)	Utility method: double-precision set-array accessor for X3D floating-point type, similar to setDirection(float[]).
DirectionalLight	setDirection(double x, double y, double z)	Utility method: double-precision set-parameters accessor for X3D floating-point type, similar to setDirection(float[]).
DirectionalLight	setDirection(float[] newValue)	Accessor method to assign 3-tuple float array to inputOutput SFVec3f field named direction.
DirectionalLight	setDirection(float x, float y, float z)	Assign values to SFVec3f direction field, similar to setDirection(float[]).
DirectionalLight	setDirection(SFVec3f newValue)	Assign typed object value to SFVec3f direction field, similar to setDirection(float[]).
DirectionalLight	setGlobal(boolean newValue)	Accessor method to assign boolean value to inputOutput SFBool field named global.
DirectionalLight	setGlobal(SFBool newValue)	Assign typed object value to SFBool global field, similar to setGlobal(boolean).
final DirectionalLight	setHtmlID(String newValue)	Accessor method to assign String value to inputOutput SFString field named id.
DirectionalLight	setHtmlID(SFString newValue)	Assign typed object value to SFString HtmlID field, similar to setHtmlID(String).
DirectionalLight	setIntensity(double newValue)	Utility method: double-precision set-parameter accessor for X3D floating-point type, similar to setIntensity(float).
DirectionalLight	setIntensity(float newValue)	Accessor method to assign float value to inputOutput SFFloat field named intensity.
DirectionalLight	setIntensity(SFFloat newValue)	Assign typed object value to SFFloat intensity field, similar to setIntensity(float).
DirectionalLight	setIS(IS newValue)	Accessor method to assign IS instance (using a properly typed node) to inputOutput SFNode field IS.
DirectionalLight	setMetadata(ProtoInstance newValue)	Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field metadata.
DirectionalLight	setMetadata(X3DMetadataObject newValue)	Accessor method to assign org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
DirectionalLight	setOn(boolean newValue)	Accessor method to assign boolean value to inputOutput SFBool field named on.
DirectionalLight	setOn(SFBool newValue)	Assign typed object value to SFBool on field, similar to setOn(boolean).
DirectionalLight	setShadowIntensity(double newValue)	Utility method: double-precision set-parameter accessor for X3D floating-point type, similar to setShadowIntensity(float).
DirectionalLight	setShadowIntensity(float newValue)	Accessor method to assign float value to inputOutput SFFloat field named shadowIntensity.
DirectionalLight	setShadowIntensity(SFFloat newValue)	Assign typed object value to SFFloat shadowIntensity field, similar to setShadowIntensity(float).
DirectionalLight	setShadows(boolean newValue)	Accessor method to assign boolean value to inputOutput SFBool field named shadows.
DirectionalLight	setShadows(SFBool newValue)	Assign typed object value to SFBool shadows field, similar to setShadows(boolean).
final DirectionalLight	setUSE(String newValue)	Accessor method to assign String value to inputOutput SFString field named USE.
DirectionalLight	setUSE(SFString newValue)	Assign typed object value to SFString USE field, similar to setUSE(String).
DirectionalLight	setUSE(DirectionalLight DEFnode)	Assign a USE reference to another DEF node of same node type, similar to setUSE(String).
String	toStringClassicVRML(int indentLevel)	Recursive method to provide ClassicVRML string serialization.
String	toStringVRML97(int indentLevel)	Recursive method to provide VRML97 string serialization.
String	toStringX3D(int indentLevel)	Recursive method to provide X3D string serialization of this model subgraph, utilizing XML encoding and conforming to X3D Canonical Form.
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

getContainerFieldAllowedValues, getContainerFieldOverride, getName, hasDEF, hasNameField, hasUSE, includesNameField, isNode, isStatement, resetContainerFieldOverride, setConcreteDEF, setConcreteUSE, setContainerFieldOverride

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

addComments, clearParent, findAncestorElementByName, findAncestorProtoBody, findAncestorScene, findAncestorX3D, getPackageName, getParent, getValidationResult, hasAncestorElementByName, hasAncestorProtoBody, hasAncestorScene, hasAncestorX3D, hasParent, isValid, setConcreteCssClass, setConcreteCssStyle, setConcreteHtmlID, setParent, toStringClassicVRML, toStringVRML97, toStringX3D

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

NAME

public static final String NAME

String constant NAME provides name of this element: DirectionalLight.

See Also:

• Constant Field Values

COMPONENT

public static final 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

IS_DEFAULT_VALUE

public static final IS IS_DEFAULT_VALUE

SFNode field named IS has default value null (Java syntax) or NULL (XML syntax).

METADATA_DEFAULT_VALUE

public static final X3DMetadataObject METADATA_DEFAULT_VALUE

SFNode field named metadata has default value null (Java syntax) or NULL (XML syntax).

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

SHADOWINTENSITY_DEFAULT_VALUE

public static final float SHADOWINTENSITY_DEFAULT_VALUE

SFFloat field named shadowIntensity has default value 1f (Java syntax) or 1 (XML syntax).

See Also:

• Constant Field Values

SHADOWS_DEFAULT_VALUE

public static final boolean SHADOWS_DEFAULT_VALUE

SFBool field named shadows has default value false (Java syntax) or false (XML syntax).

See Also:

• Constant Field Values

containerField_DEFAULT_VALUE

public static final String containerField_DEFAULT_VALUE

containerField describes typical field relationship of a node to its parent. Usage is not ordinarily needed when using this API, this default value is provided for informational purposes only.
containerField_DEFAULT_VALUE = "children";
containerField_ALLOWED_VALUES = {"children" }; type xs:NMTOKEN

See Also:

• X3D Scene Authoring Hints: containerField
• X3D Scene Authoring Hints: validation choices for containerField
• X3D Unified Object Model (X3DUOM)
• Constant Field Values

fromField_AMBIENTINTENSITY

public static final String fromField_AMBIENTINTENSITY

fromField ROUTE name for SFFloat field named ambientIntensity.

See Also:

• Constant Field Values

toField_AMBIENTINTENSITY

public static final String toField_AMBIENTINTENSITY

toField ROUTE name for SFFloat field named ambientIntensity.

See Also:

• Constant Field Values

fromField_COLOR

public static final String fromField_COLOR

fromField ROUTE name for SFColor field named color.

See Also:

• Constant Field Values

toField_COLOR

public static final String toField_COLOR

toField ROUTE name for SFColor field named color.

See Also:

• Constant Field Values

fromField_DIRECTION

public static final String fromField_DIRECTION

fromField ROUTE name for SFVec3f field named direction.

See Also:

• Constant Field Values

toField_DIRECTION

public static final String toField_DIRECTION

toField ROUTE name for SFVec3f field named direction.

See Also:

• Constant Field Values

fromField_GLOBAL

public static final String fromField_GLOBAL

fromField ROUTE name for SFBool field named global.

See Also:

• Constant Field Values

toField_GLOBAL

public static final String toField_GLOBAL

toField ROUTE name for SFBool field named global.

See Also:

• Constant Field Values

fromField_INTENSITY

public static final String fromField_INTENSITY

fromField ROUTE name for SFFloat field named intensity.

See Also:

• Constant Field Values

toField_INTENSITY

public static final String toField_INTENSITY

toField ROUTE name for SFFloat field named intensity.

See Also:

• Constant Field Values

fromField_IS

public static final String fromField_IS

fromField ROUTE name for SFNode field named IS.

See Also:

• Constant Field Values

fromField_METADATA

public static final String fromField_METADATA

fromField ROUTE name for SFNode field named metadata.

See Also:

• Constant Field Values

toField_METADATA

public static final String toField_METADATA

toField ROUTE name for SFNode field named metadata.

See Also:

• Constant Field Values

fromField_ON

public static final String fromField_ON

fromField ROUTE name for SFBool field named on.

See Also:

• Constant Field Values

toField_ON

public static final String toField_ON

toField ROUTE name for SFBool field named on.

See Also:

• Constant Field Values

fromField_SHADOWINTENSITY

public static final String fromField_SHADOWINTENSITY

fromField ROUTE name for SFFloat field named shadowIntensity.

See Also:

• Constant Field Values

toField_SHADOWINTENSITY

public static final String toField_SHADOWINTENSITY

toField ROUTE name for SFFloat field named shadowIntensity.

See Also:

• Constant Field Values

fromField_SHADOWS

public static final String fromField_SHADOWS

fromField ROUTE name for SFBool field named shadows.

See Also:

• Constant Field Values

toField_SHADOWS

public static final String toField_SHADOWS

toField ROUTE name for SFBool field named shadows.

See Also:

• Constant Field Values

Constructor Details

DirectionalLight

public DirectionalLight()

Constructor for DirectionalLight to initialize member variables with default values.

DirectionalLight

public DirectionalLight(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 Details

getElementName

public final String getElementName()

Provides name of this element: DirectionalLight

Specified by:

getElementName in class X3DConcreteElement

Returns:

name of this element

getComponent

public final 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 String getFieldType(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 String getAccessType(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 String getContainerFieldDefault()

containerField describes typical field relationship of a node to its parent. Programmer usage is not ordinarily needed when using this API, since this default value is provided for informational purposes only.

Specified by:

getContainerFieldDefault in class X3DConcreteNode

Returns:

default containerField value

See Also:

• containerField_DEFAULT_VALUE
• X3DConcreteNode.containerField_ALLOWED_VALUES
• X3D Scene Authoring Hints: containerField
• X3D Scene Authoring Hints: validation choices for 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 DirectionalLight setAmbientIntensity(float newValue)

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

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

setAmbientIntensity

public DirectionalLight setAmbientIntensity(SFFloat newValue)

Assign typed object value to SFFloat ambientIntensity field, similar to setAmbientIntensity(float).

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).

setAmbientIntensity

public DirectionalLight setAmbientIntensity(double newValue)

Utility method: double-precision set-parameter accessor for X3D floating-point type, similar to setAmbientIntensity(float).

Parameters:

newValue - is new value for field

Returns:

DirectionalLight - 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 https://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 DirectionalLight setColor(float[] newValue)

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

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

setColor

public DirectionalLight setColor(SFColor newValue)

Assign typed object value to SFColor color field, similar to setColor(float[]).

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).

setColor

public DirectionalLight 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:

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

setColor

public DirectionalLight setColor(double red,
 double green,
 double blue)

Utility method: double-precision set-parameters accessor for X3D floating-point type, similar to setColor(float[]).

Parameters:

red - first component [0..1]

green - second component [0..1]

blue - third component [0..1]

Returns:

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

setColor

public DirectionalLight setColor(double[] newArray)

Utility method: double-precision set-parameters accessor for X3D floating-point type, similar to setColor(float[]).

Parameters:

newArray - is new value for field

Returns:

DirectionalLight - 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 DirectionalLight setDirection(float[] newValue)

Accessor method to 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:

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

setDirection

public DirectionalLight setDirection(SFVec3f newValue)

Assign typed object value to SFVec3f direction field, similar to setDirection(float[]).

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).

setDirection

public DirectionalLight 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:

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

setDirection

public DirectionalLight setDirection(double x,
 double y,
 double z)

Utility method: double-precision set-parameters accessor for X3D floating-point type, similar to setDirection(float[]).

Parameters:

x - first component

y - second component

z - third component

Returns:

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

setDirection

public DirectionalLight setDirection(double[] newArray)

Utility method: double-precision set-array accessor for X3D floating-point type, similar to setDirection(float[]).

Parameters:

newArray - is new value for field

Returns:

DirectionalLight - 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 DirectionalLight setGlobal(boolean newValue)

Accessor method to 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:

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

setGlobal

public DirectionalLight setGlobal(SFBool newValue)

Assign typed object value to SFBool global field, similar to setGlobal(boolean).

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

public float getIntensity()

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

Tooltip: [0,+infinity] 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 DirectionalLight setIntensity(float newValue)

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

Tooltip: [0,+infinity] 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:

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

setIntensity

public DirectionalLight setIntensity(SFFloat newValue)

Assign typed object value to SFFloat intensity field, similar to setIntensity(float).

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).

setIntensity

public DirectionalLight setIntensity(double newValue)

Utility method: double-precision set-parameter accessor for X3D floating-point type, similar to setIntensity(float).

Parameters:

newValue - is new value for field

Returns:

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

getIS

public IS getIS()

Provide IS instance (using a properly typed node) from inputOutput SFNode field IS.

Specified by:

getIS in class X3DConcreteNode

Returns:

value of IS field

See Also:

• X3D Tooltips: IS
• X3D Tooltips: connect

setIS

public DirectionalLight setIS(IS newValue)

Accessor method to assign IS instance (using a properly typed node) to inputOutput SFNode field IS.

Specified by:

setIS in class X3DConcreteNode

Parameters:

newValue - is new value for the IS field.

Returns:

DirectionalLight - 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

clearIS

public DirectionalLight clearIS()

Utility method to clear SFNode value of IS field.

Returns:

DirectionalLight - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).

hasIS

public boolean hasIS()

Indicate whether an object is available for inputOutput SFNode field IS.

Returns:

whether a concrete statement or CommentsBlock is available.

See Also:

• getIS()

getMetadata

public 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 DirectionalLight

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:

• 
  
  Tooltip: [X3DMetadataObject] Information about this node can be contained in a MetadataBoolean, MetadataDouble, MetadataFloat, MetadataInteger, MetadataString or MetadataSet node.
  • Hint: X3D Architecture 7.2.4 Metadata https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/core.html#Metadata
• X3D Scene Authoring Hints: Metadata Nodes

setMetadata

public DirectionalLight 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 DirectionalLight

Specified by:

setMetadata in interface X3DChildNode

Specified by:

setMetadata in interface X3DLightNode

Specified by:

setMetadata in interface X3DNode

Specified by:

setMetadata in class X3DConcreteNode

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:

• 
  
  Tooltip: [X3DMetadataObject] Information about this node can be contained in a MetadataBoolean, MetadataDouble, MetadataFloat, MetadataInteger, MetadataString or MetadataSet node.
  • Hint: X3D Architecture 7.2.4 Metadata https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/core.html#Metadata
• X3D Scene Authoring Hints: Metadata Nodes

clearMetadata

public DirectionalLight clearMetadata()

Utility method to clear SFNode value of metadata field.

Returns:

DirectionalLight - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).

setMetadata

public DirectionalLight setMetadata(ProtoInstance 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:

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

See Also:

• setMetadata(org.web3d.x3d.sai.Core.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 DirectionalLight setOn(boolean newValue)

Accessor method to 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:

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

setOn

public DirectionalLight setOn(SFBool newValue)

Assign typed object value to SFBool on field, similar to setOn(boolean).

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).

getShadowIntensity

public float getShadowIntensity()

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

Tooltip: [0,1] shadowIntensity field defines how much light is obscured by shapes that cast shadows, ranging from 0 (light not obscured, no visible shadows) to 1 (light completely obscured, full-intensity shadows). *

Specified by:

getShadowIntensity in interface DirectionalLight

Specified by:

getShadowIntensity in interface X3DLightNode

Returns:

value of shadowIntensity field

setShadowIntensity

public DirectionalLight setShadowIntensity(float newValue)

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

Tooltip: [0,1] shadowIntensity field defines how much light is obscured by shapes that cast shadows, ranging from 0 (light not obscured, no visible shadows) to 1 (light completely obscured, full-intensity shadows). *

Specified by:

setShadowIntensity in interface DirectionalLight

Specified by:

setShadowIntensity in interface X3DLightNode

Parameters:

newValue - is new value for the shadowIntensity field.

Returns:

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

setShadowIntensity

public DirectionalLight setShadowIntensity(SFFloat newValue)

Assign typed object value to SFFloat shadowIntensity field, similar to setShadowIntensity(float).

Parameters:

newValue - is new value for the shadowIntensity field.

Returns:

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

setShadowIntensity

public DirectionalLight setShadowIntensity(double newValue)

Utility method: double-precision set-parameter accessor for X3D floating-point type, similar to setShadowIntensity(float).

Parameters:

newValue - is new value for field

Returns:

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

getShadows

public boolean getShadows()

Provide boolean value from inputOutput SFBool field named shadows.

Tooltip: shadows field indicates whether or not this light casts a shadow behind illuminated X3DShapeNode geometry. *

Specified by:

getShadows in interface DirectionalLight

Specified by:

getShadows in interface X3DLightNode

Returns:

value of shadows field

setShadows

public DirectionalLight setShadows(boolean newValue)

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

Tooltip: shadows field indicates whether or not this light casts a shadow behind illuminated X3DShapeNode geometry. *

Specified by:

setShadows in interface DirectionalLight

Specified by:

setShadows in interface X3DLightNode

Parameters:

newValue - is new value for the shadows field.

Returns:

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

setShadows

public DirectionalLight setShadows(SFBool newValue)

Assign typed object value to SFBool shadows field, similar to setShadows(boolean).

Parameters:

newValue - is new value for the shadows field.

Returns:

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

getDEF

public String getDEF()

Provide String value from 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 https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#NamingConventions

Overrides:

getDEF in class X3DConcreteNode

Returns:

value of DEF field

See Also:

• X3D Scene Authoring Hints: Naming Conventions

setDEF

public final DirectionalLight setDEF(String newValue)

Accessor method to 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 https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#NamingConventions

Note that setting the DEF value clears the USE value.

Specified by:

setDEF in class X3DConcreteNode

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).

setDEF

public DirectionalLight setDEF(SFString newValue)

Assign typed object value to SFString DEF field, similar to setDEF(String).

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).

getUSE

public String getUSE()

Provide String value from 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.

Overrides:

getUSE in class X3DConcreteNode

Returns:

value of USE field

See Also:

• X3D Scene Authoring Hints: Naming Conventions

setUSE

public final DirectionalLight setUSE(String newValue)

Accessor method to 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 class X3DConcreteNode

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).

setUSE

public DirectionalLight setUSE(SFString newValue)

Assign typed object value to SFString USE field, similar to setUSE(String).

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).

getCssClass

public String getCssClass()

Provide String value from inputOutput SFString field named class.

Overrides:

getCssClass in class X3DConcreteElement

Returns:

value of class field

See Also:

• X3D Architecture Annex L - HTML authoring guidelines, CSS considerations
• W3C Cascading Style Sheets
• W3C CSS Snapshot
• Wikibooks: XML - Managing Data Exchange/XSLT and Style Sheets

setCssClass

public final DirectionalLight setCssClass(String newValue)

Accessor method to assign String value to inputOutput SFString field named class.

Specified by:

setCssClass in class X3DConcreteNode

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).

See Also:

• X3D Architecture Annex L - HTML authoring guidelines, CSS considerations
• W3C Cascading Style Sheets
• W3C CSS Snapshot
• Wikibooks: XML - Managing Data Exchange/XSLT and Style Sheets

setCssClass

public DirectionalLight setCssClass(SFString newValue)

Assign typed object value to SFString cssClass field, similar to setCssClass(String).

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).

getHtmlID

public String getHtmlID()

Provide String value from inputOutput SFString field named id.

Overrides:

getHtmlID in class X3DConcreteElement

Returns:

value of id field

See Also:

• X3D Architecture Annex L - HTML authoring guidelines, CSS considerations
• W3C Cascading Style Sheets
• W3C CSS Snapshot
• Wikibooks: XML - Managing Data Exchange/XSLT and Style Sheets

setHtmlID

public final DirectionalLight setHtmlID(String newValue)

Accessor method to assign String value to inputOutput SFString field named id.

Specified by:

setHtmlID in class X3DConcreteNode

Parameters:

newValue - is new value for the id field.

Returns:

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

See Also:

• X3D Architecture Annex L - HTML authoring guidelines, CSS considerations
  Warning: the id attribute is in a distinct separate namespace from DEF identifiers and thus not applicable for USE nodes, ROUTE statements, or Script references.
• X3D Architecture Annex L - HTML authoring guidelines, L.3.1 Content definition and page presentation
• HTML 5.2 W3C Recommendation
• Document Object Model (DOM) Technical Reports
• Wikibooks: XML - Managing Data Exchange/XSLT and Style Sheets

setHtmlID

public DirectionalLight setHtmlID(SFString newValue)

Assign typed object value to SFString HtmlID field, similar to setHtmlID(String).

Parameters:

newValue - is new value for the id field.

Returns:

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

getCssStyle

public String getCssStyle()

Provide String value from inputOutput SFString field named style.

Overrides:

getCssStyle in class X3DConcreteElement

Returns:

value of style field

See Also:

• X3D Architecture Annex L - HTML authoring guidelines, CSS considerations
• W3C Cascading Style Sheets
• W3C CSS Snapshot
• Wikibooks: XML - Managing Data Exchange/XSLT and Style Sheets

setCssStyle

public final DirectionalLight setCssStyle(String newValue)

Accessor method to assign String value to inputOutput SFString field named style.

Specified by:

setCssStyle in class X3DConcreteNode

Parameters:

newValue - is new value for the style field.

Returns:

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

See Also:

• X3D Architecture Annex L - HTML authoring guidelines, CSS considerations
• W3C Cascading Style Sheets
• W3C CSS Snapshot
• Wikibooks: XML - Managing Data Exchange/XSLT and Style Sheets

setCssStyle

public DirectionalLight setCssStyle(SFString newValue)

Assign typed object value to SFString cssClass field, similar to setCssStyle(String).

Parameters:

newValue - is new value for the style field.

Returns:

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

setUSE

public DirectionalLight setUSE(DirectionalLight 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:

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

addComments

public DirectionalLight addComments(String newComment)

Add comment as String to contained commentsList.

Specified by:

addComments in class X3DConcreteElement

Parameters:

newComment - initial value

Returns:

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

See Also:

• X3D Architecture, clause 7.2.5.1 Organization

addComments

public DirectionalLight addComments(String[] newComments)

Add comments as String[] array to contained commentsList.

Specified by:

addComments in class X3DConcreteElement

Parameters:

newComments - array of comments

Returns:

DirectionalLight - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).

addComments

public DirectionalLight addComments(CommentsBlock newCommentsBlock)

Add CommentsBlock to contained commentsList.

Specified by:

addComments in class X3DConcreteElement

Parameters:

newCommentsBlock - block of comments to add

Returns:

DirectionalLight - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).

toStringX3D

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

• X3D.FILE_EXTENSION_X3D
• X3D.FILE_EXTENSION_XML
• X3D.toStringXML()
• X3D.toFileXML(String)
• X3D.toFileX3D(String)
• X3D XML Encoding
• X3D Compressed Binary Encoding: X3D Canonical Form
• X3D Canonicalization (C14N) Tool

toStringClassicVRML

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

• X3D.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 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:

• X3D.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(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 findAncestorScene() to check entire scene graph, or findAncestorX3D() 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.hasAncestorScene()
• X3DConcreteElement.findAncestorX3D()

findElementByNameValue

public X3DConcreteElement findElementByNameValue(String nameValue,
 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 findAncestorScene() to check entire scene graph, or findAncestorX3D() 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.hasAncestorScene()
• X3DConcreteElement.findAncestorX3D()

hasElementByNameValue

public boolean hasElementByNameValue(String nameValue,
 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(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 findAncestorScene() to check entire scene graph, or findAncestorX3D() 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.hasAncestorScene()
• X3DConcreteElement.findAncestorX3D()

hasNodeByDEF

public boolean hasNodeByDEF(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 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. TODO document specific validation methods.

Specified by:

validate in class X3DConcreteElement

Returns:

validation results (if any)