| java.lang.Object
 javax.media.j3d.SceneGraphObject
javax.media.j3d.Node
javax.media.j3d.Leaf
javax.media.j3d.Sound
javax.media.j3d.BackgroundSound
| BackgroundSound | | public class BackgroundSound extends Sound (Code) | | A BackgroundSound node defines an unattenuated, nonspatialized sound
source that has no position or direction. It has the same attributes as a
Sound node. This type of sound is simply added to the sound mix without
modification and is useful for playing a mono or stereo music track, or an
ambient sound effect. Unlike a Background (visual) node, more than one
BackgroundSound node can be simultaneously enabled and active.
|
| Constructor Summary | |
| public | BackgroundSound()
Constructs a new BackgroundSound node using the default parameters
for Sound nodes. | | public | BackgroundSound(MediaContainer soundData, float initialGain)
Constructs a BackgroundSound node object using only the provided
parameter values for sound data and sample gain. | | public | BackgroundSound(MediaContainer soundData, float initialGain, int loopCount, boolean release, boolean continuous, boolean enable, Bounds region, float priority)
Constructs a BackgroundSound object accepting all the parameters
associated with a Sound node. |
| Method Summary | |
| public Node | cloneNode(boolean forceDuplicate)
Creates a new instance of the node. | | void | createRetained()
Creates the retained mode BackgroundSoundRetained object that this
BackgroundSound component object will point to. | | public void | duplicateNode(Node originalNode, boolean forceDuplicate)
Copies all node information from originalNode into
the current node. |
| BackgroundSound | | public BackgroundSound()(Code) | | Constructs a new BackgroundSound node using the default parameters
for Sound nodes.
|
| BackgroundSound | | public BackgroundSound(MediaContainer soundData, float initialGain)(Code) | | Constructs a BackgroundSound node object using only the provided
parameter values for sound data and sample gain. The remaining fields
are set to the default values for a Sound node.
Parameters:
soundData - sound data associated with this sound source node
Parameters:
initialGain - amplitude scale factor applied to sound source |
| BackgroundSound | | public BackgroundSound(MediaContainer soundData, float initialGain, int loopCount, boolean release, boolean continuous, boolean enable, Bounds region, float priority)(Code) | | Constructs a BackgroundSound object accepting all the parameters
associated with a Sound node.
Parameters:
soundData - sound data associated with this sound source node
Parameters:
initialGain - amplitude scale factor applied to sound source
Parameters:
loopCount - number of times loop is looped
Parameters:
release - flag denoting playing sound data to end
Parameters:
continuous - denotes that sound silently plays when disabled
Parameters:
enable - sound switched on/off
Parameters:
region - scheduling bounds
Parameters:
priority - playback ranking value |
| cloneNode | | public Node cloneNode(boolean forceDuplicate)(Code) | | Creates a new instance of the node. This routine is called
by cloneTree to duplicate the current node.
Parameters:
forceDuplicate - when set to true, causes theduplicateOnCloneTree flag to be ignored. Whenfalse, the value of each node'sduplicateOnCloneTree variable determines whetherNodeComponent data is duplicated or copied.
See Also: Node.cloneTree
See Also: Node.cloneNode
See Also: Node.duplicateNode
See Also: NodeComponent.setDuplicateOnCloneTree |
| createRetained | | void createRetained()(Code) | | Creates the retained mode BackgroundSoundRetained object that this
BackgroundSound component object will point to.
|
| duplicateNode | | public void duplicateNode(Node originalNode, boolean forceDuplicate)(Code) | | Copies all node information from originalNode into
the current node. This method is called from the
cloneNode method which is, in turn, called by the
cloneTree method.
For any NodeComponent objects
contained by the object being duplicated, each NodeComponent
object's duplicateOnCloneTree value is used to determine
whether the NodeComponent should be duplicated in the new node
or if just a reference to the current node should be placed in the
new node. This flag can be overridden by setting the
forceDuplicate parameter in the cloneTree
method to true.
NOTE: Applications should not call this method directly.
It should only be called by the cloneNode method.
Parameters:
originalNode - the original node to duplicate.
Parameters:
forceDuplicate - when set to true, causes theduplicateOnCloneTree flag to be ignored. Whenfalse, the value of each node'sduplicateOnCloneTree variable determines whetherNodeComponent data is duplicated or copied.
exception:
ClassCastException - if originalNode is not an instance of Sound
See Also: Node.cloneTree
See Also: Node.cloneNode
See Also: NodeComponent.setDuplicateOnCloneTree |
|
|