Package org.web3d.x3d.jsail.EventUtilities

Class IntegerSequencer

java.lang.Object
org.web3d.x3d.jsail.X3DConcreteElement
org.web3d.x3d.jsail.X3DConcreteNode
org.web3d.x3d.jsail.EventUtilities.IntegerSequencer
All Implemented Interfaces:
X3DChildNode, X3DNode, IntegerSequencer, X3DSequencerNode
public class IntegerSequencer extends X3DConcreteNode implements IntegerSequencer
IntegerSequencer generates periodic discrete integer values.

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. X3D node tooltip: [X3DSequencerNode] IntegerSequencer generates periodic discrete integer values. Authors can ROUTE value_changed output events to other SFInt32 attributes (for example, useful when animating whichChoice in a Switch node). Hint: typical input connection is ROUTE someTimeSensorDEF.fraction_changed TO thisInterpolatorDEF.set_fraction Hint: typical output connection is ROUTE thisInterpolatorDEF.value_changed TO someDestinationNodeDEF.set_someAttribute. Hint: example scenes and authoring assets at <a href="https://www.web3d.org/x3d/content/examples/X3dForWebAuthors/Chapter09-EventUtilitiesScripting" target="_blank">https://www.web3d.org/x3d/content/examples/X3dForWebAuthors/Chapter09-EventUtilitiesScripting</a> Hint: X3D Event-Utility Node Diagrams <a href="https://www.web3d.org/x3d/content/examples/X3dForWebAuthors/Chapter09-EventUtilitiesScripting/X3dEventUtilityNodeEventDiagrams.pdf" target="_blank">https://www.web3d.org/x3d/content/examples/X3dForWebAuthors/Chapter09-EventUtilitiesScripting/X3dEventUtilityNodeEventDiagrams.pdf</a> *


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: IntegerSequencer.
      See Also:

    • COMPONENT

      public static final String COMPONENT
      String constant COMPONENT defines X3D component for the IntegerSequencer element: EventUtilities
      See Also:

    • LEVEL

      public static final int LEVEL
      Integer constant LEVEL provides default X3D EventUtilities component level for this element: 1
      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).

    • KEY_DEFAULT_VALUE

      public static final ArrayList<Float> KEY_DEFAULT_VALUE
      MFFloat field named key has default value equal to an empty list.

    • KEYVALUE_DEFAULT_VALUE

      public static final ArrayList<Integer> KEYVALUE_DEFAULT_VALUE
      MFInt32 field named keyValue has default value equal to an empty list.

    • METADATA_DEFAULT_VALUE

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

    • 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, default value is provided for informational purposes.
      See Also:

    • fromField_IS

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

    • fromField_KEY

      public static final String fromField_KEY
      fromField ROUTE name for MFFloat field named key.
      See Also:

    • toField_KEY

      public static final String toField_KEY
      toField ROUTE name for MFFloat field named key.
      See Also:

    • fromField_KEYVALUE

      public static final String fromField_KEYVALUE
      fromField ROUTE name for MFInt32 field named keyValue.
      See Also:

    • toField_KEYVALUE

      public static final String toField_KEYVALUE
      toField ROUTE name for MFInt32 field named keyValue.
      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:

    • toField_NEXT

      public static final String toField_NEXT
      toField ROUTE name for SFBool field named next.
      See Also:

    • toField_PREVIOUS

      public static final String toField_PREVIOUS
      toField ROUTE name for SFBool field named previous.
      See Also:

    • toField_SET_FRACTION

      public static final String toField_SET_FRACTION
      toField ROUTE name for SFFloat field named set_fraction.
      See Also:

    • fromField_VALUE_CHANGED

      public static final String fromField_VALUE_CHANGED
      fromField ROUTE name for SFInt32 field named value_changed.
      See Also:

  • Constructor Details

    • IntegerSequencer

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

    • IntegerSequencer

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

    • getComponent

      public final String getComponent()
      Defines X3D component for the IntegerSequencer element: EventUtilities
      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:

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

    • initialize

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

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

    • clearIS

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

    • getKey

      public float[] getKey()
      Provide array of Float results from inputOutput MFFloat field named key.

      Tooltip: Definition values for linear-interpolation function input intervals, listed in non-decreasing order and corresponding to a value in the keyValue array. Warning: number of keys must match number of keyValues! Warning: values in key array shall be monotonically non-decreasing, meaning that each value is greater than or equal to the preceding value. Hint: typical interval for values in key array is within range of 0 to 1, but larger intervals can be defined with arbitrary bounds. *
      Specified by:
      getKey in interface IntegerSequencer
      Specified by:
      getKey in interface X3DSequencerNode
      Returns:
      value of key field

    • getKeyList

      public ArrayList<Float> getKeyList()
      Utility method to get ArrayList value of MFFloat key field, similar to getKey().
      Returns:
      value of key field

    • getKeyString

      public String getKeyString()
      Utility method to get String value of MFFloat key field, similar to getKey().
      Returns:
      value of key field

    • setKey

      public IntegerSequencer setKey(float[] newValue)
      Accessor method to assign Float array to inputOutput MFFloat field named key.

      Tooltip: Definition values for linear-interpolation function input intervals, listed in non-decreasing order and corresponding to a value in the keyValue array. Warning: number of keys must match number of keyValues! Warning: values in key array shall be monotonically non-decreasing, meaning that each value is greater than or equal to the preceding value. Hint: typical interval for values in key array is within range of 0 to 1, but larger intervals can be defined with arbitrary bounds. *
      Specified by:
      setKey in interface IntegerSequencer
      Specified by:
      setKey in interface X3DSequencerNode
      Parameters:
      newValue - is new value for the key field.
      Returns:
      IntegerSequencer - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • setKey

      public IntegerSequencer setKey(MFFloat newValue)
      Assign typed object value to MFFloat key field, similar to setKey(float[]). // #0.e
      Parameters:
      newValue - is new value for the key field.
      Returns:
      IntegerSequencer - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • setKey

      public IntegerSequencer setKey(ArrayList<Float> newValue)
      Assign ArrayList value of MFFloat key field, similar to setKey(float[]).
      Parameters:
      newValue - is new value for the key field.
      Returns:
      IntegerSequencer - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • clearKey

      public IntegerSequencer clearKey()
      Utility method to clear MFFloat value of key field.
      Returns:
      IntegerSequencer - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).

    • setKey

      public IntegerSequencer setKey(int[] newValue)
      Assign floating-point array value of MFFloat key field, similar to setKey(float[]).
      Parameters:
      newValue - is new value for the key field.
      Returns:
      IntegerSequencer - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • addKey

      public IntegerSequencer addKey(float newValue)
      Add singleton float value to MFFloat key field.
      Parameters:
      newValue - is new value to add to the key field.
      Returns:
      IntegerSequencer - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • addKey

      public IntegerSequencer addKey(SFFloat newValue)
      Add singleton SFFloat value to MFFloat key field.
      Parameters:
      newValue - is new value to add to the key field.
      Returns:
      IntegerSequencer - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • setKey

      public IntegerSequencer setKey(double[] newArray)
      Utility method: double-precision set-array accessor for X3D floating-point type, similar to setKey(float[]).
      Parameters:
      newArray - is new value for field
      Returns:
      IntegerSequencer - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • getKeyValue

      public int[] getKeyValue()
      Provide array of Integer results from inputOutput MFInt32 field named keyValue.

      Tooltip: Output values for linear sequencing, each corresponding to an input-fraction value in the key array. Warning: number of keys must match number of keyValues!. *
      Specified by:
      getKeyValue in interface IntegerSequencer
      Returns:
      value of keyValue field

    • getKeyValueList

      public ArrayList<Integer> getKeyValueList()
      Utility method to get ArrayList value of MFInt32 keyValue field, similar to getKeyValue().
      Returns:
      value of keyValue field

    • getKeyValueString

      public String getKeyValueString()
      Utility method to get String value of MFInt32 keyValue field, similar to getKeyValue().
      Returns:
      value of keyValue field

    • setKeyValue

      public IntegerSequencer setKeyValue(int[] newValue)
      Accessor method to assign Integer array to inputOutput MFInt32 field named keyValue.

      Tooltip: Output values for linear sequencing, each corresponding to an input-fraction value in the key array. Warning: number of keys must match number of keyValues!. *
      Specified by:
      setKeyValue in interface IntegerSequencer
      Parameters:
      newValue - is new value for the keyValue field.
      Returns:
      IntegerSequencer - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • setKeyValue

      public IntegerSequencer setKeyValue(MFInt32 newValue)
      Assign typed object value to MFInt32 keyValue field, similar to setKeyValue(int[]). // #0.e
      Parameters:
      newValue - is new value for the keyValue field.
      Returns:
      IntegerSequencer - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • setKeyValue

      public IntegerSequencer setKeyValue(ArrayList<Integer> newValue)
      Assign ArrayList value of MFInt32 keyValue field, similar to setKeyValue(int[]).
      Parameters:
      newValue - is new value for the keyValue field.
      Returns:
      IntegerSequencer - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • clearKeyValue

      public IntegerSequencer clearKeyValue()
      Utility method to clear MFInt32 value of keyValue field.
      Returns:
      IntegerSequencer - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).

    • addKeyValue

      public IntegerSequencer addKeyValue(int newValue)
      Add singleton int value to MFInt32 keyValue field.
      Parameters:
      newValue - is new value to add to the keyValue field.
      Returns:
      IntegerSequencer - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • addKeyValue

      public IntegerSequencer addKeyValue(SFInt32 newValue)
      Add singleton SFInt32 value to MFInt32 keyValue field.
      Parameters:
      newValue - is new value to add to the keyValue field.
      Returns:
      IntegerSequencer - 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 IntegerSequencer
      Specified by:
      getMetadata in interface X3DChildNode
      Specified by:
      getMetadata in interface X3DNode
      Specified by:
      getMetadata in interface X3DSequencerNode
      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 <a href="https://www.web3d.org/specifications/X3Dv4Draft/ISO-IEC19775-1v4-IS.proof//Part01/components/core.html#Metadata" target="_blank">https://www.web3d.org/specifications/X3Dv4Draft/ISO-IEC19775-1v4-IS.proof//Part01/components/core.html#Metadata</a> *
      • X3D Scene Authoring Hints: Metadata Nodes

    • setMetadata

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

    • clearMetadata

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

    • setMetadata

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

    • setNext

      public IntegerSequencer setNext(boolean newValue)
      Accessor method to assign boolean value to inputOnly SFBool field named next.

      Tooltip: Send next output value in keyValue array, and reset internal fraction field to match corresponding value in key array. Hint: this input event will "wrap around" boundary of keyValue array, i.e. continue from last to first if necessary. Warning: it is an error to define this transient inputOnly field in an X3D file, instead only use it a destination for ROUTE events. *
      Specified by:
      setNext in interface IntegerSequencer
      Specified by:
      setNext in interface X3DSequencerNode
      Parameters:
      newValue - is new value for the next field.
      Returns:
      IntegerSequencer - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • setNext

      public IntegerSequencer setNext(SFBool newValue)
      Assign typed object value to SFBool next field, similar to setNext(boolean). // #0.e
      Parameters:
      newValue - is new value for the next field.
      Returns:
      IntegerSequencer - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • setPrevious

      public IntegerSequencer setPrevious(boolean newValue)
      Accessor method to assign boolean value to inputOnly SFBool field named previous.

      Tooltip: Send previous output value in keyValue array, and reset internal fraction field to match corresponding value in key array. Hint: this input event will "wrap around" boundary of keyValue array, i.e. continue from first to last if necessary. Warning: it is an error to define this transient inputOnly field in an X3D file, instead only use it a destination for ROUTE events. *
      Specified by:
      setPrevious in interface IntegerSequencer
      Specified by:
      setPrevious in interface X3DSequencerNode
      Parameters:
      newValue - is new value for the previous field.
      Returns:
      IntegerSequencer - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • setPrevious

      public IntegerSequencer setPrevious(SFBool newValue)
      Assign typed object value to SFBool previous field, similar to setPrevious(boolean). // #0.e
      Parameters:
      newValue - is new value for the previous field.
      Returns:
      IntegerSequencer - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • getValue

      public int getValue()
      Provide int value from outputOnly SFInt32 field named value_changed.

      Tooltip: Single intermittent output value determined by current key time and corresponding keyValue entry. 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:
      getValue in interface IntegerSequencer
      Returns:
      value of value_changed field

    • getDEF

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

      Tooltip: DEF defines a unique ID name for this node, referenceable by other nodes. Hint: descriptive DEF names improve clarity and help document a model. Hint: well-defined names can simplify design and debugging through improved author understanding. Hint: X3D Scene Authoring Hints, Naming Conventions <a href="https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#NamingConventions" target="_blank">https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#NamingConventions</a> *
      Overrides:
      getDEF in class X3DConcreteNode
      Returns:
      value of DEF field
      See Also:

    • setDEF

      public final IntegerSequencer setDEF(String newValue)
      Accessor method to assign String value to inputOutput SFString field named DEF.

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


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

    • setDEF

      public IntegerSequencer setDEF(SFString newValue)
      Assign typed object value to SFString DEF field, similar to setDEF(String). // #0.e
      Parameters:
      newValue - is new value for the DEF field.
      Returns:
      IntegerSequencer - 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 IntegerSequencer 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:
      IntegerSequencer - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • setUSE

      public IntegerSequencer setUSE(SFString newValue)
      Assign typed object value to SFString USE field, similar to setUSE(String). // #0.e
      Parameters:
      newValue - is new value for the USE field.
      Returns:
      IntegerSequencer - 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 IntegerSequencer 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:
      IntegerSequencer - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:

    • setCssClass

      public IntegerSequencer setCssClass(SFString newValue)
      Assign typed object value to SFString cssClass field, similar to setCssClass(String). // #0.e
      Parameters:
      newValue - is new value for the class field.
      Returns:
      IntegerSequencer - 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 IntegerSequencer 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:
      IntegerSequencer - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:

    • setHtmlID

      public IntegerSequencer setHtmlID(SFString newValue)
      Assign typed object value to SFString HtmlID field, similar to setHtmlID(String). // #0.e
      Parameters:
      newValue - is new value for the id field.
      Returns:
      IntegerSequencer - 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 IntegerSequencer 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:
      IntegerSequencer - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:

    • setCssStyle

      public IntegerSequencer setCssStyle(SFString newValue)
      Assign typed object value to SFString cssClass field, similar to setCssStyle(String). // #0.e
      Parameters:
      newValue - is new value for the style field.
      Returns:
      IntegerSequencer - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • setUSE

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

    • addComments

      public IntegerSequencer addComments(String newComment)
      Add comment as String to contained commentsList.
      Specified by:
      addComments in class X3DConcreteElement
      Parameters:
      newComment - initial value
      Returns:
      IntegerSequencer - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:

    • addComments

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

    • addComments

      public IntegerSequencer addComments(CommentsBlock newCommentsBlock)
      Add CommentsBlock to contained commentsList.
      Specified by:
      addComments in class X3DConcreteElement
      Parameters:
      newCommentsBlock - block of comments to add
      Returns:
      IntegerSequencer - 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:

    • 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.
      Specified by:
      validate in class X3DConcreteElement
      Returns:
      validation results (if any)