Interface PeriodicWave

All Superinterfaces:
X3DChildNode, X3DNode, X3DSoundNode
All Known Implementing Classes:
PeriodicWave

public interface PeriodicWave extends X3DSoundNode
PeriodicWave defines a periodic waveform that can be used to shape the output of an Oscillator.

X3D node tooltip: (X3D version 4.0 draft) [X3DNode] PeriodicWave defines a periodic waveform that can be used to shape the output of an Oscillator.#10;
Package hint: This interface is defined by the X3D Java Language Binding Specification for the Scene Authoring Interface (SAI).
See Also:
SAI Java Specification, X3D Abstract Specification: PeriodicWave, X3D Tooltips: PeriodicWave, X3D Scene Authoring Hints
  • Method Summary

    Modifier and Type
    Method
    Description
    Provide String value from inputOutput SFString field named description.
    boolean
    Provide boolean value from inputOutput SFBool field named enabled.
    Provide org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
    float[]
    Provide array of float results from inputOutput MFFloat field named optionsImag.
    float[]
    Provide array of float results from inputOutput MFFloat field named optionsReal.
    Provide String enumeration value (baseType SFString) ["sine" | "square" | "sawtooth" | "triangle" | "custom"] from inputOutput SFString field named type.
    setDescription​(String newValue)
    Accessor method to assign String value to inputOutput SFString field named description.
    setEnabled​(boolean newValue)
    Accessor method to assign boolean value to inputOutput SFBool field named enabled.
    Accessor method to assign org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
    setOptionsImag​(float[] newValue)
    Accessor method to assign float array to inputOutput MFFloat field named optionsImag.
    setOptionsReal​(float[] newValue)
    Accessor method to assign float array to inputOutput MFFloat field named optionsReal.
    setType​(String newValue)
    Accessor method to assign String enumeration value ("sine" | "square" | "sawtooth" | "triangle" | "custom") to inputOutput SFString field named type.
  • Method Details

    • getDescription

      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 X3DSoundNode
      Returns:
      value of description field
    • setDescription

      PeriodicWave 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 & for & ampersand character, or " for " quotation-mark character).
      Specified by:
      setDescription in interface X3DSoundNode
      Parameters:
      newValue - is new value for the description field.
      Returns:
      PeriodicWave - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getEnabled

      boolean getEnabled()
      Provide boolean value from inputOutput SFBool field named enabled.
      Specified by:
      getEnabled in interface X3DSoundNode
      Returns:
      value of enabled field
    • setEnabled

      PeriodicWave setEnabled(boolean newValue)
      Accessor method to assign boolean value to inputOutput SFBool field named enabled.
      Specified by:
      setEnabled in interface X3DSoundNode
      Parameters:
      newValue - is new value for the enabled field.
      Returns:
      PeriodicWave - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getMetadata

      X3DMetadataObject getMetadata()
      Provide org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.

      Tooltip: [X3DMetadataObject] Information about this node can be contained in a MetadataBoolean, MetadataDouble, MetadataFloat, MetadataInteger, MetadataString or MetadataSet node.
      Specified by:
      getMetadata in interface X3DChildNode
      Specified by:
      getMetadata in interface X3DNode
      Specified by:
      getMetadata in interface X3DSoundNode
      Returns:
      value of metadata field
      See Also:
      X3D Scene Authoring Hints: Metadata Nodes
    • setMetadata

      PeriodicWave setMetadata(X3DMetadataObject newValue)
      Accessor method to assign org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.

      Tooltip: [X3DMetadataObject] Information about this node can be contained in a MetadataBoolean, MetadataDouble, MetadataFloat, MetadataInteger, MetadataString or MetadataSet node.
      Specified by:
      setMetadata in interface X3DChildNode
      Specified by:
      setMetadata in interface X3DNode
      Specified by:
      setMetadata in interface X3DSoundNode
      Parameters:
      newValue - is new value for the metadata field.
      Returns:
      PeriodicWave - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:
      X3D Scene Authoring Hints: Metadata Nodes
    • getOptionsImag

      float[] getOptionsImag()
      Provide array of float results from inputOutput MFFloat field named optionsImag.

      Tooltip: imaginary coefficients for defining a waveform.
      • Warning: array lengths for optionsReal and optionsImag must match.
      Returns:
      value of optionsImag field
    • setOptionsImag

      PeriodicWave setOptionsImag(float[] newValue)
      Accessor method to assign float array to inputOutput MFFloat field named optionsImag.

      Tooltip: imaginary coefficients for defining a waveform.
      • Warning: array lengths for optionsReal and optionsImag must match.
      Parameters:
      newValue - is new value for the optionsImag field.
      Returns:
      PeriodicWave - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getOptionsReal

      float[] getOptionsReal()
      Provide array of float results from inputOutput MFFloat field named optionsReal.

      Tooltip: real coefficients for defining a waveform.
      • Warning: array lengths for optionsReal and optionsImag must match.
      Returns:
      value of optionsReal field
    • setOptionsReal

      PeriodicWave setOptionsReal(float[] newValue)
      Accessor method to assign float array to inputOutput MFFloat field named optionsReal.

      Tooltip: real coefficients for defining a waveform.
      • Warning: array lengths for optionsReal and optionsImag must match.
      Parameters:
      newValue - is new value for the optionsReal field.
      Returns:
      PeriodicWave - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getType

      String getType()
      Provide String enumeration value (baseType SFString) ["sine" | "square" | "sawtooth" | "triangle" | "custom"] from inputOutput SFString field named type.

      Tooltip: The type field specifies shape of waveform to play, which can be one of several provided values or else 'custom' to indicate that real and imaginary coefficient arrays define a custom waveform.
      Returns:
      value of type field
    • setType

      PeriodicWave setType(String newValue)
      Accessor method to assign String enumeration value ("sine" | "square" | "sawtooth" | "triangle" | "custom") to inputOutput SFString field named type.

      Tooltip: The type field specifies shape of waveform to play, which can be one of several provided values or else 'custom' to indicate that real and imaginary coefficient arrays define a custom waveform.
      Parameters:
      newValue - is new value for the type field.
      Returns:
      PeriodicWave - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).