All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class java.media.j3d.Soundscape 

java.lang.Object
   |
   +----java.media.j3d.SceneGraphObject
           |
           +----java.media.j3d.Node
                   |
                   +----java.media.j3d.Leaf
                           |
                           +----java.media.j3d.Soundscape
public class Soundscape
extends Leaf
The Soundscape object defines all sound state that can be set as a component object of a Leaf node.

Variable Index

o ALLOW_APPLICATION_BOUNDS_READ
For Soundscape component objects, specifies that this object allows read access to its application bounds
o ALLOW_APPLICATION_BOUNDS_WRITE
For Soundscape component objects, specifies that this object allows write access to its application bounds
o ALLOW_ATTRIBUTES_READ
For Soundscape component objects, specifies that this object allows the reading of it's aural attributes information
o ALLOW_ATTRIBUTES_WRITE
For Soundscape component objects, specifies that this object allows the writing of it's aural attribute information

Constructor Index

o Soundscape()
Constructs and initializes a new Sound node using defaults for all parameters.
o Soundscape(Bounds, AuralAttributes)
Constructs and initializes a new Sound node using specified parameters

Method Index

o getApplicationBoundingLeaf()
Retrieves the Soundscape node's application bounding leaf.
o getApplicationBounds()
Retrieves the Soundscape node's application bounds.
o getAuralAttributes()
Retrieve reference of Aural Attributes
o setApplicationBoundingLeaf(BoundingLeaf)
Set the Soundscape's application region to the specified bounding leaf.
o setApplicationBounds(Bounds)
Set the Soundscape's application region to the specified bounds.
o setAuralAttributes(AuralAttributes)
Set a set of aural attributes for this Soundscape

Variables

o ALLOW_APPLICATION_BOUNDS_READ 
 public static final int ALLOW_APPLICATION_BOUNDS_READ
For Soundscape component objects, specifies that this object allows read access to its application bounds

o ALLOW_APPLICATION_BOUNDS_WRITE 
 public static final int ALLOW_APPLICATION_BOUNDS_WRITE
For Soundscape component objects, specifies that this object allows write access to its application bounds

o ALLOW_ATTRIBUTES_READ 
 public static final int ALLOW_ATTRIBUTES_READ
For Soundscape component objects, specifies that this object allows the reading of it's aural attributes information

o ALLOW_ATTRIBUTES_WRITE 
 public static final int ALLOW_ATTRIBUTES_WRITE
For Soundscape component objects, specifies that this object allows the writing of it's aural attribute information

Constructors

o Soundscape 
 public Soundscape()
Constructs and initializes a new Sound node using defaults for all parameters.

o Soundscape 
 public Soundscape(Bounds region,
                   AuralAttributes attributes)
Constructs and initializes a new Sound node using specified parameters

Parameters:
region - application region
attributes - array of aural attribute component objects

Methods

o setApplicationBounds 
 public final void setApplicationBounds(Bounds region)
Set the Soundscape's application region to the specified bounds. This is used when the application bounding leaf is set to null.

Parameters:
region - the bounds that contains the Soundscape's new application region.
Throws: CapabilityNotSetException
if appropriate capability is not set and this object is part of live or compiled scene graph
o getApplicationBounds 
 public final Bounds getApplicationBounds()
Retrieves the Soundscape node's application bounds.

Returns:
this Soundscape's application bounds information
Throws: CapabilityNotSetException
if appropriate capability is not set and this object is part of live or compiled scene graph
o setApplicationBoundingLeaf 
 public final void setApplicationBoundingLeaf(BoundingLeaf region)
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 Soundscape node's new application region.
Throws: CapabilityNotSetException
if appropriate capability is not set and this object is part of live or compiled scene graph
o getApplicationBoundingLeaf 
 public final BoundingLeaf getApplicationBoundingLeaf()
Retrieves the Soundscape node's application bounding leaf.

Returns:
this Soundscape's application bounding leaf information
Throws: CapabilityNotSetException
if appropriate capability is not set and this object is part of live or compiled scene graph
o setAuralAttributes 
 public final void setAuralAttributes(AuralAttributes attributes)
Set a set of aural attributes for this Soundscape

Parameters:
attributes - aural attributes
Throws: CapabilityNotSetException
if appropriate capability is not set and this object is part of live or compiled scene graph
o getAuralAttributes 
 public final AuralAttributes getAuralAttributes()
Retrieve reference of Aural Attributes

Returns:
reference to aural attributes
Throws: CapabilityNotSetException
if appropriate capability is not set and this object is part of live or compiled scene graph 
All Packages  Class Hierarchy  This Package  Previous  Next  Index