javax.media.j3d

Class SoundscapeRetained

java.lang.Object

javax.media.j3d.IndexedObject

javax.media.j3d.SceneGraphObjectRetained

javax.media.j3d.NodeRetained

javax.media.j3d.LeafRetained

javax.media.j3d.SoundscapeRetained

All Implemented Interfaces:

java.lang.Cloneable, NnuId

 class SoundscapeRetained
extends LeafRetained

The SoundscapeRetained object defines all soundscape rendering state as a subclass of a Leaf node.

Field Summary

Fields

Modifier and Type	Field and Description
(package private) static int	APPLICATION_BOUNDS_CHANGED
(package private) Bounds	applicationRegion Soundscape nodes application region
(package private) AuralAttributesRetained	attributes Aural attributes associated with this Soundscape
(package private) static int	ATTRIBUTES_CHANGED
(package private) static int	BOUNDING_LEAF_CHANGED
(package private) BoundingLeafRetained	boundingLeaf The bounding leaf reference
(package private) int	isDirty
(package private) boolean	isViewScoped
(package private) int	targetThreads
(package private) Bounds	transformedRegion The transformed Application Region

Fields inherited from class javax.media.j3d.LeafRetained

boundsDirty, switchState

Fields inherited from class javax.media.j3d.NodeRetained

ALTERNATEAPPEARANCE, AMBIENTLIGHT, apiBounds, BACKGROUND, BACKGROUNDSOUND, BEHAVIOR, BOUNDINGLEAF, boundsAutoCompute, BRANCHGROUP, branchGroupPaths, cachedBounds, childIndex, CLIP, collidable, CONESOUND, CONTAINS_VIEWPLATFORM, CURRENT_LOCAL_TO_VWORLD, DECALGROUP, DIRECTIONALLIGHT, EXPONENTIALFOG, geometryBackground, GROUP, inSharedGroup, LAST_LOCAL_TO_VWORLD, LINEARFOG, LINK, localBounds, locale, localToVworld, localToVworldIndex, localToVworldKeys, MODELCLIP, MORPH, nnuId, nodeId, nodeType, NUMNODES, ORDEREDGROUP, orderedId, ORIENTEDSHAPE3D, parent, parentSwitchLink, parentTransformLink, pickable, POINTLIGHT, POINTSOUND, refCount, SHAPE, SHAREDGROUP, SOUNDSCAPE, SPOTLIGHT, staticTransform, SWITCH, TRANSFORMGROUP, universe, validCachedBounds, VIEWPLATFORM, VIEWSPECIFICGROUP

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

Constructors

Constructor and Description
SoundscapeRetained()

Method Summary

Methods

Modifier and Type	Method and Description
(package private) void	clearLive(SetLiveState s) This clearLive routine first calls the superclass's method, then it removes itself to the list of lights
(package private) void	dispatchMessage(int dirtyBit, java.lang.Object argument)
(package private) BoundingLeaf	getApplicationBoundingLeaf() Get the Soundscape's application region
(package private) Bounds	getApplicationBounds() Get the Soundscape's application region.
(package private) AuralAttributes	getAuralAttributes() Retrieve a reference to Aural Attributes
(package private) void	getMirrorObjects(java.util.ArrayList leafList, HashKey key)
(package private) void	mergeTransform(TransformGroupRetained xform)
(package private) void	setApplicationBoundingLeaf(BoundingLeaf region) Set the Soundscape's application region to the specified Leaf node.
(package private) void	setApplicationBounds(Bounds region) Set the Soundscape's application region.
(package private) void	setAuralAttributes(AuralAttributes attributes) Set a set of aural attributes for this Soundscape
(package private) void	setLive(SetLiveState s) This setLive routine first calls the superclass's method, then it adds itself to the list of soundscapes
(package private) void	update(SoundscapeRetained ss)
(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.NodeRetained

computeCombineBounds, computeNonLiveLocalToVworld, dirtyBoundsCache, doSetLive, equal, findCollidableFlags, findPickableFlags, findTransformLevels, getBounds, getBoundsAutoCompute, getCollidable, getCurrentLocalToVworld, getCurrentLocalToVworld, getCurrentLocalToVworld, getEffectiveBounds, getId, getLastLocalToVworld, getLastLocalToVworld, getLastLocalToVworld, getLocalBounds, getLocale, getLocalToVworld, getLocalToVworld, getLocalToVworld, getParent, getPickable, getVirtualUniverse, isStatic, merge, notifySceneGraphChanged, processViewSpecificInfo, recombineAbove, removeNodeData, searchGeometryAtoms, setAuxData, setBounds, setBoundsAutoCompute, setCollidable, setNodeData, setParent, setPickable, transformBounds, updateCollidable, updateLocalToVworld, updatePickable

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

ATTRIBUTES_CHANGED

static final int ATTRIBUTES_CHANGED

See Also:

Constant Field Values

BOUNDING_LEAF_CHANGED

static final int BOUNDING_LEAF_CHANGED

See Also:

Constant Field Values

APPLICATION_BOUNDS_CHANGED

static final int APPLICATION_BOUNDS_CHANGED

See Also:

Constant Field Values

applicationRegion

Bounds applicationRegion

Soundscape nodes application region

boundingLeaf

BoundingLeafRetained boundingLeaf

The bounding leaf reference

transformedRegion

Bounds transformedRegion

The transformed Application Region

attributes

AuralAttributesRetained attributes

Aural attributes associated with this Soundscape

isDirty

int isDirty

targetThreads

int targetThreads

isViewScoped

boolean isViewScoped

Constructor Detail

SoundscapeRetained

SoundscapeRetained()

Method Detail

dispatchMessage

void dispatchMessage(int dirtyBit,
                   java.lang.Object argument)

setApplicationBounds

void setApplicationBounds(Bounds region)

Set the Soundscape's application region.

Parameters:

region - a region that contains the Soundscape's new application region

getApplicationBounds

Bounds getApplicationBounds()

Get the Soundscape's application region.

Returns:

this Soundscape's application region information

setApplicationBoundingLeaf

void setApplicationBoundingLeaf(BoundingLeaf region)

Set the Soundscape's application region to the specified Leaf node.

getApplicationBoundingLeaf

BoundingLeaf getApplicationBoundingLeaf()

Get the Soundscape's application region

setAuralAttributes

void setAuralAttributes(AuralAttributes attributes)

Set a set of aural attributes for this Soundscape

Parameters:

attributes - aural attributes to be set

getAuralAttributes

AuralAttributes getAuralAttributes()

Retrieve a reference to Aural Attributes

Returns:

attributes aural attributes to be returned

updateMirrorObject

void updateMirrorObject(java.lang.Object[] objs)

Overrides:

updateMirrorObject in class LeafRetained

updateTransformChange

void updateTransformChange()

Overrides:

updateTransformChange in class LeafRetained

updateBoundingLeaf

void updateBoundingLeaf(long refTime)

setLive

void setLive(SetLiveState s)

This setLive routine first calls the superclass's method, then it adds itself to the list of soundscapes

Overrides:

setLive in class NodeRetained

clearLive

void clearLive(SetLiveState s)

This clearLive routine first calls the superclass's method, then it removes itself to the list of lights

Overrides:

clearLive in class NodeRetained

update

void update(SoundscapeRetained ss)

mergeTransform

void mergeTransform(TransformGroupRetained xform)

Overrides:

mergeTransform in class NodeRetained

getMirrorObjects

void getMirrorObjects(java.util.ArrayList leafList,
                    HashKey key)

Overrides:

getMirrorObjects in class LeafRetained