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

Class OGLAudioClip

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

org.web3d.vrml.renderer.ogl.nodes.sound.OGLAudioClip

All Implemented Interfaces:

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

public class OGLAudioClip
extends BaseAudioClip
implements OGLVRMLNode

AudioClip node implementation for OpenGL.

Version:

$Revision: 1.4 $

Author:

Alan Hudson

Field Summary

Fields inherited from class org.web3d.vrml.renderer.common.nodes.sound.BaseAudioClip

fieldDecl, fieldMap, vfDescription, vfDuration, vfIsActive, vfIsPaused, vfPitch, vfUrl

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
OGLAudioClip()	Empty constructor.
OGLAudioClip(VRMLNodeType node)	Construct a new instance of this node based on the details from the given node.

Method Summary

Modifier and Type	Method	Description
org.j3d.aviatrix3d.SceneGraphObject	getSceneGraphObject()	Get the Java3D scene graph object representation of this node.
void	setCapabilityOverrideMap(Map capBits, Map freqBits)	Provide the set of mappings that override anything that the loader might set.
void	setCapabilityRequiredMap(Map capBits, Map freqBits)	Set the mapping of capability bits that the user would like to make sure is set.
void	setContent(String mimetype, Object content)	setContent is called when the content has been loaded.
void	setLoop(boolean loop)	Set the loop variable.
void	setPitch(float newPitch)	Sets a new value for this node's pitch.
void	setupFinished()	Notification that the construction phase of this node has finished.

Methods inherited from class org.web3d.vrml.renderer.common.nodes.sound.BaseAudioClip

addContentStateListener, addSoundStateListener, addUrlListener, allEventsComplete, checkValidContentType, copy, fireContentStateChanged, fireSoundStateChanged, fireUrlChanged, getDescription, getDuration, getFieldDeclaration, getFieldIndex, getFieldValue, getIsActive, getLoadState, getNodeFieldIndices, getNumFields, getPitch, getPrimaryType, getSecondaryType, getUrl, getWorldUrl, removeContentStateListener, removeSoundStateListener, removeUrlListener, sendRoute, setDescription, setDuration, setIsActive, setLoadedURI, setLoadState, setStartTime, setStopTime, setUrl, setValue, setValue, setValue, setVRMLClock, setWorldUrl, timeClick

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, 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.nodes.FrameStateListener

allEventsComplete

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

getFieldDeclaration, getFieldIndex, getNodeFieldIndices, getNumFields, getPrimaryType, getSecondaryType, getUserData, getVRMLNodeName, isDEF, setErrorReporter, setUserData, setVersion

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

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

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

getLoop, getStartTime, getStopTime

Constructor Details

OGLAudioClip

public OGLAudioClip()

Empty constructor.

OGLAudioClip

public OGLAudioClip(VRMLNodeType node)

Construct a new instance of this node based on the details from the given node. If the node is not a Sound node, an exception will be thrown. It does not copy the source node, just this node.

Parameters:

node - The node to copy

Throws:

IllegalArgumentException - The node is not a compatible node

Method Details

getSceneGraphObject

public org.j3d.aviatrix3d.SceneGraphObject getSceneGraphObject()

Get the Java3D scene graph object representation of this node. This will need to be cast to the appropriate parent type when being used.

Specified by:

getSceneGraphObject in interface OGLVRMLNode

Returns:

The OGL representation.

setupFinished

public void setupFinished()

Description copied from interface: VRMLNodeType

Notification that the construction phase of this node has finished. If the node would like to do any internal processing, such as setting up geometry, then go for it now. It is then responsible for calling its children's setupFinished.

Specified by:

setupFinished in interface VRMLNodeType

Overrides:

setupFinished in class AbstractNode

setLoop

public void setLoop(boolean loop)

Set the loop variable. Override the base class.

Specified by:

setLoop in interface VRMLTimeControlledNodeType

Overrides:

setLoop in class BaseAudioClip

Parameters:

loop -

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

Overrides:

setPitch in class BaseAudioClip

Parameters:

newPitch - New value for pitch.

Throws:

InvalidFieldValueException - Pitch is <= 0

setCapabilityOverrideMap

public void setCapabilityOverrideMap(Map capBits,
 Map freqBits)

Provide the set of mappings that override anything that the loader might set. Default implementation does nothing.

If the key is set, but the value is null or zero length, then all capabilities on that node will be disabled. If the key is set the values override all settings that the loader may wish to normally make. This can be very dangerous if the loader is used for a file format that includes its own internal animation engine, so be very careful with this request.

Parameters:

capBits - The capability bits to be set

freqBits - The frequency bits to be set

setCapabilityRequiredMap

public void setCapabilityRequiredMap(Map capBits,
 Map freqBits)

Set the mapping of capability bits that the user would like to make sure is set. The end output is that the capabilities are the union of what the loader wants and what the user wants. Default implementation does nothing.

If the map contains a key, but the value is null or zero length, the request is ignored.

Parameters:

capBits - The capability bits to be set

freqBits - The frequency bits to be set

setContent

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

setContent is called when the content has been loaded. We require that the content object be an InputStream

Specified by:

setContent in interface VRMLSingleExternalNodeType

Overrides:

setContent in class BaseAudioClip

Parameters:

mimetype - The mime type of this object if known

content - The content of the object

Throws:

IllegalArgumentException - The content object is not supported