Package org.web3d.x3d.jsail.Scripting

Class Script

java.lang.Object

org.web3d.x3d.jsail.X3DConcreteElement

org.web3d.x3d.jsail.X3DConcreteNode

org.web3d.x3d.jsail.Scripting.Script

All Implemented Interfaces:

X3DChildNode, X3DNode, X3DUrlObject, Script, X3DScriptNode

public class Script
extends X3DConcreteNode
implements Script

Script contains author-programmed event behaviors for a scene.

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. Script node tooltip: [X3DScriptNode] Script contains author-programmed event behaviors for a scene. Define the script input-output event interface by including <field/> elements. Scripting code is embedded in a child CDATA node or (deprecated) in the url field. Optionally supported programming languages are ECMAScript (JavaScript) and Java (via url to a myNode.class file).

• Hint: insert an XML Character Data (CDATA) block within the Script node to contain source code embedded within an X3D scene, avoiding the need for escape characters.
• Hint: a contained XML Character Data (CDATA) block for source code protects whitespace, line breaks, and literal characters (such as & for ampersand character, < for less-than-sign character, and > for greater-than-sign character) from unintended escape-character modifications by XML parsers.
• Warning: strict order is required for contained constructs: first field declarations (if any), then IS/connect statements (if any), and finally CDATA source-code block.
• Hint: X3D Scene Authoring Hints, Scripts https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#Scripts
• Hint: apply containerField='watchList' when parent node is LoadSensor.ECMAScript-262 specification http://www.ecma-international.org/publications/standards/Ecma-262.htm
• Hint: embedded ecmascript: source can also be contained in the sourceCode pseudo-field without escape characters, equivalent to last entry in the url list, when using other API codebases and file encodings.

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: Script
• X3D Tooltips: Script
• X3D Scene Authoring Hints: Scripts

Field Summary

Fields

Modifier and Type	Field	Description
static final double	AUTOREFRESH_DEFAULT_VALUE	SFTime field named autoRefresh has default value 0 (Java syntax) or 0 (XML syntax).
static final double	AUTOREFRESHTIMELIMIT_DEFAULT_VALUE	SFTime field named autoRefreshTimeLimit has default value 3600 (Java syntax) or 3600 (XML syntax).
static final String	COMPONENT	String constant COMPONENT defines X3D component for the Script element: Scripting
static final String	containerField_DEFAULT_VALUE	containerField describes typical field relationship of a node to its parent.
static final String	DESCRIPTION_DEFAULT_VALUE	SFString field named description has default value equal to an empty string.
static final boolean	DIRECTOUTPUT_DEFAULT_VALUE	SFBool field named directOutput has default value false (Java syntax) or false (XML syntax).
static final String	fromField_AUTOREFRESH	fromField ROUTE name for SFTime field named autoRefresh.
static final String	fromField_AUTOREFRESHTIMELIMIT	fromField ROUTE name for SFTime field named autoRefreshTimeLimit.
static final String	fromField_DESCRIPTION	fromField ROUTE name for SFString field named description.
static final String	fromField_IS	fromField ROUTE name for SFNode field named IS.
static final String	fromField_LOAD	fromField ROUTE name for SFBool field named load.
static final String	fromField_METADATA	fromField ROUTE name for SFNode field named metadata.
static final String	fromField_SOURCECODE	fromField ROUTE name for SFString field named sourceCode.
static final String	fromField_URL	fromField ROUTE name for MFString field named url.
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 Scripting component level for this element: 1
static final boolean	LOAD_DEFAULT_VALUE	SFBool field named load has default value true (Java syntax) or true (XML syntax).
static final X3DMetadataObject	METADATA_DEFAULT_VALUE	SFNode field named metadata has default value null (Java syntax) or NULL (XML syntax).
static final boolean	MUSTEVALUATE_DEFAULT_VALUE	SFBool field named mustEvaluate has default value false (Java syntax) or false (XML syntax).
static final String	NAME	String constant NAME provides name of this element: Script.
static final String	SOURCECODE_DEFAULT_VALUE	SFString field named sourceCode has default value equal to an empty string.
static final String	toField_AUTOREFRESH	toField ROUTE name for SFTime field named autoRefresh.
static final String	toField_AUTOREFRESHTIMELIMIT	toField ROUTE name for SFTime field named autoRefreshTimeLimit.
static final String	toField_DESCRIPTION	toField ROUTE name for SFString field named description.
static final String	toField_LOAD	toField ROUTE name for SFBool field named load.
static final String	toField_METADATA	toField ROUTE name for SFNode field named metadata.
static final String	toField_SOURCECODE	toField ROUTE name for SFString field named sourceCode.
static final String	toField_URL	toField ROUTE name for MFString field named url.
static final ArrayList<String>	URL_DEFAULT_VALUE	MFString field named url has default value equal to an empty list.

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
Script()	Constructor for Script to initialize member variables with default values.
Script(String DEFlabel)	Utility constructor that assigns DEF label after initializing member variables with default values.

Method Summary

Modifier and Type	Method	Description
Script	addComments(String newComment)	Add comment as String to contained commentsList.
Script	addComments(String[] newComments)	Add comments as String[] array to contained commentsList.
Script	addComments(CommentsBlock newCommentsBlock)	Add CommentsBlock to contained commentsList.
Script	addField(field newField)	Add field to fieldList for this Script
Script	addUrl(String newValue)	Add singleton String value to MFString url field.
Script	addUrl(SFString newValue)	Add singleton SFString value to MFString url field.
Script	appendSourceCode(String newSourceCode)	Append source code (for example, JavaScript)
Script	appendSourceCode(StringBuilder newSourceCode)	Append source code (for example, JavaScript)
Script	clearField()	Utility method to clear MFNode value of fieldList field.
void	clearFields()	Clear all fields
Script	clearIS()	Utility method to clear SFNode value of IS field.
Script	clearMetadata()	Utility method to clear SFNode value of metadata field.
Script	clearSourceCode()	Clear all contained CDATA source code.
Script	clearUrl()	Utility method to clear MFString value of url 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.
field	findFieldByName(String fieldName)	Find contained field statement by name, if present.
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.
double	getAutoRefresh()	Provide double value in seconds within allowed range of [0,infinity) from inputOutput SFTime field named autoRefresh.
double	getAutoRefreshTimeLimit()	Provide double value in seconds within allowed range of [0,infinity) from inputOutput SFTime field named autoRefreshTimeLimit.
final String	getComponent()	Defines X3D component for the Script element: Scripting
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.
String	getDescription()	Provide String value from inputOutput SFString field named description.
boolean	getDirectOutput()	Provide boolean value from initializeOnly SFBool field named directOutput.
final String	getElementName()	Provides name of this element: Script
ArrayList<field>	getFieldList()	Provide array of field results (using an array consisting of properly typed nodes or ProtoInstances) from inputOutput MFNode field field.
String	getFieldType(String fieldName)	Indicate type corresponding to given fieldName.
String	getHtmlID()	Provide String value from inputOutput SFString field named id.
IS	getIS()	Provide IS instance (using a properly typed node) from inputOutput SFNode field IS.
boolean	getLoad()	Provide boolean value from inputOutput SFBool field named load.
X3DMetadataObject	getMetadata()	Provide org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
boolean	getMustEvaluate()	Provide boolean value from initializeOnly SFBool field named mustEvaluate.
String	getSourceCode()	Provide String value from inputOutput SFString field named sourceCode.
String[]	getUrl()	Provide array of String results from inputOutput MFString field named url.
ArrayList<String>	getUrlList()	Utility method to get ArrayList value of MFString url field, similar to getUrl().
String	getUrlString()	Utility method to get String value of MFString url field, similar to getUrl().
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	hasField()	Indicate whether an object is available for inputOutput MFNode field fieldList.
boolean	hasField(String fieldName)	Determine if field statement is present.
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.
boolean	removeField(String fieldName)	Remove a field by name from contained fieldList
boolean	removeField(field fieldToRemove)	Remove a field from contained fieldList
Script	setAutoRefresh(double newValue)	Accessor method to assign double value in seconds to inputOutput SFTime field named autoRefresh.
Script	setAutoRefresh(SFTime newValue)	Assign typed object value to SFTime autoRefresh field, similar to setAutoRefresh(double).
Script	setAutoRefreshTimeLimit(double newValue)	Accessor method to assign double value in seconds to inputOutput SFTime field named autoRefreshTimeLimit.
Script	setAutoRefreshTimeLimit(SFTime newValue)	Assign typed object value to SFTime autoRefreshTimeLimit field, similar to setAutoRefreshTimeLimit(double).
final Script	setCssClass(String newValue)	Accessor method to assign String value to inputOutput SFString field named class.
Script	setCssClass(SFString newValue)	Assign typed object value to SFString cssClass field, similar to setCssClass(String).
final Script	setCssStyle(String newValue)	Accessor method to assign String value to inputOutput SFString field named style.
Script	setCssStyle(SFString newValue)	Assign typed object value to SFString cssClass field, similar to setCssStyle(String).
final Script	setDEF(String newValue)	Accessor method to assign String value to inputOutput SFString field named DEF.
Script	setDEF(SFString newValue)	Assign typed object value to SFString DEF field, similar to setDEF(String).
Script	setDescription(String newValue)	Accessor method to assign String value to inputOutput SFString field named description.
Script	setDescription(SFString newValue)	Assign typed object value to SFString description field, similar to setDescription(String).
Script	setDirectOutput(boolean newValue)	Accessor method to assign boolean value to initializeOnly SFBool field named directOutput.
Script	setDirectOutput(SFBool newValue)	Assign typed object value to SFBool directOutput field, similar to setDirectOutput(boolean).
Script	setField(field newValue)	Set single child field node, replacing prior array of existing nodes (if any).
Script	setFieldList(ArrayList<field> newValue)	Accessor method to assign field array (using an array consisting of properly typed nodes or ProtoInstances) to inputOutput MFNode field field.
final Script	setHtmlID(String newValue)	Accessor method to assign String value to inputOutput SFString field named id.
Script	setHtmlID(SFString newValue)	Assign typed object value to SFString HtmlID field, similar to setHtmlID(String).
Script	setIS(IS newValue)	Accessor method to assign IS instance (using a properly typed node) to inputOutput SFNode field IS.
Script	setLoad(boolean newValue)	Accessor method to assign boolean value to inputOutput SFBool field named load.
Script	setLoad(SFBool newValue)	Assign typed object value to SFBool load field, similar to setLoad(boolean).
Script	setMetadata(ProtoInstance newValue)	Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field metadata.
Script	setMetadata(X3DMetadataObject newValue)	Accessor method to assign org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
Script	setMustEvaluate(boolean newValue)	Accessor method to assign boolean value to initializeOnly SFBool field named mustEvaluate.
Script	setMustEvaluate(SFBool newValue)	Assign typed object value to SFBool mustEvaluate field, similar to setMustEvaluate(boolean).
Script	setSourceCode(String newValue)	Accessor method to assign String value to inputOutput SFString field named sourceCode.
Script	setSourceCode(StringBuilder newSourceCode)	Set new source code (for example, JavaScript), utility method using StringBuilder.
Script	setSourceCode(SFString newValue)	Assign typed object value to SFString sourceCode field, similar to setSourceCode(String).
Script	setUrl(String newValue)	Assign singleton String value to MFString url field, similar to setUrl(String[]).
Script	setUrl(String[] newValue)	Accessor method to assign String array to inputOutput MFString field named url.
Script	setUrl(ArrayList<String> newValue)	Assign ArrayList value of MFString url field, similar to setUrl(String[]).
Script	setUrl(MFString newValue)	Assign typed object value to MFString url field, similar to setUrl(String[]).
Script	setUrl(SFString newValue)	Assign single SFString object value to MFString url field, similar to setUrl(String[]).
final Script	setUSE(String newValue)	Accessor method to assign String value to inputOutput SFString field named USE.
Script	setUSE(SFString newValue)	Assign typed object value to SFString USE field, similar to setUSE(String).
Script	setUSE(Script 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: Script.

See Also:

• Constant Field Values

COMPONENT

public static final String COMPONENT

String constant COMPONENT defines X3D component for the Script element: Scripting

See Also:

• Constant Field Values

LEVEL

public static final int LEVEL

Integer constant LEVEL provides default X3D Scripting component level for this element: 1

See Also:

• Constant Field Values

AUTOREFRESH_DEFAULT_VALUE

public static final double AUTOREFRESH_DEFAULT_VALUE

SFTime field named autoRefresh has default value 0 (Java syntax) or 0 (XML syntax).

See Also:

• Constant Field Values

AUTOREFRESHTIMELIMIT_DEFAULT_VALUE

public static final double AUTOREFRESHTIMELIMIT_DEFAULT_VALUE

SFTime field named autoRefreshTimeLimit has default value 3600 (Java syntax) or 3600 (XML syntax).

See Also:

• Constant Field Values

DESCRIPTION_DEFAULT_VALUE

public static final String DESCRIPTION_DEFAULT_VALUE

SFString field named description has default value equal to an empty string.

See Also:

• Constant Field Values

DIRECTOUTPUT_DEFAULT_VALUE

public static final boolean DIRECTOUTPUT_DEFAULT_VALUE

SFBool field named directOutput has default value false (Java syntax) or false (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).

LOAD_DEFAULT_VALUE

public static final boolean LOAD_DEFAULT_VALUE

SFBool field named load has default value true (Java syntax) or true (XML syntax).

See Also:

• Constant Field Values

METADATA_DEFAULT_VALUE

public static final X3DMetadataObject METADATA_DEFAULT_VALUE

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

MUSTEVALUATE_DEFAULT_VALUE

public static final boolean MUSTEVALUATE_DEFAULT_VALUE

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

See Also:

• Constant Field Values

SOURCECODE_DEFAULT_VALUE

public static final String SOURCECODE_DEFAULT_VALUE

SFString field named sourceCode has default value equal to an empty string.

See Also:

• Constant Field Values

URL_DEFAULT_VALUE

public static final ArrayList<String> URL_DEFAULT_VALUE

MFString field named url has default value equal to an empty list.

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", "children" }; type X3DUOM containerFieldChoicesX3DUrlObject

See Also:

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

fromField_AUTOREFRESH

public static final String fromField_AUTOREFRESH

fromField ROUTE name for SFTime field named autoRefresh.

See Also:

• Constant Field Values

toField_AUTOREFRESH

public static final String toField_AUTOREFRESH

toField ROUTE name for SFTime field named autoRefresh.

See Also:

• Constant Field Values

fromField_AUTOREFRESHTIMELIMIT

public static final String fromField_AUTOREFRESHTIMELIMIT

fromField ROUTE name for SFTime field named autoRefreshTimeLimit.

See Also:

• Constant Field Values

toField_AUTOREFRESHTIMELIMIT

public static final String toField_AUTOREFRESHTIMELIMIT

toField ROUTE name for SFTime field named autoRefreshTimeLimit.

See Also:

• Constant Field Values

fromField_DESCRIPTION

public static final String fromField_DESCRIPTION

fromField ROUTE name for SFString field named description.

See Also:

• Constant Field Values

toField_DESCRIPTION

public static final String toField_DESCRIPTION

toField ROUTE name for SFString field named description.

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_LOAD

public static final String fromField_LOAD

fromField ROUTE name for SFBool field named load.

See Also:

• Constant Field Values

toField_LOAD

public static final String toField_LOAD

toField ROUTE name for SFBool field named load.

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_SOURCECODE

public static final String fromField_SOURCECODE

fromField ROUTE name for SFString field named sourceCode.

See Also:

• Constant Field Values

toField_SOURCECODE

public static final String toField_SOURCECODE

toField ROUTE name for SFString field named sourceCode.

See Also:

• Constant Field Values

fromField_URL

public static final String fromField_URL

fromField ROUTE name for MFString field named url.

See Also:

• Constant Field Values

toField_URL

public static final String toField_URL

toField ROUTE name for MFString field named url.

See Also:

• Constant Field Values

Constructor Details

Script

public Script()

Constructor for Script to initialize member variables with default values.

Script

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

Specified by:

getElementName in class X3DConcreteElement

Returns:

name of this element

getComponent

public final String getComponent()

Defines X3D component for the Script element: Scripting

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

getAutoRefresh

public double getAutoRefresh()

Provide double value in seconds within allowed range of [0,infinity) from inputOutput SFTime field named autoRefresh.

Tooltip: autoRefresh defines interval in seconds before automatic reload of current url asset is performed.

• Hint: if preceding file loading fails or load field is false, no refresh is performed.
• Hint: repeated refresh attempts to reload currently loaded entry of url list. If that fails, the browser retries other entries in the url list.
• Warning: automatically reloading content has security considerations and needs to be considered carefully.

Specified by:

getAutoRefresh in interface Script

Specified by:

getAutoRefresh in interface X3DScriptNode

Specified by:

getAutoRefresh in interface X3DUrlObject

Returns:

value of autoRefresh field

setAutoRefresh

public Script setAutoRefresh(double newValue)

Accessor method to assign double value in seconds to inputOutput SFTime field named autoRefresh.

Tooltip: autoRefresh defines interval in seconds before automatic reload of current url asset is performed.

• Hint: if preceding file loading fails or load field is false, no refresh is performed.
• Hint: repeated refresh attempts to reload currently loaded entry of url list. If that fails, the browser retries other entries in the url list.
• Warning: automatically reloading content has security considerations and needs to be considered carefully.

Specified by:

setAutoRefresh in interface Script

Specified by:

setAutoRefresh in interface X3DScriptNode

Specified by:

setAutoRefresh in interface X3DUrlObject

Parameters:

newValue - is new value for the autoRefresh field.

Returns:

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

setAutoRefresh

public Script setAutoRefresh(SFTime newValue)

Assign typed object value to SFTime autoRefresh field, similar to setAutoRefresh(double).

Parameters:

newValue - is new value for the autoRefresh field.

Returns:

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

getAutoRefreshTimeLimit

public double getAutoRefreshTimeLimit()

Provide double value in seconds within allowed range of [0,infinity) from inputOutput SFTime field named autoRefreshTimeLimit.

Tooltip: autoRefreshTimeLimit defines maximum duration that automatic refresh activity can occur.

• Hint: Automatic refresh is different than query and response timeouts performed by a networking library while sequentially attempting to retrieve addressed content from a url list.
• Warning: automatically reloading content has security considerations and needs to be considered carefully.

Specified by:

getAutoRefreshTimeLimit in interface Script

Specified by:

getAutoRefreshTimeLimit in interface X3DScriptNode

Specified by:

getAutoRefreshTimeLimit in interface X3DUrlObject

Returns:

value of autoRefreshTimeLimit field

setAutoRefreshTimeLimit

public Script setAutoRefreshTimeLimit(double newValue)

Accessor method to assign double value in seconds to inputOutput SFTime field named autoRefreshTimeLimit.

Tooltip: autoRefreshTimeLimit defines maximum duration that automatic refresh activity can occur.

• Hint: Automatic refresh is different than query and response timeouts performed by a networking library while sequentially attempting to retrieve addressed content from a url list.
• Warning: automatically reloading content has security considerations and needs to be considered carefully.

Specified by:

setAutoRefreshTimeLimit in interface Script

Specified by:

setAutoRefreshTimeLimit in interface X3DScriptNode

Specified by:

setAutoRefreshTimeLimit in interface X3DUrlObject

Parameters:

newValue - is new value for the autoRefreshTimeLimit field.

Returns:

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

setAutoRefreshTimeLimit

public Script setAutoRefreshTimeLimit(SFTime newValue)

Assign typed object value to SFTime autoRefreshTimeLimit field, similar to setAutoRefreshTimeLimit(double).

Parameters:

newValue - is new value for the autoRefreshTimeLimit field.

Returns:

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

getDescription

public String getDescription()

Provide String value from inputOutput SFString field named description.

Tooltip: Author-provided prose that describes intended purpose of the url asset.

• Hint: many XML tools substitute XML character references for special characters automatically if needed within an attribute value (such as & for & ampersand character, or " for " quotation-mark character).

Specified by:

getDescription in interface Script

Specified by:

getDescription in interface X3DScriptNode

Specified by:

getDescription in interface X3DUrlObject

Returns:

value of description field

setDescription

public Script setDescription(String newValue)

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

Tooltip: Author-provided prose that describes intended purpose of the url asset.

• Hint: many XML tools substitute XML character references for special characters automatically if needed within an attribute value (such as & for & ampersand character, or " for " quotation-mark character).

Specified by:

setDescription in interface Script

Specified by:

setDescription in interface X3DScriptNode

Specified by:

setDescription in interface X3DUrlObject

Parameters:

newValue - is new value for the description field.

Returns:

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

setDescription

public Script setDescription(SFString newValue)

Assign typed object value to SFString description field, similar to setDescription(String).

Parameters:

newValue - is new value for the description field.

Returns:

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

getDirectOutput

public boolean getDirectOutput()

Provide boolean value from initializeOnly SFBool field named directOutput.

Tooltip: Set directOutput true if Script has field reference(s) of type SFNode/MFNode, and also uses direct access to modify attributes of a referenced node in the Scene.

• Hint: set directOutput true if Script dynamically establishes or breaks ROUTEs.
• Hint: directOutput is a browser hint to avoid overoptimizing referenced nodes, since a Script might directly change attribute values in referenced SFNode/MFNode fields, without a ROUTE connecting output events.
• Hint: directOutput false means Script cannot modify referenced nodes or change ROUTEs.

Specified by:

getDirectOutput in interface Script

Returns:

value of directOutput field

setDirectOutput

public Script setDirectOutput(boolean newValue)

Accessor method to assign boolean value to initializeOnly SFBool field named directOutput.

Tooltip: Set directOutput true if Script has field reference(s) of type SFNode/MFNode, and also uses direct access to modify attributes of a referenced node in the Scene.

• Hint: set directOutput true if Script dynamically establishes or breaks ROUTEs.
• Hint: directOutput is a browser hint to avoid overoptimizing referenced nodes, since a Script might directly change attribute values in referenced SFNode/MFNode fields, without a ROUTE connecting output events.
• Hint: directOutput false means Script cannot modify referenced nodes or change ROUTEs.

Specified by:

setDirectOutput in interface Script

Parameters:

newValue - is new value for the directOutput field.

Returns:

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

setDirectOutput

public Script setDirectOutput(SFBool newValue)

Assign typed object value to SFBool directOutput field, similar to setDirectOutput(boolean).

Parameters:

newValue - is new value for the directOutput field.

Returns:

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

getFieldList

public ArrayList<field> getFieldList()

Provide array of field results (using an array consisting of properly typed nodes or ProtoInstances) from inputOutput MFNode field field.

Tooltip: Include a field statement for each field declaration in this Script node.

• Warning: to aid portability and avoid unintended overloading of variable references, it is good practice for X3D Script authors to avoid the use of variables with global scope.

Warning: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to field.

Returns:

value of field

See Also:

• field

setFieldList

public Script setFieldList(ArrayList<field> newValue)

Accessor method to assign field array (using an array consisting of properly typed nodes or ProtoInstances) to inputOutput MFNode field field.

Tooltip: Include a field statement for each field declaration in this Script node.

• Warning: to aid portability and avoid unintended overloading of variable references, it is good practice for X3D Script authors to avoid the use of variables with global scope.

Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to field.

Parameters:

newValue - is new value for the field field.

Returns:

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

setField

public Script setField(field newValue)

Set single child field node, replacing prior array of existing nodes (if any).

Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are restricted to field.

Parameters:

newValue - is new node for the field field (restricted to field)

Returns:

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

clearField

public Script clearField()

Utility method to clear MFNode value of fieldList field. This method does not initialize withFIELD_DEFAULT_VALUE.

Returns:

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

hasField

public boolean hasField()

Indicate whether an object is available for inputOutput MFNode field fieldList.

Returns:

whether a concrete statement array or CommentsBlock is available.

See Also:

• getFieldList()

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

Script - 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 Script clearIS()

Utility method to clear SFNode value of IS field.

Returns:

Script - 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()

getLoad

public boolean getLoad()

Provide boolean value from inputOutput SFBool field named load.

Tooltip: load=true means load immediately, load=false means defer loading or else unload a previously loaded scene.

• Hint: allows author to design when Inline loading occurs via user interaction, event chains or scripting.
• Hint: use a separate LoadSensor node to detect when loading is complete.

Specified by:

getLoad in interface Script

Specified by:

getLoad in interface X3DScriptNode

Specified by:

getLoad in interface X3DUrlObject

Returns:

value of load field

setLoad

public Script setLoad(boolean newValue)

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

Tooltip: load=true means load immediately, load=false means defer loading or else unload a previously loaded scene.

• Hint: allows author to design when Inline loading occurs via user interaction, event chains or scripting.
• Hint: use a separate LoadSensor node to detect when loading is complete.

Specified by:

setLoad in interface Script

Specified by:

setLoad in interface X3DScriptNode

Specified by:

setLoad in interface X3DUrlObject

Parameters:

newValue - is new value for the load field.

Returns:

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

setLoad

public Script setLoad(SFBool newValue)

Assign typed object value to SFBool load field, similar to setLoad(boolean).

Parameters:

newValue - is new value for the load field.

Returns:

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

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 Script

Specified by:

getMetadata in interface X3DChildNode

Specified by:

getMetadata in interface X3DNode

Specified by:

getMetadata in interface X3DScriptNode

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

Specified by:

setMetadata in interface X3DChildNode

Specified by:

setMetadata in interface X3DNode

Specified by:

setMetadata in interface X3DScriptNode

Specified by:

setMetadata in class X3DConcreteNode

Parameters:

newValue - is new value for the metadata field.

Returns:

Script - 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 Script clearMetadata()

Utility method to clear SFNode value of metadata field.

Returns:

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

setMetadata

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

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

getMustEvaluate

public boolean getMustEvaluate()

Provide boolean value from initializeOnly SFBool field named mustEvaluate.

Tooltip: If mustEvaluate false, then the X3D player may delay sending input events to Script until output events are needed. If mustEvaluate true, then Script must receive input events immediately without any event-aggregation delays.

• Hint: set mustEvaluate true when sending/receiving values via the network.

Specified by:

getMustEvaluate in interface Script

Returns:

value of mustEvaluate field

setMustEvaluate

public Script setMustEvaluate(boolean newValue)

Accessor method to assign boolean value to initializeOnly SFBool field named mustEvaluate.

Tooltip: If mustEvaluate false, then the X3D player may delay sending input events to Script until output events are needed. If mustEvaluate true, then Script must receive input events immediately without any event-aggregation delays.

• Hint: set mustEvaluate true when sending/receiving values via the network.

Specified by:

setMustEvaluate in interface Script

Parameters:

newValue - is new value for the mustEvaluate field.

Returns:

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

setMustEvaluate

public Script setMustEvaluate(SFBool newValue)

Assign typed object value to SFBool mustEvaluate field, similar to setMustEvaluate(boolean).

Parameters:

newValue - is new value for the mustEvaluate field.

Returns:

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

getSourceCode

public String getSourceCode()

Provide String value from inputOutput SFString field named sourceCode.

Specified by:

getSourceCode in interface Script

Returns:

value of sourceCode field

setSourceCode

public Script setSourceCode(String newValue)

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

Specified by:

setSourceCode in interface Script

Parameters:

newValue - is new value for the sourceCode field.

Returns:

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

setSourceCode

public Script setSourceCode(SFString newValue)

Assign typed object value to SFString sourceCode field, similar to setSourceCode(String).

Parameters:

newValue - is new value for the sourceCode field.

Returns:

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

getUrl

public String[] getUrl()

Provide array of String results from inputOutput MFString field named url.

Tooltip: List of address links for runnable script files.

• Hint: embedded ecmascript: source can also be contained in the sourceCode pseudo-field without escape characters, equivalent to last entry in the url list, when using other API codebases and file encodings.
• Hint: browsers are not required to support any particular scripting language, but ECMAScript (JavaScript) is widely supported.
• Hint: equivalent script code written in multiple programming languages can be provided for portability, the first runnable version is chosen at run time.
• Hint: X3D Scene Authoring Hints, Scripts https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#Scripts
• Warning: source code can be placed in url attribute but may be unparsable due to escaping of special characters and elimination of line breaks (causing comments to nullify follow-on code). Use contained CDATA section instead for embedding source code.
• Hint: if both url field and CDATA section are provided simultaneously, the url field is processed first. This approach allows utilization of update modifications or live queries in external scripts, while still providing reliable script source as a fallback alternative within the model itself.
• Hint: X3D XML Encoding, 4.3.13 Encapsulating Script node code https://www.web3d.org/documents/specifications/19776-1/V3.3/Part01/concepts.html#EncapsulatingScriptNodeCode
• Hint: MFString arrays can have multiple values, so separate each individual string by quote marks "https://www.web3d.org" "https://www.web3d.org/about" "etc."
• Hint: alternative XML encoding for quotation mark " is " (which is an example of a character entity).
• Warning: strictly match directory and filename capitalization for http links! This is important for portability. Some operating systems are forgiving of capitalization mismatches, but http/https url addresses and paths in Unix-based operating systems are all case sensitive and intolerant of uppercase/lowercase mismatches.
• Hint: can replace embedded blank(s) in url queries with %20 for each blank character.
• Hint: X3D Scene Authoring Hints, urls https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#urls

Specified by:

getUrl in interface Script

Specified by:

getUrl in interface X3DScriptNode

Specified by:

getUrl in interface X3DUrlObject

Returns:

value of url field

getUrlList

public ArrayList<String> getUrlList()

Utility method to get ArrayList value of MFString url field, similar to getUrl().

Returns:

value of url field

getUrlString

public String getUrlString()

Utility method to get String value of MFString url field, similar to getUrl().

Returns:

value of url field

setUrl

public Script setUrl(String[] newValue)

Accessor method to assign String array to inputOutput MFString field named url.

Tooltip: List of address links for runnable script files.

• Hint: embedded ecmascript: source can also be contained in the sourceCode pseudo-field without escape characters, equivalent to last entry in the url list, when using other API codebases and file encodings.
• Hint: browsers are not required to support any particular scripting language, but ECMAScript (JavaScript) is widely supported.
• Hint: equivalent script code written in multiple programming languages can be provided for portability, the first runnable version is chosen at run time.
• Hint: X3D Scene Authoring Hints, Scripts https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#Scripts
• Warning: source code can be placed in url attribute but may be unparsable due to escaping of special characters and elimination of line breaks (causing comments to nullify follow-on code). Use contained CDATA section instead for embedding source code.
• Hint: if both url field and CDATA section are provided simultaneously, the url field is processed first. This approach allows utilization of update modifications or live queries in external scripts, while still providing reliable script source as a fallback alternative within the model itself.
• Hint: X3D XML Encoding, 4.3.13 Encapsulating Script node code https://www.web3d.org/documents/specifications/19776-1/V3.3/Part01/concepts.html#EncapsulatingScriptNodeCode
• Hint: MFString arrays can have multiple values, so separate each individual string by quote marks "https://www.web3d.org" "https://www.web3d.org/about" "etc."
• Hint: alternative XML encoding for quotation mark " is " (which is an example of a character entity).
• Warning: strictly match directory and filename capitalization for http links! This is important for portability. Some operating systems are forgiving of capitalization mismatches, but http/https url addresses and paths in Unix-based operating systems are all case sensitive and intolerant of uppercase/lowercase mismatches.
• Hint: can replace embedded blank(s) in url queries with %20 for each blank character.
• Hint: X3D Scene Authoring Hints, urls https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#urls

Specified by:

setUrl in interface Script

Specified by:

setUrl in interface X3DScriptNode

Specified by:

setUrl in interface X3DUrlObject

Parameters:

newValue - is new value for the url field.

Returns:

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

setUrl

public Script setUrl(MFString newValue)

Assign typed object value to MFString url field, similar to setUrl(String[]).

Parameters:

newValue - is new value for the url field.

Returns:

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

setUrl

public Script setUrl(SFString newValue)

Assign single SFString object value to MFString url field, similar to setUrl(String[]).

Parameters:

newValue - is new value for the url field.

Returns:

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

setUrl

public Script setUrl(String newValue)

Assign singleton String value to MFString url field, similar to setUrl(String[]).

Parameters:

newValue - is new value for the url field.

Returns:

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

setUrl

public Script setUrl(ArrayList<String> newValue)

Assign ArrayList value of MFString url field, similar to setUrl(String[]).

Parameters:

newValue - is new value for the url field.

Returns:

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

clearUrl

public Script clearUrl()

Utility method to clear MFString value of url field. This method does not initialize withURL_DEFAULT_VALUE.

Returns:

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

addUrl

public Script addUrl(String newValue)

Add singleton String value to MFString url field.

Parameters:

newValue - is new value to add to the url field.

Returns:

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

See Also:

• MFString.cleanupEnumerationValues(String)

addUrl

public Script addUrl(SFString newValue)

Add singleton SFString value to MFString url field.

Parameters:

newValue - is new value to add to the url field.

Returns:

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

See Also:

• MFString.cleanupEnumerationValues(String)

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: DEF name is needed or else ROUTEs cannot connect Script node interfaces.
• 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 Script 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: DEF name is needed or else ROUTEs cannot connect Script node interfaces.
• 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:

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

setDEF

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

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

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

setUSE

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

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

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

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

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

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

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

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

setUSE

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

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

addComments

public Script addComments(String newComment)

Add comment as String to contained commentsList.

Specified by:

addComments in class X3DConcreteElement

Parameters:

newComment - initial value

Returns:

Script - 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 Script addComments(String[] newComments)

Add comments as String[] array to contained commentsList.

Specified by:

addComments in class X3DConcreteElement

Parameters:

newComments - array of comments

Returns:

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

addComments

public Script addComments(CommentsBlock newCommentsBlock)

Add CommentsBlock to contained commentsList.

Specified by:

addComments in class X3DConcreteElement

Parameters:

newCommentsBlock - block of comments to add

Returns:

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

addField

public Script addField(field newField)

Add field to fieldList for this Script

Parameters:

newField - is field to add

Returns:

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

removeField

public boolean removeField(field fieldToRemove)

Remove a field from contained fieldList

Parameters:

fieldToRemove - matching field of interest

Returns:

whether field was removed

See Also:

• removeField(String)

removeField

public boolean removeField(String fieldName)

Remove a field by name from contained fieldList

Parameters:

fieldName - matching field of interest

Returns:

whether field was removed

See Also:

• removeField(field)

clearFields

public void clearFields()

Clear all fields

findFieldByName

public field findFieldByName(String fieldName)

Find contained field statement by name, if present.

Parameters:

fieldName - is name attribute for field of interest

Returns:

field reference of interest, null otherwise

hasField

public boolean hasField(String fieldName)

Determine if field statement is present.

Parameters:

fieldName - is name attribute for field of interest

Returns:

whether field is found

setSourceCode

public Script setSourceCode(StringBuilder newSourceCode)

Set new source code (for example, JavaScript), utility method using StringBuilder. WARNING: be sure to prepend ecmascript: prior to any actual source code.

Parameters:

newSourceCode - is source to set

Returns:

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

appendSourceCode

public Script appendSourceCode(String newSourceCode)

Append source code (for example, JavaScript)

Parameters:

newSourceCode - is source to append

Returns:

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

appendSourceCode

public Script appendSourceCode(StringBuilder newSourceCode)

Append source code (for example, JavaScript)

Parameters:

newSourceCode - is source to append

Returns:

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

clearSourceCode

public Script clearSourceCode()

Clear all contained CDATA source code.

Returns:

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