Package org.web3d.vrml.renderer.common.nodes.sound

Class BaseAudioClip

java.lang.Object

org.web3d.vrml.renderer.common.nodes.AbstractNode

org.web3d.vrml.renderer.common.nodes.BaseTimeDependentNode

org.web3d.vrml.renderer.common.nodes.BaseTimeControlledNode

org.web3d.vrml.renderer.common.nodes.sound.BaseAudioClip

All Implemented Interfaces:

VRMLNode, FrameStateListener, VRMLAudioClipNodeType, VRMLChildNodeType, VRMLExternalNodeType, VRMLNodeType, VRMLSingleExternalNodeType, VRMLTimeControlledNodeType, VRMLTimeDependentNodeType, VRMLTimeListener, VRMLWorldRootChildNodeType

Direct Known Subclasses:

NRAudioClip, OGLAudioClip

public class BaseAudioClip
extends BaseTimeControlledNode
implements VRMLSingleExternalNodeType, VRMLTimeListener, VRMLTimeDependentNodeType, VRMLAudioClipNodeType

AudioClip node implementation.

Version:

$Revision: 1.23 $

Author:

Guy Carpenter

Field Summary

Fields

Modifier and Type	Field	Description
protected static VRMLFieldDeclaration[]	fieldDecl	Array of VRMLFieldDeclarations
protected static final Map<String,Integer>	fieldMap	Hashmap between a field name and its index
protected String	vfDescription	exposedField SFString description ""
protected double	vfDuration	duration of most recently loaded clip
protected boolean	vfIsActive	eventOut SFBool isActive
protected boolean	vfIsPaused	eventOut SFBool isPaused
protected float	vfPitch	exposedField SFFloat pitch, default 1.0
protected String[]	vfUrl	exposedField MFString url

Fields inherited from class org.web3d.vrml.renderer.common.nodes.BaseTimeControlledNode

FIELD_ELAPSED_TIME, FIELD_LOOP, FIELD_PAUSE_TIME, FIELD_RESUME_TIME, FIELD_START_TIME, FIELD_STOP_TIME, LAST_TIME_INDEX, vfElapsedTime, vfLoop, vfPauseTime, vfResumeTime, vfStartTime, vfStopTime

Fields inherited from class org.web3d.vrml.renderer.common.nodes.BaseTimeDependentNode

vrmlClock

Fields inherited from class org.web3d.vrml.renderer.common.nodes.AbstractNode

errorReporter, FIELD_METADATA, fieldLocalData, hasChanged, inSetup, isDEF, isStatic, LAST_NODE_INDEX, layerIds, nodeName, pMetadata, refCounts, removedLayerIds, stateManager, STATIC_SCENE_GRAPH, vfMetadata, vrmlMajorVersion, vrmlMinorVersion

Fields inherited from interface org.web3d.vrml.nodes.VRMLExternalNodeType

LOAD_COMPLETE, LOAD_FAILED, LOADING, NOT_LOADED

Constructor Summary

Constructors

Constructor	Description
BaseAudioClip()	Constructor creates a default audioclip node.

Method Summary

Modifier and Type	Method	Description
void	addContentStateListener(VRMLContentStateListener listener)	Add a listener to this node instance for the content state changes.
void	addSoundStateListener(VRMLSoundStateListener listener)	Add a listener to this node instance.
void	addUrlListener(VRMLUrlListener listener)	Add a listener to this node instance.
void	allEventsComplete()	Notification that the rendering of the event model is complete and that rendering is about to begin.
boolean	checkValidContentType(String mimetype)	Check to see if the given MIME type is one that would be supported as content coming into this node.
void	copy(VRMLNodeType node)	Copies all of the field values from the passed nodes into our own node.
protected void	fireContentStateChanged()	Send a notification to the registered listeners that the content state has been changed.
protected void	fireSoundStateChanged()	Send a notification to the registered listeners that a field has been changed.
protected void	fireUrlChanged(int index)	Send a notification to the registered listeners that a field has been changed.
String	getDescription()	Accessor method to get current value of field description
double	getDuration()	Accessor method to get current value of field duration
VRMLFieldDeclaration	getFieldDeclaration(int index)	Get the declaration of the field at the given index.
int	getFieldIndex(String fieldName)	Get the index of the given field name.
VRMLFieldData	getFieldValue(int index)	Get the value of a field.
boolean	getIsActive()	Accessor method to get current value of field isActive
int	getLoadState()	Ask the state of the load of this node.
int[]	getNodeFieldIndices()	Get the list of indices that correspond to fields that contain nodes ie MFNode and SFNode).
int	getNumFields()	Get the number of fields.
float	getPitch()	Accessor method to get current value of field pitch, default value is 1.
int	getPrimaryType()	Get the primary type of this node.
int[]	getSecondaryType()	Get the secondary type of this node.
String[]	getUrl()	Get the list of URLs requested by this node.
String	getWorldUrl()	Get the world URL so set for this node.
void	removeContentStateListener(VRMLContentStateListener listener)	Remove a listener from this node instance for the content state changes.
void	removeSoundStateListener(VRMLSoundStateListener listener)	Remove a listener from this node instance.
void	removeUrlListener(VRMLUrlListener listener)	Remove a listener from this node instance.
void	sendRoute(double time, int srcIndex, VRMLNodeType destNode, int destIndex)	Send a routed value from this node to the given destination node.
void	setContent(String mimetype, Object content)	Set the content of this node to the given object.
void	setDescription(String newDescription)	Set a new description string for this node.
void	setDuration(double newDuration)	Accessor method to set a new value for field attribute duration
void	setIsActive(boolean newIsActive)	Set a new value for isActive.
void	setLoadedURI(String URI)	Notify the node which URL was used to load the content.
void	setLoadState(int state)	Set the load state of the node.
void	setLoop(boolean loop)	Set the loop variable.
void	setPitch(float newPitch)	Sets a new value for this node's pitch.
void	setStartTime(double newStartTime)	Set a new value for the start time.
void	setStopTime(double newStopTime)	Set a new value for the stop time.
void	setUrl(String[] newURL, int numValid)	Sets the URL to a new value.
void	setValue(int index, float value)	Set the value of the field at the given index as a float.
void	setValue(int index, String value)	Set the value of the field at the given index as a string.
void	setValue(int index, String[] value, int numValid)	Set the value of the field at the given index as an array of strings.
void	setVRMLClock(VRMLClock clk)	Set the vrmlClock that this time dependent node will be running with.
void	setWorldUrl(String url)	Set the world URL so that any relative URLs may be corrected to the fully qualified version.
void	timeClick(long time)	Notification that the time is now this value.

Methods inherited from class org.web3d.vrml.renderer.common.nodes.BaseTimeControlledNode

copy, getLoop, getStartTime, getStopTime, setPauseTime, setResumeTime, setValue, setValue

Methods inherited from class org.web3d.vrml.renderer.common.nodes.AbstractNode

addNodeListener, checkNodeType, checkSecondaryType, checkSecondaryType, clearRemovedLayerIds, fireFieldChanged, getLayerIds, getMetadataObject, getRefCount, getRemovedLayerIds, getUserData, getVRMLNodeName, hasFieldChanged, isDEF, isSetupFinished, notifyExternProtoLoaded, removeNodeListener, setDEF, setErrorReporter, setFrameStateManager, setMetadataObject, setupFinished, setUserData, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setVersion, throwInitOnlyWriteException, throwInputOnlyWriteException, throwInvalidNodeException, throwInvalidProtoException, throwOutputOnlyWriteException, updateRefCount, updateRefs

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.web3d.vrml.lang.VRMLNode

getUserData, getVRMLNodeName, isDEF, setErrorReporter, setUserData, setVersion

Methods inherited from interface org.web3d.vrml.nodes.VRMLNodeType

addNodeListener, clearRemovedLayerIds, getLayerIds, getMetadataObject, getRefCount, getRemovedLayerIds, hasFieldChanged, isSetupFinished, notifyExternProtoLoaded, removeNodeListener, setDEF, setFrameStateManager, setMetadataObject, setupFinished, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, updateRefCount

Methods inherited from interface org.web3d.vrml.nodes.VRMLTimeControlledNodeType

getLoop, getStartTime, getStopTime

Field Details

fieldDecl

protected static VRMLFieldDeclaration[] fieldDecl

Array of VRMLFieldDeclarations

fieldMap

protected static final Map<String,Integer> fieldMap

Hashmap between a field name and its index

vfDescription

protected String vfDescription

exposedField SFString description ""

vfIsActive

protected boolean vfIsActive

eventOut SFBool isActive

vfIsPaused

protected boolean vfIsPaused

eventOut SFBool isPaused

vfPitch

protected float vfPitch

exposedField SFFloat pitch, default 1.0

vfDuration

protected double vfDuration

duration of most recently loaded clip

vfUrl

protected String[] vfUrl

exposedField MFString url

Constructor Details

BaseAudioClip

public BaseAudioClip()

Constructor creates a default audioclip node.

Method Details

copy

public void copy(VRMLNodeType node)

Copies all of the field values from the passed nodes into our own node.

Parameters:

node - The node to copy

Throws:

IllegalArgumentException - The node is not a compatible node

setStartTime

public void setStartTime(double newStartTime)

Set a new value for the start time. If the sensor is active then it is ignored (as per the spec).

Specified by:

setStartTime in interface VRMLTimeControlledNodeType

Overrides:

setStartTime in class BaseTimeControlledNode

Parameters:

newStartTime - The new start time

setStopTime

public void setStopTime(double newStopTime)

Set a new value for the stop time. If the sensor is active and the stop time is less than the current start time, it is ignored. If the stop time is less that now, it is set to now.

Specified by:

setStopTime in interface VRMLTimeControlledNodeType

Overrides:

setStopTime in class BaseTimeControlledNode

Parameters:

newStopTime - The new stop time

setDescription

public void setDescription(String newDescription)

Set a new description string for this node.

Specified by:

setDescription in interface VRMLAudioClipNodeType

Parameters:

newDescription - The new description string.

setIsActive

public void setIsActive(boolean newIsActive)

Set a new value for isActive. This may be called by the containing Sound node when non-looped audio has finished playing

Specified by:

setIsActive in interface VRMLAudioClipNodeType

Parameters:

newIsActive - New active state for this node.

setPitch

public void setPitch(float newPitch)
              throws InvalidFieldValueException

Sets a new value for this node's pitch. The value must be > 0.

Specified by:

setPitch in interface VRMLAudioClipNodeType

Parameters:

newPitch - New value for pitch.

Throws:

InvalidFieldValueException - Pitch is <= 0

setDuration

public void setDuration(double newDuration)

Description copied from interface: VRMLAudioClipNodeType

Accessor method to set a new value for field attribute duration

Specified by:

setDuration in interface VRMLAudioClipNodeType

Parameters:

newDuration - The new duration

addSoundStateListener

public void addSoundStateListener(VRMLSoundStateListener listener)

Add a listener to this node instance. If the listener is already added or null the request is silently ignored.

Parameters:

listener - The listener instance to add

removeSoundStateListener

public void removeSoundStateListener(VRMLSoundStateListener listener)

Remove a listener from this node instance. If the listener is null or not registered, the request is silently ignored.

Parameters:

listener - The listener to be removed

addContentStateListener

public void addContentStateListener(VRMLContentStateListener listener)

Add a listener to this node instance for the content state changes. If the listener is already added or null the request is silently ignored.

Specified by:

addContentStateListener in interface VRMLExternalNodeType

Parameters:

listener - The listener instance to add

removeContentStateListener

public void removeContentStateListener(VRMLContentStateListener listener)

Remove a listener from this node instance for the content state changes. If the listener is null or not registered, the request is silently ignored.

Specified by:

removeContentStateListener in interface VRMLExternalNodeType

Parameters:

listener - The listener to be removed

getFieldIndex

public int getFieldIndex(String fieldName)

Get the index of the given field name. If the name does not exist for this node then return a value of -1.

Specified by:

getFieldIndex in interface VRMLNode

Parameters:

fieldName - The name of the field we want the index from

Returns:

The index of the field name or -1

getPrimaryType

public int getPrimaryType()

Get the primary type of this node. Replaces the instanceof mechanism for use in switch statements.

Specified by:

getPrimaryType in interface VRMLNode

Returns:

The primary type

getSecondaryType

public int[] getSecondaryType()

Get the secondary type of this node. Replaces the instanceof mechanism for use in switch statements.

Specified by:

getSecondaryType in interface VRMLNode

Overrides:

getSecondaryType in class AbstractNode

Returns:

The secondary type

getNodeFieldIndices

public int[] getNodeFieldIndices()

Get the list of indices that correspond to fields that contain nodes ie MFNode and SFNode). Used for blind scene graph traversal without needing to spend time querying for all fields etc. If a node does not have any fields that contain nodes, this shall return null. The field list covers all field types, regardless of whether they are readable or not at the VRML-level.

Specified by:

getNodeFieldIndices in interface VRMLNode

Returns:

The list of field indices that correspond to SF/MFnode fields or null if none

getFieldDeclaration

public VRMLFieldDeclaration getFieldDeclaration(int index)

Get the declaration of the field at the given index. This allows for reverse lookup if needed. If the field does not exist, this will give a value of null.

Specified by:

getFieldDeclaration in interface VRMLNode

Parameters:

index - The index of the field to get information

Returns:

A representation of this field's information

getNumFields

public int getNumFields()

Get the number of fields.

Specified by:

getNumFields in interface VRMLNode

Returns:

The number of fields.

getFieldValue

public VRMLFieldData getFieldValue(int index)
                            throws InvalidFieldException

Get the value of a field. If the field is a primitive type, it will return a class representing the value. For arrays or nodes it will return the instance directly.

Specified by:

getFieldValue in interface VRMLNodeType

Overrides:

getFieldValue in class BaseTimeControlledNode

Parameters:

index - The index of the field to change.

Returns:

The class representing the field value

Throws:

InvalidFieldException - The field index is not known

sendRoute

public void sendRoute(double time,
 int srcIndex,
 VRMLNodeType destNode,
 int destIndex)

Send a routed value from this node to the given destination node. The route should use the appropriate setValue() method of the destination node. It should not attempt to cast the node up to a higher level. Routing should also follow the standard rules for the loop breaking and other appropriate rules for the specification.

Specified by:

sendRoute in interface VRMLNodeType

Overrides:

sendRoute in class AbstractNode

Parameters:

time - The time that this route occurred (not necessarily epoch time. Should be treated as a relative value only)

srcIndex - The index of the field in this node that the value should be sent from

destNode - The node reference that we will be sending the value to

destIndex - The index of the field in the destination node that the value should be sent to.

setValue

public void setValue(int index,
 String value)
              throws InvalidFieldException,
InvalidFieldValueException

Set the value of the field at the given index as a string. This would be used to set SFString field types.

Specified by:

setValue in interface VRMLNodeType

Overrides:

setValue in class AbstractNode

Parameters:

index - The index of destination field to set

value - The new value to use for the node

Throws:

InvalidFieldException - The index is not a valid field

InvalidFieldValueException - The field value is not legal for the field specified.

setValue

public void setValue(int index,
 String[] value,
 int numValid)
              throws InvalidFieldException,
InvalidFieldValueException

Set the value of the field at the given index as an array of strings. This would be used to set MFString field types.

Specified by:

setValue in interface VRMLNodeType

Overrides:

setValue in class AbstractNode

Parameters:

index - The index of destination field to set

value - The new value to use for the node

numValid - The number of valid values to copy from the array

Throws:

InvalidFieldException - The field index is not know

InvalidFieldValueException - The field value is not legal for the field specified.

setValue

public void setValue(int index,
 float value)
              throws InvalidFieldException,
InvalidFieldValueException

Set the value of the field at the given index as a float. This would be used to set SFFloat field types.

Specified by:

setValue in interface VRMLNodeType

Overrides:

setValue in class AbstractNode

Parameters:

index - The index of destination field to set

value - The new value to use for the node

Throws:

InvalidFieldException - The field index is not known

InvalidFieldValueException - The value provided is out of range for the field type.

allEventsComplete

public void allEventsComplete()

Notification that the rendering of the event model is complete and that rendering is about to begin. Used to update the transformation matrix only once per frame.

Specified by:

allEventsComplete in interface FrameStateListener

Overrides:

allEventsComplete in class AbstractNode

fireUrlChanged

protected void fireUrlChanged(int index)

Send a notification to the registered listeners that a field has been changed. If no listeners have been registered, then this does nothing, so always call it regardless.

Parameters:

index - The index of the field that changed

fireSoundStateChanged

protected void fireSoundStateChanged()

Send a notification to the registered listeners that a field has been changed. If no listeners have been registered, then this does nothing, so always call it regardless.

fireContentStateChanged

protected void fireContentStateChanged()

Send a notification to the registered listeners that the content state has been changed. If no listeners have been registered, then this does nothing, so always call it regardless.

getLoadState

public int getLoadState()

Ask the state of the load of this node. The value will be one of the constants defined in VRMLSingleExternalNodeType.

Specified by:

getLoadState in interface VRMLSingleExternalNodeType

Returns:

The current load state of the node

setLoadState

public void setLoadState(int state)

Set the load state of the node. The value must be one of the constants defined in VRMLSingleExternalNodeType.

Specified by:

setLoadState in interface VRMLSingleExternalNodeType

Parameters:

state - The new state of the node

setUrl

public void setUrl(String[] newURL,
 int numValid)

Sets the URL to a new value. We will load only one of these URL's. The list provides alternates.

Specified by:

setUrl in interface VRMLAudioClipNodeType

Specified by:

setUrl in interface VRMLSingleExternalNodeType

Parameters:

newURL - Array of candidate URL strings

numValid - The number of valid values to copy from the array

getUrl

public String[] getUrl()

Get the list of URLs requested by this node. If there are no URLs supplied in the text file then this will return a zero length array.

Specified by:

getUrl in interface VRMLAudioClipNodeType

Specified by:

getUrl in interface VRMLSingleExternalNodeType

Returns:

The list of URLs to attempt to load

checkValidContentType

public boolean checkValidContentType(String mimetype)

Check to see if the given MIME type is one that would be supported as content coming into this node.

Specified by:

checkValidContentType in interface VRMLSingleExternalNodeType

Parameters:

mimetype - The type to check for

Returns:

true if this is OK, false if not

setLoadedURI

public void setLoadedURI(String URI)

Notify the node which URL was used to load the content. It will be the complete URI with path, query and references parts. This method will be called before setContent.

Specified by:

setLoadedURI in interface VRMLSingleExternalNodeType

Parameters:

URI - The URI used to load this content

setContent

public void setContent(String mimetype,
 Object content)
                throws IllegalArgumentException

Set the content of this node to the given object. The object is then cast by the internal representation to the form it needs. This assumes at least some amount of intelligence on the part of the caller, but we also know that we should not pass something dumb to it when we can check what sort of content types it likes to handle. We assume the loader thread is operating in the same context as the one that created the node in the first place and thus knows the general types of items to pass through.

Specified by:

setContent in interface VRMLSingleExternalNodeType

Parameters:

mimetype - The mime type of this object if known

content - The content of the object

Throws:

IllegalArgumentException - The content object is not supported

setWorldUrl

public void setWorldUrl(String url)

Set the world URL so that any relative URLs may be corrected to the fully qualified version. Guaranteed to be non-null.

Specified by:

setWorldUrl in interface VRMLExternalNodeType

Parameters:

url - The world URL.

getWorldUrl

public String getWorldUrl()

Get the world URL so set for this node.

Specified by:

getWorldUrl in interface VRMLExternalNodeType

Returns:

url The world URL.

addUrlListener

public void addUrlListener(VRMLUrlListener listener)

Add a listener to this node instance. If the listener is already added or null the request is silently ignored.

Specified by:

addUrlListener in interface VRMLExternalNodeType

Parameters:

listener - The listener instance to add

removeUrlListener

public void removeUrlListener(VRMLUrlListener listener)

Remove a listener from this node instance. If the listener is null or not registered, the request is silently ignored.

Specified by:

removeUrlListener in interface VRMLExternalNodeType

Parameters:

listener - The listener to be removed

setVRMLClock

public void setVRMLClock(VRMLClock clk)

Set the vrmlClock that this time dependent node will be running with.

Specified by:

setVRMLClock in interface VRMLTimeDependentNodeType

Overrides:

setVRMLClock in class BaseTimeDependentNode

Parameters:

clk - The vrmlClock to use for this node

setLoop

public void setLoop(boolean loop)

Set the loop variable. Override the base class. TODO: Need to commonize timer handling, this is not exactly right.

Specified by:

setLoop in interface VRMLTimeControlledNodeType

Overrides:

setLoop in class BaseTimeControlledNode

Parameters:

loop -

getDescription

public String getDescription()

Accessor method to get current value of field description

Specified by:

getDescription in interface VRMLAudioClipNodeType

Returns:

The description

getPitch

public float getPitch()

Accessor method to get current value of field pitch, default value is 1.

Specified by:

getPitch in interface VRMLAudioClipNodeType

Returns:

The Pitch

getDuration

public double getDuration()

Accessor method to get current value of field duration

Specified by:

getDuration in interface VRMLAudioClipNodeType

Returns:

The duration

getIsActive

public boolean getIsActive()

Accessor method to get current value of field isActive

Specified by:

getIsActive in interface VRMLAudioClipNodeType

Returns:

The value of isActive

timeClick

public void timeClick(long time)

Notification that the time is now this value.

Specified by:

timeClick in interface VRMLTimeListener

Parameters:

time - The current time