All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class java.media.j3d.ConeSound 

java.lang.Object
   |
   +----java.media.j3d.SceneGraphObject
           |
           +----java.media.j3d.Node
                   |
                   +----java.media.j3d.Leaf
                           |
                           +----java.media.j3d.Sound
                                   |
                                   +----java.media.j3d.PointSound
                                           |
                                           +----java.media.j3d.ConeSound
public class ConeSound
extends PointSound

Variable Index

o ALLOW_ANGULAR_ATTENUATION_READ
Specifies that this ConeSound allows access to its object's cone params information.
o ALLOW_ANGULAR_ATTENUATION_WRITE
Specifies that this ConeSound allows writing to its object's cone params information.
o ALLOW_DIRECTION_READ
Specifies that this ConeSound allows access to its object's direction information.
o ALLOW_DIRECTION_WRITE
Specifies that this ConeSound allows writing to its object's direction information.

Constructor Index

o ConeSound()
Constructs a cone sound with default parameters.
o ConeSound(MediaContainer, float, float, float, float, float, float, float)
Constructs and initializes a new Cone Sound node using specified parameters.
o ConeSound(MediaContainer, float, int, boolean, boolean, boolean, Bounds, float, float, float, float[], float[], float, float, float, float[], float[], float[])
Constructs and initializes a new Point Sound node using specified parameters.
o ConeSound(MediaContainer, float, int, boolean, boolean, boolean, Bounds, float, float, float, Point2f[], float, float, float, Point3f[])
Constructs and initializes a new Point Sound node using specified parameters.
o ConeSound(MediaContainer, float, int, boolean, boolean, boolean, Bounds, Point3f, float[], float[], Vector3f, float[], float[], float[])
Constructs and initializes a new Cone Sound node using specified parameters.
o ConeSound(MediaContainer, float, int, boolean, boolean, boolean, Bounds, Point3f, Point2f[], Vector3f, Point3f[])
Constructs and initializes a new Cone Sound node using specified parameters.
o ConeSound(MediaContainer, float, Point3f, Vector3f)
Constructs and initializes a new Cone Sound node using specified parameters.

Method Index

o getAngularAttenuation(float[], float[], float[])
Retrieves angular attenuation including gain and filter using separate arrays
o getAngularAttenuation(Point3f[])
Retrieves angular attenuation including gain and filter in a single array
o getDirection(Vector3f)
Retrieves this sound's direction and places it in the vector provided.
o setAngularAttenuation(float[], float[], float[])
Sets angular attenuation including gain and filter using separate arrays
o setAngularAttenuation(Point2f[])
Sets this sound's angular gain attenuation (not including filter)
o setAngularAttenuation(Point3f[])
Sets this sound's angular attenuation including both gain and filter.
o setDirection(float, float, float)
Sets this sound's direction from the three values provided.
o setDirection(Vector3f)
Sets this sound's direction from the vector provided.

Variables

o ALLOW_DIRECTION_READ 
 public static final int ALLOW_DIRECTION_READ
Specifies that this ConeSound allows access to its object's direction information.

o ALLOW_DIRECTION_WRITE 
 public static final int ALLOW_DIRECTION_WRITE
Specifies that this ConeSound allows writing to its object's direction information.

o ALLOW_ANGULAR_ATTENUATION_READ 
 public static final int ALLOW_ANGULAR_ATTENUATION_READ
Specifies that this ConeSound allows access to its object's cone params information.

o ALLOW_ANGULAR_ATTENUATION_WRITE 
 public static final int ALLOW_ANGULAR_ATTENUATION_WRITE
Specifies that this ConeSound allows writing to its object's cone params information.

Constructors

o ConeSound 
 public ConeSound()
Constructs a cone sound with default parameters.

o ConeSound 
 public ConeSound(MediaContainer soundData,
                  float initialGain,
                  Point3f position,
                  Vector3f direction)
Constructs and initializes a new Cone Sound node using specified parameters.

Parameters:
soundData - sound source data associated with this node
initialGain - amplitude scale factor applied to sound
position - 3D location of source
direction - 3D vector defining cones axis
o ConeSound 
 public ConeSound(MediaContainer soundData,
                  float initialGain,
                  float posX,
                  float posY,
                  float posZ,
                  float dirX,
                  float dirY,
                  float dirZ)
Constructs and initializes a new Cone Sound node using specified parameters.

Parameters:
soundData - sound source data
initialGain - amplitude scale factor applied to sound
posX - x coordinate of location of source
posY - y coordinate of location of source
posZ - z coordinate of location of source
dirX - x coordinate cones' axii vector
dirY - y coordinate cones' axii vector
dirZ - z coordinate cones' axii vector
o ConeSound 
 public ConeSound(MediaContainer soundData,
                  float initialGain,
                  int loopCount,
                  boolean release,
                  boolean continuous,
                  boolean enable,
                  Bounds region,
                  Point3f position,
                  Point2f distanceAttenuation[],
                  Vector3f direction,
                  Point3f angularAttenuation[])
Constructs and initializes a new Cone Sound node using specified parameters.

Parameters:
soundData - sound source data associated with this node
initialGain - amplitude scale factor applied to sound
loopCount - number of times sound is looped
release - flag denoting playing sound to end
continuous - denotes that sound silently plays when disabled
enable - sound switched on/off
position - 3D location of source
distanceGain - array of (distance,gain) pairs controling attenuation
direction - vector defining cones' axii
angularAttenuation - array of tuples defining angular gain/filtering
o ConeSound 
 public ConeSound(MediaContainer soundData,
                  float initialGain,
                  int loopCount,
                  boolean release,
                  boolean continuous,
                  boolean enable,
                  Bounds region,
                  float posX,
                  float posY,
                  float posZ,
                  Point2f distanceAttenuation[],
                  float dirX,
                  float dirY,
                  float dirZ,
                  Point3f angularAttenuation[])
Constructs and initializes a new Point Sound node using specified parameters.

Parameters:
soundData - sound source data associated with this node.
initialGain - amplitude scale factor applied to sound
loopCount - number of times sound is looped
release - flag denoting playing sound to end
continuous - denotes that sound silently plays when disabled
enable - sound switched on/off
region - activation bounds
posX - x coordinate of location of source
posY - y coordinate of location of source
posZ - z coordinate of location of source
distanceGain - array of (distance,gain) pairs controling attenuation
dirX - x coordinate cones' axii vector
dirY - y coordinate cones' axii vector
dirZ - z coordinate cones' axii vector
angularAttenuation - array of tuples defining angular gain/filtering
o ConeSound 
 public ConeSound(MediaContainer soundData,
                  float initialGain,
                  int loopCount,
                  boolean release,
                  boolean continuous,
                  boolean enable,
                  Bounds region,
                  Point3f position,
                  float distance[],
                  float distanceGain[],
                  Vector3f direction,
                  float angle[],
                  float angularGain[],
                  float frequencyCutoff[])
Constructs and initializes a new Cone Sound node using specified parameters.

Parameters:
soundData - sound source data associated with this node
initialGain - amplitude scale factor applied to sound
loopCount - number of times sound is looped
release - flag denoting playing sound to end
continuous - denotes that sound silently plays when disabled
enable - sound switched on/off
position - 3D location of source
distance - array of distance values used for attenuation
distanceGain - array of gain scale factors used for attenuation
direction - vector defining cones' axii
angle - array of angle radians for angularAttenuation
angularGain - array of gain scale factors for angularAttenuation
frequencyCutoff - array of lowpass filter values in Hertz
o ConeSound 
 public ConeSound(MediaContainer soundData,
                  float initialGain,
                  int loopCount,
                  boolean release,
                  boolean continuous,
                  boolean enable,
                  Bounds region,
                  float posX,
                  float posY,
                  float posZ,
                  float distance[],
                  float distanceGain[],
                  float dirX,
                  float dirY,
                  float dirZ,
                  float angle[],
                  float angularGain[],
                  float frequencyCutoff[])
Constructs and initializes a new Point Sound node using specified parameters.

Parameters:
soundData - sound source data associated with this node.
initialGain - amplitude scale factor applied to sound
loopCount - number of times sound is looped
release - flag denoting playing sound to end
continuous - denotes that sound silently plays when disabled
enable - sound switched on/off
region - activation bounds
posX - x coordinate of location of source
posY - y coordinate of location of source
posZ - z coordinate of location of source
distance - array of distance values used for attenuation
distanceGain - array of gain scale factors used for attenuation
dirX - x coordinate cones' axii vector
dirY - y coordinate cones' axii vector
dirZ - z coordinate cones' axii vector
angle - array of angle radians for angularAttenuation
angularGain - array of gain scale factors for angularAttenuation
frequencyCutoff - array of lowpass filter values in Hertz

Methods

o setDirection 
 public final void setDirection(Vector3f direction)
Sets this sound's direction from the vector provided.

Parameters:
direction - the new direction
Throws: CapabilityNotSetException
if appropriate capability is not set and this object is part of live or compiled scene graph
o setDirection 
 public final void setDirection(float x,
                                float y,
                                float z)
Sets this sound's direction from the three values provided.

Parameters:
x - the new x direction
y - the new y direction
z - the new z direction
Throws: CapabilityNotSetException
if appropriate capability is not set and this object is part of live or compiled scene graph
o getDirection 
 public final void getDirection(Vector3f direction)
Retrieves this sound's direction and places it in the vector provided.

Parameters:
direction - axis of cones; 'direction' of sound
Throws: CapabilityNotSetException
if appropriate capability is not set and this object is part of live or compiled scene graph
o setAngularAttenuation 
 public final void setAngularAttenuation(Point2f attenuation[])
Sets this sound's angular gain attenuation (not including filter)

Parameters:
attenuation - array containing angular distance and gain
Throws: CapabilityNotSetException
if appropriate capability is not set and this object is part of live or compiled scene graph
o setAngularAttenuation 
 public final void setAngularAttenuation(Point3f attenuation[])
Sets this sound's angular attenuation including both gain and filter.

Parameters:
attenuation - array containing angular distance, gain and filter
Throws: CapabilityNotSetException
if appropriate capability is not set and this object is part of live or compiled scene graph
o setAngularAttenuation 
 public final void setAngularAttenuation(float distance[],
                                         float gain[],
                                         float filter[])
Sets angular attenuation including gain and filter using separate arrays

Parameters:
distance - array containing angular distance
gain - array containing angular gain attenuation
filter - array containing angular low-pass frequency cutoff values
Throws: CapabilityNotSetException
if appropriate capability is not set and this object is part of live or compiled scene graph
o getAngularAttenuation 
 public final void getAngularAttenuation(Point3f attenuation[])
Retrieves angular attenuation including gain and filter in a single array

Parameters:
attenuation - applied to gain when listener is between cones
Throws: CapabilityNotSetException
if appropriate capability is not set and this object is part of live or compiled scene graph
o getAngularAttenuation 
 public final void getAngularAttenuation(float distance[],
                                         float gain[],
                                         float filter[])
Retrieves angular attenuation including gain and filter using separate arrays

Parameters:
distance - array containing angular distance
gain - array containing angular gain attenuation
filter - array containing angular low-pass frequency cutoff values
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