Class WaveShaper

java.lang.Object
All Implemented Interfaces:
X3DChildNode, X3DNode, WaveShaper, X3DSoundProcessingNode, X3DTimeDependentNode

public class WaveShaper
extends X3DConcreteNode
implements WaveShaper
WaveShaper node represents a nonlinear distorter that applies a wave-shaping distortion curve to the signal.

X3D node tooltip: (X3D version 4.0 draft) [X3DSoundProcessingNode] WaveShaper node represents a nonlinear distorter that applies a wave-shaping distortion curve to the signal. Non-linear waveshaping distortion is commonly used for both subtle non-linear warming, or more obvious distortion effects. Arbitrary non-linear shaping curves may be specified.
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: WaveShaper, X3D Tooltips: WaveShaper, X3D Scene Authoring Hints
  • Field Summary

    Fields 
    Modifier and Type Field Description
    static java.lang.String CHANNELCOUNTMODE_CLAMPED_MAX
    SFString field named channelCountMode with X3DUOM simpleType channelCountModeChoices and with X3DUOM baseType SFString can equal this value "clamped-max" (Java syntax) or clamped-max (XML syntax).
    static java.lang.String CHANNELCOUNTMODE_DEFAULT_VALUE
    SFString field named channelCountMode has default value "max" (Java syntax) or max (XML syntax).
    static java.lang.String CHANNELCOUNTMODE_EXPLICIT
    SFString field named channelCountMode with X3DUOM simpleType channelCountModeChoices and with X3DUOM baseType SFString can equal this value "explicit" (Java syntax) or explicit (XML syntax).
    static java.lang.String CHANNELCOUNTMODE_MAX
    SFString field named channelCountMode with X3DUOM simpleType channelCountModeChoices and with X3DUOM baseType SFString can equal this value "max" (Java syntax) or max (XML syntax).
    static java.lang.String CHANNELINTERPRETATION_DEFAULT_VALUE
    SFString field named channelInterpretation has default value "speakers" (Java syntax) or speakers (XML syntax).
    static java.lang.String CHANNELINTERPRETATION_DISCRETE
    SFString field named channelInterpretation with X3DUOM simpleType channelInterpretationChoices and with X3DUOM baseType SFString can equal this value "discrete" (Java syntax) or discrete (XML syntax).
    static java.lang.String CHANNELINTERPRETATION_SPEAKERS
    SFString field named channelInterpretation with X3DUOM simpleType channelInterpretationChoices and with X3DUOM baseType SFString can equal this value "speakers" (Java syntax) or speakers (XML syntax).
    static java.lang.String COMPONENT
    String constant COMPONENT defines X3D component for the WaveShaper element: Sound
    static java.lang.String containerField_DEFAULT_VALUE
    containerField describes typical field relationship of a node to its parent.
    static java.lang.String DESCRIPTION_DEFAULT_VALUE
    SFString field named description has default value equal to an empty string.
    static boolean ENABLED_DEFAULT_VALUE
    SFBool field named enabled has default value true (Java syntax) or true (XML syntax).
    static java.lang.String fromField_CHANNELCOUNT
    fromField ROUTE name for SFInt32 field named channelCount.
    static java.lang.String fromField_CHANNELCOUNTMODE
    fromField ROUTE name for SFString field named channelCountMode.
    static java.lang.String fromField_CHANNELINTERPRETATION
    fromField ROUTE name for SFString field named channelInterpretation.
    static java.lang.String fromField_DESCRIPTION
    fromField ROUTE name for SFString field named description.
    static java.lang.String fromField_ELAPSEDTIME
    fromField ROUTE name for SFTime field named elapsedTime.
    static java.lang.String fromField_ENABLED
    fromField ROUTE name for SFBool field named enabled.
    static java.lang.String fromField_GAIN
    fromField ROUTE name for SFFloat field named gain.
    static java.lang.String fromField_IS
    fromField ROUTE name for SFNode field named IS.
    static java.lang.String fromField_ISACTIVE
    fromField ROUTE name for SFBool field named isActive.
    static java.lang.String fromField_ISPAUSED
    fromField ROUTE name for SFBool field named isPaused.
    static java.lang.String fromField_METADATA
    fromField ROUTE name for SFNode field named metadata.
    static java.lang.String fromField_OVERSAMPLE
    fromField ROUTE name for SFString field named oversample.
    static java.lang.String fromField_PAUSETIME
    fromField ROUTE name for SFTime field named pauseTime.
    static java.lang.String fromField_RESUMETIME
    fromField ROUTE name for SFTime field named resumeTime.
    static java.lang.String fromField_STARTTIME
    fromField ROUTE name for SFTime field named startTime.
    static java.lang.String fromField_STOPTIME
    fromField ROUTE name for SFTime field named stopTime.
    static java.lang.String fromField_TAILTIME
    fromField ROUTE name for SFTime field named tailTime.
    static float GAIN_DEFAULT_VALUE
    SFFloat field named gain has default value 1f (Java syntax) or 1 (XML syntax).
    static IS IS_DEFAULT_VALUE
    SFNode field named IS has default value null (Java syntax) or NULL (XML syntax).
    static int LEVEL
    Integer constant LEVEL provides default X3D Sound component level for this element: 2
    static X3DMetadataObject METADATA_DEFAULT_VALUE
    SFNode field named metadata has default value null (Java syntax) or NULL (XML syntax).
    static java.lang.String NAME
    String constant NAME provides name of this element: WaveShaper.
    static java.lang.String OVERSAMPLE_2X
    SFString field named oversample with X3DUOM simpleType waveShaperOversampleChoices and with X3DUOM baseType SFString can equal this value "2x" (Java syntax) or 2x (XML syntax).
    static java.lang.String OVERSAMPLE_4X
    SFString field named oversample with X3DUOM simpleType waveShaperOversampleChoices and with X3DUOM baseType SFString can equal this value "4x" (Java syntax) or 4x (XML syntax).
    static java.lang.String OVERSAMPLE_DEFAULT_VALUE
    SFString field named oversample has default value "none" (Java syntax) or none (XML syntax).
    static java.lang.String OVERSAMPLE_NONE
    SFString field named oversample with X3DUOM simpleType waveShaperOversampleChoices and with X3DUOM baseType SFString can equal this value "none" (Java syntax) or none (XML syntax).
    static double PAUSETIME_DEFAULT_VALUE
    SFTime field named pauseTime has default value 0 (Java syntax) or 0 (XML syntax).
    static double RESUMETIME_DEFAULT_VALUE
    SFTime field named resumeTime has default value 0 (Java syntax) or 0 (XML syntax).
    static double STARTTIME_DEFAULT_VALUE
    SFTime field named startTime has default value 0 (Java syntax) or 0 (XML syntax).
    static double STOPTIME_DEFAULT_VALUE
    SFTime field named stopTime has default value 0 (Java syntax) or 0 (XML syntax).
    static double TAILTIME_DEFAULT_VALUE
    SFTime field named tailTime has default value 0 (Java syntax) or 0 (XML syntax).
    static java.lang.String toField_CHANNELCOUNTMODE
    toField ROUTE name for SFString field named channelCountMode.
    static java.lang.String toField_CHANNELINTERPRETATION
    toField ROUTE name for SFString field named channelInterpretation.
    static java.lang.String toField_DESCRIPTION
    toField ROUTE name for SFString field named description.
    static java.lang.String toField_ENABLED
    toField ROUTE name for SFBool field named enabled.
    static java.lang.String toField_GAIN
    toField ROUTE name for SFFloat field named gain.
    static java.lang.String toField_METADATA
    toField ROUTE name for SFNode field named metadata.
    static java.lang.String toField_OVERSAMPLE
    toField ROUTE name for SFString field named oversample.
    static java.lang.String toField_PAUSETIME
    toField ROUTE name for SFTime field named pauseTime.
    static java.lang.String toField_RESUMETIME
    toField ROUTE name for SFTime field named resumeTime.
    static java.lang.String toField_STARTTIME
    toField ROUTE name for SFTime field named startTime.
    static java.lang.String toField_STOPTIME
    toField ROUTE name for SFTime field named stopTime.
    static java.lang.String toField_TAILTIME
    toField ROUTE name for SFTime field named tailTime.

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

    validationResult
  • Constructor Summary

    Constructors 
    Constructor Description
    WaveShaper()
    Constructor for WaveShaper to initialize member variables with default values.
    WaveShaper​(java.lang.String DEFlabel)
    Utility constructor that assigns DEF label after initializing member variables with default values.
  • Method Summary

    Modifier and Type Method Description
    WaveShaper addComments​(java.lang.String newComment)
    Add comment as String to contained commentsList.
    WaveShaper addComments​(java.lang.String[] newComments)
    Add comments as String[] array to contained commentsList.
    WaveShaper addComments​(CommentsBlock newCommentsBlock)
    Add CommentsBlock to contained commentsList.
    WaveShaper clearIS()
    Utility method to clear SFNode value of IS field.
    WaveShaper clearMetadata()
    Utility method to clear SFNode value of metadata field.
    X3DConcreteElement findElementByNameValue​(java.lang.String nameValue)
    Recursive method to provide object reference to node or statement by name attribute, if found as part of this element or in a contained element.
    X3DConcreteElement findElementByNameValue​(java.lang.String nameValue, java.lang.String elementName)
    Recursive method to provide object reference to node or statement by name attribute, if found as part of this element or in a contained element.
    X3DConcreteNode findNodeByDEF​(java.lang.String DEFvalue)
    Recursive method to provide object reference to node by DEF, if found as this node or in a contained node.
    java.lang.String getAccessType​(java.lang.String fieldName)
    Indicate accessType corresponding to given fieldName.
    int getChannelCount()
    Provide int value from outputOnly SFInt32 field named channelCount.
    java.lang.String getChannelCountMode()
    Provide String enumeration value (baseType SFString) ["max" | "clamped-max" | "explicit"] from inputOutput SFString field named channelCountMode.
    java.lang.String getChannelInterpretation()
    Provide String enumeration value (baseType SFString) ["speakers" | "discrete"] from inputOutput SFString field named channelInterpretation.
    java.lang.String getComponent()
    Defines X3D component for the WaveShaper element: Sound
    int getComponentLevel()
    Provides default X3D component level for this element: 2
    java.lang.String getContainerFieldDefault()
    containerField describes typical field relationship of a node to its parent.
    java.lang.String getCssClass()
    Provide String value from inputOutput SFString field named class.
    java.lang.String getDEF()
    Provide String value from inputOutput SFString field named DEF.
    java.lang.String getDescription()
    Provide String value from inputOutput SFString field named description.
    double getElapsedTime()
    Provide double value in seconds within allowed range of [0,infinity) from outputOnly SFTime field named elapsedTime.
    java.lang.String getElementName()
    Provides name of this element: WaveShaper
    boolean getEnabled()
    Provide boolean value from inputOutput SFBool field named enabled.
    java.lang.String getFieldType​(java.lang.String fieldName)
    Indicate type corresponding to given fieldName.
    float getGain()
    Provide float value from inputOutput SFFloat field named gain.
    IS getIS()
    Provide IS instance (using a properly typed node) from inputOutput SFNode field IS.
    boolean getIsActive()
    Provide boolean value from outputOnly SFBool field named isActive.
    boolean getIsPaused()
    Provide boolean value from outputOnly SFBool field named isPaused.
    X3DMetadataObject getMetadata()
    Provide org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
    java.lang.String getOversample()
    Provide String enumeration value (baseType SFString) ["none" | "2x" | "4x"] from inputOutput SFString field named oversample.
    double getPauseTime()
    Provide double value in seconds from inputOutput SFTime field named pauseTime.
    double getResumeTime()
    Provide double value in seconds from inputOutput SFTime field named resumeTime.
    double getStartTime()
    Provide double value in seconds from inputOutput SFTime field named startTime.
    double getStopTime()
    Provide double value in seconds from inputOutput SFTime field named stopTime.
    double getTailTime()
    Provide double value in seconds within allowed range of [0,infinity) from inputOutput SFTime field named tailTime.
    java.lang.String getUSE()
    Provide String value from inputOutput SFString field named USE.
    boolean hasElementByNameValue​(java.lang.String nameValue, java.lang.String elementName)
    Recursive method to determine whether node or statement with given name attribute is found, meaning both objects are attached to same scene graph.
    boolean hasIS()
    Indicate whether an object is available for inputOutput SFNode field IS.
    boolean hasMetadata()
    Indicate whether an object is available for inputOutput SFNode field metadata.
    boolean hasNodeByDEF​(java.lang.String DEFvalue)
    Recursive method to determine whether node with DEFvalue is found, meaning both objects are attached to same scene graph.
    void initialize()
    Initialize all member variables to default values.
    WaveShaper setChannelCountMode​(java.lang.String newValue)
    Accessor method to assign String enumeration value ("max" | "clamped-max" | "explicit") to inputOutput SFString field named channelCountMode.
    WaveShaper setChannelCountMode​(SFString newValue)
    Assign typed object value to SFString channelCountMode field, similar to setChannelCountMode(String).
    WaveShaper setChannelInterpretation​(java.lang.String newValue)
    Accessor method to assign String enumeration value ("speakers" | "discrete") to inputOutput SFString field named channelInterpretation.
    WaveShaper setChannelInterpretation​(SFString newValue)
    Assign typed object value to SFString channelInterpretation field, similar to setChannelInterpretation(String).
    WaveShaper setCssClass​(java.lang.String newValue)
    Accessor method to assign String value to inputOutput SFString field named class.
    WaveShaper setCssClass​(SFString newValue)
    Assign typed object value to SFString cssClass field, similar to setCssClass(String).
    WaveShaper setDEF​(java.lang.String newValue)
    Accessor method to assign String value to inputOutput SFString field named DEF.
    WaveShaper setDEF​(SFString newValue)
    Assign typed object value to SFString DEF field, similar to setDEF(String).
    WaveShaper setDescription​(java.lang.String newValue)
    Accessor method to assign String value to inputOutput SFString field named description.
    WaveShaper setDescription​(SFString newValue)
    Assign typed object value to SFString description field, similar to setDescription(String).
    WaveShaper setEnabled​(boolean newValue)
    Accessor method to assign boolean value to inputOutput SFBool field named enabled.
    WaveShaper setEnabled​(SFBool newValue)
    Assign typed object value to SFBool enabled field, similar to setEnabled(boolean).
    WaveShaper setGain​(double newValue)
    Utility method: double-precision set-parameter accessor for X3D floating-point type, similar to setGain(float).
    WaveShaper setGain​(float newValue)
    Accessor method to assign float value to inputOutput SFFloat field named gain.
    WaveShaper setGain​(SFFloat newValue)
    Assign typed object value to SFFloat gain field, similar to setGain(float).
    WaveShaper setIS​(IS newValue)
    Accessor method to assign IS instance (using a properly typed node) to inputOutput SFNode field IS.
    WaveShaper setMetadata​(ProtoInstance newValue)
    Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field metadata.
    WaveShaper setMetadata​(X3DMetadataObject newValue)
    Accessor method to assign org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
    WaveShaper setOversample​(java.lang.String newValue)
    Accessor method to assign String enumeration value ("none" | "2x" | "4x") to inputOutput SFString field named oversample.
    WaveShaper setOversample​(SFString newValue)
    Assign typed object value to SFString oversample field, similar to setOversample(String).
    WaveShaper setPauseTime​(double newValue)
    Accessor method to assign double value in seconds to inputOutput SFTime field named pauseTime.
    WaveShaper setPauseTime​(SFTime newValue)
    Assign typed object value to SFTime pauseTime field, similar to setPauseTime(double).
    WaveShaper setResumeTime​(double newValue)
    Accessor method to assign double value in seconds to inputOutput SFTime field named resumeTime.
    WaveShaper setResumeTime​(SFTime newValue)
    Assign typed object value to SFTime resumeTime field, similar to setResumeTime(double).
    WaveShaper setStartTime​(double newValue)
    Accessor method to assign double value in seconds to inputOutput SFTime field named startTime.
    WaveShaper setStartTime​(SFTime newValue)
    Assign typed object value to SFTime startTime field, similar to setStartTime(double).
    WaveShaper setStopTime​(double newValue)
    Accessor method to assign double value in seconds to inputOutput SFTime field named stopTime.
    WaveShaper setStopTime​(SFTime newValue)
    Assign typed object value to SFTime stopTime field, similar to setStopTime(double).
    WaveShaper setTailTime​(double newValue)
    Accessor method to assign double value in seconds to inputOutput SFTime field named tailTime.
    WaveShaper setTailTime​(SFTime newValue)
    Assign typed object value to SFTime tailTime field, similar to setTailTime(double).
    WaveShaper setUSE​(java.lang.String newValue)
    Accessor method to assign String value to inputOutput SFString field named USE.
    WaveShaper setUSE​(SFString newValue)
    Assign typed object value to SFString USE field, similar to setUSE(String).
    WaveShaper setUSE​(WaveShaper DEFnode)
    Assign a USE reference to another DEF node of same node type, similar to setUSE(String).
    java.lang.String toStringClassicVRML​(int indentLevel)
    Recursive method to provide ClassicVRML string serialization.
    java.lang.String toStringVRML97​(int indentLevel)
    Recursive method to provide VRML97 string serialization.
    java.lang.String toStringX3D​(int indentLevel)
    Recursive method to provide X3D string serialization of this model subgraph, utilizing XML encoding and conforming to X3D Canonical Form.
    java.lang.String validate()
    Recursive method to validate this element plus all contained nodes and statements, using both datatype-specification value checks and regular expression (regex) checking of corresponding string values.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
  • Field Details

  • Constructor Details

    • WaveShaper

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

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

      public final java.lang.String getComponent()
      Defines X3D component for the WaveShaper element: Sound
      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: 2
      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
    • getChannelCount

      public int getChannelCount()
      Provide int value from outputOnly SFInt32 field named channelCount.

      Tooltip: [0,+infinity) channelCount reports number of channels provided by input nodes.
      Specified by:
      getChannelCount in interface WaveShaper
      Specified by:
      getChannelCount in interface X3DSoundProcessingNode
      Returns:
      value of channelCount field
    • getChannelCountMode

      public java.lang.String getChannelCountMode()
      Provide String enumeration value (baseType SFString) ["max" | "clamped-max" | "explicit"] from inputOutput SFString field named channelCountMode.

      Tooltip: channelCountMode determines how individual channels are counted when up-mixing and down-mixing connections to any inputs.

      Available enumeration values for string comparison: MAX, CLAMPED_MAX, EXPLICIT.
      Specified by:
      getChannelCountMode in interface WaveShaper
      Specified by:
      getChannelCountMode in interface X3DSoundProcessingNode
      Returns:
      value of channelCountMode field
    • setChannelCountMode

      public WaveShaper setChannelCountMode​(java.lang.String newValue)
      Accessor method to assign String enumeration value ("max" | "clamped-max" | "explicit") to inputOutput SFString field named channelCountMode.

      Warning: authors can only choose from a strict list of enumeration values (MAX, CLAMPED_MAX, EXPLICIT).

      Tooltip: channelCountMode determines how individual channels are counted when up-mixing and down-mixing connections to any inputs.
      Specified by:
      setChannelCountMode in interface WaveShaper
      Specified by:
      setChannelCountMode in interface X3DSoundProcessingNode
      Parameters:
      newValue - is new value for the channelCountMode field.
      Returns:
      WaveShaper - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setChannelCountMode

      public WaveShaper setChannelCountMode​(SFString newValue)
      Assign typed object value to SFString channelCountMode field, similar to setChannelCountMode(String).
      Parameters:
      newValue - is new value for the channelCountMode field.
      Returns:
      WaveShaper - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getChannelInterpretation

      public java.lang.String getChannelInterpretation()
      Provide String enumeration value (baseType SFString) ["speakers" | "discrete"] from inputOutput SFString field named channelInterpretation.

      Tooltip: channelInterpretation determines how individual channels are treated when up-mixing and down-mixing connections to any inputs.

      Available enumeration values for string comparison: SPEAKERS, DISCRETE.
      Specified by:
      getChannelInterpretation in interface WaveShaper
      Specified by:
      getChannelInterpretation in interface X3DSoundProcessingNode
      Returns:
      value of channelInterpretation field
    • setChannelInterpretation

      public WaveShaper setChannelInterpretation​(java.lang.String newValue)
      Accessor method to assign String enumeration value ("speakers" | "discrete") to inputOutput SFString field named channelInterpretation.

      Warning: authors can only choose from a strict list of enumeration values (SPEAKERS, DISCRETE).

      Tooltip: channelInterpretation determines how individual channels are treated when up-mixing and down-mixing connections to any inputs.
      Specified by:
      setChannelInterpretation in interface WaveShaper
      Specified by:
      setChannelInterpretation in interface X3DSoundProcessingNode
      Parameters:
      newValue - is new value for the channelInterpretation field.
      Returns:
      WaveShaper - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setChannelInterpretation

      public WaveShaper setChannelInterpretation​(SFString newValue)
      Assign typed object value to SFString channelInterpretation field, similar to setChannelInterpretation(String).
      Parameters:
      newValue - is new value for the channelInterpretation field.
      Returns:
      WaveShaper - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getDescription

      public java.lang.String getDescription()
      Provide String value from inputOutput SFString field named description.

      Tooltip: Author-provided prose that describes intended purpose of the url asset.
      • Hint: many XML tools substitute XML character references for special characters automatically if needed within an attribute value (such as & for & ampersand character, or " for " quotation-mark character).
      Specified by:
      getDescription in interface WaveShaper
      Specified by:
      getDescription in interface X3DSoundProcessingNode
      Specified by:
      getDescription in interface X3DTimeDependentNode
      Returns:
      value of description field
    • setDescription

      public WaveShaper setDescription​(java.lang.String newValue)
      Accessor method to assign String value to inputOutput SFString field named description.

      Tooltip: Author-provided prose that describes intended purpose of the url asset.
      • Hint: many XML tools substitute XML character references for special characters automatically if needed within an attribute value (such as & for & ampersand character, or " for " quotation-mark character).
      Specified by:
      setDescription in interface WaveShaper
      Specified by:
      setDescription in interface X3DSoundProcessingNode
      Specified by:
      setDescription in interface X3DTimeDependentNode
      Parameters:
      newValue - is new value for the description field.
      Returns:
      WaveShaper - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setDescription

      public WaveShaper setDescription​(SFString newValue)
      Assign typed object value to SFString description field, similar to setDescription(String).
      Parameters:
      newValue - is new value for the description field.
      Returns:
      WaveShaper - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getElapsedTime

      public double getElapsedTime()
      Provide double value in seconds within allowed range of [0,infinity) from outputOnly SFTime field named elapsedTime.

      Tooltip: [0,+infinity) Current elapsed time since AudioClip activated/running, cumulative in seconds, and not counting any paused time.
      • Warning: it is an error to define this transient outputOnly field in an X3D file, instead only use it a source for ROUTE events.
      • Hint: elapsedTime is a nonnegative SFTime duration interval, not an absolute clock time.
      Specified by:
      getElapsedTime in interface WaveShaper
      Specified by:
      getElapsedTime in interface X3DSoundProcessingNode
      Specified by:
      getElapsedTime in interface X3DTimeDependentNode
      Returns:
      value of elapsedTime field
    • getEnabled

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

      Tooltip: Enables/disables node operation. *
      Specified by:
      getEnabled in interface WaveShaper
      Specified by:
      getEnabled in interface X3DSoundProcessingNode
      Returns:
      value of enabled field
    • setEnabled

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

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

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

      public float getGain()
      Provide float value from inputOutput SFFloat field named gain.

      Tooltip: (-infinity,+infinity) The gain field is a factor that represents the amount of linear amplification to apply to the output of the node.
      • Warning: Decibel values shall not be used.
      • Hint: Negative gain factors negate the input signal.
      Specified by:
      getGain in interface WaveShaper
      Specified by:
      getGain in interface X3DSoundProcessingNode
      Returns:
      value of gain field
    • setGain

      public WaveShaper setGain​(float newValue)
      Accessor method to assign float value to inputOutput SFFloat field named gain.

      Tooltip: (-infinity,+infinity) The gain field is a factor that represents the amount of linear amplification to apply to the output of the node.
      • Warning: Decibel values shall not be used.
      • Hint: Negative gain factors negate the input signal.
      Specified by:
      setGain in interface WaveShaper
      Specified by:
      setGain in interface X3DSoundProcessingNode
      Parameters:
      newValue - is new value for the gain field.
      Returns:
      WaveShaper - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setGain

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

      public WaveShaper setGain​(double newValue)
      Utility method: double-precision set-parameter accessor for X3D floating-point type, similar to setGain(float).
      Parameters:
      newValue - is new value for field
      Returns:
      WaveShaper - 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:
      X3D Tooltips: IS, X3D Tooltips: connect
    • setIS

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

      public boolean getIsActive()
      Provide boolean value from outputOnly SFBool field named isActive.

      Tooltip: isActive true/false events are sent when playback 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 WaveShaper
      Specified by:
      getIsActive in interface X3DSoundProcessingNode
      Specified by:
      getIsActive in interface X3DTimeDependentNode
      Returns:
      value of isActive field
    • getIsPaused

      public boolean getIsPaused()
      Provide boolean value from outputOnly SFBool field named isPaused.

      Tooltip: isPaused true/false events are sent when AudioClip is paused/resumed.
      • 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:
      getIsPaused in interface WaveShaper
      Specified by:
      getIsPaused in interface X3DSoundProcessingNode
      Specified by:
      getIsPaused in interface X3DTimeDependentNode
      Returns:
      value of isPaused 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 WaveShaper
      Specified by:
      getMetadata in interface X3DChildNode
      Specified by:
      getMetadata in interface X3DNode
      Specified by:
      getMetadata in interface X3DSoundProcessingNode
      Specified by:
      getMetadata in interface X3DTimeDependentNode
      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 WaveShaper 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 WaveShaper
      Specified by:
      setMetadata in interface X3DChildNode
      Specified by:
      setMetadata in interface X3DNode
      Specified by:
      setMetadata in interface X3DSoundProcessingNode
      Specified by:
      setMetadata in interface X3DTimeDependentNode
      Specified by:
      setMetadata in class X3DConcreteNode
      Parameters:
      newValue - is new value for the metadata field.
      Returns:
      WaveShaper - 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 WaveShaper clearMetadata()
      Utility method to clear SFNode value of metadata field.
      Returns:
      WaveShaper - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
    • setMetadata

      public WaveShaper 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:
      WaveShaper - 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
    • getOversample

      public java.lang.String getOversample()
      Provide String enumeration value (baseType SFString) ["none" | "2x" | "4x"] from inputOutput SFString field named oversample.

      Tooltip: The oversample field is specifies what type of oversampling (if any) should be used when applying the shaping curve. Allowed values follow. Note that for some applications, avoiding oversampling can produce a precise shaping curve.

      Available enumeration values for string comparison: NONE, 2X, 4X.
      Specified by:
      getOversample in interface WaveShaper
      Returns:
      value of oversample field
    • setOversample

      public WaveShaper setOversample​(java.lang.String newValue)
      Accessor method to assign String enumeration value ("none" | "2x" | "4x") to inputOutput SFString field named oversample.

      Warning: authors can only choose from a strict list of enumeration values (NONE, 2X, 4X).

      Tooltip: The oversample field is specifies what type of oversampling (if any) should be used when applying the shaping curve. Allowed values follow. Note that for some applications, avoiding oversampling can produce a precise shaping curve.
      Specified by:
      setOversample in interface WaveShaper
      Parameters:
      newValue - is new value for the oversample field.
      Returns:
      WaveShaper - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setOversample

      public WaveShaper setOversample​(SFString newValue)
      Assign typed object value to SFString oversample field, similar to setOversample(String).
      Parameters:
      newValue - is new value for the oversample field.
      Returns:
      WaveShaper - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getPauseTime

      public double getPauseTime()
      Provide double value in seconds from inputOutput SFTime field named pauseTime.

      Tooltip: When time now >= pauseTime, isPaused becomes true and AudioClip becomes paused. Absolute time: number of seconds since January 1, 1970, 00:00:00 GMT.
      • Hint: ROUTE a time value matching system clock to this field, such as output event from TouchSensor touchTime or TimeTrigger triggerTime.
      Specified by:
      getPauseTime in interface WaveShaper
      Specified by:
      getPauseTime in interface X3DSoundProcessingNode
      Specified by:
      getPauseTime in interface X3DTimeDependentNode
      Returns:
      value of pauseTime field
    • setPauseTime

      public WaveShaper setPauseTime​(double newValue)
      Accessor method to assign double value in seconds to inputOutput SFTime field named pauseTime.

      Tooltip: When time now >= pauseTime, isPaused becomes true and AudioClip becomes paused. Absolute time: number of seconds since January 1, 1970, 00:00:00 GMT.
      • Hint: ROUTE a time value matching system clock to this field, such as output event from TouchSensor touchTime or TimeTrigger triggerTime.
      Specified by:
      setPauseTime in interface WaveShaper
      Specified by:
      setPauseTime in interface X3DSoundProcessingNode
      Specified by:
      setPauseTime in interface X3DTimeDependentNode
      Parameters:
      newValue - is new value for the pauseTime field.
      Returns:
      WaveShaper - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setPauseTime

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

      public double getResumeTime()
      Provide double value in seconds from inputOutput SFTime field named resumeTime.

      Tooltip: When resumeTime becomes <= time now, isPaused becomes false and AudioClip becomes active. Absolute time: number of seconds since January 1, 1970, 00:00:00 GMT.
      • Hint: ROUTE a time value matching system clock to this field, such as output event from TouchSensor touchTime or TimeTrigger triggerTime.
      Specified by:
      getResumeTime in interface WaveShaper
      Specified by:
      getResumeTime in interface X3DSoundProcessingNode
      Specified by:
      getResumeTime in interface X3DTimeDependentNode
      Returns:
      value of resumeTime field
    • setResumeTime

      public WaveShaper setResumeTime​(double newValue)
      Accessor method to assign double value in seconds to inputOutput SFTime field named resumeTime.

      Tooltip: When resumeTime becomes <= time now, isPaused becomes false and AudioClip becomes active. Absolute time: number of seconds since January 1, 1970, 00:00:00 GMT.
      • Hint: ROUTE a time value matching system clock to this field, such as output event from TouchSensor touchTime or TimeTrigger triggerTime.
      Specified by:
      setResumeTime in interface WaveShaper
      Specified by:
      setResumeTime in interface X3DSoundProcessingNode
      Specified by:
      setResumeTime in interface X3DTimeDependentNode
      Parameters:
      newValue - is new value for the resumeTime field.
      Returns:
      WaveShaper - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setResumeTime

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

      public double getStartTime()
      Provide double value in seconds from inputOutput SFTime field named startTime.

      Tooltip: Absolute time: number of seconds since January 1, 1970, 00:00:00 GMT.
      • Hint: ROUTE a time value matching system clock to this field, such as output event from TouchSensor touchTime or TimeTrigger triggerTime.
      Specified by:
      getStartTime in interface WaveShaper
      Specified by:
      getStartTime in interface X3DSoundProcessingNode
      Specified by:
      getStartTime in interface X3DTimeDependentNode
      Returns:
      value of startTime field
    • setStartTime

      public WaveShaper setStartTime​(double newValue)
      Accessor method to assign double value in seconds to inputOutput SFTime field named startTime.

      Tooltip: Absolute time: number of seconds since January 1, 1970, 00:00:00 GMT.
      • Hint: ROUTE a time value matching system clock to this field, such as output event from TouchSensor touchTime or TimeTrigger triggerTime.
      Specified by:
      setStartTime in interface WaveShaper
      Specified by:
      setStartTime in interface X3DSoundProcessingNode
      Specified by:
      setStartTime in interface X3DTimeDependentNode
      Parameters:
      newValue - is new value for the startTime field.
      Returns:
      WaveShaper - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setStartTime

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

      public double getStopTime()
      Provide double value in seconds from inputOutput SFTime field named stopTime.

      Tooltip: Absolute time: number of seconds since January 1, 1970, 00:00:00 GMT.
      • Hint: ROUTE a time value matching system clock to this field, such as output event from TouchSensor touchTime or TimeTrigger triggerTime.
      • Warning: An active TimeSensor node ignores set_cycleInterval and set_startTime events.
      • Warning: An active TimeSensor node ignores set_stopTime event values less than or equal to startTime.
      Specified by:
      getStopTime in interface WaveShaper
      Specified by:
      getStopTime in interface X3DSoundProcessingNode
      Specified by:
      getStopTime in interface X3DTimeDependentNode
      Returns:
      value of stopTime field
    • setStopTime

      public WaveShaper setStopTime​(double newValue)
      Accessor method to assign double value in seconds to inputOutput SFTime field named stopTime.

      Tooltip: Absolute time: number of seconds since January 1, 1970, 00:00:00 GMT.
      • Hint: ROUTE a time value matching system clock to this field, such as output event from TouchSensor touchTime or TimeTrigger triggerTime.
      • Warning: An active TimeSensor node ignores set_cycleInterval and set_startTime events.
      • Warning: An active TimeSensor node ignores set_stopTime event values less than or equal to startTime.
      Specified by:
      setStopTime in interface WaveShaper
      Specified by:
      setStopTime in interface X3DSoundProcessingNode
      Specified by:
      setStopTime in interface X3DTimeDependentNode
      Parameters:
      newValue - is new value for the stopTime field.
      Returns:
      WaveShaper - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setStopTime

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

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

      Tooltip: [0,+infinity) tailTime is duration of time that a node continues to provide output signal after the input signal becomes silent. *
      Specified by:
      getTailTime in interface WaveShaper
      Specified by:
      getTailTime in interface X3DSoundProcessingNode
      Returns:
      value of tailTime field
    • setTailTime

      public WaveShaper setTailTime​(double newValue)
      Accessor method to assign double value in seconds to inputOutput SFTime field named tailTime.

      Tooltip: [0,+infinity) tailTime is duration of time that a node continues to provide output signal after the input signal becomes silent. *
      Specified by:
      setTailTime in interface WaveShaper
      Specified by:
      setTailTime in interface X3DSoundProcessingNode
      Parameters:
      newValue - is new value for the tailTime field.
      Returns:
      WaveShaper - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setTailTime

      public WaveShaper setTailTime​(SFTime newValue)
      Assign typed object value to SFTime tailTime field, similar to setTailTime(double).
      Parameters:
      newValue - is new value for the tailTime field.
      Returns:
      WaveShaper - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • 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 WaveShaper 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:
      WaveShaper - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setDEF

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

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

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

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

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

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