Class SoundObject

java.lang.Object
All Implemented Interfaces:
X3DChildNode, X3DNode, Sound, X3DSoundNode

public class SoundObject
extends X3DConcreteNode
implements Sound
The Sound node controls the 3D spatialization of sound playback by a child AudioClip or MovieTexture node.

X3D node tooltip: [X3DSoundNode] The Sound node controls the 3D spatialization of sound playback by a child AudioClip or MovieTexture node. Sound intensity includes stereo support, varying according to user location and view direction in the scene.
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: Sound, X3D Tooltips: Sound, X3D Scene Authoring Hints: Audio
  • Field Details

  • Constructor Details

    • SoundObject

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

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

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

      public float[] getDirection()
      Provide array of 3-tuple float results from inputOutput SFVec3f field named direction.

      Tooltip: direction of sound axis, relative to local coordinate system. *
      Specified by:
      getDirection in interface Sound
      Returns:
      value of direction field
    • setDirection

      public SoundObject setDirection​(float[] newValue)
      Accessor method to assign 3-tuple float array to inputOutput SFVec3f field named direction.

      Tooltip: direction of sound axis, relative to local coordinate system. *
      Specified by:
      setDirection in interface Sound
      Parameters:
      newValue - is new value for the direction field.
      Returns:
      SoundObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setDirection

      public SoundObject setDirection​(SFVec3fObject newValue)
      Assign typed object value to SFVec3f direction field, similar to setDirection(float[]).
      Parameters:
      newValue - is new value for the direction field.
      Returns:
      SoundObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setDirection

      public SoundObject setDirection​(float x, float y, float z)
      Assign values to SFVec3f direction field, similar to setDirection(float[]).
      Parameters:
      x - first component
      y - second component
      z - third component
      Returns:
      SoundObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setDirection

      public SoundObject setDirection​(double x, double y, double z)
      Utility method: double-precision set-parameters accessor for X3D floating-point type, similar to setDirection(float[]).
      Parameters:
      x - first component
      y - second component
      z - third component
      Returns:
      SoundObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setDirection

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

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

      Tooltip: Factor [0,1] adjusting loudness (decibels) of emitted sound. *
      Specified by:
      getIntensity in interface Sound
      Returns:
      value of intensity field
    • setIntensity

      public SoundObject setIntensity​(float newValue)
      Accessor method to assign float value to inputOutput SFFloat field named intensity.

      Tooltip: Factor [0,1] adjusting loudness (decibels) of emitted sound. *
      Specified by:
      setIntensity in interface Sound
      Parameters:
      newValue - is new value for the intensity field.
      Returns:
      SoundObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setIntensity

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

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

      public ISObject getIS()
      Provide ISObject 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 SoundObject setIS​(ISObject newValue)
      Accessor method to assign ISObject 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:
      SoundObject - 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 SoundObject clearIS()
      Utility method to clear SFNode value of IS field.
      Returns:
      SoundObject - 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()
    • getLocation

      public float[] getLocation()
      Provide array of 3-tuple float results from inputOutput SFVec3f field named location.

      Tooltip: Position of sound ellipsoid center, relative to local coordinate system.
      • Hint: improve audibility by setting location='0 1.6 0' so that center height of sound ellipsoid matches typical NavigationInfo avatarSize height.
      Specified by:
      getLocation in interface Sound
      Returns:
      value of location field
    • setLocation

      public SoundObject setLocation​(float[] newValue)
      Accessor method to assign 3-tuple float array to inputOutput SFVec3f field named location.

      Tooltip: Position of sound ellipsoid center, relative to local coordinate system.
      • Hint: improve audibility by setting location='0 1.6 0' so that center height of sound ellipsoid matches typical NavigationInfo avatarSize height.
      Specified by:
      setLocation in interface Sound
      Parameters:
      newValue - is new value for the location field.
      Returns:
      SoundObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setLocation

      public SoundObject setLocation​(SFVec3fObject newValue)
      Assign typed object value to SFVec3f location field, similar to setLocation(float[]).
      Parameters:
      newValue - is new value for the location field.
      Returns:
      SoundObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setLocation

      public SoundObject setLocation​(float x, float y, float z)
      Assign values to SFVec3f location field, similar to setLocation(float[]).
      Parameters:
      x - first component
      y - second component
      z - third component
      Returns:
      SoundObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setLocation

      public SoundObject setLocation​(double x, double y, double z)
      Utility method: double-precision set-parameters accessor for X3D floating-point type, similar to setLocation(float[]).
      Parameters:
      x - first component
      y - second component
      z - third component
      Returns:
      SoundObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setLocation

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

      public float getMaxBack()
      Provide float value within allowed range of [0,infinity) from inputOutput SFFloat field named maxBack.

      Tooltip: Outer (zero loudness)ellipsoid distance along back direction.
      • Warning: ensure minBack <= maxBack.
      Specified by:
      getMaxBack in interface Sound
      Returns:
      value of maxBack field
    • setMaxBack

      public SoundObject setMaxBack​(float newValue)
      Accessor method to assign float value to inputOutput SFFloat field named maxBack.

      Tooltip: Outer (zero loudness)ellipsoid distance along back direction.
      • Warning: ensure minBack <= maxBack.
      Specified by:
      setMaxBack in interface Sound
      Parameters:
      newValue - is new value for the maxBack field.
      Returns:
      SoundObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setMaxBack

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

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

      public float getMaxFront()
      Provide float value within allowed range of [0,infinity) from inputOutput SFFloat field named maxFront.

      Tooltip: Outer (zero loudness)ellipsoid distance along front direction.
      • Warning: ensure minFront <= maxFront.
      Specified by:
      getMaxFront in interface Sound
      Returns:
      value of maxFront field
    • setMaxFront

      public SoundObject setMaxFront​(float newValue)
      Accessor method to assign float value to inputOutput SFFloat field named maxFront.

      Tooltip: Outer (zero loudness)ellipsoid distance along front direction.
      • Warning: ensure minFront <= maxFront.
      Specified by:
      setMaxFront in interface Sound
      Parameters:
      newValue - is new value for the maxFront field.
      Returns:
      SoundObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setMaxFront

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

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

      public X3DMetadataObject getMetadata()
      Provide X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
      Specified by:
      getMetadata in interface Sound
      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:
      getMetadataProtoInstance(), X3D Scene Authoring Hints: Metadata Nodes
    • setMetadata

      public SoundObject setMetadata​(X3DMetadataObject newValue)
      Accessor method to assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
      Specified by:
      setMetadata in interface Sound
      Specified by:
      setMetadata in interface X3DChildNode
      Specified by:
      setMetadata in interface X3DNode
      Specified by:
      setMetadata in interface X3DSoundNode
      Specified by:
      setMetadata in class X3DConcreteNode
      Parameters:
      newValue - is new value for the metadata field.
      Returns:
      SoundObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:
      setMetadata(ProtoInstanceObject), X3D Scene Authoring Hints: Metadata Nodes
    • clearMetadata

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

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

      public float getMinBack()
      Provide float value within allowed range of [0,infinity) from inputOutput SFFloat field named minBack.

      Tooltip: Inner (full loudness) ellipsoid distance along back direction.
      • Warning: ensure minBack <= maxBack.
      Specified by:
      getMinBack in interface Sound
      Returns:
      value of minBack field
    • setMinBack

      public SoundObject setMinBack​(float newValue)
      Accessor method to assign float value to inputOutput SFFloat field named minBack.

      Tooltip: Inner (full loudness) ellipsoid distance along back direction.
      • Warning: ensure minBack <= maxBack.
      Specified by:
      setMinBack in interface Sound
      Parameters:
      newValue - is new value for the minBack field.
      Returns:
      SoundObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setMinBack

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

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

      public float getMinFront()
      Provide float value within allowed range of [0,infinity) from inputOutput SFFloat field named minFront.

      Tooltip: Inner (full loudness) ellipsoid distance along front direction.
      • Warning: ensure minFront <= maxFront.
      Specified by:
      getMinFront in interface Sound
      Returns:
      value of minFront field
    • setMinFront

      public SoundObject setMinFront​(float newValue)
      Accessor method to assign float value to inputOutput SFFloat field named minFront.

      Tooltip: Inner (full loudness) ellipsoid distance along front direction.
      • Warning: ensure minFront <= maxFront.
      Specified by:
      setMinFront in interface Sound
      Parameters:
      newValue - is new value for the minFront field.
      Returns:
      SoundObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setMinFront

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

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

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

      Tooltip: Player hint [0,1] if needed to choose which sounds to play. *
      Specified by:
      getPriority in interface Sound
      Returns:
      value of priority field
    • setPriority

      public SoundObject setPriority​(float newValue)
      Accessor method to assign float value to inputOutput SFFloat field named priority.

      Tooltip: Player hint [0,1] if needed to choose which sounds to play. *
      Specified by:
      setPriority in interface Sound
      Parameters:
      newValue - is new value for the priority field.
      Returns:
      SoundObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setPriority

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

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

      public X3DSoundSourceNode getSource()
      Provide X3DSoundSourceNode instance (using a properly typed node) from inputOutput SFNode field source.
      Specified by:
      getSource in interface Sound
      Returns:
      value of source field
      See Also:
      Tooltip: [X3DSoundSourceNode] sound source for the Sound node, either an AudioClip node or a MovieTexture node. Warning: if source field is not specified, the Sound node does not emit audio.
    • setSource

      public SoundObject setSource​(X3DSoundSourceNode newValue)
      Accessor method to assign X3DSoundSourceNode instance (using a properly typed node) to inputOutput SFNode field source.
      Specified by:
      setSource in interface Sound
      Parameters:
      newValue - is new value for the source field.
      Returns:
      SoundObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:
      Tooltip: [X3DSoundSourceNode] sound source for the Sound node, either an AudioClip node or a MovieTexture node. Warning: if source field is not specified, the Sound node does not emit audio.
    • clearSource

      public SoundObject clearSource()
      Utility method to clear SFNode value of source field.
      Returns:
      SoundObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
    • setSource

      public SoundObject setSource​(ProtoInstanceObject newValue)
      Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field source.
      Parameters:
      newValue - is new value for the source field.
      Returns:
      SoundObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:
      setSource(X3DSoundSourceNode)
    • hasSource

      public boolean hasSource()
      Indicate whether an object is available for inputOutput SFNode field source.
      Returns:
      whether a properly typed node or ProtoInstance or CommentsBlock is available.
      See Also:
      getSource(), getSourceProtoInstance()
    • getSpatialize

      public boolean getSpatialize()
      Provide boolean value from initializeOnly SFBool field named spatialize.

      Tooltip: Whether to spatialize sound playback relative to viewer.
      • Hint: only effective between minimum and maximum ellipsoids.
      Specified by:
      getSpatialize in interface Sound
      Returns:
      value of spatialize field
    • setSpatialize

      public SoundObject setSpatialize​(boolean newValue)
      Accessor method to assign boolean value to initializeOnly SFBool field named spatialize.

      Tooltip: Whether to spatialize sound playback relative to viewer.
      • Hint: only effective between minimum and maximum ellipsoids.
      Specified by:
      setSpatialize in interface Sound
      Parameters:
      newValue - is new value for the spatialize field.
      Returns:
      SoundObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setSpatialize

      public SoundObject setSpatialize​(SFBoolObject newValue)
      Assign typed object value to SFBool spatialize field, similar to setSpatialize(boolean).
      Parameters:
      newValue - is new value for the spatialize field.
      Returns:
      SoundObject - 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 SoundObject 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:
      SoundObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setDEF

      public SoundObject setDEF​(SFStringObject newValue)
      Assign typed object value to SFString DEF field, similar to setDEF(String).
      Parameters:
      newValue - is new value for the DEF field.
      Returns:
      SoundObject - 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 SoundObject 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:
      SoundObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setUSE

      public SoundObject setUSE​(SFStringObject newValue)
      Assign typed object value to SFString USE field, similar to setUSE(String).
      Parameters:
      newValue - is new value for the USE field.
      Returns:
      SoundObject - 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 CSS cascading stylesheets.
      • Warning: currently the class attribute is only supported in XML encoding of X3D scenes.
      • Hint: W3C Cascading Style Sheets https://www.w3.org/Style/CSS
      Overrides:
      getCssClass in class X3DConcreteNode
      Returns:
      value of class field
      See Also:
      W3C Cascading Style Sheets
    • setCssClass

      public final SoundObject 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 CSS cascading stylesheets.
      • Warning: currently the class attribute is only supported in XML encoding of X3D scenes.
      • Hint: W3C Cascading Style Sheets https://www.w3.org/Style/CSS
      Specified by:
      setCssClass in class X3DConcreteNode
      Parameters:
      newValue - is new value for the class field.
      Returns:
      SoundObject - 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 SoundObject setCssClass​(SFStringObject newValue)
      Assign typed object value to SFString cssClass field, similar to setCssClass(String).
      Parameters:
      newValue - is new value for the class field.
      Returns:
      SoundObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setUSE

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

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

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

      public SoundObject addComments​(CommentsBlock newCommentsBlock)
      Add CommentsBlock to contained commentsList.
      Specified by:
      addComments in class X3DConcreteElement
      Parameters:
      newCommentsBlock - block of comments to add
      Returns:
      SoundObject - 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:
      X3DObject.FILE_EXTENSION_X3D, X3DObject.FILE_EXTENSION_XML, X3DObject.toStringXML(), X3DObject.toFileXML(String), X3DObject.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:
      X3DObject.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:
      X3DObject.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 findAncestorSceneObject() to check entire scene graph, or findAncestorX3DObject() 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.hasAncestorSceneObject(), X3DConcreteElement.findAncestorX3DObject()
    • 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 findAncestorSceneObject() to check entire scene graph, or findAncestorX3DObject() 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.hasAncestorSceneObject(), X3DConcreteElement.findAncestorX3DObject()
    • 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 findAncestorSceneObject() to check entire scene graph, or findAncestorX3DObject() 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.hasAncestorSceneObject(), X3DConcreteElement.findAncestorX3DObject()
    • 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)