|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectjavax.media.j3d.IndexedObject
javax.media.j3d.SceneGraphObjectRetained
javax.media.j3d.NodeRetained
javax.media.j3d.LeafRetained
javax.media.j3d.SoundRetained
abstract class SoundRetained
SoundRetained is an abstract class that contains instance varables common to all retained sounds.
Field Summary | |
---|---|
(package private) static int |
ALL_ATTIBS_DIRTY_BITS
|
(package private) static int |
ALL_STATE_DIRTY_BITS
|
(package private) static int |
ANGULAR_ATTENUATION_DIRTY_BIT
|
private int |
atomCount
|
(package private) static int |
ATTRIBUTE_DIRTY_BITS
|
(package private) static int |
BACK_DISTANCE_GAIN_DIRTY_BIT
|
(package private) static int |
BOUNDING_LEAF_DIRTY_BIT
|
(package private) BoundingLeafRetained |
boundingLeaf
The bounding leaf reference |
(package private) static int |
BOUNDS_CHANGED
|
(package private) static int |
BOUNDS_DIRTY_BIT
|
(package private) boolean |
continuous
Flag denoting if sound silently continues playing when it's deactivated. |
(package private) static int |
CONTINUOUS_DIRTY_BIT
|
(package private) static boolean |
debugFlag
|
(package private) static int |
DIRECTION_DIRTY_BIT
|
(package private) static int |
DIRECTIONAL_DIRTY_BITS
|
(package private) static int |
DISTANCE_GAIN_DIRTY_BIT
|
(package private) long |
duration
|
(package private) boolean |
enable
Switch for turning sound on or off while the sound is "active" |
(package private) static int |
ENABLE_DIRTY_BIT
|
(package private) static int |
IMMEDIATE_MODE_DIRTY_BIT
|
(package private) boolean |
inImmCtx
This is true when this sound is referenced in an immediate mode context |
(package private) static int |
INITIAL_GAIN_DIRTY_BIT
|
(package private) float |
initialGain
Overall Scale Factor applied to sound. |
(package private) static boolean |
internalErrors
|
(package private) boolean |
isViewScoped
|
(package private) HashKey |
key
|
(package private) static int |
LIVE_DIRTY_BIT
|
(package private) static int |
LOAD_COMPLETE
Load Sound Data Status |
(package private) static int |
LOAD_FAILED
|
(package private) static int |
LOAD_NULL
|
(package private) static int |
LOAD_PENDING
|
(package private) static int |
LOAD_SOUND_DIRTY_BIT
|
private SoundSchedulerAtom[] |
loadedAtoms
Array of references to sound scheduler atoms associated with this node. |
(package private) int |
loadStatus
|
(package private) static int |
LOOP_COUNT_DIRTY_BIT
|
(package private) int |
loopCount
Number of times sound is looped/repeated during play |
(package private) SoundRetained[] |
mirrorSounds
|
(package private) boolean |
mute
Flag denoting if sound is explicitly muted, so that if begins playing it will be played silently. |
(package private) static int |
MUTE_DIRTY_BIT
|
(package private) static int |
NULL_SOUND
Null Sound identifier denotes sound is not created or initialized |
(package private) int |
numMirrorSounds
|
(package private) boolean |
pause
Flag denoting if sound is paused from playing - waiting to be resumed |
(package private) static int |
PAUSE_DIRTY_BIT
|
(package private) static int |
POSITION_DIRTY_BIT
|
(package private) static int |
POSITIONAL_DIRTY_BITS
|
(package private) float |
priority
Sound priority ranking value. |
(package private) static int |
PRIORITY_DIRTY_BIT
|
(package private) float |
rate
Rate Scale Factor applied to sounds playback sample rate in Hertz. |
(package private) static int |
RATE_DIRTY_BIT
|
(package private) boolean |
release
Type of release when sound is disabled. |
(package private) static int |
RELEASE_DIRTY_BIT
|
(package private) Bounds |
schedulingRegion
The Boundary object defining the sound's scheduling region. |
(package private) SoundRetained |
sgSound
|
(package private) static int |
SOUND_DATA_DIRTY_BIT
|
(package private) MediaContainer |
soundData
sound data associated with sound source |
(package private) int |
soundType
|
(package private) static int |
targetThreads
|
(package private) Bounds |
transformedRegion
The transformed bounds from either schedulingRegion or boundingLeaf |
(package private) static int |
XFORM_DIRTY_BIT
|
Fields inherited from class javax.media.j3d.LeafRetained |
---|
boundsDirty, switchState |
Fields inherited from class javax.media.j3d.SceneGraphObjectRetained |
---|
DONT_MERGE, inBackgroundGroup, inSetLive, MERGE, MERGE_DONE, mergeFlag, onUpdateList, source |
Fields inherited from class javax.media.j3d.IndexedObject |
---|
listIdx |
Constructor Summary | |
---|---|
SoundRetained()
|
Method Summary | |
---|---|
(package private) void |
changeAtomList(SoundSchedulerAtom atom,
int loadStatus)
|
(package private) void |
clearLive(SetLiveState s)
|
(package private) void |
debugPrint(java.lang.String message)
|
(package private) void |
dispatchAttribChange(int dirtyBit,
java.lang.Object argument)
Dispatch a message about a sound attribute change |
(package private) void |
dispatchStateChange(int dirtyBit,
java.lang.Object argument)
Dispatch a message about a sound state change |
(package private) boolean |
getContinuousEnable()
Retrieves sound's continuous play flag |
(package private) long |
getDuration()
Retrieves sound's duration in milliseconds |
(package private) boolean |
getEnable()
Retrieves sound's enabled flag |
(package private) boolean |
getInImmCtx()
This gets the immedate mode context flag |
(package private) float |
getInitialGain()
Get the overall gain (applied to the sound data associated with source). |
(package private) int |
getLoop()
Retrieves the loop count |
(package private) void |
getMirrorObjects(java.util.ArrayList leafList,
HashKey key)
|
(package private) SoundRetained |
getMirrorSound(HashKey key)
This gets the mirror sound for this sound given the key. |
(package private) boolean |
getMute()
Retrieves sound Mute state. |
(package private) int |
getNumberOfChannelsUsed()
Retrieves number of channels allocated for this sound on the primary view's audio device. |
(package private) int |
getNumberOfChannelsUsed(View viewRef)
Retrieves number of channels allocated for this sound on the audio devices associated with a given view. |
(package private) boolean |
getPause()
Retrieves sound Pause state. |
(package private) float |
getPriority()
Retrieves sound's priority value. |
(package private) float |
getRateScaleFactor()
Retrieves sound's rate scale factor |
(package private) boolean |
getReleaseEnable()
Retrieves release flag for sound associated with this source node |
(package private) BoundingLeaf |
getSchedulingBoundingLeaf()
Get the Sound's scheduling region |
(package private) Bounds |
getSchedulingBounds()
Get the Sound's scheduling region. |
(package private) MediaContainer |
getSoundData()
Retrieves sound data associated with this sound source node |
(package private) void |
initMirrorObject(SoundRetained ms)
|
(package private) boolean |
isPlaying()
Retrieves sound's playing status true if potentially audible (enabled and active) on ANY audio device false otherwise |
(package private) boolean |
isPlaying(View viewRef)
Retrieves sound's playing status for a particular view true if potentially audible (enabled and active) on audio device associated with the given view false otherwise |
(package private) boolean |
isPlayingSilently()
Retrieves sound's playing silently status true if enabled but not active (on any device) false otherwise |
(package private) boolean |
isPlayingSilently(View viewRef)
Retrieves sound's playing silently status for a particular view true if potentially audible (enabled and active) on audio device associated with the given view false otherwise |
(package private) boolean |
isReady()
Retrieves sound's ready state for ALL active views. |
(package private) boolean |
isReady(View viewRef)
Retrieves sound's ready state for a particular view. |
(package private) void |
mergeTransform(TransformGroupRetained xform)
|
(package private) void |
setContinuousEnable(boolean state)
Enable or disable continuous play flag |
(package private) void |
setEnable(boolean state)
Sets the flag denotine sound enabled/disabled and sends a message for the following to be done: If state is true: if sound is not playing, sound is started. |
(package private) void |
setInImmCtx(boolean inCtx)
This sets the immedate mode context flag |
(package private) void |
setInitialGain(float scaleFactor)
Set the gain scale factor applied to this sound |
(package private) void |
setLive(SetLiveState s)
|
(package private) void |
setLoop(int loopCount)
Sets the sound's loop count |
(package private) void |
setMute(boolean state)
Set mute state flag. |
(package private) void |
setPause(boolean state)
Set pause state flag. |
(package private) void |
setPriority(float rank)
Set sound's proirity value. |
(package private) void |
setRateScaleFactor(float scaleFactor)
Set scale factor |
(package private) void |
setReleaseEnable(boolean state)
Enable or disable the release flag for this sound source |
(package private) void |
setSchedulingBoundingLeaf(BoundingLeaf region)
Set the Sound's scheduling region to the specified Leaf node. |
(package private) void |
setSchedulingBounds(Bounds region)
Set the Sound's scheduling region. |
(package private) void |
setSoundData(MediaContainer soundData)
Associates sound data with this sound source node Attempt to load sound |
(package private) void |
setSoundDataState(MediaContainer soundData)
Assign value into sound data field |
(package private) void |
updateBoundingLeaf(long refTime)
|
(package private) void |
updateMirrorObject(java.lang.Object[] objs)
|
(package private) void |
updateTransformChange()
|
Methods inherited from class javax.media.j3d.LeafRetained |
---|
clone, updateBoundingLeaf, updateBounds |
Methods inherited from class javax.media.j3d.SceneGraphObjectRetained |
---|
clearLive, clearLive, clone, compile, doSetLive, getSource, handleFrequencyChange, isInSetLive, markAsLive, setCompiled, setLive, setSource, traverse |
Methods inherited from class javax.media.j3d.IndexedObject |
---|
getIdxUsed, incIdxUsed |
Methods inherited from class java.lang.Object |
---|
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
static final int NULL_SOUND
MediaContainer soundData
float initialGain
int loopCount
boolean enable
boolean release
boolean continuous
boolean mute
boolean pause
float priority
float rate
Bounds schedulingRegion
BoundingLeafRetained boundingLeaf
Bounds transformedRegion
static final int SOUND_DATA_DIRTY_BIT
static final int INITIAL_GAIN_DIRTY_BIT
static final int LOOP_COUNT_DIRTY_BIT
static final int BOUNDS_DIRTY_BIT
static final int BOUNDING_LEAF_DIRTY_BIT
static final int PRIORITY_DIRTY_BIT
static final int POSITION_DIRTY_BIT
static final int DISTANCE_GAIN_DIRTY_BIT
static final int BACK_DISTANCE_GAIN_DIRTY_BIT
static final int DIRECTION_DIRTY_BIT
static final int ANGULAR_ATTENUATION_DIRTY_BIT
static final int RATE_DIRTY_BIT
static final int BOUNDS_CHANGED
static final int ATTRIBUTE_DIRTY_BITS
static final int POSITIONAL_DIRTY_BITS
static final int DIRECTIONAL_DIRTY_BITS
static final int ALL_ATTIBS_DIRTY_BITS
static final int LIVE_DIRTY_BIT
static final int IMMEDIATE_MODE_DIRTY_BIT
static final int LOAD_SOUND_DIRTY_BIT
static final int RELEASE_DIRTY_BIT
static final int CONTINUOUS_DIRTY_BIT
static final int ENABLE_DIRTY_BIT
static final int MUTE_DIRTY_BIT
static final int PAUSE_DIRTY_BIT
static final int XFORM_DIRTY_BIT
static final int ALL_STATE_DIRTY_BITS
int soundType
SoundRetained sgSound
HashKey key
SoundRetained[] mirrorSounds
int numMirrorSounds
private SoundSchedulerAtom[] loadedAtoms
private int atomCount
boolean inImmCtx
static final int LOAD_COMPLETE
static final int LOAD_PENDING
static final int LOAD_NULL
static final int LOAD_FAILED
int loadStatus
long duration
static final int targetThreads
boolean isViewScoped
static final boolean debugFlag
static final boolean internalErrors
Constructor Detail |
---|
SoundRetained()
Method Detail |
---|
void dispatchAttribChange(int dirtyBit, java.lang.Object argument)
void dispatchStateChange(int dirtyBit, java.lang.Object argument)
void setSoundDataState(MediaContainer soundData)
soundData
- description of sound source datavoid setSoundData(MediaContainer soundData)
soundData
- descrition of sound source dataMediaContainer getSoundData()
void setInitialGain(float scaleFactor)
amplitude
- gain scale factorfloat getInitialGain()
void setLoop(int loopCount)
loopCount
- number of times sound is looped during playint getLoop()
void setReleaseEnable(boolean state)
state
- flag denoting release sound before stoppingboolean getReleaseEnable()
void setContinuousEnable(boolean state)
state
- denotes if sound continues playing silently when deactivatedboolean getContinuousEnable()
void setEnable(boolean state)
state
- true or false to enable or disable the soundboolean getEnable()
void setSchedulingBounds(Bounds region)
region
- a region that contains the Sound's new scheduling regionBounds getSchedulingBounds()
void setSchedulingBoundingLeaf(BoundingLeaf region)
BoundingLeaf getSchedulingBoundingLeaf()
void updateMirrorObject(java.lang.Object[] objs)
updateMirrorObject
in class LeafRetained
void updateBoundingLeaf(long refTime)
void setPriority(float rank)
priority
- value used to order sound's importance for playback.float getPriority()
long getDuration()
void setRateScaleFactor(float scaleFactor)
scaleFactor
- applied to sound playback ratefloat getRateScaleFactor()
void changeAtomList(SoundSchedulerAtom atom, int loadStatus)
boolean isReady()
boolean isReady(View viewRef)
viewRef
- view to test sound readiness for
boolean isPlaying()
boolean isPlaying(View viewRef)
viewRef
- view to test sound playing state for
boolean isPlayingSilently()
boolean isPlayingSilently(View viewRef)
viewRef
- view to test sound playing silently state for
int getNumberOfChannelsUsed()
int getNumberOfChannelsUsed(View viewRef)
viewRef
- view to test sound playing silently state for
void setMute(boolean state)
state
- flagboolean getMute()
void setPause(boolean state)
state
- flagboolean getPause()
void setInImmCtx(boolean inCtx)
boolean getInImmCtx()
SoundRetained getMirrorSound(HashKey key)
void initMirrorObject(SoundRetained ms)
void setLive(SetLiveState s)
setLive
in class NodeRetained
void clearLive(SetLiveState s)
clearLive
in class NodeRetained
void mergeTransform(TransformGroupRetained xform)
mergeTransform
in class NodeRetained
void updateTransformChange()
updateTransformChange
in class LeafRetained
void debugPrint(java.lang.String message)
void getMirrorObjects(java.util.ArrayList leafList, HashKey key)
getMirrorObjects
in class LeafRetained
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |