Package org.web3d.x3d.jsail.Sound
Class AudioClipObject
java.lang.Object
org.web3d.x3d.jsail.X3DConcreteElement
org.web3d.x3d.jsail.X3DConcreteNode
org.web3d.x3d.jsail.Sound.AudioClipObject
- All Implemented Interfaces:
X3DChildNode
,X3DNode
,X3DUrlObject
,AudioClip
,X3DSoundSourceNode
,X3DTimeDependentNode
public class AudioClipObject extends X3DConcreteNode implements AudioClip
AudioClip provides audio data used by parent Sound nodes.
X3D node tooltip: [X3DSoundSourceNode,X3DUrlObject] AudioClip provides audio data used by parent Sound nodes.
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.
X3D node tooltip: [X3DSoundSourceNode,X3DUrlObject] AudioClip provides audio data used by parent Sound nodes.
- Hint: add a parent Sound node first.
- Hint: utilize DEF/USE references for multiple copies of a single AudioClip sound file in order to avoid multiple-download delays, reduce memory requirements, and maintain synchronization.
- Hint: authors can provide multiple audio formats for the same audio track, with each source address listed separately in the url field.
- Hint: player support for .wav format is required, .midi format is recommended, other formats are optional.
- Hint: X3D Scene Authoring Hints:Audio https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#Audio
- Hint: apply containerField='watchList' when parent node is LoadSensor.
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.
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
COMPONENT
String constant COMPONENT defines X3D component for the AudioClip element: Soundstatic java.lang.String
containerField_DEFAULT_VALUE
containerField describes typical field relationship of a node to its parent.static java.lang.String
DESCRIPTION_DEFAULT_VALUE
SFString field named description has default value equal to an empty string.static java.lang.String
fromField_DESCRIPTION
fromField ROUTE name for SFString field named description.static java.lang.String
fromField_DURATION_CHANGED
fromField ROUTE name for SFTime field named duration_changed.static java.lang.String
fromField_ELAPSEDTIME
fromField ROUTE name for SFTime field named elapsedTime.static java.lang.String
fromField_IS
fromField ROUTE name for SFNode field named IS.static java.lang.String
fromField_ISACTIVE
fromField ROUTE name for SFBool field named isActive.static java.lang.String
fromField_ISPAUSED
fromField ROUTE name for SFBool field named isPaused.static java.lang.String
fromField_LOOP
fromField ROUTE name for SFBool field named loop.static java.lang.String
fromField_METADATA
fromField ROUTE name for SFNode field named metadata.static java.lang.String
fromField_PAUSETIME
fromField ROUTE name for SFTime field named pauseTime.static java.lang.String
fromField_PITCH
fromField ROUTE name for SFFloat field named pitch.static java.lang.String
fromField_RESUMETIME
fromField ROUTE name for SFTime field named resumeTime.static java.lang.String
fromField_STARTTIME
fromField ROUTE name for SFTime field named startTime.static java.lang.String
fromField_STOPTIME
fromField ROUTE name for SFTime field named stopTime.static java.lang.String
fromField_URL
fromField ROUTE name for MFString field named url.static ISObject
IS_DEFAULT_VALUE
SFNode field named IS has default value null (Java syntax) or NULL (XML syntax).static int
LEVEL
Integer constant LEVEL provides default X3D Sound component level for this element: 1static boolean
LOOP_DEFAULT_VALUE
SFBool field named loop has default value false (Java syntax) or false (XML syntax).static X3DMetadataObject
METADATA_DEFAULT_VALUE
SFNode field named metadata has default value null (Java syntax) or NULL (XML syntax).static java.lang.String
NAME
String constant NAME provides name of this element: AudioClip.static double
PAUSETIME_DEFAULT_VALUE
SFTime field named pauseTime has default value 0 (Java syntax) or 0 (XML syntax).static float
PITCH_DEFAULT_VALUE
SFFloat field named pitch has default value 1.0f (Java syntax) or 1.0 (XML syntax).static double
RESUMETIME_DEFAULT_VALUE
SFTime field named resumeTime has default value 0 (Java syntax) or 0 (XML syntax).static double
STARTTIME_DEFAULT_VALUE
SFTime field named startTime has default value 0 (Java syntax) or 0 (XML syntax).static double
STOPTIME_DEFAULT_VALUE
SFTime field named stopTime has default value 0 (Java syntax) or 0 (XML syntax).static java.lang.String
toField_DESCRIPTION
toField ROUTE name for SFString field named description.static java.lang.String
toField_LOOP
toField ROUTE name for SFBool field named loop.static java.lang.String
toField_METADATA
toField ROUTE name for SFNode field named metadata.static java.lang.String
toField_PAUSETIME
toField ROUTE name for SFTime field named pauseTime.static java.lang.String
toField_PITCH
toField ROUTE name for SFFloat field named pitch.static java.lang.String
toField_RESUMETIME
toField ROUTE name for SFTime field named resumeTime.static java.lang.String
toField_STARTTIME
toField ROUTE name for SFTime field named startTime.static java.lang.String
toField_STOPTIME
toField ROUTE name for SFTime field named stopTime.static java.lang.String
toField_URL
toField ROUTE name for MFString field named url.static java.util.ArrayList<java.lang.String>
URL_DEFAULT_VALUE
MFString field named url has default value equal to an empty list.Fields inherited from class org.web3d.x3d.jsail.X3DConcreteNode
CLASS_DEFAULT_VALUE, containerField_ALTERNATE_VALUES, DEF_DEFAULT_VALUE, USE_DEFAULT_VALUE
-
Constructor Summary
Constructors Constructor Description AudioClipObject()
Constructor for AudioClipObject to initialize member variables with default values.AudioClipObject(java.lang.String DEFlabel)
Utility constructor that assigns DEF label after initializing member variables with default values. -
Method Summary
Modifier and Type Method Description AudioClipObject
addComments(java.lang.String newComment)
Add comment as String to contained commentsList.AudioClipObject
addComments(java.lang.String[] newComments)
Add comments as String[] array to contained commentsList.AudioClipObject
addComments(CommentsBlock newCommentsBlock)
Add CommentsBlock to contained commentsList.AudioClipObject
addUrl(java.lang.String newValue)
Add singleton String value to MFString url field.AudioClipObject
addUrl(SFStringObject newValue)
Add singleton SFStringObject value to MFString url field.AudioClipObject
clearIS()
Utility method to clear SFNode value of IS field.AudioClipObject
clearMetadata()
Utility method to clear SFNode value of metadata field.AudioClipObject
clearUrl()
Utility method to clear MFString value of url field.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.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.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.java.lang.String
getAccessType(java.lang.String fieldName)
Indicate accessType corresponding to given fieldName.java.lang.String
getComponent()
Defines X3D component for the AudioClip element: Soundint
getComponentLevel()
Provides default X3D component level for this element: 1java.lang.String
getContainerFieldDefault()
containerField describes typical field relationship of a node to its parent.java.lang.String
getCssClass()
Provide String value from inputOutput SFString field named class.java.lang.String
getDEF()
Provide String value from inputOutput SFString field named DEF.java.lang.String
getDescription()
Provide String value from inputOutput SFString field named description.double
getDuration()
Provide double value in seconds within allowed range of [-1,infinity) from outputOnly SFTime field named duration_changed.double
getElapsedTime()
Provide double value in seconds within allowed range of [0,infinity) from outputOnly SFTime field named elapsedTime.java.lang.String
getElementName()
Provides name of this element: AudioClipjava.lang.String
getFieldType(java.lang.String fieldName)
Indicate type corresponding to given fieldName.ISObject
getIS()
Provide ISObject instance (using a properly typed node) from inputOutput SFNode field IS.boolean
getIsActive()
Provide boolean value from outputOnly SFBool field named isActive.boolean
getIsPaused()
Provide boolean value from outputOnly SFBool field named isPaused.boolean
getLoop()
Provide boolean value from inputOutput SFBool field named loop.X3DMetadataObject
getMetadata()
Provide X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.double
getPauseTime()
Provide double value in seconds from inputOutput SFTime field named pauseTime.float
getPitch()
Provide float value within allowed range of (0,infinity) from inputOutput SFFloat field named pitch.double
getResumeTime()
Provide double value in seconds from inputOutput SFTime field named resumeTime.double
getStartTime()
Provide double value in seconds from inputOutput SFTime field named startTime.double
getStopTime()
Provide double value in seconds from inputOutput SFTime field named stopTime.java.lang.String[]
getUrl()
Provide array of String results from inputOutput MFString field named url.java.util.ArrayList<java.lang.String>
getUrlList()
Utility method to get ArrayList value of MFString url field, similar togetUrl()
.java.lang.String
getUrlString()
Utility method to get String value of MFString url field, similar togetUrl()
.java.lang.String
getUSE()
Provide String value from inputOutput SFString field named USE.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.boolean
hasIS()
Indicate whether an object is available for inputOutput SFNode field IS.boolean
hasMetadata()
Indicate whether an object is available for inputOutput SFNode field metadata.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.void
initialize()
Initialize all member variables to default values.AudioClipObject
setCssClass(java.lang.String newValue)
Accessor method to assign String value to inputOutput SFString field named class.AudioClipObject
setCssClass(SFStringObject newValue)
Assign typed object value to SFString cssClass field, similar tosetCssClass(String)
.AudioClipObject
setDEF(java.lang.String newValue)
Accessor method to assign String value to inputOutput SFString field named DEF.AudioClipObject
setDEF(SFStringObject newValue)
Assign typed object value to SFString DEF field, similar tosetDEF(String)
.AudioClipObject
setDescription(java.lang.String newValue)
Accessor method to assign String value to inputOutput SFString field named description.AudioClipObject
setDescription(SFStringObject newValue)
Assign typed object value to SFString description field, similar tosetDescription(String)
.AudioClipObject
setIS(ISObject newValue)
Accessor method to assign ISObject instance (using a properly typed node) to inputOutput SFNode field IS.AudioClipObject
setLoop(boolean newValue)
Accessor method to assign boolean value to inputOutput SFBool field named loop.AudioClipObject
setLoop(SFBoolObject newValue)
Assign typed object value to SFBool loop field, similar tosetLoop(boolean)
.AudioClipObject
setMetadata(ProtoInstanceObject newValue)
Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field metadata.AudioClipObject
setMetadata(X3DMetadataObject newValue)
Accessor method to assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.AudioClipObject
setPauseTime(double newValue)
Accessor method to assign double value in seconds to inputOutput SFTime field named pauseTime.AudioClipObject
setPauseTime(SFTimeObject newValue)
Assign typed object value to SFTime pauseTime field, similar tosetPauseTime(double)
.AudioClipObject
setPitch(double newValue)
Utility method: double-precision set-parameter accessor for X3D floating-point type, similar tosetPitch(float)
.AudioClipObject
setPitch(float newValue)
Accessor method to assign float value to inputOutput SFFloat field named pitch.AudioClipObject
setPitch(SFFloatObject newValue)
Assign typed object value to SFFloat pitch field, similar tosetPitch(float)
.AudioClipObject
setResumeTime(double newValue)
Accessor method to assign double value in seconds to inputOutput SFTime field named resumeTime.AudioClipObject
setResumeTime(SFTimeObject newValue)
Assign typed object value to SFTime resumeTime field, similar tosetResumeTime(double)
.AudioClipObject
setStartTime(double newValue)
Accessor method to assign double value in seconds to inputOutput SFTime field named startTime.AudioClipObject
setStartTime(SFTimeObject newValue)
Assign typed object value to SFTime startTime field, similar tosetStartTime(double)
.AudioClipObject
setStopTime(double newValue)
Accessor method to assign double value in seconds to inputOutput SFTime field named stopTime.AudioClipObject
setStopTime(SFTimeObject newValue)
Assign typed object value to SFTime stopTime field, similar tosetStopTime(double)
.AudioClipObject
setUrl(java.lang.String newValue)
Assign singleton String value to MFString url field, similar tosetUrl(String[])
.AudioClipObject
setUrl(java.lang.String[] newValue)
Accessor method to assign String array to inputOutput MFString field named url.AudioClipObject
setUrl(java.util.ArrayList<java.lang.String> newValue)
Assign ArrayList value of MFString url field, similar tosetUrl(String[])
.AudioClipObject
setUrl(MFStringObject newValue)
Assign typed object value to MFString url field, similar tosetUrl(String[])
.AudioClipObject
setUrl(SFStringObject newValue)
Assign single SFString object value to MFString url field, similar tosetUrl(String[])
.AudioClipObject
setUSE(java.lang.String newValue)
Accessor method to assign String value to inputOutput SFString field named USE.AudioClipObject
setUSE(SFStringObject newValue)
Assign typed object value to SFString USE field, similar tosetUSE(String)
.AudioClipObject
setUSE(AudioClipObject DEFnode)
Assign a USE reference to another DEF node of same node type, similar tosetUSE(String)
.java.lang.String
toStringClassicVRML(int indentLevel)
Recursive method to provide ClassicVRML string serialization.java.lang.String
toStringVRML97(int indentLevel)
Recursive method to provide VRML97 string serialization.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.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.Methods inherited from class org.web3d.x3d.jsail.X3DConcreteNode
getContainerFieldAlternateValues, getContainerFieldOverride, isNode, isStatement, isUSE, resetContainerFieldOverride, setConcreteCssClass, setConcreteDEF, setConcreteUSE, setContainerFieldOverride
Methods inherited from class org.web3d.x3d.jsail.X3DConcreteElement
clearParentObject, findAncestorElementByName, findAncestorProtoBody, findAncestorSceneObject, findAncestorX3DObject, getPackageName, getParentObject, getValidationResult, hasAncestorElementByName, hasAncestorProtoBody, hasAncestorSceneObject, hasAncestorX3DObject, hasParentObject, isValid, setParentObject, toStringClassicVRML, toStringVRML97, toStringX3D
-
Field Details
-
NAME
public static final java.lang.String NAMEString constant NAME provides name of this element: AudioClip.- See Also:
- Constant Field Values
-
COMPONENT
public static final java.lang.String COMPONENTString constant COMPONENT defines X3D component for the AudioClip element: Sound- See Also:
- Constant Field Values
-
LEVEL
public static final int LEVELInteger 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_VALUESFString field named description has default value equal to an empty string.- See Also:
- Constant Field Values
-
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_VALUESFBool field named loop has default value false (Java syntax) or false (XML syntax).- See Also:
- Constant Field Values
-
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_VALUESFTime 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_VALUESFFloat 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_VALUESFTime 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_VALUESFTime 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_VALUESFTime 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_VALUEMFString field named url has default value equal to an empty list. -
containerField_DEFAULT_VALUE
public static final java.lang.String containerField_DEFAULT_VALUEcontainerField 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. -
fromField_DESCRIPTION
public static final java.lang.String fromField_DESCRIPTIONfromField ROUTE name for SFString field named description.- See Also:
- Constant Field Values
-
toField_DESCRIPTION
public static final java.lang.String toField_DESCRIPTIONtoField ROUTE name for SFString field named description.- See Also:
- Constant Field Values
-
fromField_DURATION_CHANGED
public static final java.lang.String fromField_DURATION_CHANGEDfromField ROUTE name for SFTime field named duration_changed.- See Also:
- Constant Field Values
-
fromField_ELAPSEDTIME
public static final java.lang.String fromField_ELAPSEDTIMEfromField ROUTE name for SFTime field named elapsedTime.- See Also:
- Constant Field Values
-
fromField_IS
public static final java.lang.String fromField_ISfromField ROUTE name for SFNode field named IS.- See Also:
- Constant Field Values
-
fromField_ISACTIVE
public static final java.lang.String fromField_ISACTIVEfromField ROUTE name for SFBool field named isActive.- See Also:
- Constant Field Values
-
fromField_ISPAUSED
public static final java.lang.String fromField_ISPAUSEDfromField ROUTE name for SFBool field named isPaused.- See Also:
- Constant Field Values
-
fromField_LOOP
public static final java.lang.String fromField_LOOPfromField ROUTE name for SFBool field named loop.- See Also:
- Constant Field Values
-
toField_LOOP
public static final java.lang.String toField_LOOPtoField ROUTE name for SFBool field named loop.- See Also:
- Constant Field Values
-
fromField_METADATA
public static final java.lang.String fromField_METADATAfromField ROUTE name for SFNode field named metadata.- See Also:
- Constant Field Values
-
toField_METADATA
public static final java.lang.String toField_METADATAtoField ROUTE name for SFNode field named metadata.- See Also:
- Constant Field Values
-
fromField_PAUSETIME
public static final java.lang.String fromField_PAUSETIMEfromField ROUTE name for SFTime field named pauseTime.- See Also:
- Constant Field Values
-
toField_PAUSETIME
public static final java.lang.String toField_PAUSETIMEtoField ROUTE name for SFTime field named pauseTime.- See Also:
- Constant Field Values
-
fromField_PITCH
public static final java.lang.String fromField_PITCHfromField ROUTE name for SFFloat field named pitch.- See Also:
- Constant Field Values
-
toField_PITCH
public static final java.lang.String toField_PITCHtoField ROUTE name for SFFloat field named pitch.- See Also:
- Constant Field Values
-
fromField_RESUMETIME
public static final java.lang.String fromField_RESUMETIMEfromField ROUTE name for SFTime field named resumeTime.- See Also:
- Constant Field Values
-
toField_RESUMETIME
public static final java.lang.String toField_RESUMETIMEtoField ROUTE name for SFTime field named resumeTime.- See Also:
- Constant Field Values
-
fromField_STARTTIME
public static final java.lang.String fromField_STARTTIMEfromField ROUTE name for SFTime field named startTime.- See Also:
- Constant Field Values
-
toField_STARTTIME
public static final java.lang.String toField_STARTTIMEtoField ROUTE name for SFTime field named startTime.- See Also:
- Constant Field Values
-
fromField_STOPTIME
public static final java.lang.String fromField_STOPTIMEfromField ROUTE name for SFTime field named stopTime.- See Also:
- Constant Field Values
-
toField_STOPTIME
public static final java.lang.String toField_STOPTIMEtoField ROUTE name for SFTime field named stopTime.- See Also:
- Constant Field Values
-
fromField_URL
public static final java.lang.String fromField_URLfromField ROUTE name for MFString field named url.- See Also:
- Constant Field Values
-
toField_URL
public static final java.lang.String toField_URLtoField ROUTE name for MFString field named url.- See Also:
- Constant Field Values
-
-
Constructor Details
-
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 Details
-
getElementName
public final java.lang.String getElementName()Provides name of this element: AudioClip- Specified by:
getElementName
in classX3DConcreteElement
- Returns:
- name of this element
-
getComponent
public final java.lang.String getComponent()Defines X3D component for the AudioClip element: Sound- Specified by:
getComponent
in classX3DConcreteElement
- Returns:
- X3D component for this element
-
getComponentLevel
public final int getComponentLevel()Provides default X3D component level for this element: 1- Specified by:
getComponentLevel
in classX3DConcreteElement
- 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 classX3DConcreteElement
- 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 classX3DConcreteElement
- 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 classX3DConcreteNode
- 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 classX3DConcreteNode
-
getDescription
public java.lang.String getDescription()Provide String value from inputOutput SFString field named description.
Tooltip: Author-provided prose that describes intended purpose of this node.- Hint: many XML tools substitute XML character references for special characters automatically if needed within an attribute value (such as & for & ampersand character, or " for " quotation-mark character).
- Specified by:
getDescription
in interfaceAudioClip
- Specified by:
getDescription
in interfaceX3DSoundSourceNode
- Returns:
- value of description field
-
setDescription
Accessor method to assign String value to inputOutput SFString field named description.
Tooltip: Author-provided prose that describes intended purpose of this node.- Hint: many XML tools substitute XML character references for special characters automatically if needed within an attribute value (such as & for & ampersand character, or " for " quotation-mark character).
- Specified by:
setDescription
in interfaceAudioClip
- Specified by:
setDescription
in interfaceX3DSoundSourceNode
- 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
Assign typed object value to SFString description field, similar tosetDescription(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 interfaceAudioClip
- Specified by:
getDuration
in interfaceX3DSoundSourceNode
- 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 interfaceAudioClip
- Specified by:
getElapsedTime
in interfaceX3DSoundSourceNode
- Specified by:
getElapsedTime
in interfaceX3DTimeDependentNode
- Returns:
- value of elapsedTime field
-
getIS
Provide ISObject instance (using a properly typed node) from inputOutput SFNode field IS.- Specified by:
getIS
in classX3DConcreteNode
- Returns:
- value of IS field
- See Also:
- X3D Tooltips: IS, X3D Tooltips: connect
-
setIS
Accessor method to assign ISObject instance (using a properly typed node) to inputOutput SFNode field IS.- Specified by:
setIS
in classX3DConcreteNode
- Parameters:
newValue
- is new value for the IS field.- Returns:
AudioClipObject
- 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
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 interfaceAudioClip
- Specified by:
getIsActive
in interfaceX3DSoundSourceNode
- Specified by:
getIsActive
in interfaceX3DTimeDependentNode
- 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 interfaceAudioClip
- Specified by:
getIsPaused
in interfaceX3DSoundSourceNode
- Specified by:
getIsPaused
in interfaceX3DTimeDependentNode
- 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 interfaceAudioClip
- Specified by:
getLoop
in interfaceX3DSoundSourceNode
- Specified by:
getLoop
in interfaceX3DTimeDependentNode
- Returns:
- value of loop field
-
setLoop
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 interfaceAudioClip
- Specified by:
setLoop
in interfaceX3DSoundSourceNode
- Specified by:
setLoop
in interfaceX3DTimeDependentNode
- 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
Assign typed object value to SFBool loop field, similar tosetLoop(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).
-
getMetadata
Provide X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.- Specified by:
getMetadata
in interfaceAudioClip
- Specified by:
getMetadata
in interfaceX3DChildNode
- Specified by:
getMetadata
in interfaceX3DNode
- Specified by:
getMetadata
in interfaceX3DSoundSourceNode
- Specified by:
getMetadata
in interfaceX3DTimeDependentNode
- Returns:
- value of metadata field
- See Also:
Tooltip: [X3DMetadataObject] Information about this node can be contained in a MetadataBoolean, MetadataDouble, MetadataFloat, MetadataInteger, MetadataString or MetadataSet node. Hint: X3D Architecture 7.2.4 Metadata https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/core.html#Metadata
, X3D Scene Authoring Hints: Metadata Nodes
-
setMetadata
Accessor method to assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.- Specified by:
setMetadata
in interfaceAudioClip
- Specified by:
setMetadata
in interfaceX3DChildNode
- Specified by:
setMetadata
in interfaceX3DNode
- Specified by:
setMetadata
in interfaceX3DSoundSourceNode
- Specified by:
setMetadata
in interfaceX3DTimeDependentNode
- Specified by:
setMetadata
in classX3DConcreteNode
- Parameters:
newValue
- is new value for the metadata field.- Returns:
AudioClipObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
Tooltip: [X3DMetadataObject] Information about this node can be contained in a MetadataBoolean, MetadataDouble, MetadataFloat, MetadataInteger, MetadataString or MetadataSet node. Hint: X3D Architecture 7.2.4 Metadata https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/core.html#Metadata
, X3D Scene Authoring Hints: Metadata Nodes
-
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).
-
setMetadata
Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field metadata.- Specified by:
setMetadata
in classX3DConcreteNode
- Parameters:
newValue
- is new value for the metadata field.- Returns:
AudioClipObject
- 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
-
getPauseTime
public double getPauseTime()Provide double value in seconds from inputOutput SFTime field named pauseTime.
Tooltip: When time now >= 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 interfaceAudioClip
- Specified by:
getPauseTime
in interfaceX3DSoundSourceNode
- Specified by:
getPauseTime
in interfaceX3DTimeDependentNode
- Returns:
- value of pauseTime field
-
setPauseTime
Accessor method to assign double value in seconds to inputOutput SFTime field named pauseTime.
Tooltip: When time now >= 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 interfaceAudioClip
- Specified by:
setPauseTime
in interfaceX3DSoundSourceNode
- Specified by:
setPauseTime
in interfaceX3DTimeDependentNode
- 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
Assign typed object value to SFTime pauseTime field, similar tosetPauseTime(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 interfaceAudioClip
- Specified by:
getPitch
in interfaceX3DSoundSourceNode
- Returns:
- value of pitch field
-
setPitch
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 interfaceAudioClip
- Specified by:
setPitch
in interfaceX3DSoundSourceNode
- 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
Assign typed object value to SFFloat pitch field, similar tosetPitch(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
Utility method: double-precision set-parameter accessor for X3D floating-point type, similar tosetPitch(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 <= 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 interfaceAudioClip
- Specified by:
getResumeTime
in interfaceX3DSoundSourceNode
- Specified by:
getResumeTime
in interfaceX3DTimeDependentNode
- Returns:
- value of resumeTime field
-
setResumeTime
Accessor method to assign double value in seconds to inputOutput SFTime field named resumeTime.
Tooltip: When resumeTime becomes <= 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 interfaceAudioClip
- Specified by:
setResumeTime
in interfaceX3DSoundSourceNode
- Specified by:
setResumeTime
in interfaceX3DTimeDependentNode
- 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
Assign typed object value to SFTime resumeTime field, similar tosetResumeTime(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 interfaceAudioClip
- Specified by:
getStartTime
in interfaceX3DSoundSourceNode
- Specified by:
getStartTime
in interfaceX3DTimeDependentNode
- Returns:
- value of startTime field
-
setStartTime
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 interfaceAudioClip
- Specified by:
setStartTime
in interfaceX3DSoundSourceNode
- Specified by:
setStartTime
in interfaceX3DTimeDependentNode
- 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
Assign typed object value to SFTime startTime field, similar tosetStartTime(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 interfaceAudioClip
- Specified by:
getStopTime
in interfaceX3DSoundSourceNode
- Specified by:
getStopTime
in interfaceX3DTimeDependentNode
- Returns:
- value of stopTime field
-
setStopTime
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 interfaceAudioClip
- Specified by:
setStopTime
in interfaceX3DSoundSourceNode
- Specified by:
setStopTime
in interfaceX3DTimeDependentNode
- 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
Assign typed object value to SFTime stopTime field, similar tosetStopTime(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. "https://www.web3d.org" "https://www.web3d.org/about" "etc."
- Hint: alternative XML encoding for quotation mark " is " (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 https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#urls
- Specified by:
getUrl
in interfaceAudioClip
- Specified by:
getUrl
in interfaceX3DUrlObject
- 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 togetUrl()
.- Returns:
- value of url field
-
getUrlString
public java.lang.String getUrlString()Utility method to get String value of MFString url field, similar togetUrl()
.- Returns:
- value of url field
-
setUrl
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. "https://www.web3d.org" "https://www.web3d.org/about" "etc."
- Hint: alternative XML encoding for quotation mark " is " (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 https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#urls
- Specified by:
setUrl
in interfaceAudioClip
- Specified by:
setUrl
in interfaceX3DUrlObject
- 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
Assign typed object value to MFString url field, similar tosetUrl(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
Assign single SFString object value to MFString url field, similar tosetUrl(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
Assign singleton String value to MFString url field, similar tosetUrl(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
Assign ArrayList value of MFString url field, similar tosetUrl(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
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
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)
-
addUrl
Add singleton SFStringObject 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)
-
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.- Hint: descriptive DEF names improve clarity and help document a model.
- Hint: well-defined names can simplify design and debugging through improved author understanding.
- Hint: X3D Scene Authoring Hints, Naming Conventions https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#NamingConventions
- Overrides:
getDEF
in classX3DConcreteNode
- Returns:
- value of DEF field
- See Also:
- X3D Scene Authoring Hints: Naming Conventions
-
setDEF
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.- Hint: descriptive DEF names improve clarity and help document a model.
- Hint: well-defined names can simplify design and debugging through improved author understanding.
- Hint: X3D Scene Authoring Hints, Naming Conventions https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#NamingConventions
Note that setting the DEF value clears the USE value.- Specified by:
setDEF
in classX3DConcreteNode
- 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
Assign typed object value to SFString DEF field, similar tosetDEF(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 classX3DConcreteNode
- Returns:
- value of USE field
- See Also:
- X3D Scene Authoring Hints: Naming Conventions
-
setUSE
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: eachUSE
node is still an independent object, with theUSE
value matching theDEF
value in the preceding object.
Warning: invoking thesetUSE()
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 classX3DConcreteNode
- 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
Assign typed object value to SFString USE field, similar tosetUSE(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 classX3DConcreteNode
- Returns:
- value of class field
- See Also:
- W3C Cascading Style Sheets
-
setCssClass
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 classX3DConcreteNode
- 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
Assign typed object value to SFString cssClass field, similar tosetCssClass(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
Assign a USE reference to another DEF node of same node type, similar tosetUSE(String)
.
Warning: note that thesetUSE()
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
Add comment as String to contained commentsList.- Specified by:
addComments
in classX3DConcreteElement
- Parameters:
newComment
- initial value- Returns:
AudioClipObject
- namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
-
addComments
Add comments as String[] array to contained commentsList.- Specified by:
addComments
in classX3DConcreteElement
- Parameters:
newComments
- array of comments- Returns:
AudioClipObject
- namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
-
addComments
Add CommentsBlock to contained commentsList.- Specified by:
addComments
in classX3DConcreteElement
- Parameters:
newCommentsBlock
- block of comments to add- Returns:
AudioClipObject
- 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 classX3DConcreteElement
- 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 classX3DConcreteElement
- 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 classX3DConcreteElement
- 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
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 classX3DConcreteElement
- 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 classX3DConcreteElement
- 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
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 classX3DConcreteElement
- 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 classX3DConcreteElement
- Returns:
- validation results (if any)
-