Package org.web3d.x3d.sai.Shape

Interface AcousticProperties

All Superinterfaces:
X3DAppearanceChildNode, X3DNode
All Known Implementing Classes:
AcousticProperties
public interface AcousticProperties
extends X3DAppearanceChildNode
AcousticProperties specifies the interaction of sound waves with characteristics of geometric objects in the scene.

X3D node tooltip: (X3D version 4.0 draft) [X3DAppearanceChildNode] AcousticProperties specifies the interaction of sound waves with characteristics of geometric objects in the scene. Acoustic coefficient values are expected to fully account for physical and structural characteristics of associated geometry such as width, height, thickness, shape, softness and/or hardness, and density variations.
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: AcousticProperties, X3D Tooltips: AcousticProperties, X3D Scene Authoring Hints

  • Method Summary

    Modifier and Type Method Description
    float getAbsorption()
    Provide float value within allowed range of [0,1] from inputOutput SFFloat field named absorption.
    java.lang.String getDescription()
    Provide String value from inputOutput SFString field named description.
    float getDiffuse()
    Provide float value within allowed range of [0,1] from inputOutput SFFloat field named diffuse.
    boolean getEnabled()
    Provide boolean value from inputOutput SFBool field named enabled.
    X3DMetadataObject getMetadata()
    Provide org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
    float getRefraction()
    Provide float value within allowed range of [0,1] from inputOutput SFFloat field named refraction.
    float getSpecular()
    Provide float value within allowed range of [0,1] from inputOutput SFFloat field named specular.
    AcousticProperties setAbsorption​(float newValue)
    Accessor method to assign float value to inputOutput SFFloat field named absorption.
    AcousticProperties setDescription​(java.lang.String newValue)
    Accessor method to assign String value to inputOutput SFString field named description.
    AcousticProperties setDiffuse​(float newValue)
    Accessor method to assign float value to inputOutput SFFloat field named diffuse.
    AcousticProperties setEnabled​(boolean newValue)
    Accessor method to assign boolean value to inputOutput SFBool field named enabled.
    AcousticProperties setMetadata​(X3DMetadataObject newValue)
    Accessor method to assign org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
    AcousticProperties setRefraction​(float newValue)
    Accessor method to assign float value to inputOutput SFFloat field named refraction.
    AcousticProperties setSpecular​(float newValue)
    Accessor method to assign float value to inputOutput SFFloat field named specular.

  • Method Details

    • getAbsorption

      float getAbsorption()
      Provide float value within allowed range of [0,1] from inputOutput SFFloat field named absorption.

      Tooltip: [0,1] specifies the sound absorption coefficient of a surface, meaning the ratio of sound intensity not reflected by a surface. *
      Returns:
      value of absorption field

    • setAbsorption

      AcousticProperties setAbsorption​(float newValue)
      Accessor method to assign float value to inputOutput SFFloat field named absorption.

      Tooltip: [0,1] specifies the sound absorption coefficient of a surface, meaning the ratio of sound intensity not reflected by a surface. *
      Parameters:
      newValue - is new value for the absorption field.
      Returns:
      AcousticProperties - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • getDescription

      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).
      Returns:
      value of description field

    • setDescription

      AcousticProperties 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).
      Parameters:
      newValue - is new value for the description field.
      Returns:
      AcousticProperties - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • getDiffuse

      float getDiffuse()
      Provide float value within allowed range of [0,1] from inputOutput SFFloat field named diffuse.

      Tooltip: [0,1] diffuse coefficient of sound reflection indicuating how mutch of incident sound energy is reflected back in multiple directions. *
      Returns:
      value of diffuse field

    • setDiffuse

      AcousticProperties setDiffuse​(float newValue)
      Accessor method to assign float value to inputOutput SFFloat field named diffuse.

      Tooltip: [0,1] diffuse coefficient of sound reflection indicuating how mutch of incident sound energy is reflected back in multiple directions. *
      Parameters:
      newValue - is new value for the diffuse field.
      Returns:
      AcousticProperties - 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.

      Tooltip: Enables/disables node operation. *
      Returns:
      value of enabled field

    • setEnabled

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

      Tooltip: Enables/disables node operation. *
      Parameters:
      newValue - is new value for the enabled field.
      Returns:
      AcousticProperties - 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 X3DAppearanceChildNode
      Specified by:
      getMetadata in interface X3DNode
      Returns:
      value of metadata field
      See Also:
      X3D Scene Authoring Hints: Metadata Nodes

    • setMetadata

      AcousticProperties 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 X3DAppearanceChildNode
      Specified by:
      setMetadata in interface X3DNode
      Parameters:
      newValue - is new value for the metadata field.
      Returns:
      AcousticProperties - 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

    • getRefraction

      float getRefraction()
      Provide float value within allowed range of [0,1] from inputOutput SFFloat field named refraction.

      Tooltip: [0,1] sound refraction coefficient of a medium, which determines change in propagation direction of sound wave when obliquely crossing boundary between two mediums where its speed is different.
      Returns:
      value of refraction field

    • setRefraction

      AcousticProperties setRefraction​(float newValue)
      Accessor method to assign float value to inputOutput SFFloat field named refraction.

      Tooltip: [0,1] sound refraction coefficient of a medium, which determines change in propagation direction of sound wave when obliquely crossing boundary between two mediums where its speed is different.
      Parameters:
      newValue - is new value for the refraction field.
      Returns:
      AcousticProperties - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • getSpecular

      float getSpecular()
      Provide float value within allowed range of [0,1] from inputOutput SFFloat field named specular.

      Tooltip: [0,1] specular coefficient of sound reflection striking a plane surface, directly reflected back into space, where angle of reflection equals angle of incidence. *
      Returns:
      value of specular field

    • setSpecular

      AcousticProperties setSpecular​(float newValue)
      Accessor method to assign float value to inputOutput SFFloat field named specular.

      Tooltip: [0,1] specular coefficient of sound reflection striking a plane surface, directly reflected back into space, where angle of reflection equals angle of incidence. *
      Parameters:
      newValue - is new value for the specular field.
      Returns:
      AcousticProperties - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).