Class ColorDamper

All Implemented Interfaces:
X3DChildNode, X3DNode, ColorDamper, X3DDamperNode, X3DFollowerNode

public class ColorDamper extends X3DConcreteNode implements ColorDamper
ColorDamper generates a series of RGB color values that progressively change from initial value to destination value.

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: (X3D version 3.2 or later) [X3DDamperNode] ColorDamper generates a series of RGB color values that progressively change from initial value to destination value. Hint: ROUTE value_changed output events to one of a &lt;Material&gt; node's color fields, for example. Hint: X3D Scene Authoring Hints, Color <a href="https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#Color" target="_blank">https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#Color</a> *


Note that SFColor provides a variety of color constants.

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: ColorDamper.
      See Also:
    • COMPONENT

      public static final String COMPONENT
      String constant COMPONENT defines X3D component for the ColorDamper element: Followers
      See Also:
    • LEVEL

      public static final int LEVEL
      Integer constant LEVEL provides default X3D Followers component level for this element: 1
      See Also:
    • INITIALDESTINATION_DEFAULT_VALUE

      public static final float[] INITIALDESTINATION_DEFAULT_VALUE
      SFColor field named initialDestination has default value {0.8f,0.8f,0.8f} (Java syntax) or 0.8 0.8 0.8 (XML syntax).
    • INITIALVALUE_DEFAULT_VALUE

      public static final float[] INITIALVALUE_DEFAULT_VALUE
      SFColor field named initialValue has default value {0.8f,0.8f,0.8f} (Java syntax) or 0.8 0.8 0.8 (XML syntax).
    • 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).
    • ORDER_DEFAULT_VALUE

      public static final int ORDER_DEFAULT_VALUE
      SFInt32 field named order has default value 3 (Java syntax) or 3 (XML syntax).
      See Also:
    • TAU_DEFAULT_VALUE

      public static final double TAU_DEFAULT_VALUE
      SFTime field named tau has default value 0.3 (Java syntax) or 0.3 (XML syntax).
      See Also:
    • TOLERANCE_DEFAULT_VALUE

      public static final float TOLERANCE_DEFAULT_VALUE
      SFFloat field named tolerance has default value -1f (Java syntax) or -1 (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, 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_ISACTIVE

      public static final String fromField_ISACTIVE
      fromField ROUTE name for SFBool field named isActive.
      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_SET_DESTINATION

      public static final String toField_SET_DESTINATION
      toField ROUTE name for SFColor field named set_destination.
      See Also:
    • toField_SET_VALUE

      public static final String toField_SET_VALUE
      toField ROUTE name for SFColor field named set_value.
      See Also:
    • fromField_TAU

      public static final String fromField_TAU
      fromField ROUTE name for SFTime field named tau.
      See Also:
    • toField_TAU

      public static final String toField_TAU
      toField ROUTE name for SFTime field named tau.
      See Also:
    • fromField_TOLERANCE

      public static final String fromField_TOLERANCE
      fromField ROUTE name for SFFloat field named tolerance.
      See Also:
    • toField_TOLERANCE

      public static final String toField_TOLERANCE
      toField ROUTE name for SFFloat field named tolerance.
      See Also:
    • fromField_VALUE_CHANGED

      public static final String fromField_VALUE_CHANGED
      fromField ROUTE name for SFColor field named value_changed.
      See Also:
  • Constructor Details

    • ColorDamper

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

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

      public final String getComponent()
      Defines X3D component for the ColorDamper element: Followers
      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
    • getInitialDestination

      public float[] getInitialDestination()
      Provide array of 3-tuple float results using RGB values [0..1] using RGB values [0..1] from initializeOnly SFColor field named initialDestination.

      Tooltip: Initial destination value for this node. *
      Specified by:
      getInitialDestination in interface ColorDamper
      Returns:
      value of initialDestination field
    • setInitialDestination

      public ColorDamper setInitialDestination(float[] newValue)
      Accessor method to assign 3-tuple float array using RGB values [0..1] to initializeOnly SFColor field named initialDestination.

      Tooltip: Initial destination value for this node. *
      Specified by:
      setInitialDestination in interface ColorDamper
      Parameters:
      newValue - is new value for the initialDestination field.
      Returns:
      ColorDamper - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setInitialDestination

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

      public ColorDamper setInitialDestination(float red, float green, float blue)
      Assign values to SFColor initialDestination field, similar to setInitialDestination(float[]).
      Parameters:
      red - first component
      green - second component
      blue - third component
      Returns:
      ColorDamper - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setInitialDestination

      public ColorDamper setInitialDestination(double red, double green, double blue)
      Utility method: double-precision set-parameters accessor for X3D floating-point type, similar to setInitialDestination(float[]).
      Parameters:
      red - first component [0..1]
      green - second component [0..1]
      blue - third component [0..1]
      Returns:
      ColorDamper - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setInitialDestination

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

      public float[] getInitialValue()
      Provide array of 3-tuple float results using RGB values [0..1] using RGB values [0..1] from initializeOnly SFColor field named initialValue.

      Tooltip: Initial starting value for this node. *
      Specified by:
      getInitialValue in interface ColorDamper
      Returns:
      value of initialValue field
    • setInitialValue

      public ColorDamper setInitialValue(float[] newValue)
      Accessor method to assign 3-tuple float array using RGB values [0..1] to initializeOnly SFColor field named initialValue.

      Tooltip: Initial starting value for this node. *
      Specified by:
      setInitialValue in interface ColorDamper
      Parameters:
      newValue - is new value for the initialValue field.
      Returns:
      ColorDamper - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setInitialValue

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

      public ColorDamper setInitialValue(float red, float green, float blue)
      Assign values to SFColor initialValue field, similar to setInitialValue(float[]).
      Parameters:
      red - first component
      green - second component
      blue - third component
      Returns:
      ColorDamper - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setInitialValue

      public ColorDamper setInitialValue(double red, double green, double blue)
      Utility method: double-precision set-parameters accessor for X3D floating-point type, similar to setInitialValue(float[]).
      Parameters:
      red - first component [0..1]
      green - second component [0..1]
      blue - third component [0..1]
      Returns:
      ColorDamper - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setInitialValue

      public ColorDamper setInitialValue(double[] newArray)
      Utility method: double-precision set-parameters accessor for X3D floating-point type, similar to setInitialValue(float[]).
      Parameters:
      newArray - is new value for field
      Returns:
      ColorDamper - 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 ColorDamper 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:
      ColorDamper - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:
    • clearIS

      public ColorDamper clearIS()
      Utility method to clear SFNode value of IS field.
      Returns:
      ColorDamper - 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 follower-node computation 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 ColorDamper
      Specified by:
      getIsActive in interface X3DDamperNode
      Specified by:
      getIsActive in interface X3DFollowerNode
      Returns:
      value of isActive 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 ColorDamper
      Specified by:
      getMetadata in interface X3DChildNode
      Specified by:
      getMetadata in interface X3DDamperNode
      Specified by:
      getMetadata in interface X3DFollowerNode
      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 <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 ColorDamper 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 ColorDamper
      Specified by:
      setMetadata in interface X3DChildNode
      Specified by:
      setMetadata in interface X3DDamperNode
      Specified by:
      setMetadata in interface X3DFollowerNode
      Specified by:
      setMetadata in interface X3DNode
      Specified by:
      setMetadata in class X3DConcreteNode
      Parameters:
      newValue - is new value for the metadata field.
      Returns:
      ColorDamper - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:
    • clearMetadata

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

      public ColorDamper 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:
      ColorDamper - 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:
    • getOrder

      public int getOrder()
      Provide int value within allowed range of [0,5] from initializeOnly SFInt32 field named order.

      Tooltip: [0,5] order defines the number of internal filters (larger means smoother response, longer delay). *
      Specified by:
      getOrder in interface ColorDamper
      Specified by:
      getOrder in interface X3DDamperNode
      Returns:
      value of order field
    • setOrder

      public ColorDamper setOrder(int newValue)
      Accessor method to assign int value to initializeOnly SFInt32 field named order.

      Tooltip: [0,5] order defines the number of internal filters (larger means smoother response, longer delay). *
      Specified by:
      setOrder in interface ColorDamper
      Specified by:
      setOrder in interface X3DDamperNode
      Parameters:
      newValue - is new value for the order field.
      Returns:
      ColorDamper - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setOrder

      public ColorDamper setOrder(SFInt32 newValue)
      Assign typed object value to SFInt32 order field, similar to setOrder(int).
      Parameters:
      newValue - is new value for the order field.
      Returns:
      ColorDamper - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getTau

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

      Tooltip: [0,+infinity) tau is the exponential-decay time constant for filter response in seconds. *
      Specified by:
      getTau in interface ColorDamper
      Specified by:
      getTau in interface X3DDamperNode
      Returns:
      value of tau field
    • setTau

      public ColorDamper setTau(double newValue)
      Accessor method to assign double value in seconds to inputOutput SFTime field named tau.

      Tooltip: [0,+infinity) tau is the exponential-decay time constant for filter response in seconds. *
      Specified by:
      setTau in interface ColorDamper
      Specified by:
      setTau in interface X3DDamperNode
      Parameters:
      newValue - is new value for the tau field.
      Returns:
      ColorDamper - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setTau

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

      public float getTolerance()
      Provide float value from inputOutput SFFloat field named tolerance.

      Tooltip: [0,+infinity) or -1. Absolute value for satisfactory completion proximity (-1 lets browser choose). *
      Specified by:
      getTolerance in interface ColorDamper
      Specified by:
      getTolerance in interface X3DDamperNode
      Returns:
      value of tolerance field
    • setTolerance

      public ColorDamper setTolerance(float newValue)
      Accessor method to assign float value to inputOutput SFFloat field named tolerance.

      Tooltip: [0,+infinity) or -1. Absolute value for satisfactory completion proximity (-1 lets browser choose). *
      Specified by:
      setTolerance in interface ColorDamper
      Specified by:
      setTolerance in interface X3DDamperNode
      Parameters:
      newValue - is new value for the tolerance field.
      Returns:
      ColorDamper - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setTolerance

      public ColorDamper setTolerance(SFFloat newValue)
      Assign typed object value to SFFloat tolerance field, similar to setTolerance(float).
      Parameters:
      newValue - is new value for the tolerance field.
      Returns:
      ColorDamper - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setTolerance

      public ColorDamper setTolerance(double newValue)
      Utility method: double-precision set-parameter accessor for X3D floating-point type, similar to setTolerance(float).
      Parameters:
      newValue - is new value for field
      Returns:
      ColorDamper - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getValue

      public float[] getValue()
      Provide array of 3-tuple float results using RGB values [0..1] using RGB values [0..1] from outputOnly SFColor field named value_changed.

      Tooltip: Computed output value that approaches within tolerance of destination value, as determined by elapsed time, order and tau. 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 ColorDamper
      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 ColorDamper 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:
      ColorDamper - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setDEF

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

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

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

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

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

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

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

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

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