org.web3d.x3d.jsail.Networking

Class LoadSensorObject

java.lang.Object

org.web3d.x3d.jsail.X3DConcreteElement

org.web3d.x3d.jsail.X3DConcreteNode

org.web3d.x3d.jsail.Networking.LoadSensorObject

All Implemented Interfaces:

X3DChildNode, X3DNode, X3DSensorNode, LoadSensor, X3DNetworkSensorNode

public class LoadSensorObject
extends X3DConcreteNode
implements LoadSensor

X3D node tooltip: [X3DNetworkSensorNode] LoadSensor generates events as watchList child nodes are either loaded or fail to load. Changing watchlist child nodes restarts the LoadSensor.

• Hint: use multiple LoadSensor nodes to track multiple loading nodes individually.
• Hint: Background is not sensed due to multiple-image ambiguity.
• Warning: watchList child nodes are not rendered, so normally USE copies of other nodes to sense load status.
• Hint: use Inline 'load' field to prompt or defer loading.
• Warning: new X3D node, not supported in VRML97.

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: LoadSensor, X3D Tooltips: LoadSensor, X3D Scene Authoring Hints

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	COMPONENT String constant COMPONENT defines X3D component for the LoadSensor element: Networking
static java.lang.String	containerField_DEFAULT_VALUE containerField describes typical field relationship of a node to its parent.
static boolean	ENABLED_DEFAULT_VALUE SFBool field named enabled has default value true (Java syntax) or true (XML syntax).
static java.lang.String	fromField_ENABLED fromField ROUTE name for SFBool field named enabled.
static java.lang.String	fromField_ISACTIVE fromField ROUTE name for SFBool field named isActive.
static java.lang.String	fromField_ISLOADED fromField ROUTE name for SFBool field named isLoaded.
static java.lang.String	fromField_LOADTIME fromField ROUTE name for SFTime field named loadTime.
static java.lang.String	fromField_METADATA fromField ROUTE name for SFNode field named metadata.
static java.lang.String	fromField_PROGRESS fromField ROUTE name for SFFloat field named progress.
static java.lang.String	fromField_TIMEOUT fromField ROUTE name for SFTime field named timeOut.
static java.lang.String	fromField_WATCHLIST fromField ROUTE name for MFNode field named watchList.
static int	LEVEL Integer constant LEVEL provides default X3D Networking component level for this element: 3
static java.lang.String	NAME String constant NAME provides name of this element: LoadSensor.
static double	TIMEOUT_DEFAULT_VALUE SFTime field named timeOut has default value 0 (Java syntax) or 0 (XML syntax).
static java.lang.String	toField_ENABLED toField ROUTE name for SFBool field named enabled.
static java.lang.String	toField_METADATA toField ROUTE name for SFNode field named metadata.
static java.lang.String	toField_TIMEOUT toField ROUTE name for SFTime field named timeOut.
static java.lang.String	toField_WATCHLIST toField ROUTE name for MFNode field named watchList.

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

CLASS_DEFAULT_VALUE, containerField_ALTERNATE_VALUES, DEF_DEFAULT_VALUE, USE_DEFAULT_VALUE

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

validationResult

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
LoadSensorObject	addComments(CommentsBlock newCommentsBlock) Add CommentsBlock to contained commentsList.
LoadSensorObject	addComments(java.lang.String newComment) Add comment as String to contained commentsList.
LoadSensorObject	addComments(java.lang.String[] newComments) Add comments as String[] array to contained commentsList.
LoadSensorObject	addWatchList(X3DNode newValue) Add single child node to existing array of watchList nodes (if any).
void	addWatchList(X3DNode[] newValue) Add array of child watchList nodes to array of existing nodes (if any).
LoadSensorObject	clearMetadata() Utility method to clear SFNode value of metadata field.
LoadSensorObject	clearWatchList() Utility method to clear MFNode value of watchList field.
X3DConcreteElement	findElementByNameValue(java.lang.String nameValue) Recursive method to provide object reference to node or statement by name attribute, if found as part of this element or in a contained element.
X3DConcreteElement	findElementByNameValue(java.lang.String nameValue, java.lang.String elementName) Recursive method to provide object reference to node or statement by name attribute, if found as part of this element or in a contained element.
X3DConcreteNode	findNodeByDEF(java.lang.String DEFvalue) Recursive method to provide object reference to node by DEF, if found as this node or in a contained node.
java.lang.String	getAccessType(java.lang.String fieldName) Indicate accessType corresponding to given fieldName.
java.lang.String	getComponent() Defines X3D component for the LoadSensor element: Networking
int	getComponentLevel() Provides default X3D component level for this element: 3
java.lang.String	getContainerFieldDefault() containerField describes typical field relationship of a node to its parent.
java.lang.String	getElementName() Provides name of this element: LoadSensor
boolean	getEnabled() Provide boolean value from inputOutput SFBool field named enabled.
java.lang.String	getFieldType(java.lang.String fieldName) Indicate type corresponding to given fieldName.
ISObject	getIS() Provide field named IS for establishing IS/connect field connections between ProtoInterface fields and internal ProtoBody nodes.
boolean	getIsActive() Provide boolean value from outputOnly SFBool field named isActive.
boolean	getIsLoaded() Provide boolean value from outputOnly SFBool field named isLoaded.
double	getLoadTime() Provide double value in seconds from outputOnly SFTime field named loadTime.
X3DMetadataObject	getMetadata() Provide X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
float	getProgress() Provide float value from outputOnly SFFloat field named progress.
double	getTimeOut() Provide double value in seconds within allowed range of [0,infinity) from inputOutput SFTime field named timeOut.
X3DNode[]	getWatchList() Provide array of X3DUrlObject results (using an array consisting of properly typed nodes or ProtoInstanceObjects) from inputOutput MFNode field watchList.
java.util.ArrayList<X3DNode>	getWatchListList() Utility method to get ArrayList value of MFNode watchList field, similar to getWatchList().
boolean	hasElementByNameValue(java.lang.String nameValue, java.lang.String elementName) Recursive method to determine whether node or statement with given name attribute is found, meaning both objects are attached to same scene graph.
boolean	hasMetadata() Indicate whether an object is available for inputOutput SFNode field metadata.
boolean	hasNodeByDEF(java.lang.String DEFvalue) Recursive method to determine whether node with DEFvalue is found, meaning both objects are attached to same scene graph.
boolean	hasWatchList() Indicate whether an object is available for inputOutput MFNode field watchList.
void	initialize() Initialize all member variables to default values.
LoadSensorObject	setCssClass(SFStringObject newValue) Assign typed object value to SFString cssClass field, similar to setCssClass(String).
LoadSensorObject	setCssClass(java.lang.String newValue) Assign String value to inputOutput SFString field named class.
LoadSensorObject	setDEF(SFStringObject newValue) Assign typed object value to SFString DEF field, similar to setDEF(String).
LoadSensorObject	setDEF(java.lang.String newValue) Assign String value to inputOutput SFString field named DEF.
LoadSensorObject	setEnabled(boolean newValue) Assign boolean value to inputOutput SFBool field named enabled.
LoadSensorObject	setEnabled(SFBoolObject newValue) Assign typed object value to SFBool enabled field, similar to setEnabled(boolean).
LoadSensorObject	setIS(ISObject newValue) Assign field named IS for establishing IS/connect field connections between ProtoInterface fields and internal ProtoBody nodes.
LoadSensorObject	setMetadata(ProtoInstanceObject newValue) Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field metadata.
LoadSensorObject	setMetadata(X3DMetadataObject newValue) Assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
LoadSensorObject	setTimeOut(double newValue) Assign double value in seconds within allowed range of [0,infinity) to inputOutput SFTime field named timeOut.
LoadSensorObject	setTimeOut(SFTimeObject newValue) Assign typed object value to SFTime timeOut field, similar to setTimeOut(double).
LoadSensorObject	setUSE(LoadSensorObject DEFnode) Assign a USE reference to another DEF node of same node type, similar to setUSE(String).
LoadSensorObject	setUSE(SFStringObject newValue) Assign typed object value to SFString USE field, similar to setUSE(String).
LoadSensorObject	setUSE(java.lang.String newValue) Assign String value to inputOutput SFString field named USE.
LoadSensorObject	setWatchList(java.util.ArrayList<X3DUrlObject> newValue) Assign ArrayList value of MFNode watchList field, similar to setWatchList(X3DNode[]).
LoadSensorObject	setWatchList(X3DConcreteNode newValue) Utility method to set single SFNode as LoadSensorObject watchList.
void	setWatchList(X3DNode newValue) Set single child watchList node, replacing prior array of existing nodes (if any).
LoadSensorObject	setWatchList(X3DNode[] newValue) Assign X3DUrlObject array (using an array consisting of properly typed nodes or ProtoInstanceObjects) to inputOutput MFNode field watchList.
java.lang.String	toStringClassicVRML(int indentLevel) Recursive method to provide ClassicVRML string serialization.
java.lang.String	toStringVRML97(int indentLevel) Recursive method to provide VRML97 string serialization.
java.lang.String	toStringX3D(int indentLevel) Recursive method to provide X3D string serialization of this model subgraph, utilizing XML encoding and conforming to X3D Canonical Form.
java.lang.String	validate() Recursive method to validate this element plus all contained nodes and statements, using both datatype-specification value checks and regular expression (regex) checking of corresponding string values.

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

getContainerFieldAlternateValues, getContainerFieldOverride, getCssClass, getDEF, getUSE, isNode, isStatement, isUSE, resetContainerFieldOverride, setConcreteCssClass, setConcreteDEF, setConcreteUSE, setContainerFieldOverride

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

clearParentObject, findAncestorElementByName, findAncestorProtoBody, findAncestorSceneObject, findAncestorX3DObject, getPackageName, getParentObject, getValidationResult, hasAncestorElementByName, hasAncestorProtoBody, hasAncestorSceneObject, hasAncestorX3DObject, setParentObject, toStringClassicVRML, toStringVRML97, toStringX3D

Methods inherited from class java.lang.Object

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

Field Detail

NAME

public static final java.lang.String NAME

String constant NAME provides name of this element: LoadSensor.

See Also:

Constant Field Values

COMPONENT

public static final java.lang.String COMPONENT

String constant COMPONENT defines X3D component for the LoadSensor element: Networking

See Also:

Constant Field Values

LEVEL

public static final int LEVEL

Integer constant LEVEL provides default X3D Networking component level for this element: 3

See Also:

Constant Field Values

ENABLED_DEFAULT_VALUE

public static final boolean ENABLED_DEFAULT_VALUE

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

See Also:

Constant Field Values

TIMEOUT_DEFAULT_VALUE

public static final double TIMEOUT_DEFAULT_VALUE

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

See Also:

Constant Field Values

containerField_DEFAULT_VALUE

public static final java.lang.String containerField_DEFAULT_VALUE

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

See Also:

X3D Scene Authoring Hints: containerField, X3D Unified Object Model (X3DUOM), Constant Field Values

fromField_ENABLED

public static final java.lang.String fromField_ENABLED

fromField ROUTE name for SFBool field named enabled.

See Also:

Constant Field Values

toField_ENABLED

public static final java.lang.String toField_ENABLED

toField ROUTE name for SFBool field named enabled.

See Also:

Constant Field Values

fromField_ISACTIVE

public static final java.lang.String fromField_ISACTIVE

fromField ROUTE name for SFBool field named isActive.

See Also:

Constant Field Values

fromField_ISLOADED

public static final java.lang.String fromField_ISLOADED

fromField ROUTE name for SFBool field named isLoaded.

See Also:

Constant Field Values

fromField_LOADTIME

public static final java.lang.String fromField_LOADTIME

fromField ROUTE name for SFTime field named loadTime.

See Also:

Constant Field Values

fromField_METADATA

public static final java.lang.String fromField_METADATA

fromField ROUTE name for SFNode field named metadata.

See Also:

Constant Field Values

toField_METADATA

public static final java.lang.String toField_METADATA

toField ROUTE name for SFNode field named metadata.

See Also:

Constant Field Values

fromField_PROGRESS

public static final java.lang.String fromField_PROGRESS

fromField ROUTE name for SFFloat field named progress.

See Also:

Constant Field Values

fromField_TIMEOUT

public static final java.lang.String fromField_TIMEOUT

fromField ROUTE name for SFTime field named timeOut.

See Also:

Constant Field Values

toField_TIMEOUT

public static final java.lang.String toField_TIMEOUT

toField ROUTE name for SFTime field named timeOut.

See Also:

Constant Field Values

fromField_WATCHLIST

public static final java.lang.String fromField_WATCHLIST

fromField ROUTE name for MFNode field named watchList.

See Also:

Constant Field Values

toField_WATCHLIST

public static final java.lang.String toField_WATCHLIST

toField ROUTE name for MFNode field named watchList.

See Also:

Constant Field Values

Constructor Detail

LoadSensorObject

public LoadSensorObject()

Constructor for LoadSensorObject to initialize member variables with default values.

LoadSensorObject

public LoadSensorObject(java.lang.String DEFlabel)

Utility constructor that assigns DEF label after initializing member variables with default values.

Parameters:

DEFlabel - unique DEF name for this X3D node

Method Detail

getElementName

public final java.lang.String getElementName()

Provides name of this element: LoadSensor

Specified by:

getElementName in class X3DConcreteElement

Returns:

name of this element

getComponent

public final java.lang.String getComponent()

Defines X3D component for the LoadSensor element: Networking

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

Specified by:

getComponentLevel in class X3DConcreteElement

Returns:

default X3D component level for this element

getFieldType

public java.lang.String getFieldType(java.lang.String fieldName)

Indicate type corresponding to given fieldName.

Specified by:

getFieldType in class X3DConcreteElement

Parameters:

fieldName - name of field in this X3D node

Returns:

X3D type (SFvec3f etc.), otherwise ConfigurationProperties.ERROR_UNKNOWN_FIELD_TYPE if not recognized

See Also:

ConfigurationProperties.ERROR_UNKNOWN_FIELD_TYPE

getAccessType

public java.lang.String getAccessType(java.lang.String fieldName)

Indicate accessType corresponding to given fieldName.

Specified by:

getAccessType in class X3DConcreteElement

Parameters:

fieldName - name of field in this X3D node

Returns:

X3D accessType (inputOnly etc.), otherwise ConfigurationProperties.ERROR_UNKNOWN_FIELD_ACCESSTYPE if not recognized

See Also:

ConfigurationProperties.ERROR_UNKNOWN_FIELD_ACCESSTYPE

getContainerFieldDefault

public final java.lang.String getContainerFieldDefault()

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

Specified by:

getContainerFieldDefault in class X3DConcreteNode

Returns:

default containerField value

See Also:

X3D Scene Authoring Hints: containerField, X3D Unified Object Model (X3DUOM)

initialize

public final void initialize()

Initialize all member variables to default values.

Overrides:

initialize in class X3DConcreteNode

getEnabled

public boolean getEnabled()

Provide boolean value from inputOutput SFBool field named enabled.

Tooltip: Enables/disables node operation. *

Specified by:

getEnabled in interface X3DSensorNode

Specified by:

getEnabled in interface LoadSensor

Specified by:

getEnabled in interface X3DNetworkSensorNode

Returns:

value of enabled field

setEnabled

public LoadSensorObject setEnabled(boolean newValue)

Assign boolean value to inputOutput SFBool field named enabled.

Tooltip: Enables/disables node operation.

Specified by:

setEnabled in interface X3DSensorNode

Specified by:

setEnabled in interface LoadSensor

Specified by:

setEnabled in interface X3DNetworkSensorNode

Parameters:

newValue - is new value for the enabled field.

Returns:

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

setEnabled

public LoadSensorObject setEnabled(SFBoolObject newValue)

Assign typed object value to SFBool enabled field, similar to setEnabled(boolean).

Parameters:

newValue - is new value for the enabled field.

Returns:

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

getIsActive

public boolean getIsActive()

Provide boolean value from outputOnly SFBool field named isActive.

Tooltip: isActive true/false events are sent when sensing starts/stops.

• Warning: it is an error to define this transient outputOnly field in an X3D file.

Specified by:

getIsActive in interface X3DSensorNode

Specified by:

getIsActive in interface LoadSensor

Specified by:

getIsActive in interface X3DNetworkSensorNode

Returns:

value of isActive field

getIsLoaded

public boolean getIsLoaded()

Provide boolean value from outputOnly SFBool field named isLoaded.

Tooltip: Notify when all watchList child nodes are loaded, or at least one has failed. Sends true on successfully loading all watchList child nodes. Sends false on timeOut of any watchList child nodes, failure of any watchList child nodes to load, or no local copies available and no network present.

• Hint: use multiple LoadSensor nodes to track multiple loading nodes individually.
• Warning: it is an error to define this transient outputOnly field in an X3D file.

Specified by:

getIsLoaded in interface LoadSensor

Returns:

value of isLoaded field

getLoadTime

public double getLoadTime()

Provide double value in seconds from outputOnly SFTime field named loadTime.

Tooltip: Time of successful load complete, not sent on failure.

• Warning: it is an error to define this transient outputOnly field in an X3D file.

Specified by:

getLoadTime in interface LoadSensor

Returns:

value of loadTime field

getMetadata

public X3DMetadataObject getMetadata()

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

Specified by:

getMetadata in interface X3DChildNode

Specified by:

getMetadata in interface X3DNode

Specified by:

getMetadata in interface X3DSensorNode

Specified by:

getMetadata in interface LoadSensor

Specified by:

getMetadata in interface X3DNetworkSensorNode

Returns:

value of metadata field

See Also:

getMetadataProtoInstance(), X3D Scene Authoring Hints: Metadata Nodes

setMetadata

public LoadSensorObject setMetadata(X3DMetadataObject newValue)

Assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.

Specified by:

setMetadata in interface X3DChildNode

Specified by:

setMetadata in interface X3DNode

Specified by:

setMetadata in interface X3DSensorNode

Specified by:

setMetadata in interface LoadSensor

Specified by:

setMetadata in interface X3DNetworkSensorNode

Specified by:

setMetadata in class X3DConcreteNode

Parameters:

newValue - is new value for the metadata field.

Returns:

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

See Also:

setMetadata(ProtoInstanceObject), X3D Scene Authoring Hints: Metadata Nodes

clearMetadata

public LoadSensorObject clearMetadata()

Utility method to clear SFNode value of metadata field.

Returns:

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

setMetadata

public LoadSensorObject setMetadata(ProtoInstanceObject newValue)

Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field metadata.

Specified by:

setMetadata in class X3DConcreteNode

Parameters:

newValue - is new value for the metadata field.

Returns:

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

See Also:

setMetadata(X3DMetadataObject)

hasMetadata

public boolean hasMetadata()

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

Returns:

whether a properly typed node or ProtoInstance or CommentsBlock is available.

See Also:

getMetadata(), getMetadataProtoInstance(), X3D Scene Authoring Hints: Metadata Nodes

getProgress

public float getProgress()

Provide float value from outputOnly SFFloat field named progress.

Tooltip: [0,1] Sends 0.0 on start and 1.0 on completion. Intermediate values are browser dependent and always increasing (may indicate fraction of bytes, fraction of expected time or another metric).

• Hint: only 0 and 1 events are guaranteed.
• Warning: it is an error to define this transient outputOnly field in an X3D file.

Specified by:

getProgress in interface LoadSensor

Returns:

value of progress field

getTimeOut

public double getTimeOut()

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

Tooltip: Time in seconds of maximum load duration prior to declaring failure. Default value zero means use browser defaults. *

Specified by:

getTimeOut in interface LoadSensor

Returns:

value of timeOut field

setTimeOut

public LoadSensorObject setTimeOut(double newValue)

Assign double value in seconds within allowed range of [0,infinity) to inputOutput SFTime field named timeOut.

Tooltip: Time in seconds of maximum load duration prior to declaring failure. Default value zero means use browser defaults.

Specified by:

setTimeOut in interface LoadSensor

Parameters:

newValue - is new value for the timeOut field.

Returns:

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

setTimeOut

public LoadSensorObject setTimeOut(SFTimeObject newValue)

Assign typed object value to SFTime timeOut field, similar to setTimeOut(double).

Parameters:

newValue - is new value for the timeOut field.

Returns:

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

getWatchList

public X3DNode[] getWatchList()

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

Tooltip: [X3DUrlObject] The watchList field monitors one or more USE nodes that contain a valid url field.

• Hint: if watchList contains multiple USE nodes, output events are only generated when all children have loaded successfully or at least one node has failed.
• Hint: if individual load status information is desired for different nodes, multiple LoadSensor nodes may be used, each with a single watchList element.
• Hint: Anchor nodes can be monitored for binding a target Viewpoint, loading a new scene, or loading a new scene in a new window.

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

Specified by:

getWatchList in interface LoadSensor

Returns:

value of watchList field

See Also:

X3DUrlObject

getWatchListList

public java.util.ArrayList<X3DNode> getWatchListList()

Utility method to get ArrayList value of MFNode watchList field, similar to getWatchList().

Returns:

value of watchList field

setWatchList

public LoadSensorObject setWatchList(X3DNode[] newValue)

Assign X3DUrlObject array (using an array consisting of properly typed nodes or ProtoInstanceObjects) to inputOutput MFNode field watchList.

Tooltip: [X3DUrlObject] The watchList field monitors one or more USE nodes that contain a valid url field. Hint: if watchList contains multiple USE nodes, output events are only generated when all children have loaded successfully or at least one node has failed. Hint: if individual load status information is desired for different nodes, multiple LoadSensor nodes may be used, each with a single watchList element. Hint: Anchor nodes can be monitored for binding a target Viewpoint, loading a new scene, or loading a new scene in a new window.

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

Specified by:

setWatchList in interface LoadSensor

Parameters:

newValue - is new value for the watchList field.

Returns:

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

setWatchList

public LoadSensorObject setWatchList(java.util.ArrayList<X3DUrlObject> newValue)

Assign ArrayList value of MFNode watchList field, similar to setWatchList(X3DNode[]).

Parameters:

newValue - is new value for the watchList field.

Returns:

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

addWatchList

public LoadSensorObject addWatchList(X3DNode newValue)

Add single child node to existing array of watchList nodes (if any).

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

Parameters:

newValue - is new value to be appended the watchList field.

Returns:

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

addWatchList

public void addWatchList(X3DNode[] newValue)

Add array of child watchList nodes to array of existing nodes (if any).

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

Specified by:

addWatchList in interface LoadSensor

Parameters:

newValue - is new value array to be appended the watchList field.

setWatchList

public void setWatchList(X3DNode newValue)

Set single child watchList node, replacing prior array of existing nodes (if any). Unable to return this object and pipeline methods since abstract SAI specifies void return type.

Specified by:

setWatchList in interface LoadSensor

Parameters:

newValue - is new node for the watchList field

See Also:

stackoverflow: Can overridden methods differ in return type?

setWatchList

public LoadSensorObject setWatchList(X3DConcreteNode newValue)

Utility method to set single SFNode as LoadSensorObject watchList.

Parameters:

newValue - LoadSensorObject node to set

Returns:

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

clearWatchList

public LoadSensorObject clearWatchList()

Utility method to clear MFNode value of watchList field.

Returns:

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

hasWatchList

public boolean hasWatchList()

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

Returns:

whether a properly typed node or ProtoInstance array or CommentsBlock is available.

See Also:

getWatchList()

setDEF

public final LoadSensorObject setDEF(java.lang.String newValue)

Assign String value to inputOutput SFString field named DEF.

Tooltip: DEF defines a unique ID name for this node, referenceable by other nodes. Hint: descriptive DEF names improve clarity and help document a model. Hint: well-defined names can simplify design and debugging through improved author understanding. Hint: X3D Scene Authoring Hints, Naming Conventions http://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#NamingConventions

Note that setting the DEF value clears the USE value.

Specified by:

setDEF in interface X3DChildNode

Specified by:

setDEF in interface X3DNode

Specified by:

setDEF in interface X3DSensorNode

Specified by:

setDEF in interface LoadSensor

Specified by:

setDEF in interface X3DNetworkSensorNode

Specified by:

setDEF in class X3DConcreteNode

Parameters:

newValue - is new value for the DEF field.

Returns:

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

setDEF

public LoadSensorObject setDEF(SFStringObject newValue)

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

Parameters:

newValue - is new value for the DEF field.

Returns:

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

setUSE

public final LoadSensorObject setUSE(java.lang.String newValue)

Assign String value to inputOutput SFString field named USE.

Tooltip: USE means reuse an already DEF-ed node ID, excluding all child nodes and all other attributes (except for containerField, which can have a different value). Hint: USE references to previously defined DEF geometry (instead of duplicating nodes) can improve performance. Warning: do NOT include any child nodes, a DEF attribute, or any other attribute values (except for containerField) when defining a USE attribute. Warning: each USE value must match a corresponding DEF value that is defined earlier in the scene.

Note: each USE node is still an independent object, with the USE value matching the DEF value in the preceding object.

Warning: invoking the setUSE() method on this node resets all other fields to their default values (except for containerField) and also releases all child nodes.

Warning: no other operations can be performed to modify a USE node other than setting an alternate containerField value.

Specified by:

setUSE in interface X3DChildNode

Specified by:

setUSE in interface X3DNode

Specified by:

setUSE in interface X3DSensorNode

Specified by:

setUSE in interface LoadSensor

Specified by:

setUSE in interface X3DNetworkSensorNode

Specified by:

setUSE in class X3DConcreteNode

Parameters:

newValue - is new value for the USE field.

Returns:

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

setUSE

public LoadSensorObject setUSE(SFStringObject newValue)

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

Parameters:

newValue - is new value for the USE field.

Returns:

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

setCssClass

public final LoadSensorObject setCssClass(java.lang.String newValue)

Assign String value to inputOutput SFString field named class.

Tooltip: The class attribute is a space-separated list of classes, reserved for use by CSS cascading stylesheets. Warning: currently the class attribute is only supported in XML encoding of X3D scenes. Hint: W3C Cascading Style Sheets https://www.w3.org/Style/CSS

Specified by:

setCssClass in interface X3DChildNode

Specified by:

setCssClass in interface X3DNode

Specified by:

setCssClass in interface X3DSensorNode

Specified by:

setCssClass in interface LoadSensor

Specified by:

setCssClass in interface X3DNetworkSensorNode

Specified by:

setCssClass in class X3DConcreteNode

Parameters:

newValue - is new value for the class field.

Returns:

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

See Also:

W3C Cascading Style Sheets

setCssClass

public LoadSensorObject setCssClass(SFStringObject newValue)

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

Parameters:

newValue - is new value for the class field.

Returns:

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

setIS

public LoadSensorObject setIS(ISObject newValue)

Assign field named IS for establishing IS/connect field connections between ProtoInterface fields and internal ProtoBody nodes. The IS statement connects node fields defined inside a ProtoBody declaration back to corresponding ProtoInterface fields.

Specified by:

setIS in class X3DConcreteNode

Parameters:

newValue - is new value for the description field.

Returns:

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

See Also:

X3D Tooltips: IS, X3D Tooltips: connect

getIS

public ISObject getIS()

Provide field named IS for establishing IS/connect field connections between ProtoInterface fields and internal ProtoBody nodes. The IS statement connects node fields defined inside a ProtoBody declaration back to corresponding ProtoInterface fields.

Specified by:

getIS in class X3DConcreteNode

Returns:

current ISObject, if any.

See Also:

X3D Tooltips: IS, X3D Tooltips: connect

setUSE

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

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

addComments

public LoadSensorObject addComments(java.lang.String newComment)

Add comment as String to contained commentsList.

Specified by:

addComments in class X3DConcreteElement

Parameters:

newComment - initial value

Returns:

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

addComments

public LoadSensorObject addComments(java.lang.String[] newComments)

Add comments as String[] array to contained commentsList.

Specified by:

addComments in class X3DConcreteElement

Parameters:

newComments - array of comments

Returns:

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

addComments

public LoadSensorObject addComments(CommentsBlock newCommentsBlock)

Add CommentsBlock to contained commentsList.

Specified by:

addComments in class X3DConcreteElement

Parameters:

newCommentsBlock - block of comments to add

Returns:

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

toStringX3D

public java.lang.String toStringX3D(int indentLevel)

Recursive method to provide X3D string serialization of this model subgraph, utilizing XML encoding and conforming to X3D Canonical Form.

Specified by:

toStringX3D in class X3DConcreteElement

Parameters:

indentLevel - number of levels of indentation for this element

Returns:

X3D string

See Also:

X3DObject.FILE_EXTENSION_X3D, X3DObject.FILE_EXTENSION_XML, X3DObject.toStringXML(), X3DObject.toFileXML(String), X3DObject.toFileX3D(String), X3D XML Encoding, X3D Compressed Binary Encoding: X3D Canonical Form

toStringClassicVRML

public java.lang.String toStringClassicVRML(int indentLevel)

Recursive method to provide ClassicVRML string serialization.

Specified by:

toStringClassicVRML in class X3DConcreteElement

Parameters:

indentLevel - number of levels of indentation for this element

Returns:

ClassicVRML string

See Also:

X3DObject.FILE_EXTENSION_CLASSICVRML, X3D Resources: Virtual Reality Modeling Language (VRML) 97, Extensible 3D (X3D) encodings Part 2: Classic VRML encoding, Extensible 3D (X3D) encodings Part 2: Classic VRML encoding, Annex A: Grammar

toStringVRML97

public java.lang.String toStringVRML97(int indentLevel)

Recursive method to provide VRML97 string serialization.

Specified by:

toStringVRML97 in class X3DConcreteElement

Parameters:

indentLevel - number of levels of indentation for this element

Returns:

VRML97 string

See Also:

X3DObject.FILE_EXTENSION_VRML97, X3D Resources: Virtual Reality Modeling Language (VRML) 97, Virtual Reality Modeling Language (VRML) 97 specification, VRML 97 v2.1 Amendment

findElementByNameValue

public X3DConcreteElement findElementByNameValue(java.lang.String nameValue)

Recursive method to provide object reference to node or statement by name attribute, if found as part of this element or in a contained element. Elements with name fields include meta, Metadata* nodes, field/fieldValue, ProtoDeclare/ExternProtoDeclare/ProtoInstance, CAD and HAnim nodes.

Warning: first start with findAncestorSceneObject() to check entire scene graph, or findAncestorX3DObject() to check entire model document.

Warning: more than one element may be found that has the same name, this method does not handle that case.

Specified by:

findElementByNameValue in class X3DConcreteElement

Parameters:

nameValue - is value of the name field being searched for in this element and child elements(if any)

Returns:

object reference to found element, null otherwise

See Also:

findNodeByDEF(String), X3DConcreteElement.hasAncestorSceneObject(), X3DConcreteElement.findAncestorX3DObject()

findElementByNameValue

public X3DConcreteElement findElementByNameValue(java.lang.String nameValue,
                                                 java.lang.String elementName)

Recursive method to provide object reference to node or statement by name attribute, if found as part of this element or in a contained element. Elements with name fields include meta, Metadata* nodes, field/fieldValue, ProtoDeclare/ExternProtoDeclare/ProtoInstance, CAD and HAnim nodes.

Warning: first start with findAncestorSceneObject() to check entire scene graph, or findAncestorX3DObject() to check entire model document.

Warning: more than one element may be found that has the same name, this method does not handle that case.

Specified by:

findElementByNameValue in class X3DConcreteElement

Parameters:

nameValue - is value of the name field being searched for in this element and child elements(if any)

elementName - identifies the element of interest (meta MetadataString ProtoDeclare CADassembly ProtoInstance HAnimHumanoid etc.)

Returns:

object reference to found element, null otherwise

See Also:

findNodeByDEF(String), X3DConcreteElement.hasAncestorSceneObject(), X3DConcreteElement.findAncestorX3DObject()

hasElementByNameValue

public boolean hasElementByNameValue(java.lang.String nameValue,
                                     java.lang.String elementName)

Recursive method to determine whether node or statement with given name attribute is found, meaning both objects are attached to same scene graph.

Parameters:

nameValue - is value of the name field being searched for in this element and child elements(if any)

elementName - identifies the element of interest (meta MetadataString ProtoDeclare CADassembly ProtoInstance HAnimHumanoid etc.)

Returns:

whether node is found

See Also:

findElementByNameValue(String, String)

findNodeByDEF

public X3DConcreteNode findNodeByDEF(java.lang.String DEFvalue)

Recursive method to provide object reference to node by DEF, if found as this node or in a contained node.

Warning: first start with findAncestorSceneObject() to check entire scene graph, or findAncestorX3DObject() to check entire model document.

Warning: more than one element may be found that has the same DEF, this method does not handle that case.

Specified by:

findNodeByDEF in class X3DConcreteElement

Parameters:

DEFvalue - is value of the name field being searched for in this element and child elements(if any)

Returns:

object reference to found node, null otherwise

See Also:

findElementByNameValue(String), X3DConcreteElement.hasAncestorSceneObject(), X3DConcreteElement.findAncestorX3DObject()

hasNodeByDEF

public boolean hasNodeByDEF(java.lang.String DEFvalue)

Recursive method to determine whether node with DEFvalue is found, meaning both objects are attached to same scene graph.

Parameters:

DEFvalue - is value of the name field being searched for in this element and child elements(if any)

Returns:

whether node is found

See Also:

findNodeByDEF(String)

validate

public java.lang.String validate()

Recursive method to validate this element plus all contained nodes and statements, using both datatype-specification value checks and regular expression (regex) checking of corresponding string values.

Specified by:

validate in class X3DConcreteElement

Returns:

validation results (if any)