All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class java.media.j3d.AuralAttributes

java.lang.Object
   |
   +----java.media.j3d.SceneGraphObject
           |
           +----java.media.j3d.NodeComponent
                   |
                   +----java.media.j3d.AuralAttributes

public class AuralAttributes

extends NodeComponent

ALLOW_ATTRIBUTE_GAIN_READ

For AuralAttributes component objects, specifies that this object allows the reading of it's attribute gain scale factor information

ALLOW_ATTRIBUTE_GAIN_WRITE

For AuralAttributes component objects, specifies that this object allows the writing of it's attribute gain scale factor information

ALLOW_DISTANCE_FILTER_READ

For AuralAttributes component objects, specifies that this object allows the reading of it's frequency cutoff information

ALLOW_DISTANCE_FILTER_WRITE

For AuralAttributes component objects, specifies that this object allows the writing of it's frequency cutoff information

ALLOW_DOPPLER_SCALE_FACTOR_READ

For AuralAttributes component objects, specifies that this object allows the reading of it's Doppler scale factor information.

ALLOW_DOPPLER_SCALE_FACTOR_WRITE

For AuralAttributes component objects, specifies that this object allows the writing of it's Doppler scale factor information.

ALLOW_DOPPLER_VELOCITY_READ

For AuralAttributes component objects, specifies that this object allows the reading of it's Doppler velocity information.

ALLOW_DOPPLER_VELOCITY_WRITE

For AuralAttributes component objects, specifies that this object allows the writing of it's Doppler velocity information.

ALLOW_REFLECTION_COEFFICIENT_READ

For AuralAttributes component objects, specifies that this object allows the reading of it's reflection coefficient

ALLOW_REFLECTION_COEFFICIENT_WRITE

For AuralAttributes component objects, specifies that this object allows the writing of it's reflection coefficient

ALLOW_REVERB_DELAY_READ

For AuralAttributes component objects, specifies that this object allows the reading of it's reverberation delay information

ALLOW_REVERB_DELAY_WRITE

For AuralAttributes component objects, specifies that this object allows the writing of it's reverberation delay information

ALLOW_REVERB_ORDER_READ

For AuralAttributes component objects, specifies that this object allows the reading of it's reverb order (feedback loop) information

ALLOW_REVERB_ORDER_WRITE

For AuralAttributes component objects, specifies that this object allows the writing of it's reverb order (feedback loop) information

ALLOW_ROLLOFF_READ

For AuralAttributes component objects, specifies that this object allows the reading of it's atmospheric rolloff.

ALLOW_ROLLOFF_WRITE

For AuralAttributes component objects, specifies that this object allows the writing of it's atmospheric rolloff.

AuralAttributes()

Constructs and initializes a new AuralAttributes object using defaults for all parameters.

AuralAttributes(float, float, float, float, int, float[], float[], float, float)

Constructs and initializes a new AuralAttributes object using specified parameters with separate float arrays for components of distanceFilter

AuralAttributes(float, float, float, float, int, Point2f[], float, float)

Constructs and initializes a new AuralAttributes object using specified parameters including a array of Point2f for the distanceFilter

getAttributeGain()

Retrieve Attrribute Gain (amplitude)

getDistanceFilter(float[], float[])

Retrieve Distance Filter in separate distance and frequency cutoff arrays

getDistanceFilter(Point2f[])

Retrieve Distance Filter as a single array containing distances and frequency cutoff

getDopplerScaleFactor()

Retrieve Doppler Scale Factor

getDopplerVelocity()

Retrieve Velocity used to calculate Doppler Effect

getReflectionCoefficient()

Retrieve Reflective Coefficient

getReverbDelay()

Retrieve Revereration Delay Time

getReverbOrder()

Retrieve Reverberation Order of Reflections

getRolloff()

Retrieve Attribute Gain Rolloff

setAttributeGain(float)

Set Attribute Gain (amplitude)

setDistanceFilter(float[], float[])

Set Distance Filter using separate arrays for distances and frequency cutoff

setDistanceFilter(Point2f[])

Set Distance Filter using a single array containing distances and frequency cutoff

setDopplerScaleFactor(float)

Set Doppler Scale Factor

setDopplerVelocity(float)

Set Velocity used to calculate Doppler Effect

setReflectionCoefficient(float)

Set Reflective Coefficient

setReverbDelay(Bounds)

Set Revereration Delay Time using volume of bounds

setReverbDelay(float)

Set Revereration Delay Time

setReverbOrder(int)

Set Reverberation Order of Reflections

setRolloff(float)

Set Attribute Gain Rolloff

 public static final int ALLOW_ATTRIBUTE_GAIN_READ

For AuralAttributes component objects, specifies that this object allows the reading of it's attribute gain scale factor information

 public static final int ALLOW_ATTRIBUTE_GAIN_WRITE

For AuralAttributes component objects, specifies that this object allows the writing of it's attribute gain scale factor information

 public static final int ALLOW_ROLLOFF_READ

For AuralAttributes component objects, specifies that this object allows the reading of it's atmospheric rolloff.

 public static final int ALLOW_ROLLOFF_WRITE

For AuralAttributes component objects, specifies that this object allows the writing of it's atmospheric rolloff.

 public static final int ALLOW_REFLECTION_COEFFICIENT_READ

For AuralAttributes component objects, specifies that this object allows the reading of it's reflection coefficient

 public static final int ALLOW_REFLECTION_COEFFICIENT_WRITE

For AuralAttributes component objects, specifies that this object allows the writing of it's reflection coefficient

 public static final int ALLOW_REVERB_DELAY_READ

For AuralAttributes component objects, specifies that this object allows the reading of it's reverberation delay information

 public static final int ALLOW_REVERB_DELAY_WRITE

For AuralAttributes component objects, specifies that this object allows the writing of it's reverberation delay information

 public static final int ALLOW_REVERB_ORDER_READ

For AuralAttributes component objects, specifies that this object allows the reading of it's reverb order (feedback loop) information

 public static final int ALLOW_REVERB_ORDER_WRITE

For AuralAttributes component objects, specifies that this object allows the writing of it's reverb order (feedback loop) information

 public static final int ALLOW_DISTANCE_FILTER_READ

For AuralAttributes component objects, specifies that this object allows the reading of it's frequency cutoff information

 public static final int ALLOW_DISTANCE_FILTER_WRITE

For AuralAttributes component objects, specifies that this object allows the writing of it's frequency cutoff information

 public static final int ALLOW_DOPPLER_SCALE_FACTOR_READ

For AuralAttributes component objects, specifies that this object allows the reading of it's Doppler scale factor information.

 public static final int ALLOW_DOPPLER_SCALE_FACTOR_WRITE

For AuralAttributes component objects, specifies that this object allows the writing of it's Doppler scale factor information.

 public static final int ALLOW_DOPPLER_VELOCITY_READ

For AuralAttributes component objects, specifies that this object allows the reading of it's Doppler velocity information.

 public static final int ALLOW_DOPPLER_VELOCITY_WRITE

For AuralAttributes component objects, specifies that this object allows the writing of it's Doppler velocity information.

 public AuralAttributes()

Constructs and initializes a new AuralAttributes object using defaults for all parameters.

 public AuralAttributes(float gain,
                        float rolloff,
                        float reflectionCoefficient,
                        float reverbDelay,
                        int reverbOrder,
                        Point2f distanceFilter[],
                        float dopplerScaleFactor,
                        float dopplerVelocity)

Constructs and initializes a new AuralAttributes object using specified parameters including a array of Point2f for the distanceFilter

Parameters:

gain - amplitude scale factor

rolloff - atmospheric (changing speed of sound) scale factor

coefficient - reflection/absorption scale factor applied to reverb

reverb_delay - time between each order of reflection

reverb_order - number of times reflections added to reverb signal

cutoff - distance filter frequency cutoff

doppler_scale_factor - factor applied to velocity/wave-length

doppler_velocity - velocity of sound in relation to listener

 public AuralAttributes(float gain,
                        float rolloff,
                        float reflectionCoefficient,
                        float reverbDelay,
                        int reverbOrder,
                        float distance[],
                        float frequencyCutoff[],
                        float dopplerScaleFactor,
                        float dopplerVelocity)

Constructs and initializes a new AuralAttributes object using specified parameters with separate float arrays for components of distanceFilter

Parameters:

gain - amplitude scale factor

rolloff - atmospheric (changing speed of sound) scale factor

coefficient - reflection/absorption scale factor applied to reverb

reverb_delay - time between each order of reflection

reverb_order - number of times reflections added to reverb signal

cutoff - distance filter frequency cutoff

doppler_scale_factor - factor applied to velocity/wave-length

doppler_velocity - velocity of sound in relation to listener

 public final void setAttributeGain(float gain)

Set Attribute Gain (amplitude)

Parameters:

gain - scale factor applied to amplitude

Throws: CapabilityNotSetException

if appropriate capability is not set and this object is part of live or compiled scene graph

 public final float getAttributeGain()

Retrieve Attrribute Gain (amplitude)

Returns:

gain amplitude scale factor

Throws: CapabilityNotSetException

if appropriate capability is not set and this object is part of live or compiled scene graph

 public final void setRolloff(float rolloff)

Set Attribute Gain Rolloff

Parameters:

rolloff - atmospheric gain scale factor (changing speed of sound)

Throws: CapabilityNotSetException

if appropriate capability is not set and this object is part of live or compiled scene graph

 public final float getRolloff()

Retrieve Attribute Gain Rolloff

Returns:

rolloff atmospheric gain scale factor (changing speed of sound)

Throws: CapabilityNotSetException

if appropriate capability is not set and this object is part of live or compiled scene graph

 public final void setReflectionCoefficient(float coefficient)

Set Reflective Coefficient

Parameters:

coefficient - reflection/absorption factor applied to reverb

Throws: CapabilityNotSetException

if appropriate capability is not set and this object is part of live or compiled scene graph

 public final float getReflectionCoefficient()

Retrieve Reflective Coefficient

Returns:

reflection coeff reflection/absorption factor applied to reverb

Throws: CapabilityNotSetException

if appropriate capability is not set and this object is part of live or compiled scene graph

 public final void setReverbDelay(float reverbDelay)

Set Revereration Delay Time

Parameters:

reverbDelay - time between each order of reflection

Throws: CapabilityNotSetException

if appropriate capability is not set and this object is part of live or compiled scene graph

 public final void setReverbDelay(Bounds reverbVolume)

Set Revereration Delay Time using volume of bounds

Parameters:

reverbVolume - bounds used to approximate reverb time.

Throws: CapabilityNotSetException

if appropriate capability is not set and this object is part of live or compiled scene graph

 public final float getReverbDelay()

Retrieve Revereration Delay Time

Returns:

reverb delay time between each order of reflection

Throws: CapabilityNotSetException

if appropriate capability is not set and this object is part of live or compiled scene graph

 public final void setReverbOrder(int reverbOrder)

Set Reverberation Order of Reflections

Parameters:

reverbOrder - number of times reflections added to reverb signal

Throws: CapabilityNotSetException

if appropriate capability is not set and this object is part of live or compiled scene graph

 public final int getReverbOrder()

Retrieve Reverberation Order of Reflections

Returns:

reverb order number of times reflections added to reverb signal

Throws: CapabilityNotSetException

if appropriate capability is not set and this object is part of live or compiled scene graph

 public final void setDistanceFilter(Point2f attenuation[])

Set Distance Filter using a single array containing distances and frequency cutoff

Parameters:

attenuation - array of pairs of distance and frequency cutoff

Throws: CapabilityNotSetException

if appropriate capability is not set and this object is part of live or compiled scene graph

 public final void setDistanceFilter(float distance[],
                                     float frequencyCutoff[])

Set Distance Filter using separate arrays for distances and frequency cutoff

Parameters:

distance - array of float distance with corresponding cutoff values

frequencyCutoff - array of frequency cutoff values in Hertz

Throws: CapabilityNotSetException

if appropriate capability is not set and this object is part of live or compiled scene graph

 public final void getDistanceFilter(Point2f attenuation[])

Retrieve Distance Filter as a single array containing distances and frequency cutoff

Returns:

attenuation array of pais of distance and frequency cutoff values

Throws: CapabilityNotSetException

if appropriate capability is not set and this object is part of live or compiled scene graph

 public final void getDistanceFilter(float distance[],
                                     float frequencyCutoff[])

Retrieve Distance Filter in separate distance and frequency cutoff arrays

Parameters:

distance - array

frequency - cutoff array

Throws: CapabilityNotSetException

if appropriate capability is not set and this object is part of live or compiled scene graph

 public final void setDopplerScaleFactor(float dopplerScaleFactor)

Set Doppler Scale Factor

Parameters:

dopplerScaleFactor - factor applied to velocity/wave-length

Throws: CapabilityNotSetException

if appropriate capability is not set and this object is part of live or compiled scene graph

 public final float getDopplerScaleFactor()

Retrieve Doppler Scale Factor

Returns:

doppler scaleFactor factor applied to velocity/wave-length

Throws: CapabilityNotSetException

if appropriate capability is not set and this object is part of live or compiled scene graph

 public final void setDopplerVelocity(float dopplerVelocity)

Set Velocity used to calculate Doppler Effect

Parameters:

dopplerVelocity - velocity of sound in relation to listener

Throws: CapabilityNotSetException

if appropriate capability is not set and this object is part of live or compiled scene graph

 public final float getDopplerVelocity()

Retrieve Velocity used to calculate Doppler Effect

Returns:

doppler velocity velocity of sound in relation to listener

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