| java.lang.Object
 javax.media.j3d.SceneGraphObject
javax.media.j3d.Node
javax.media.j3d.Leaf
javax.media.j3d.Soundscape
| Soundscape | | public class Soundscape extends Leaf (Code) | | The Soundscape Leaf Node defines the attributes that characterize the
listener's environment as it pertains to sound. This node defines an
application region and an associated aural attribute component object
that controls reverberation and atmospheric properties that affect sound
source rendering. Multiple Soundscape nodes can be included in a single
scene graph.
The Soundscape application region, different from a Sound node's scheduling
region, is used to select which Soundscape (and thus which aural attribute
object) is to be applied to the sounds being rendered. This selection is
based on the position of the ViewPlatform (i.e., the listener), not the
position of the sound.
It will be common that multiple Soundscape regions are contained within a
scene graph. For example, two Soundscape regions within a single space the
listener can move about: a region with a large open area on the right, and
a smaller more constricted, less reverberant area on the left. The rever-
beration attributes for these two regions could be set to approximate their
physical differences so that active sounds are rendered differently depending
on which region the listener is in.
|
| ALLOW_APPLICATION_BOUNDS_READ | | final public static int ALLOW_APPLICATION_BOUNDS_READ(Code) | | For Soundscape component objects, specifies that this object
allows read access to its application bounds
|
| ALLOW_APPLICATION_BOUNDS_WRITE | | final public static int ALLOW_APPLICATION_BOUNDS_WRITE(Code) | | For Soundscape component objects, specifies that this object
allows write access to its application bounds
|
| ALLOW_ATTRIBUTES_READ | | final public static int ALLOW_ATTRIBUTES_READ(Code) | | For Soundscape component objects, specifies that this object
allows the reading of it's aural attributes information
|
| ALLOW_ATTRIBUTES_WRITE | | final public static int ALLOW_ATTRIBUTES_WRITE(Code) | | For Soundscape component objects, specifies that this object
allows the writing of it's aural attribute information
|
| Soundscape | | public Soundscape()(Code) | | Constructs and initializes a new Sound node using following
defaults:
application region: null (no active region)
aural attributes: null (uses default aural attributes)
|
| Soundscape | | public Soundscape(Bounds region, AuralAttributes attributes)(Code) | | Constructs and initializes a new Sound node using specified
parameters
Parameters:
region - application region
Parameters:
attributes - array of aural attribute component objects |
| 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 SoundscapeRetained object that this
component object will point to.
|
| duplicateAttributes | | void duplicateAttributes(Node originalNode, boolean forceDuplicate)(Code) | | Copies all Soundscape information from
originalNode into
the current node. This method is called from the
cloneNode method which is, in turn, called by the
cloneTree 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:
RestrictedAccessException - if this object is part of a liveor compiled scenegraph.
See Also: Node.duplicateNode
See Also: Node.cloneTree
See Also: NodeComponent.setDuplicateOnCloneTree |
| 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 Soundscape
See Also: Node.cloneTree
See Also: Node.cloneNode
See Also: NodeComponent.setDuplicateOnCloneTree |
| getApplicationBoundingLeaf | | public BoundingLeaf getApplicationBoundingLeaf()(Code) | | Retrieves the Soundscape node's application bounding leaf.
this Soundscape's application bounding leaf information
exception:
CapabilityNotSetException - if appropriate capability isnot set and this object is part of live or compiled scene graph |
| getApplicationBounds | | public Bounds getApplicationBounds()(Code) | | Retrieves the Soundscape node's application bounds.
this Soundscape's application bounds information
exception:
CapabilityNotSetException - if appropriate capability isnot set and this object is part of live or compiled scene graph |
| getAuralAttributes | | public AuralAttributes getAuralAttributes()(Code) | | Retrieve reference of Aural Attributes
reference to aural attributes
exception:
CapabilityNotSetException - if appropriate capability isnot set and this object is part of live or compiled scene graph |
| setApplicationBoundingLeaf | | public void setApplicationBoundingLeaf(BoundingLeaf region)(Code) | | Set the Soundscape's application region to the specified bounding leaf.
When set to a value other than null, this overrides the application
bounds object.
Parameters:
region - the bounding leaf node used to specify the Soundscapenode's new application region.
exception:
CapabilityNotSetException - if appropriate capability isnot set and this object is part of live or compiled scene graph |
| setApplicationBounds | | public void setApplicationBounds(Bounds region)(Code) | | Set the Soundscape's application region to the specified bounds
specified in local coordinates of this leaf node. The aural
attributes associated with this Soundscape are used to render
the active sounds when this application region intersects the
ViewPlatform's activation volume. The getApplicationBounds method
returns a new Bounds object.
This region is used when the application bounding leaf is null.
Parameters:
region - the bounds that contains the Soundscape's new applicationregion.
exception:
CapabilityNotSetException - if appropriate capability isnot set and this object is part of live or compiled scene graph |
| setAuralAttributes | | public void setAuralAttributes(AuralAttributes attributes)(Code) | | Set a set of aural attributes for this Soundscape
Parameters:
attributes - aural attributes
exception:
CapabilityNotSetException - if appropriate capability isnot set and this object is part of live or compiled scene graph |
| updateNodeReferences | | public void updateNodeReferences(NodeReferenceTable referenceTable)(Code) | | Callback used to allow a node to check if any scene graph objects
referenced
by that node have been duplicated via a call to cloneTree.
This method is called by cloneTree after all nodes in
the sub-graph have been duplicated. The cloned Leaf node's method
will be called and the Leaf node can then look up any object references
by using the getNewObjectReference method found in the
NodeReferenceTable object. If a match is found, a
reference to the corresponding object in the newly cloned sub-graph
is returned. If no corresponding reference is found, either a
DanglingReferenceException is thrown or a reference to the original
object is returned depending on the value of the
allowDanglingReferences parameter passed in the
cloneTree call.
NOTE: Applications should not call this method directly.
It should only be called by the cloneTree method.
Parameters:
referenceTable - a NodeReferenceTableObject that contains thegetNewObjectReference method needed to search fornew object instances.
See Also: NodeReferenceTable
See Also: Node.cloneTree
See Also: DanglingReferenceException |
|
|