Class LoadSensor

java.lang.Object
org.web3d.x3d.jsail.X3DConcreteElement
org.web3d.x3d.jsail.X3DConcreteNode
org.web3d.x3d.jsail.Networking.LoadSensor
All Implemented Interfaces:
X3DChildNode, X3DNode, X3DSensorNode, LoadSensor, X3DNetworkSensorNode
public class LoadSensor extends X3DConcreteNode implements LoadSensor
LoadSensor generates events as watchList child nodes are either loaded or fail to load.

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. LoadSensor node tooltip: [X3DNetworkSensorNode] LoadSensor generates events as watchList child nodes are either loaded or fail to load. Changing watchlist child nodes restarts the LoadSensor.
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:

  • Field Details

    • NAME

      public static final String NAME
      String constant NAME provides name of this element: LoadSensor.
      See Also:

    • COMPONENT

      public static final String COMPONENT
      String constant COMPONENT defines X3D component for the LoadSensor element: Networking
      See Also:

    • LEVEL

      public static final int LEVEL
      Integer constant LEVEL provides default X3D Networking component level for this element: 3
      See Also:

    • DESCRIPTION_DEFAULT_VALUE

      public static final String DESCRIPTION_DEFAULT_VALUE
      SFString field named description has default value equal to an empty string.
      See Also:

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

    • IS_DEFAULT_VALUE

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

    • METADATA_DEFAULT_VALUE

      public static final X3DMetadataObject METADATA_DEFAULT_VALUE
      SFNode field named metadata has default value null (Java syntax) or NULL (XML syntax).

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

    • containerField_DEFAULT_VALUE

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

    • fromField_CHILDREN

      public static final String fromField_CHILDREN
      fromField ROUTE name for MFNode field named children.
      See Also:

    • toField_CHILDREN

      public static final String toField_CHILDREN
      toField ROUTE name for MFNode field named children.
      See Also:

    • fromField_DESCRIPTION

      public static final String fromField_DESCRIPTION
      fromField ROUTE name for SFString field named description.
      See Also:

    • toField_DESCRIPTION

      public static final String toField_DESCRIPTION
      toField ROUTE name for SFString field named description.
      See Also:

    • fromField_ENABLED

      public static final String fromField_ENABLED
      fromField ROUTE name for SFBool field named enabled.
      See Also:

    • toField_ENABLED

      public static final String toField_ENABLED
      toField ROUTE name for SFBool field named enabled.
      See Also:

    • fromField_IS

      public static final String fromField_IS
      fromField ROUTE name for SFNode field named IS.
      See Also:

    • fromField_ISACTIVE

      public static final String fromField_ISACTIVE
      fromField ROUTE name for SFBool field named isActive.
      See Also:

    • fromField_ISLOADED

      public static final String fromField_ISLOADED
      fromField ROUTE name for SFBool field named isLoaded.
      See Also:

    • fromField_LOADTIME

      public static final String fromField_LOADTIME
      fromField ROUTE name for SFTime field named loadTime.
      See Also:

    • fromField_METADATA

      public static final String fromField_METADATA
      fromField ROUTE name for SFNode field named metadata.
      See Also:

    • toField_METADATA

      public static final String toField_METADATA
      toField ROUTE name for SFNode field named metadata.
      See Also:

    • fromField_PROGRESS

      public static final String fromField_PROGRESS
      fromField ROUTE name for SFFloat field named progress.
      See Also:

    • fromField_TIMEOUT

      public static final String fromField_TIMEOUT
      fromField ROUTE name for SFTime field named timeOut.
      See Also:

    • toField_TIMEOUT

      public static final String toField_TIMEOUT
      toField ROUTE name for SFTime field named timeOut.
      See Also:

  • Constructor Details

    • LoadSensor

      public LoadSensor()
      Constructor for LoadSensor to initialize member variables with default values.

    • LoadSensor

      public LoadSensor(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: LoadSensor
      Specified by:
      getElementName in class X3DConcreteElement
      Returns:
      name of this element

    • getComponent

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

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

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

    • initialize

      public final void initialize()
      Initialize all member variables to default values.
      Overrides:
      initialize in class X3DConcreteNode

    • getChildren

      public X3DNode[] getChildren()
      Provide array of org.web3d.x3d.sai.Networking.X3DUrlObject results (using an array consisting of properly typed nodes or ProtoInstances) from inputOutput MFNode field children.

      Tooltip: [X3DUrlObject] The children field monitors one or more USE nodes that contain a valid url field.
      • Warning: field originally named 'watchList' in X3Dv3. https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#fieldNameChanges
      • 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:
      getChildren in interface LoadSensor
      Returns:
      value of children field
      See Also:

    • getChildrenList

      public ArrayList<X3DNode> getChildrenList()
      Utility method to get ArrayList value of MFNode children field, similar to getChildren().
      Returns:
      value of children field

    • setChildren

      public LoadSensor setChildren(X3DNode[] newValue)
      Accessor method to assign org.web3d.x3d.sai.Networking.X3DUrlObject array (using an array consisting of properly typed nodes or ProtoInstances) to inputOutput MFNode field children.

      Tooltip: [X3DUrlObject] The children field monitors one or more USE nodes that contain a valid url field.
      • Warning: field originally named 'watchList' in X3Dv3. https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#fieldNameChanges
      • 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:
      setChildren in interface LoadSensor
      Parameters:
      newValue - is new value for the children field.
      Returns:
      LoadSensor - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • setChildren

      public LoadSensor setChildren(ArrayList<X3DUrlObject> newValue)
      Assign ArrayList value of MFNode children field, similar to setChildren(org.web3d.x3d.sai.Core.X3DNode[]).
      Parameters:
      newValue - is new value for the children field.
      Returns:
      LoadSensor - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • addChildren

      public void addChildren(X3DNode newValue)
      Add single node to existing array of children 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 children field.

    • addChildren

      public LoadSensor addChildren(ProtoInstance newValue)
      Add single ProtoInstance (with appropriate node type and containerField value) to MFNode array for children field.

      Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to ShaderPart and ProtoInstance.
      Parameters:
      newValue - is new value to be appended the parts field.
      Returns:
      LoadSensor - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • addChild

      public LoadSensor addChild(X3DUrlObject newValue)
      Utility method to add single child element to contained list of existing children nodes (if any).
      Parameters:
      newValue - is new node value to be appended the children field.
      Returns:
      LoadSensor - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • addChildren

      public void addChildren(X3DNode[] newValue)
      Add array of children 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:
      addChildren in interface LoadSensor
      Parameters:
      newValue - is new value array to be appended the children field.

    • setChildren

      public void setChildren(X3DNode newValue)
      Set single children 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:
      setChildren in interface LoadSensor
      Parameters:
      newValue - is new node for the children field
      See Also:

    • clearChildren

      public LoadSensor clearChildren()
      Utility method to clear MFNode value of children field. This method does not initialize withCHILDREN_DEFAULT_VALUE.
      Returns:
      LoadSensor - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).

    • hasChildren

      public boolean hasChildren()
      Indicate whether an object is available for inputOutput MFNode field children.
      Returns:
      whether a properly typed node or ProtoInstance array or CommentsBlock is available.
      See Also:

    • addComments

      public LoadSensor addComments(String newComment)
      Add comment as CommentsBlock to children field
      Specified by:
      addComments in class X3DConcreteElement
      Parameters:
      newComment - initial value
      Returns:
      LoadSensor - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).

    • addComments

      public LoadSensor addComments(String[] newComments)
      Add comments as String[] array to children field
      Specified by:
      addComments in class X3DConcreteElement
      Parameters:
      newComments - array of comments
      Returns:
      LoadSensor - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).

    • addComments

      public LoadSensor addComments(CommentsBlock newCommentsBlock)
      Add CommentsBlock to children field
      Specified by:
      addComments in class X3DConcreteElement
      Parameters:
      newCommentsBlock - block of comments to add
      Returns:
      LoadSensor - 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 node.
      • Hint: many XML tools substitute XML character references for special characters automatically if needed within an attribute value (such as &#38; for & ampersand character, or &#34; for " quotation-mark character).
      Specified by:
      getDescription in interface LoadSensor
      Specified by:
      getDescription in interface X3DNetworkSensorNode
      Specified by:
      getDescription in interface X3DSensorNode
      Returns:
      value of description field

    • setDescription

      public LoadSensor 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 node.
      • Hint: many XML tools substitute XML character references for special characters automatically if needed within an attribute value (such as &#38; for & ampersand character, or &#34; for " quotation-mark character).
      Specified by:
      setDescription in interface LoadSensor
      Specified by:
      setDescription in interface X3DNetworkSensorNode
      Specified by:
      setDescription in interface X3DSensorNode
      Parameters:
      newValue - is new value for the description field.
      Returns:
      LoadSensor - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • setDescription

      public LoadSensor 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:
      LoadSensor - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • getEnabled

      public boolean getEnabled()
      Provide boolean value from inputOutput SFBool field named enabled.

      Tooltip: Enables/disables node operation. *
      Specified by:
      getEnabled in interface LoadSensor
      Specified by:
      getEnabled in interface X3DNetworkSensorNode
      Specified by:
      getEnabled in interface X3DSensorNode
      Returns:
      value of enabled field

    • setEnabled

      public LoadSensor setEnabled(boolean newValue)
      Accessor method to assign boolean value to inputOutput SFBool field named enabled.

      Tooltip: Enables/disables node operation. *
      Specified by:
      setEnabled in interface LoadSensor
      Specified by:
      setEnabled in interface X3DNetworkSensorNode
      Specified by:
      setEnabled in interface X3DSensorNode
      Parameters:
      newValue - is new value for the enabled field.
      Returns:
      LoadSensor - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • setEnabled

      public LoadSensor setEnabled(SFBool newValue)
      Assign typed object value to SFBool enabled field, similar to setEnabled(boolean).
      Parameters:
      newValue - is new value for the enabled field.
      Returns:
      LoadSensor - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • getIS

      public IS getIS()
      Provide IS instance (using a properly typed node) from inputOutput SFNode field IS.
      Specified by:
      getIS in class X3DConcreteNode
      Returns:
      value of IS field
      See Also:

    • setIS

      public LoadSensor 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:
      LoadSensor - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:

    • clearIS

      public LoadSensor clearIS()
      Utility method to clear SFNode value of IS field.
      Returns:
      LoadSensor - 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:

    • 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, instead only use it a source for ROUTE events.
      Specified by:
      getIsActive in interface LoadSensor
      Specified by:
      getIsActive in interface X3DNetworkSensorNode
      Specified by:
      getIsActive in interface X3DSensorNode
      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, instead only use it a source for ROUTE events.
      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, instead only use it a source for ROUTE events.
      Specified by:
      getLoadTime in interface LoadSensor
      Returns:
      value of loadTime field

    • 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 LoadSensor
      Specified by:
      getMetadata in interface X3DChildNode
      Specified by:
      getMetadata in interface X3DNetworkSensorNode
      Specified by:
      getMetadata in interface X3DNode
      Specified by:
      getMetadata in interface X3DSensorNode
      Returns:
      value of metadata field
      See Also:

    • setMetadata

      public LoadSensor 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 LoadSensor
      Specified by:
      setMetadata in interface X3DChildNode
      Specified by:
      setMetadata in interface X3DNetworkSensorNode
      Specified by:
      setMetadata in interface X3DNode
      Specified by:
      setMetadata in interface X3DSensorNode
      Specified by:
      setMetadata in class X3DConcreteNode
      Parameters:
      newValue - is new value for the metadata field.
      Returns:
      LoadSensor - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:

    • clearMetadata

      public LoadSensor clearMetadata()
      Utility method to clear SFNode value of metadata field.
      Returns:
      LoadSensor - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).

    • setMetadata

      public LoadSensor 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:
      LoadSensor - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:

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

    • 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, instead only use it a source for ROUTE events.
      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 LoadSensor setTimeOut(double newValue)
      Accessor method to assign double value in seconds 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:
      LoadSensor - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • setTimeOut

      public LoadSensor setTimeOut(SFTime newValue)
      Assign typed object value to SFTime timeOut field, similar to setTimeOut(double).
      Parameters:
      newValue - is new value for the timeOut field.
      Returns:
      LoadSensor - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • getDEF

      public String getDEF()
      Provide String value from inputOutput SFString field named DEF.

      Tooltip: DEF defines a unique ID name for this node, referenceable by other nodes.
      Overrides:
      getDEF in class X3DConcreteNode
      Returns:
      value of DEF field
      See Also:

    • setDEF

      public final LoadSensor 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.

      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:
      LoadSensor - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • setDEF

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

    • setUSE

      public final LoadSensor 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:
      LoadSensor - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • setUSE

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

    • setCssClass

      public final LoadSensor 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:
      LoadSensor - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:

    • setCssClass

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

    • setHtmlID

      public final LoadSensor 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:
      LoadSensor - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:

    • setHtmlID

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

    • setCssStyle

      public final LoadSensor 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:
      LoadSensor - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:

    • setCssStyle

      public LoadSensor 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:
      LoadSensor - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • setUSE

      public LoadSensor setUSE(LoadSensor 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:
      LoadSensor - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

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

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

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

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

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

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

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

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

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