Class Convolver

java.lang.Object
org.web3d.x3d.jsail.X3DConcreteElement
org.web3d.x3d.jsail.X3DConcreteNode
org.web3d.x3d.jsail.Sound.Convolver
All Implemented Interfaces:
X3DChildNode, X3DNode, Convolver, X3DSoundNode, X3DSoundProcessingNode, X3DTimeDependentNode
public class Convolver extends X3DConcreteNode implements Convolver
Convolver performs a linear convolution on a given AudioBuffer, often used to achieve a reverberation effect.

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. Convolver node tooltip: [X3DSoundProcessingNode] Convolver performs a linear convolution on a given AudioBuffer, often used to achieve a reverberation effect.
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

    • CHANNELCOUNTMODE_MAX

      public static final String CHANNELCOUNTMODE_MAX
      Tooltip: X3D version of "max" in Web Audio API. SFString field named channelCountMode with X3DUOM simpleType channelCountModeChoices and with X3DUOM baseType SFString can equal this value "MAX" (Java syntax) or MAX (XML syntax).
      See Also:

    • CHANNELCOUNTMODE_MAX_ALIAS

      public static final String CHANNELCOUNTMODE_MAX_ALIAS
      SFString SFString enumeration value "MAX" has alias "max"
      See Also:

    • CHANNELCOUNTMODE_CLAMPED_MAX

      public static final String CHANNELCOUNTMODE_CLAMPED_MAX
      Tooltip: X3D version of "clamped-max" in Web Audio API. 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).
      See Also:

    • CHANNELCOUNTMODE_CLAMPED_MAX_ALIAS

      public static final String CHANNELCOUNTMODE_CLAMPED_MAX_ALIAS
      SFString SFString enumeration value "CLAMPED_MAX" has alias "clamped-max"
      See Also:

    • CHANNELCOUNTMODE_EXPLICIT

      public static final String CHANNELCOUNTMODE_EXPLICIT
      Tooltip: X3D version of "explicit" in Web Audio API. SFString field named channelCountMode with X3DUOM simpleType channelCountModeChoices and with X3DUOM baseType SFString can equal this value "EXPLICIT" (Java syntax) or EXPLICIT (XML syntax).
      See Also:

    • CHANNELCOUNTMODE_EXPLICIT_ALIAS

      public static final String CHANNELCOUNTMODE_EXPLICIT_ALIAS
      SFString SFString enumeration value "EXPLICIT" has alias "explicit"
      See Also:

    • CHANNELINTERPRETATION_SPEAKERS

      public static final String CHANNELINTERPRETATION_SPEAKERS
      Tooltip: X3D version of "speakers" in Web Audio API. SFString field named channelInterpretation with X3DUOM simpleType channelInterpretationChoices and with X3DUOM baseType SFString can equal this value "SPEAKERS" (Java syntax) or SPEAKERS (XML syntax).
      See Also:

    • CHANNELINTERPRETATION_DISCRETE

      public static final String CHANNELINTERPRETATION_DISCRETE
      Tooltip: X3D version of "discrete" in Web Audio API. SFString field named channelInterpretation with X3DUOM simpleType channelInterpretationChoices and with X3DUOM baseType SFString can equal this value "DISCRETE" (Java syntax) or DISCRETE (XML syntax).
      See Also:

    • NAME

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

    • COMPONENT

      public static final String COMPONENT
      String constant COMPONENT defines X3D component for the Convolver element: Sound
      See Also:

    • LEVEL

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

    • BUFFER_DEFAULT_VALUE

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

    • CHANNELCOUNTMODE_DEFAULT_VALUE

      public static final String CHANNELCOUNTMODE_DEFAULT_VALUE
      SFString field named channelCountMode has default value "MAX" (Java syntax) or MAX (XML syntax).
      See Also:

    • CHANNELINTERPRETATION_DEFAULT_VALUE

      public static final String CHANNELINTERPRETATION_DEFAULT_VALUE
      SFString field named channelInterpretation has default value "SPEAKERS" (Java syntax) or SPEAKERS (XML syntax).
      See Also:

    • DESCRIPTION_DEFAULT_VALUE

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

    • ENABLED_DEFAULT_VALUE

      public static final boolean ENABLED_DEFAULT_VALUE
      SFBool field named enabled has default value true (Java syntax) or true (XML syntax).
      See Also:

    • GAIN_DEFAULT_VALUE

      public static final float GAIN_DEFAULT_VALUE
      SFFloat field named gain has default value 1f (Java syntax) or 1 (XML syntax).
      See Also:

    • IS_DEFAULT_VALUE

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

    • METADATA_DEFAULT_VALUE

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

    • NORMALIZE_DEFAULT_VALUE

      public static final boolean NORMALIZE_DEFAULT_VALUE
      SFBool field named normalize has default value false (Java syntax) or false (XML syntax).
      See Also:

    • PAUSETIME_DEFAULT_VALUE

      public static final double PAUSETIME_DEFAULT_VALUE
      SFTime field named pauseTime has default value 0 (Java syntax) or 0 (XML syntax).
      See Also:

    • RESUMETIME_DEFAULT_VALUE

      public static final double RESUMETIME_DEFAULT_VALUE
      SFTime field named resumeTime has default value 0 (Java syntax) or 0 (XML syntax).
      See Also:

    • STARTTIME_DEFAULT_VALUE

      public static final double STARTTIME_DEFAULT_VALUE
      SFTime field named startTime has default value 0 (Java syntax) or 0 (XML syntax).
      See Also:

    • STOPTIME_DEFAULT_VALUE

      public static final double STOPTIME_DEFAULT_VALUE
      SFTime field named stopTime has default value 0 (Java syntax) or 0 (XML syntax).
      See Also:

    • TAILTIME_DEFAULT_VALUE

      public static final double TAILTIME_DEFAULT_VALUE
      SFTime field named tailTime has default value 0 (Java syntax) or 0 (XML syntax).
      See Also:

    • containerField_DEFAULT_VALUE

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

    • fromField_BUFFER

      public static final String fromField_BUFFER
      fromField ROUTE name for MFFloat field named buffer.
      See Also:

    • toField_BUFFER

      public static final String toField_BUFFER
      toField ROUTE name for MFFloat field named buffer.
      See Also:

    • fromField_CHANNELCOUNT

      public static final String fromField_CHANNELCOUNT
      fromField ROUTE name for SFInt32 field named channelCount.
      See Also:

    • fromField_CHANNELCOUNTMODE

      public static final String fromField_CHANNELCOUNTMODE
      fromField ROUTE name for SFString field named channelCountMode.
      See Also:

    • toField_CHANNELCOUNTMODE

      public static final String toField_CHANNELCOUNTMODE
      toField ROUTE name for SFString field named channelCountMode.
      See Also:

    • fromField_CHANNELINTERPRETATION

      public static final String fromField_CHANNELINTERPRETATION
      fromField ROUTE name for SFString field named channelInterpretation.
      See Also:

    • toField_CHANNELINTERPRETATION

      public static final String toField_CHANNELINTERPRETATION
      toField ROUTE name for SFString field named channelInterpretation.
      See Also:

    • fromField_CHILDREN

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

    • toField_CHILDREN

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

    • fromField_DESCRIPTION

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

    • toField_DESCRIPTION

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

    • fromField_ELAPSEDTIME

      public static final String fromField_ELAPSEDTIME
      fromField ROUTE name for SFTime field named elapsedTime.
      See Also:

    • fromField_ENABLED

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

    • toField_ENABLED

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

    • fromField_GAIN

      public static final String fromField_GAIN
      fromField ROUTE name for SFFloat field named gain.
      See Also:

    • toField_GAIN

      public static final String toField_GAIN
      toField ROUTE name for SFFloat field named gain.
      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_ISPAUSED

      public static final String fromField_ISPAUSED
      fromField ROUTE name for SFBool field named isPaused.
      See Also:

    • fromField_METADATA

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

    • toField_METADATA

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

    • fromField_NORMALIZE

      public static final String fromField_NORMALIZE
      fromField ROUTE name for SFBool field named normalize.
      See Also:

    • toField_NORMALIZE

      public static final String toField_NORMALIZE
      toField ROUTE name for SFBool field named normalize.
      See Also:

    • fromField_PAUSETIME

      public static final String fromField_PAUSETIME
      fromField ROUTE name for SFTime field named pauseTime.
      See Also:

    • toField_PAUSETIME

      public static final String toField_PAUSETIME
      toField ROUTE name for SFTime field named pauseTime.
      See Also:

    • fromField_RESUMETIME

      public static final String fromField_RESUMETIME
      fromField ROUTE name for SFTime field named resumeTime.
      See Also:

    • toField_RESUMETIME

      public static final String toField_RESUMETIME
      toField ROUTE name for SFTime field named resumeTime.
      See Also:

    • fromField_STARTTIME

      public static final String fromField_STARTTIME
      fromField ROUTE name for SFTime field named startTime.
      See Also:

    • toField_STARTTIME

      public static final String toField_STARTTIME
      toField ROUTE name for SFTime field named startTime.
      See Also:

    • fromField_STOPTIME

      public static final String fromField_STOPTIME
      fromField ROUTE name for SFTime field named stopTime.
      See Also:

    • toField_STOPTIME

      public static final String toField_STOPTIME
      toField ROUTE name for SFTime field named stopTime.
      See Also:

    • fromField_TAILTIME

      public static final String fromField_TAILTIME
      fromField ROUTE name for SFTime field named tailTime.
      See Also:

    • toField_TAILTIME

      public static final String toField_TAILTIME
      toField ROUTE name for SFTime field named tailTime.
      See Also:

  • Constructor Details

    • Convolver

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

    • Convolver

      public Convolver(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

    • getChannelCountModeAlias

      public static String getChannelCountModeAlias(String channelCountModeValue)
      Get alias for this channelCountMode
      Parameters:
      channelCountModeValue - of interest
      Returns:
      alias value, otherwise empty string if not found

    • hasChannelCountModeAlias

      public static boolean hasChannelCountModeAlias(String channelCountMode)
      Whether a alias exists for this channelCountMode
      Parameters:
      channelCountMode - of interest
      Returns:
      true if found

    • getElementName

      public final String getElementName()
      Provides name of this element: Convolver
      Specified by:
      getElementName in class X3DConcreteElement
      Returns:
      name of this element

    • getComponent

      public final String getComponent()
      Defines X3D component for the Convolver 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 String getFieldType(String fieldName)
      Indicate type corresponding to given fieldName.
      Specified by:
      getFieldType in class X3DConcreteElement
      Parameters:
      fieldName - name of field in this X3D node
      Returns:
      X3D type (SFvec3f etc.), otherwise ConfigurationProperties.ERROR_UNKNOWN_FIELD_TYPE if not recognized
      See Also:

    • getAccessType

      public String getAccessType(String fieldName)
      Indicate accessType corresponding to given fieldName.
      Specified by:
      getAccessType in class X3DConcreteElement
      Parameters:
      fieldName - name of field in this X3D node
      Returns:
      X3D accessType (inputOnly etc.), otherwise ConfigurationProperties.ERROR_UNKNOWN_FIELD_ACCESSTYPE if not recognized
      See Also:

    • getContainerFieldDefault

      public final String getContainerFieldDefault()
      containerField describes typical field relationship of a node to its parent. Programmer usage is not ordinarily needed when using this API, since this default value is provided for informational purposes only.
      Specified by:
      getContainerFieldDefault in class X3DConcreteNode
      Returns:
      default containerField value
      See Also:

    • initialize

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

    • getBuffer

      public float[] getBuffer()
      Provide array of Float results within allowed range of [-1,1] from inputOutput MFFloat field named buffer.

      Tooltip: buffer is a memory-resident audio asset that can contain one or more channels. buffer data format is non-interleaved 32-bit floating-point linear PCM values with a normal range of [−1,1], but values are not limited to this range.
      Specified by:
      getBuffer in interface Convolver
      Returns:
      value of buffer field

    • getBufferList

      public ArrayList<Float> getBufferList()
      Utility method to get ArrayList value of MFFloat buffer field, similar to getBuffer().
      Returns:
      value of buffer field

    • getBufferString

      public String getBufferString()
      Utility method to get String value of MFFloat buffer field, similar to getBuffer().
      Returns:
      value of buffer field

    • setBuffer

      public Convolver setBuffer(float[] newValue)
      Accessor method to assign Float array to inputOutput MFFloat field named buffer.

      Tooltip: buffer is a memory-resident audio asset that can contain one or more channels. buffer data format is non-interleaved 32-bit floating-point linear PCM values with a normal range of [−1,1], but values are not limited to this range.
      Specified by:
      setBuffer in interface Convolver
      Parameters:
      newValue - is new value for the buffer field.
      Returns:
      Convolver - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • setBuffer

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

    • setBuffer

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

    • clearBuffer

      public Convolver clearBuffer()
      Utility method to clear MFFloat value of buffer field. This method does not initialize withBUFFER_DEFAULT_VALUE.
      Returns:
      Convolver - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).

    • setBuffer

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

    • addBuffer

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

    • addBuffer

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

    • setBuffer

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

    • 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 Convolver
      Specified by:
      getChannelCount in interface X3DSoundProcessingNode
      Returns:
      value of channelCount field

    • getChannelCountMode

      public 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 Convolver
      Specified by:
      getChannelCountMode in interface X3DSoundProcessingNode
      Returns:
      value of channelCountMode field

    • setChannelCountMode

      public Convolver setChannelCountMode(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 Convolver
      Specified by:
      setChannelCountMode in interface X3DSoundProcessingNode
      Parameters:
      newValue - is new value for the channelCountMode field.
      Returns:
      Convolver - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • setChannelCountMode

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

    • getChannelInterpretation

      public 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 Convolver
      Specified by:
      getChannelInterpretation in interface X3DSoundProcessingNode
      Returns:
      value of channelInterpretation field

    • setChannelInterpretation

      public Convolver setChannelInterpretation(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 Convolver
      Specified by:
      setChannelInterpretation in interface X3DSoundProcessingNode
      Parameters:
      newValue - is new value for the channelInterpretation field.
      Returns:
      Convolver - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • setChannelInterpretation

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

    • getChildren

      public X3DNode[] getChildren()
      Provide array of org.web3d.x3d.sai.Core.X3DNode results (using an array consisting of properly typed nodes or ProtoInstances) with acceptable node types limited to Analyser|AudioClip|AudioDestination|BiquadFilter|BufferAudioSource|ChannelMerger|ChannelSelector|ChannelSplitter|Convolver|Delay|DynamicsCompressor|Gain|ListenerPointSource|MicrophoneSource|MovieTexture|OscillatorSource|Sound|SpatialSound|StreamAudioDestination|StreamAudioSource|WaveShaper, from inputOutput MFNode field children.

      Tooltip: [X3DSoundChannelNode|X3DSoundProcessingNode|X3DSoundSourceNode] The children field specifies audio-graph sound sources providing input signals for this node. If multiple input signals are provided by the inputs children field, all channels are mixed together and merged prior to presentation.
      • Warning: contained AudioClip or MovieTexture nodes must have containerField='children' to override otherwise-incorrect defaults.
      • Hint: can be original (DEF) or referenced (USE) nodes.


      Warning: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to Analyser|AudioClip|AudioDestination|BiquadFilter|BufferAudioSource|ChannelMerger|ChannelSelector|ChannelSplitter|Convolver|Delay|DynamicsCompressor|Gain|ListenerPointSource|MicrophoneSource|MovieTexture|OscillatorSource|Sound|SpatialSound|StreamAudioDestination|StreamAudioSource|WaveShaper.
      Specified by:
      getChildren in interface Convolver
      Returns:
      value of children field
      See Also:

    • getChildrenList

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

    • setChildren

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

      Tooltip: [X3DSoundChannelNode|X3DSoundProcessingNode|X3DSoundSourceNode] The children field specifies audio-graph sound sources providing input signals for this node. If multiple input signals are provided by the inputs children field, all channels are mixed together and merged prior to presentation.
      • Warning: contained AudioClip or MovieTexture nodes must have containerField='children' to override otherwise-incorrect defaults.
      • Hint: can be original (DEF) or referenced (USE) nodes.


      Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to Analyser|AudioClip|AudioDestination|BiquadFilter|BufferAudioSource|ChannelMerger|ChannelSelector|ChannelSplitter|Convolver|Delay|DynamicsCompressor|Gain|ListenerPointSource|MicrophoneSource|MovieTexture|OscillatorSource|Sound|SpatialSound|StreamAudioDestination|StreamAudioSource|WaveShaper.
      Specified by:
      setChildren in interface Convolver
      Parameters:
      newValue - is new value for the children field.
      Returns:
      Convolver - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • setChildren

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

    • addChildren

      public void addChildren(X3DNode newValue)
      Add single node to existing array of children nodes (if any).

      Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to Analyser|AudioClip|AudioDestination|BiquadFilter|BufferAudioSource|ChannelMerger|ChannelSelector|ChannelSplitter|Convolver|Delay|DynamicsCompressor|Gain|ListenerPointSource|MicrophoneSource|MovieTexture|OscillatorSource|Sound|SpatialSound|StreamAudioDestination|StreamAudioSource|WaveShaper and ProtoInstance.
      Parameters:
      newValue - is new value to be appended the children field.

    • addChildren

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

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

    • addChild

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

    • addChildren

      public void addChildren(X3DNode[] newValue)
      Add array of children nodes to array of existing nodes (if any).

      Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to Analyser|AudioClip|AudioDestination|BiquadFilter|BufferAudioSource|ChannelMerger|ChannelSelector|ChannelSplitter|Convolver|Delay|DynamicsCompressor|Gain|ListenerPointSource|MicrophoneSource|MovieTexture|OscillatorSource|Sound|SpatialSound|StreamAudioDestination|StreamAudioSource|WaveShaper.
      Specified by:
      addChildren in interface Convolver
      Parameters:
      newValue - is new value array to be appended the children field.

    • setChildren

      public void setChildren(X3DNode newValue)
      Set single children node, replacing prior array of existing nodes (if any).

      Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are restricted to Analyser|AudioClip|AudioDestination|BiquadFilter|BufferAudioSource|ChannelMerger|ChannelSelector|ChannelSplitter|Convolver|Delay|DynamicsCompressor|Gain|ListenerPointSource|MicrophoneSource|MovieTexture|OscillatorSource|Sound|SpatialSound|StreamAudioDestination|StreamAudioSource|WaveShaper.
      Specified by:
      setChildren in interface Convolver
      Parameters:
      newValue - is new node for the children field (restricted to Analyser|AudioClip|AudioDestination|BiquadFilter|BufferAudioSource|ChannelMerger|ChannelSelector|ChannelSplitter|Convolver|Delay|DynamicsCompressor|Gain|ListenerPointSource|MicrophoneSource|MovieTexture|OscillatorSource|Sound|SpatialSound|StreamAudioDestination|StreamAudioSource|WaveShaper)

    • clearChildren

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

    • hasChildren

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

    • addComments

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

    • addComments

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

    • addComments

      public Convolver addComments(CommentsBlock newCommentsBlock)
      Add CommentsBlock to children field
      Specified by:
      addComments in class X3DConcreteElement
      Parameters:
      newCommentsBlock - block of comments to add
      Returns:
      Convolver - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • getDescription

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

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

    • setDescription

      public Convolver setDescription(String newValue)
      Accessor method to assign String value to inputOutput SFString field named description.

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

    • setDescription

      public Convolver 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:
      Convolver - 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 Convolver
      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 Convolver
      Specified by:
      getEnabled in interface X3DSoundNode
      Specified by:
      getEnabled in interface X3DSoundProcessingNode
      Returns:
      value of enabled field

    • setEnabled

      public Convolver 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 Convolver
      Specified by:
      setEnabled in interface X3DSoundNode
      Specified by:
      setEnabled in interface X3DSoundProcessingNode
      Parameters:
      newValue - is new value for the enabled field.
      Returns:
      Convolver - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • setEnabled

      public Convolver 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:
      Convolver - 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 Convolver
      Specified by:
      getGain in interface X3DSoundProcessingNode
      Returns:
      value of gain field

    • setGain

      public Convolver 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 Convolver
      Specified by:
      setGain in interface X3DSoundProcessingNode
      Parameters:
      newValue - is new value for the gain field.
      Returns:
      Convolver - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • setGain

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

    • setGain

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

    • clearIS

      public Convolver clearIS()
      Utility method to clear SFNode value of IS field.
      Returns:
      Convolver - 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 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 Convolver
      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 Convolver
      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 Convolver
      Specified by:
      getMetadata in interface X3DChildNode
      Specified by:
      getMetadata in interface X3DNode
      Specified by:
      getMetadata in interface X3DSoundNode
      Specified by:
      getMetadata in interface X3DSoundProcessingNode
      Specified by:
      getMetadata in interface X3DTimeDependentNode
      Returns:
      value of metadata field
      See Also:

    • setMetadata

      public Convolver 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 Convolver
      Specified by:
      setMetadata in interface X3DChildNode
      Specified by:
      setMetadata in interface X3DNode
      Specified by:
      setMetadata in interface X3DSoundNode
      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:
      Convolver - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:

    • clearMetadata

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

    • setMetadata

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

    • getNormalize

      public boolean getNormalize()
      Provide boolean value from inputOutput SFBool field named normalize.

      Tooltip: normalize controls whether or not the impulse response from the buffer is scaled by an equal-power normalization when the buffer field is set. *
      Specified by:
      getNormalize in interface Convolver
      Returns:
      value of normalize field

    • setNormalize

      public Convolver setNormalize(boolean newValue)
      Accessor method to assign boolean value to inputOutput SFBool field named normalize.

      Tooltip: normalize controls whether or not the impulse response from the buffer is scaled by an equal-power normalization when the buffer field is set. *
      Specified by:
      setNormalize in interface Convolver
      Parameters:
      newValue - is new value for the normalize field.
      Returns:
      Convolver - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • setNormalize

      public Convolver setNormalize(SFBool newValue)
      Assign typed object value to SFBool normalize field, similar to setNormalize(boolean).
      Parameters:
      newValue - is new value for the normalize field.
      Returns:
      Convolver - 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 &gt;= 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 Convolver
      Specified by:
      getPauseTime in interface X3DSoundProcessingNode
      Specified by:
      getPauseTime in interface X3DTimeDependentNode
      Returns:
      value of pauseTime field

    • setPauseTime

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

      Tooltip: When time now &gt;= 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 Convolver
      Specified by:
      setPauseTime in interface X3DSoundProcessingNode
      Specified by:
      setPauseTime in interface X3DTimeDependentNode
      Parameters:
      newValue - is new value for the pauseTime field.
      Returns:
      Convolver - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • setPauseTime

      public Convolver 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:
      Convolver - 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 &lt;= 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 Convolver
      Specified by:
      getResumeTime in interface X3DSoundProcessingNode
      Specified by:
      getResumeTime in interface X3DTimeDependentNode
      Returns:
      value of resumeTime field

    • setResumeTime

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

      Tooltip: When resumeTime becomes &lt;= 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 Convolver
      Specified by:
      setResumeTime in interface X3DSoundProcessingNode
      Specified by:
      setResumeTime in interface X3DTimeDependentNode
      Parameters:
      newValue - is new value for the resumeTime field.
      Returns:
      Convolver - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • setResumeTime

      public Convolver 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:
      Convolver - 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 Convolver
      Specified by:
      getStartTime in interface X3DSoundProcessingNode
      Specified by:
      getStartTime in interface X3DTimeDependentNode
      Returns:
      value of startTime field

    • setStartTime

      public Convolver 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 Convolver
      Specified by:
      setStartTime in interface X3DSoundProcessingNode
      Specified by:
      setStartTime in interface X3DTimeDependentNode
      Parameters:
      newValue - is new value for the startTime field.
      Returns:
      Convolver - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • setStartTime

      public Convolver 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:
      Convolver - 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 Convolver
      Specified by:
      getStopTime in interface X3DSoundProcessingNode
      Specified by:
      getStopTime in interface X3DTimeDependentNode
      Returns:
      value of stopTime field

    • setStopTime

      public Convolver 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 Convolver
      Specified by:
      setStopTime in interface X3DSoundProcessingNode
      Specified by:
      setStopTime in interface X3DTimeDependentNode
      Parameters:
      newValue - is new value for the stopTime field.
      Returns:
      Convolver - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • setStopTime

      public Convolver 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:
      Convolver - 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 Convolver
      Specified by:
      getTailTime in interface X3DSoundProcessingNode
      Returns:
      value of tailTime field

    • setTailTime

      public Convolver 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 Convolver
      Specified by:
      setTailTime in interface X3DSoundProcessingNode
      Parameters:
      newValue - is new value for the tailTime field.
      Returns:
      Convolver - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • setTailTime

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

    • getDEF

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

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

    • setDEF

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

      Tooltip: DEF defines a unique ID name for this node, referenceable by other nodes.

      Note that setting the DEF value clears the USE value.
      Specified by:
      setDEF in class X3DConcreteNode
      Parameters:
      newValue - is new value for the DEF field.
      Returns:
      Convolver - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • setDEF

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

    • setUSE

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

    • setCssClass

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

    • setHtmlID

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

    • setCssStyle

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

    • setUSE

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

    • toStringX3D

      public String toStringX3D(int indentLevel)
      Recursive method to provide X3D string serialization of this model subgraph, utilizing XML encoding and conforming to X3D Canonical Form.
      Specified by:
      toStringX3D in class X3DConcreteElement
      Parameters:
      indentLevel - number of levels of indentation for this element
      Returns:
      X3D string
      See Also:

    • toStringClassicVRML

      public String toStringClassicVRML(int indentLevel)
      Recursive method to provide ClassicVRML string serialization.
      Specified by:
      toStringClassicVRML in class X3DConcreteElement
      Parameters:
      indentLevel - number of levels of indentation for this element
      Returns:
      ClassicVRML string
      See Also:

    • toStringVRML97

      public String toStringVRML97(int indentLevel)
      Recursive method to provide VRML97 string serialization.
      Specified by:
      toStringVRML97 in class X3DConcreteElement
      Parameters:
      indentLevel - number of levels of indentation for this element
      Returns:
      VRML97 string
      See Also:

    • findElementByNameValue

      public X3DConcreteElement findElementByNameValue(String nameValue)
      Recursive method to provide object reference to node or statement by name attribute, if found as part of this element or in a contained element. Elements with name fields include meta, Metadata* nodes, field/fieldValue, ProtoDeclare/ExternProtoDeclare/ProtoInstance, CAD and HAnim nodes.

      Warning: first start with findAncestorScene() to check entire scene graph, or findAncestorX3D() to check entire model document.

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

    • findElementByNameValue

      public X3DConcreteElement findElementByNameValue(String nameValue, String elementName)
      Recursive method to provide object reference to node or statement by name attribute, if found as part of this element or in a contained element. Elements with name fields include meta, Metadata* nodes, field/fieldValue, ProtoDeclare/ExternProtoDeclare/ProtoInstance, CAD and HAnim nodes.

      Warning: first start with findAncestorScene() to check entire scene graph, or findAncestorX3D() to check entire model document.

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

    • hasElementByNameValue

      public boolean hasElementByNameValue(String nameValue, String elementName)
      Recursive method to determine whether node or statement with given name attribute is found, meaning both objects are attached to same scene graph.
      Parameters:
      nameValue - is value of the name field being searched for in this element and child elements(if any)
      elementName - identifies the element of interest (meta MetadataString ProtoDeclare CADassembly ProtoInstance HAnimHumanoid etc.)
      Returns:
      whether node is found
      See Also:

    • findNodeByDEF

      public X3DConcreteNode findNodeByDEF(String DEFvalue)
      Recursive method to provide object reference to node by DEF, if found as this node or in a contained node.

      Warning: first start with findAncestorScene() to check entire scene graph, or findAncestorX3D() to check entire model document.

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

    • hasNodeByDEF

      public boolean hasNodeByDEF(String DEFvalue)
      Recursive method to determine whether node with DEFvalue is found, meaning both objects are attached to same scene graph.
      Parameters:
      DEFvalue - is value of the name field being searched for in this element and child elements(if any)
      Returns:
      whether node is found
      See Also:

    • validate

      public String validate()
      Recursive method to validate this element plus all contained nodes and statements, using both datatype-specification value checks and regular expression (regex) checking of corresponding string values. TODO document specific validation methods.
      Specified by:
      validate in class X3DConcreteElement
      Returns:
      validation results (if any)