Class PositionInterpolator2D

java.lang.Object
org.web3d.x3d.jsail.X3DConcreteElement
org.web3d.x3d.jsail.X3DConcreteNode
org.web3d.x3d.jsail.Interpolation.PositionInterpolator2D
All Implemented Interfaces:
X3DChildNode, X3DNode, PositionInterpolator2D, X3DInterpolatorNode

public class PositionInterpolator2D
extends X3DConcreteNode
implements PositionInterpolator2D
PositionInterpolator2D generates a series of SFVec2f values.

X3D node tooltip: [X3DInterpolatorNode] PositionInterpolator2D generates a series of SFVec2f values. Authors can ROUTE value_changed output events to a SFVec2f attribute.
  • 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.
  • Warning: requires X3D profile='Full' or else include <component name='Interpolation' level='3'/>
  • Hint: example scenes and authoring assets at https://x3dgraphics.com/examples/X3dForWebAuthors/Chapter07EventAnimationInterpolation

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: PositionInterpolator2D, X3D Tooltips: PositionInterpolator2D, X3D Scene Authoring Hints
  • Field Details

    • NAME

      public static final java.lang.String NAME
      String constant NAME provides name of this element: PositionInterpolator2D.
      See Also:
      Constant Field Values
    • COMPONENT

      public static final java.lang.String COMPONENT
      String constant COMPONENT defines X3D component for the PositionInterpolator2D element: Interpolation
      See Also:
      Constant Field Values
    • LEVEL

      public static final int LEVEL
      Integer constant LEVEL provides default X3D Interpolation component level for this element: 3
      See Also:
      Constant Field Values
    • IS_DEFAULT_VALUE

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

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

      public static final float[] KEYVALUE_DEFAULT_VALUE
      MFVec2f 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 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_IS

      public static final java.lang.String fromField_IS
      fromField ROUTE name for SFNode field named IS.
      See Also:
      Constant Field Values
    • fromField_KEY

      public static final java.lang.String fromField_KEY
      fromField ROUTE name for MFFloat field named key.
      See Also:
      Constant Field Values
    • toField_KEY

      public static final java.lang.String toField_KEY
      toField ROUTE name for MFFloat field named key.
      See Also:
      Constant Field Values
    • fromField_KEYVALUE

      public static final java.lang.String fromField_KEYVALUE
      fromField ROUTE name for MFVec2f field named keyValue.
      See Also:
      Constant Field Values
    • toField_KEYVALUE

      public static final java.lang.String toField_KEYVALUE
      toField ROUTE name for MFVec2f field named keyValue.
      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
    • toField_SET_FRACTION

      public static final java.lang.String toField_SET_FRACTION
      toField ROUTE name for SFFloat field named set_fraction.
      See Also:
      Constant Field Values
    • fromField_VALUE_CHANGED

      public static final java.lang.String fromField_VALUE_CHANGED
      fromField ROUTE name for SFVec2f field named value_changed.
      See Also:
      Constant Field Values
  • Constructor Details

    • PositionInterpolator2D

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

      public PositionInterpolator2D​(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 Details

    • getElementName

      public final java.lang.String getElementName()
      Provides name of this element: PositionInterpolator2D
      Specified by:
      getElementName in class X3DConcreteElement
      Returns:
      name of this element
    • getComponent

      public final java.lang.String getComponent()
      Defines X3D component for the PositionInterpolator2D element: Interpolation
      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
    • getIS

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

      public PositionInterpolator2D 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:
      PositionInterpolator2D - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:
      X3D Tooltips: IS, X3D Tooltips: connect
    • clearIS

      public PositionInterpolator2D clearIS()
      Utility method to clear SFNode value of IS field.
      Returns:
      PositionInterpolator2D - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
    • hasIS

      public boolean hasIS()
      Indicate whether an object is available for inputOutput SFNode field IS.
      Returns:
      whether a concrete statement or CommentsBlock is available.
      See Also:
      getIS()
    • 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.
      • Hint: number of keyValues must be an integer multiple of the number of keys!
      • Hint: keyValue/key integer multiple defines how many coordinates are sent in value_changed outputOnlys.
      • 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 PositionInterpolator2D
      Specified by:
      getKey in interface X3DInterpolatorNode
      Returns:
      value of key field
    • getKeyList

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

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

      public PositionInterpolator2D 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.
      • Hint: number of keyValues must be an integer multiple of the number of keys!
      • Hint: keyValue/key integer multiple defines how many coordinates are sent in value_changed outputOnlys.
      • 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 PositionInterpolator2D
      Specified by:
      setKey in interface X3DInterpolatorNode
      Parameters:
      newValue - is new value for the key field.
      Returns:
      PositionInterpolator2D - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setKey

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

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

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

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

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

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

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

      public float[] getKeyValue()
      Provide array of 2-tuple float results from inputOutput MFVec2f field named keyValue.

      Tooltip: Output values for linear interpolation, each corresponding to an input-fraction value in the key array.
      • Hint: identical adjacent entries in keyValue array have the effect of defining constant-value step functions. https://en.wikipedia.org/wiki/Step_function
      • Hint: number of keyValues must be an integer multiple of the number of keys!
      • Hint: keyValue/key integer multiple defines how many coordinates are sent in value_changed outputOnlys.
      Specified by:
      getKeyValue in interface PositionInterpolator2D
      Returns:
      value of keyValue field
    • setKeyValue

      public PositionInterpolator2D setKeyValue​(float[] newValue)
      Accessor method to assign 2-tuple float array to inputOutput MFVec2f field named keyValue.

      Tooltip: Output values for linear interpolation, each corresponding to an input-fraction value in the key array.
      • Hint: identical adjacent entries in keyValue array have the effect of defining constant-value step functions. https://en.wikipedia.org/wiki/Step_function
      • Hint: number of keyValues must be an integer multiple of the number of keys!
      • Hint: keyValue/key integer multiple defines how many coordinates are sent in value_changed outputOnlys.
      Specified by:
      setKeyValue in interface PositionInterpolator2D
      Parameters:
      newValue - is new value for the keyValue field.
      Returns:
      PositionInterpolator2D - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setKeyValue

      public PositionInterpolator2D setKeyValue​(MFVec2f newValue)
      Assign typed object value to MFVec2f keyValue field, similar to setKeyValue(float[]).
      Parameters:
      newValue - is new value for the keyValue field.
      Returns:
      PositionInterpolator2D - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • addKeyValue

      public PositionInterpolator2D addKeyValue​(SFVec2f newValue)
      Add singleton SFVec2f value to MFVec2f keyValue field.
      Parameters:
      newValue - is new value to add to the keyValue field.
      Returns:
      PositionInterpolator2D - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setKeyValue

      public PositionInterpolator2D setKeyValue​(double[] newArray)
      Utility method: double-precision set-array accessor for X3D floating-point type, similar to setKeyValue(float[]).
      Parameters:
      newArray - is new value for field
      Returns:
      PositionInterpolator2D - 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 PositionInterpolator2D
      Specified by:
      getMetadata in interface X3DChildNode
      Specified by:
      getMetadata in interface X3DInterpolatorNode
      Specified by:
      getMetadata in interface X3DNode
      Returns:
      value of metadata field
      See Also:
      Tooltip: [X3DMetadataObject] Information about this node can be contained in a MetadataBoolean, MetadataDouble, MetadataFloat, MetadataInteger, MetadataString or MetadataSet node. Hint: X3D Architecture 7.2.4 Metadata https://www.web3d.org/specifications/X3Dv4Draft/ISO-IEC19775-1v4-WD2/Part01/components/core.html#Metadata , X3D Scene Authoring Hints: Metadata Nodes
    • setMetadata

      public PositionInterpolator2D 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 PositionInterpolator2D
      Specified by:
      setMetadata in interface X3DChildNode
      Specified by:
      setMetadata in interface X3DInterpolatorNode
      Specified by:
      setMetadata in interface X3DNode
      Specified by:
      setMetadata in class X3DConcreteNode
      Parameters:
      newValue - is new value for the metadata field.
      Returns:
      PositionInterpolator2D - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:
      Tooltip: [X3DMetadataObject] Information about this node can be contained in a MetadataBoolean, MetadataDouble, MetadataFloat, MetadataInteger, MetadataString or MetadataSet node. Hint: X3D Architecture 7.2.4 Metadata https://www.web3d.org/specifications/X3Dv4Draft/ISO-IEC19775-1v4-WD2/Part01/components/core.html#Metadata , X3D Scene Authoring Hints: Metadata Nodes
    • clearMetadata

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

      public PositionInterpolator2D 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:
      PositionInterpolator2D - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:
      setMetadata( org.web3d.x3d.sai.Core.X3DMetadataObject)
    • hasMetadata

      public boolean hasMetadata()
      Indicate whether an object is available for inputOutput SFNode field metadata.
      Returns:
      whether a properly typed node or ProtoInstance or CommentsBlock is available.
      See Also:
      getMetadata(), getMetadataProtoInstance(), X3D Scene Authoring Hints: Metadata Nodes
    • getValue

      public float[] getValue()
      Provide array of 2-tuple float results from outputOnly SFVec2f field named value_changed.

      Tooltip: Linearly interpolated output value determined by current key time and corresponding keyValue pair.
      • Hint: X3D players might not send unchanging intermediate values, thus avoiding excessive superfluous events that have no effect.
      • Hint: keyValue/key integer multiple defines how many coordinates are sent in value_changed outputOnlys.
      • 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 PositionInterpolator2D
      Returns:
      value of value_changed field
    • getDEF

      public java.lang.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:
      X3D Scene Authoring Hints: Naming Conventions
    • setDEF

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

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

      public java.lang.String getUSE()
      Provide String value from inputOutput SFString field named USE.

      Tooltip: USE means reuse an already DEF-ed node ID, excluding all child nodes and all other attributes (except for containerField, which can have a different value).
      • Hint: USE references to previously defined DEF geometry (instead of duplicating nodes) can improve performance.
      • Warning: do NOT include any child nodes, a DEF attribute, or any other attribute values (except for containerField) when defining a USE attribute.
      • Warning: each USE value must match a corresponding DEF value that is defined earlier in the scene.
      Overrides:
      getUSE in class X3DConcreteNode
      Returns:
      value of USE field
      See Also:
      X3D Scene Authoring Hints: Naming Conventions
    • setUSE

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

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

      public java.lang.String getCssClass()
      Provide String value from inputOutput SFString field named class.

      Tooltip: The class attribute is a space-separated list of classes, reserved for use by Cascading Style Sheets (CSS) and XML stylesheets.
      Overrides:
      getCssClass in class X3DConcreteNode
      Returns:
      value of class field
      See Also:
      W3C Cascading Style Sheets
    • setCssClass

      public final PositionInterpolator2D setCssClass​(java.lang.String newValue)
      Accessor method to assign String value to inputOutput SFString field named class.

      Tooltip: The class attribute is a space-separated list of classes, reserved for use by Cascading Style Sheets (CSS) and XML stylesheets.
      Specified by:
      setCssClass in class X3DConcreteNode
      Parameters:
      newValue - is new value for the class field.
      Returns:
      PositionInterpolator2D - 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 PositionInterpolator2D 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:
      PositionInterpolator2D - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setUSE

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

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

      public PositionInterpolator2D 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:
      PositionInterpolator2D - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
    • addComments

      public PositionInterpolator2D addComments​(CommentsBlock newCommentsBlock)
      Add CommentsBlock to contained commentsList.
      Specified by:
      addComments in class X3DConcreteElement
      Parameters:
      newCommentsBlock - block of comments to add
      Returns:
      PositionInterpolator2D - 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:
      X3D.FILE_EXTENSION_X3D, X3D.FILE_EXTENSION_XML, X3D.toStringXML(), X3D.toFileXML(String), X3D.toFileX3D(String), X3D XML Encoding, X3D Compressed Binary Encoding: X3D Canonical Form, X3D Canonicalization (C14N) Tool
    • toStringClassicVRML

      public 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:
      X3D.FILE_EXTENSION_CLASSICVRML, X3D Resources: Virtual Reality Modeling Language (VRML) 97, Extensible 3D (X3D) encodings Part 2: Classic VRML encoding, Extensible 3D (X3D) encodings Part 2: Classic VRML encoding, Annex A: Grammar
    • toStringVRML97

      public 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:
      X3D.FILE_EXTENSION_VRML97, X3D Resources: Virtual Reality Modeling Language (VRML) 97, Virtual Reality Modeling Language (VRML) 97 specification, VRML 97 v2.1 Amendment
    • findElementByNameValue

      public X3DConcreteElement findElementByNameValue​(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 findAncestorScene() to check entire scene graph, or findAncestorX3D() to check entire model document.

      Warning: more than one element may be found that has the same name, this method does not handle that case.
      Specified by:
      findElementByNameValue in class X3DConcreteElement
      Parameters:
      nameValue - is value of the name field being searched for in this element and child elements(if any)
      Returns:
      object reference to found element, null otherwise
      See Also:
      findNodeByDEF(String), X3DConcreteElement.hasAncestorScene(), X3DConcreteElement.findAncestorX3D()
    • findElementByNameValue

      public X3DConcreteElement findElementByNameValue​(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 findAncestorScene() to check entire scene graph, or findAncestorX3D() to check entire model document.

      Warning: more than one element may be found that has the same name, this method does not handle that case.
      Specified by:
      findElementByNameValue in class X3DConcreteElement
      Parameters:
      nameValue - is value of the name field being searched for in this element and child elements(if any)
      elementName - identifies the element of interest (meta MetadataString ProtoDeclare CADassembly ProtoInstance HAnimHumanoid etc.)
      Returns:
      object reference to found element, null otherwise
      See Also:
      findNodeByDEF(String), X3DConcreteElement.hasAncestorScene(), X3DConcreteElement.findAncestorX3D()
    • hasElementByNameValue

      public boolean hasElementByNameValue​(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 findAncestorScene() to check entire scene graph, or findAncestorX3D() to check entire model document.

      Warning: more than one element may be found that has the same DEF, this method does not handle that case.
      Specified by:
      findNodeByDEF in class X3DConcreteElement
      Parameters:
      DEFvalue - is value of the name field being searched for in this element and child elements(if any)
      Returns:
      object reference to found node, null otherwise
      See Also:
      findElementByNameValue(String), X3DConcreteElement.hasAncestorScene(), X3DConcreteElement.findAncestorX3D()
    • hasNodeByDEF

      public boolean hasNodeByDEF​(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)