Class AudioClipObject

    • Field Detail

      • NAME

        public static final java.lang.String NAME
        String constant NAME provides name of this element: AudioClip.
        See Also:
        Constant Field Values
      • COMPONENT

        public static final java.lang.String COMPONENT
        String constant COMPONENT defines X3D component for the AudioClip element: Sound
        See Also:
        Constant Field Values
      • LEVEL

        public static final int LEVEL
        Integer constant LEVEL provides default X3D Sound component level for this element: 1
        See Also:
        Constant Field Values
      • DESCRIPTION_DEFAULT_VALUE

        public static final java.lang.String DESCRIPTION_DEFAULT_VALUE
        SFString field named description has default value equal to an empty string.
        See Also:
        Constant Field Values
      • IS_DEFAULT_VALUE

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

        public static final boolean LOOP_DEFAULT_VALUE
        SFBool field named loop has default value false (Java syntax) or false (XML syntax).
        See Also:
        Constant Field Values
      • METADATA_DEFAULT_VALUE

        public static final X3DMetadataObject METADATA_DEFAULT_VALUE
        SFNode field named metadata has default value null (Java syntax) or NULL (XML syntax).
      • 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:
        Constant Field Values
      • PITCH_DEFAULT_VALUE

        public static final float PITCH_DEFAULT_VALUE
        SFFloat field named pitch has default value 1.0f (Java syntax) or 1.0 (XML syntax).
        See Also:
        Constant Field Values
      • 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:
        Constant Field Values
      • 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:
        Constant Field Values
      • 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:
        Constant Field Values
      • URL_DEFAULT_VALUE

        public static final java.util.ArrayList<java.lang.String> URL_DEFAULT_VALUE
        MFString field named url has default value equal to an empty list.
      • fromField_DESCRIPTION

        public static final java.lang.String fromField_DESCRIPTION
        fromField ROUTE name for SFString field named description.
        See Also:
        Constant Field Values
      • toField_DESCRIPTION

        public static final java.lang.String toField_DESCRIPTION
        toField ROUTE name for SFString field named description.
        See Also:
        Constant Field Values
      • fromField_DURATION_CHANGED

        public static final java.lang.String fromField_DURATION_CHANGED
        fromField ROUTE name for SFTime field named duration_changed.
        See Also:
        Constant Field Values
      • fromField_ELAPSEDTIME

        public static final java.lang.String fromField_ELAPSEDTIME
        fromField ROUTE name for SFTime field named elapsedTime.
        See Also:
        Constant Field Values
      • fromField_IS

        public static final java.lang.String fromField_IS
        fromField ROUTE name for SFNode field named IS.
        See Also:
        Constant Field Values
      • fromField_ISACTIVE

        public static final java.lang.String fromField_ISACTIVE
        fromField ROUTE name for SFBool field named isActive.
        See Also:
        Constant Field Values
      • fromField_ISPAUSED

        public static final java.lang.String fromField_ISPAUSED
        fromField ROUTE name for SFBool field named isPaused.
        See Also:
        Constant Field Values
      • fromField_LOOP

        public static final java.lang.String fromField_LOOP
        fromField ROUTE name for SFBool field named loop.
        See Also:
        Constant Field Values
      • toField_LOOP

        public static final java.lang.String toField_LOOP
        toField ROUTE name for SFBool field named loop.
        See Also:
        Constant Field Values
      • fromField_METADATA

        public static final java.lang.String fromField_METADATA
        fromField ROUTE name for SFNode field named metadata.
        See Also:
        Constant Field Values
      • toField_METADATA

        public static final java.lang.String toField_METADATA
        toField ROUTE name for SFNode field named metadata.
        See Also:
        Constant Field Values
      • fromField_PAUSETIME

        public static final java.lang.String fromField_PAUSETIME
        fromField ROUTE name for SFTime field named pauseTime.
        See Also:
        Constant Field Values
      • toField_PAUSETIME

        public static final java.lang.String toField_PAUSETIME
        toField ROUTE name for SFTime field named pauseTime.
        See Also:
        Constant Field Values
      • fromField_PITCH

        public static final java.lang.String fromField_PITCH
        fromField ROUTE name for SFFloat field named pitch.
        See Also:
        Constant Field Values
      • toField_PITCH

        public static final java.lang.String toField_PITCH
        toField ROUTE name for SFFloat field named pitch.
        See Also:
        Constant Field Values
      • fromField_RESUMETIME

        public static final java.lang.String fromField_RESUMETIME
        fromField ROUTE name for SFTime field named resumeTime.
        See Also:
        Constant Field Values
      • toField_RESUMETIME

        public static final java.lang.String toField_RESUMETIME
        toField ROUTE name for SFTime field named resumeTime.
        See Also:
        Constant Field Values
      • fromField_STARTTIME

        public static final java.lang.String fromField_STARTTIME
        fromField ROUTE name for SFTime field named startTime.
        See Also:
        Constant Field Values
      • toField_STARTTIME

        public static final java.lang.String toField_STARTTIME
        toField ROUTE name for SFTime field named startTime.
        See Also:
        Constant Field Values
      • fromField_STOPTIME

        public static final java.lang.String fromField_STOPTIME
        fromField ROUTE name for SFTime field named stopTime.
        See Also:
        Constant Field Values
      • toField_STOPTIME

        public static final java.lang.String toField_STOPTIME
        toField ROUTE name for SFTime field named stopTime.
        See Also:
        Constant Field Values
      • fromField_URL

        public static final java.lang.String fromField_URL
        fromField ROUTE name for MFString field named url.
        See Also:
        Constant Field Values
      • toField_URL

        public static final java.lang.String toField_URL
        toField ROUTE name for MFString field named url.
        See Also:
        Constant Field Values
    • Constructor Detail

      • AudioClipObject

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

        public AudioClipObject​(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 Detail

      • getElementName

        public final java.lang.String getElementName()
        Provides name of this element: AudioClip
        Specified by:
        getElementName in class X3DConcreteElement
        Returns:
        name of this element
      • getComponent

        public final java.lang.String getComponent()
        Defines X3D component for the AudioClip 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
      • initialize

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

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

        Tooltip: Author-provided text tooltip that tells users the expected action of this node.
        • 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 AudioClip
        Specified by:
        getDescription in interface X3DSoundSourceNode
        Returns:
        value of description field
      • setDescription

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

        Tooltip: Author-provided text tooltip that tells users the expected action of this node.
        • 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 AudioClip
        Specified by:
        setDescription in interface X3DSoundSourceNode
        Parameters:
        newValue - is new value for the description field.
        Returns:
        AudioClipObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • setDescription

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

        public double getDuration()
        Provide double value in seconds within allowed range of [-1,infinity) from outputOnly SFTime field named duration_changed.

        Tooltip: [0,+infinity) or -1. duration_changed is length of time in seconds for one cycle of media stream.
        • Warning: duration value of -1 implies that media data has not yet loaded or is unavailable for some reason.
        • 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: duration_changed is an SFTime duration interval, normally nonnegative, and not an absolute clock time.
        • Hint: changing the pitch field does not trigger a duration_changed event. Playback interval may vary but duration of the original media data remains unmodified.
        Specified by:
        getDuration in interface AudioClip
        Specified by:
        getDuration in interface X3DSoundSourceNode
        Returns:
        value of duration_changed field
      • 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 AudioClip
        Specified by:
        getElapsedTime in interface X3DSoundSourceNode
        Specified by:
        getElapsedTime in interface X3DTimeDependentNode
        Returns:
        value of elapsedTime field
      • clearIS

        public AudioClipObject clearIS()
        Utility method to clear SFNode value of IS field.
        Returns:
        AudioClipObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
      • hasIS

        public boolean hasIS()
        Indicate whether an object is available for inputOutput SFNode field IS.
        Returns:
        whether a concrete statement or CommentsBlock is available.
        See Also:
        getIS()
      • getIsActive

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

        Tooltip: isActive true/false events are sent when playback starts/stops.
        • Warning: it is an error to define this transient outputOnly field in an X3D file, instead only use it a source for ROUTE events.
        Specified by:
        getIsActive in interface AudioClip
        Specified by:
        getIsActive in interface X3DSoundSourceNode
        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 AudioClip
        Specified by:
        getIsPaused in interface X3DSoundSourceNode
        Specified by:
        getIsPaused in interface X3DTimeDependentNode
        Returns:
        value of isPaused field
      • getLoop

        public boolean getLoop()
        Provide boolean value from inputOutput SFBool field named loop.

        Tooltip: repeat indefinitely when loop=true, repeat only once when loop=false. *
        Specified by:
        getLoop in interface AudioClip
        Specified by:
        getLoop in interface X3DSoundSourceNode
        Specified by:
        getLoop in interface X3DTimeDependentNode
        Returns:
        value of loop field
      • setLoop

        public AudioClipObject setLoop​(boolean newValue)
        Accessor method to assign boolean value to inputOutput SFBool field named loop.

        Tooltip: repeat indefinitely when loop=true, repeat only once when loop=false. *
        Specified by:
        setLoop in interface AudioClip
        Specified by:
        setLoop in interface X3DSoundSourceNode
        Specified by:
        setLoop in interface X3DTimeDependentNode
        Parameters:
        newValue - is new value for the loop field.
        Returns:
        AudioClipObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • setLoop

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

        public AudioClipObject clearMetadata()
        Utility method to clear SFNode value of metadata field.
        Returns:
        AudioClipObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
      • 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
      • 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 AudioClip
        Specified by:
        getPauseTime in interface X3DSoundSourceNode
        Specified by:
        getPauseTime in interface X3DTimeDependentNode
        Returns:
        value of pauseTime field
      • setPauseTime

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

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

        public float getPitch()
        Provide float value within allowed range of (0,infinity) from inputOutput SFFloat field named pitch.

        Tooltip: (0,+infinity) Multiplier for the rate at which sampled sound is played. Changing pitch also changes playback speed.
        • Hint: changing the pitch field does not trigger a duration_changed event. Playback interval may vary but duration of the original media data remains unmodified.
        Specified by:
        getPitch in interface AudioClip
        Specified by:
        getPitch in interface X3DSoundSourceNode
        Returns:
        value of pitch field
      • setPitch

        public AudioClipObject setPitch​(float newValue)
        Accessor method to assign float value to inputOutput SFFloat field named pitch.

        Tooltip: (0,+infinity) Multiplier for the rate at which sampled sound is played. Changing pitch also changes playback speed.
        • Hint: changing the pitch field does not trigger a duration_changed event. Playback interval may vary but duration of the original media data remains unmodified.
        Specified by:
        setPitch in interface AudioClip
        Specified by:
        setPitch in interface X3DSoundSourceNode
        Parameters:
        newValue - is new value for the pitch field.
        Returns:
        AudioClipObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • setPitch

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

        public AudioClipObject setPitch​(double newValue)
        Utility method: double-precision set-parameter accessor for X3D floating-point type, similar to setPitch(float).
        Parameters:
        newValue - is new value for field
        Returns:
        AudioClipObject - 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 AudioClip
        Specified by:
        getResumeTime in interface X3DSoundSourceNode
        Specified by:
        getResumeTime in interface X3DTimeDependentNode
        Returns:
        value of resumeTime field
      • setResumeTime

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

        public AudioClipObject setResumeTime​(SFTimeObject newValue)
        Assign typed object value to SFTime resumeTime field, similar to setResumeTime(double).
        Parameters:
        newValue - is new value for the resumeTime field.
        Returns:
        AudioClipObject - 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 AudioClip
        Specified by:
        getStartTime in interface X3DSoundSourceNode
        Specified by:
        getStartTime in interface X3DTimeDependentNode
        Returns:
        value of startTime field
      • setStartTime

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

        public AudioClipObject setStartTime​(SFTimeObject newValue)
        Assign typed object value to SFTime startTime field, similar to setStartTime(double).
        Parameters:
        newValue - is new value for the startTime field.
        Returns:
        AudioClipObject - 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 AudioClip
        Specified by:
        getStopTime in interface X3DSoundSourceNode
        Specified by:
        getStopTime in interface X3DTimeDependentNode
        Returns:
        value of stopTime field
      • setStopTime

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

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

        public java.lang.String[] getUrl()
        Provide array of String results from inputOutput MFString field named url.

        Tooltip: Location and filename of sound file or stream. Support for .wav format is required, .midi format is recommended, other formats are optional.
        • Hint: MFString arrays can have multiple values, so separate each individual string by quote marks. "http://www.web3d.org" "http://www.web3d.org/about" "etc."
        • Hint: alternative XML encoding for quotation mark " is &quot; (which is an example of a character entity).
        • Warning: strictly match directory and filename capitalization for http links! This is important for portability. Some operating systems are forgiving of capitalization mismatches, but http/https url addresses and paths in Unix-based operating systems are all case sensitive and intolerant of uppercase/lowercase mismatches.
        • Hint: can replace embedded blank(s) in url queries with %20 for each blank character.
        • Hint: X3D Scene Authoring Hints, urls http://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#urls
        Specified by:
        getUrl in interface AudioClip
        Specified by:
        getUrl in interface X3DUrlObject
        Returns:
        value of url field
      • getUrlList

        public java.util.ArrayList<java.lang.String> getUrlList()
        Utility method to get ArrayList value of MFString url field, similar to getUrl().
        Returns:
        value of url field
      • setUrl

        public AudioClipObject setUrl​(java.lang.String[] newValue)
        Accessor method to assign String array to inputOutput MFString field named url.

        Tooltip: Location and filename of sound file or stream. Support for .wav format is required, .midi format is recommended, other formats are optional.
        • Hint: MFString arrays can have multiple values, so separate each individual string by quote marks. "http://www.web3d.org" "http://www.web3d.org/about" "etc."
        • Hint: alternative XML encoding for quotation mark " is &quot; (which is an example of a character entity).
        • Warning: strictly match directory and filename capitalization for http links! This is important for portability. Some operating systems are forgiving of capitalization mismatches, but http/https url addresses and paths in Unix-based operating systems are all case sensitive and intolerant of uppercase/lowercase mismatches.
        • Hint: can replace embedded blank(s) in url queries with %20 for each blank character.
        • Hint: X3D Scene Authoring Hints, urls http://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#urls
        Specified by:
        setUrl in interface AudioClip
        Specified by:
        setUrl in interface X3DUrlObject
        Parameters:
        newValue - is new value for the url field.
        Returns:
        AudioClipObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • setUrl

        public AudioClipObject setUrl​(MFStringObject newValue)
        Assign typed object value to MFString url field, similar to setUrl(String[]).
        Parameters:
        newValue - is new value for the url field.
        Returns:
        AudioClipObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • setUrl

        public AudioClipObject setUrl​(SFStringObject newValue)
        Assign single SFString object value to MFString url field, similar to setUrl(String[]).
        Parameters:
        newValue - is new value for the url field.
        Returns:
        AudioClipObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • setUrl

        public AudioClipObject setUrl​(java.lang.String newValue)
        Assign singleton String value to MFString url field, similar to setUrl(String[]).
        Parameters:
        newValue - is new value for the url field.
        Returns:
        AudioClipObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • setUrl

        public AudioClipObject setUrl​(java.util.ArrayList<java.lang.String> newValue)
        Assign ArrayList value of MFString url field, similar to setUrl(String[]).
        Parameters:
        newValue - is new value for the url field.
        Returns:
        AudioClipObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • clearUrl

        public AudioClipObject clearUrl()
        Utility method to clear MFString value of url field.
        Returns:
        AudioClipObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
      • addUrl

        public AudioClipObject addUrl​(java.lang.String newValue)
        Add singleton String value to MFString url field.
        Parameters:
        newValue - is new value to add to the url field.
        Returns:
        AudioClipObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
        See Also:
        MFStringObject.cleanupEnumerationValues(String)
      • setDEF

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

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

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

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

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

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

        public AudioClipObject addComments​(CommentsBlock newCommentsBlock)
        Add CommentsBlock to contained commentsList.
        Specified by:
        addComments in class X3DConcreteElement
        Parameters:
        newCommentsBlock - block of comments to add
        Returns:
        AudioClipObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
      • 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)
      • 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)