Java Doc for AuralAttributes.java in  » 6.0-JDK-Modules » java-3d » javax » media » j3d » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation
1. 6.0 JDK Core
2. 6.0 JDK Modules
3. 6.0 JDK Modules com.sun
4. 6.0 JDK Modules com.sun.java
5. 6.0 JDK Modules sun
6. 6.0 JDK Platform
7. Ajax
8. Apache Harmony Java SE
9. Aspect oriented
10. Authentication Authorization
11. Blogger System
12. Build
13. Byte Code
14. Cache
15. Chart
16. Chat
17. Code Analyzer
18. Collaboration
19. Content Management System
20. Database Client
21. Database DBMS
22. Database JDBC Connection Pool
23. Database ORM
24. Development
25. EJB Server geronimo
26. EJB Server GlassFish
27. EJB Server JBoss 4.2.1
28. EJB Server resin 3.1.5
29. ERP CRM Financial
30. ESB
31. Forum
32. GIS
33. Graphic Library
34. Groupware
35. HTML Parser
36. IDE
37. IDE Eclipse
38. IDE Netbeans
39. Installer
40. Internationalization Localization
41. Inversion of Control
42. Issue Tracking
43. J2EE
44. JBoss
45. JMS
46. JMX
47. Library
48. Mail Clients
49. Net
50. Parser
51. PDF
52. Portal
53. Profiler
54. Project Management
55. Report
56. RSS RDF
57. Rule Engine
58. Science
59. Scripting
60. Search Engine
61. Security
62. Sevlet Container
63. Source Control
64. Swing Library
65. Template Engine
66. Test Coverage
67. Testing
68. UML
69. Web Crawler
70. Web Framework
71. Web Mail
72. Web Server
73. Web Services
74. Web Services apache cxf 2.0.1
75. Web Services AXIS2
76. Wiki Engine
77. Workflow Engines
78. XML
79. XML UI
Java
Java Tutorial
Java Open Source
Jar File Download
Java Articles
Java Products
Java by API
Photoshop Tutorials
Maya Tutorials
Flash Tutorials
3ds-Max Tutorials
Illustrator Tutorials
GIMP Tutorials
C# / C Sharp
C# / CSharp Tutorial
C# / CSharp Open Source
ASP.Net
ASP.NET Tutorial
JavaScript DHTML
JavaScript Tutorial
JavaScript Reference
HTML / CSS
HTML CSS Reference
C / ANSI-C
C Tutorial
C++
C++ Tutorial
Ruby
PHP
Python
Python Tutorial
Python Open Source
SQL Server / T-SQL
SQL Server / T-SQL Tutorial
Oracle PL / SQL
Oracle PL/SQL Tutorial
PostgreSQL
SQL / MySQL
MySQL Tutorial
VB.Net
VB.Net Tutorial
Flash / Flex / ActionScript
VBA / Excel / Access / Word
XML
XML Tutorial
Microsoft Office PowerPoint 2007 Tutorial
Microsoft Office Excel 2007 Tutorial
Microsoft Office Word 2007 Tutorial
Java Source Code / Java Documentation » 6.0 JDK Modules » java 3d » javax.media.j3d 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.lang.Object
   javax.media.j3d.SceneGraphObject
      javax.media.j3d.NodeComponent
         javax.media.j3d.AuralAttributes

AuralAttributes
public class AuralAttributes extends NodeComponent (Code)
The AuralAttributes object is a component object of a Soundscape node that defines environmental audio parameters that affect sound rendering. These attributes include gain scale factor, atmospheric rolloff, and parameters controlling reverberation, distance frequency filtering, and velocity-based Doppler effect.

Attribute Gain

    Scale factor applied to all sound's amplitude active within this region. This factor attenuates both direct and reflected/reverbered amplitudes. Valid values are >= 0.0

Attribute Gain Rolloff

    Rolloff scale factor is used to model atmospheric changes from normal speed of sound. The base value, 0.344 meters/millisecond is used to approximate the speed of sound through air at room temperature, is multipled by this scale factor whenever the speed of sound is applied during spatialization calculations. Valid values are >= 0.0. Values > 1.0 increase the speed of sound, while values < 1.0 decrease its speed. A value of zero makes sound silent (but it continues to play).

Auralization

    Auralization is the environmental modeling of sound iteratively reflecting off the surfaces of the bounded region the listener is in. Auralization components include early, distinct, low-order reflections and later, dense, higher-order reflections referred to as reverberation. These reflections are attenuated relative to the direct, unreflected sound. The difference in gain between direct and reflected sound gives the listener a sense of the surface material and the relative distance of the sound. The delay between the start of the direct sound and start of reverberation (as detected by the listener), as well as the length of time reverberation is audible as it exponentially decays, give the listener a sense of the size of the listening space.

    In Java3D's model for auralization there are several parameters that approximate sound reflection and reverberation for a particular listening space:

      Reflection Coefficient
        Gain attenuation of the initial reflections across all frequencies.
      (Early) Reflection Delay
        The time it takes for the first low-order reflected sound to reach the listener.
      Reverb Coefficient
        Gain attenuation of the late reflections (referred to as 'reverb') across all frequencies.
      Reverb Delay
        The time it takes for reverbered sound to reach the listener.
      Decay Time
        Describes the reverb decay curve by defining the length of time reverb takes to decay to effective zero.
      Decay Filter
        High-frequencies of the late reverberation can be attenuated at a different rate.
      Density
        Modal density (spectral coloration) of reverberation.
      Diffusion
        Echo dispersement of reverberation.
      Reverb Bounds
        Approximates the volume of the listening space. If specified, it defines the reverberation delay.
      Reverb Order
        Optionally limits the amount of times during reverb calculation that a sound is recursively reflected off the bounding region.

    Reflection Coefficient

      The reflection coefficient is an amplitude scale factor used to approximate the average reflective or absorptive characteristics for early reflections of the composite surfaces in the region the listener is in. This scale factor is applied to the sound's amplitude regardless of the sound's position. The range of valid values is 0.0 to 1.0. A value of 1.0 denotes that reflections are unattenuated - the amplitude of reflected sound waves are not decreased. A value of 0.0 represents full absorption of reflections by the surfaces in the listening space (no reflections occur thus reverberation is disabled).

    Reflection Delay

      The early reflection delay time (in milliseconds) can be explicitly set. Well-defined values are floats > 0.0. A value of 0.0 results in reverberation being added as soon as possible after the sound begins.

    Reverberation Coefficient

      The reverb coefficient is an amplitude scale factor used to approximate the average reflective or absorptive characteristics of late reflections. A value of 0.0 represents full absorption of reflections by the surfaces in the listening space (no reflections occur thus reverberation is disabled).

    Reverberation Delay

      The reverb delay time (in milliseconds) is set either explicitly, or implicitly by supplying a reverb bounds volume (from which the delay time can be calculated). Well-defined values are floats > 0.0. A value of 0.0 results in reverberation being added as soon as possible after the sound begins. Reverb delay, as calculated from non- null reverb bounds, takes precedence over explicitly set delay time.

    Reverberation Bounds

      The reverb bounding region defines the overall size of space that reverberation is calculated for. This optional bounds does not have to be the same as the application region of the Soundscape node referencing this AuralAttributes object. If this bounding region is specified then reverb decay and delay are internally calculated from this bounds.

    Reverberation Order

      The reverb order is a hint that can be used during reverberation to limit the number of late reflections required in calculation of reverb decay. All positive values can be interpreted during reverb rendering as the maximum order of reflections to be calculated. A non-positive value signifies that no limit is placed on the order of reflections calculated during reverberation rendering. In the case where reverb order is not limited, reverb decay is defined strictly by the Reverberation Decay Time parameter.

    Decay Time

      The reverberation decay time explicitly defines the length of time in milliseconds it takes for the amplitude of late reflections to exponentally decrease to effective zero. In the case where reverb delay is set non-positive the renderer will perform the shortest reverberation decay possible. If ReverbOrder is set, this parameter is clamped by the reverb time calculated as time = reverb Delay * reverb Order. If ReverbOrder is 0, the decay time parameter is not clamped.

    Decay Filter

      The reverberation decay filter defines how frequencies above a given value are attenuated by the listening space. This allows for modelling materials on surfaces that absorb high frequencies at a faster rate than low frequencies.

    Reverberation Diffusion

      The reverberation diffusion explicitly defines echo dispersement (sometimes refered to as echo density). The value for diffusion is proportional to the number of echos per second heard in late reverberation, especially noticable at the tail of the reverberation decay. The greater the diffusion the more 'natural' the reverberation decay sounds. Reducing diffusion makes the decay sound hollow as produced in a small highly reflecive space (such as a bathroom).

    Reverberation Density

      The reverberation density explicitly defines modal reverb density The value for this modal density is proportional to the number of resonances heard in late reverberation perceived as spectral coloration. The greater the density, the smoother, less grainy the later reverberation decay.

Distance Filter

    This parameter specifies a (distance, filter) attenuation pairs array. If this is not set, no distance filtering is performed (equivalent to using a distance filter of Sound.NO_FILTER for all distances). Currently, this filter is a low-pass cutoff frequency. This array of pairs defines a piece-wise linear slope for range of values. This attenuation array is similar to the PointSound node's distanceAttenuation pair array, except paired with distances in this list are frequency values. Using these pairs, distance-based low-pass frequency filtering can be applied during sound rendering. Distances, specified in the local coordinate system in meters, must be > 0. Frequencies (in Hz) must be > 0.

    If the distance from the listener to the sound source is less than the first distance in the array, the first filter is applied to the sound source. This creates a spherical region around the listener within which a sound is uniformly attenuated by the first filter in the array. If the distance from the listener to the sound source is greater than the last distance in the array, the last filter is applied to the sound source.

    Distance elements in these array of pairs is a monotonically-increasing set of floating point numbers measured from the location of the sound source. FrequencyCutoff elements in this list of pairs can be any positive float. While for most applications this list of values will usually be monotonically-decreasing, they do not have to be.

    The getDistanceFilterLength method returns the length of the distance filter arrays. Arrays passed into getDistanceFilter methods should all be at least this size.

Doppler Effect Model

    Doppler effect can be used to create a greater sense of movement of sound sources, and can help reduce front-back localization errors. The frequency of sound waves emanating from the source are raised or lowered based on the speed of the source in relation to the listener, and several AuralAttribute parameters.

    The FrequencyScaleFactor can be used to increase or reduce the change of frequency associated with normal Doppler calculation, or to shift the pitch of the sound directly if Doppler effect is disabled. Values must be > zero for sounds to be heard. If the value is zero, sounds affected by this AuralAttribute object are paused.

    To simulate Doppler effect, the relative velocity (change in distance in the local coordinate system between the sound source and the listener over time, in meters per second) is calculated. This calculated velocity is multipled by the given VelocityScaleFactor. Values must be >= zero. If is a scale factor value of zero is given, Doppler effect is not calculated or applied to sound.



Field Summary
final public static  intALLOW_ATTRIBUTE_GAIN_READ
     For AuralAttributes component objects, specifies that this object allows the reading of it's attribute gain scale factor information.
final public static  intALLOW_ATTRIBUTE_GAIN_WRITE
     For AuralAttributes component objects, specifies that this object allows the writing of it's attribute gain scale factor information.
final public static  intALLOW_DECAY_FILTER_READ
     For AuralAttributes component objects, specifies that this object allows the reading of it's reverb decay filter information.
final public static  intALLOW_DECAY_FILTER_WRITE
     For AuralAttributes component objects, specifies that this object allows the writing of it's reverb decay filter information.
final public static  intALLOW_DECAY_TIME_READ
     For AuralAttributes component objects, specifies that this object allows the reading of it's reverb decay time information.
final public static  intALLOW_DECAY_TIME_WRITE
     For AuralAttributes component objects, specifies that this object allows the writing of it's reverb decay time information.
final public static  intALLOW_DENSITY_READ
     For AuralAttributes component objects, specifies that this object allows the reading of it's reverb density information.
final public static  intALLOW_DENSITY_WRITE
     For AuralAttributes component objects, specifies that this object allows the writing of it's reverb density information.
final public static  intALLOW_DIFFUSION_READ
     For AuralAttributes component objects, specifies that this object allows the reading of it's reverb diffusion information.
final public static  intALLOW_DIFFUSION_WRITE
     For AuralAttributes component objects, specifies that this object allows the writing of it's reverb diffusion information.
final public static  intALLOW_DISTANCE_FILTER_READ
     For AuralAttributes component objects, specifies that this object allows the reading of it's frequency cutoff information.
final public static  intALLOW_DISTANCE_FILTER_WRITE
     For AuralAttributes component objects, specifies that this object allows the writing of it's frequency cutoff information.
final public static  intALLOW_FREQUENCY_SCALE_FACTOR_READ
     For AuralAttributes component objects, specifies that this object allows the reading of it's frequency scale factor information.
final public static  intALLOW_FREQUENCY_SCALE_FACTOR_WRITE
     For AuralAttributes component objects, specifies that this object allows the writing of it's frequency scale factor information.
final public static  intALLOW_REFLECTION_COEFFICIENT_READ
     For AuralAttributes component objects, specifies that this object allows the reading of it's reflection coefficient.
final public static  intALLOW_REFLECTION_COEFFICIENT_WRITE
     For AuralAttributes component objects, specifies that this object allows the writing of it's reflection coefficient.
final public static  intALLOW_REFLECTION_DELAY_READ
     For AuralAttributes component objects, specifies that this object allows the reading of it's reflection delay information.
final public static  intALLOW_REFLECTION_DELAY_WRITE
     For AuralAttributes component objects, specifies that this object allows the writing of it's reflection delay information.
final public static  intALLOW_REVERB_COEFFICIENT_READ
     For AuralAttributes component objects, specifies that this object allows the reading of it's reverb coefficient.
final public static  intALLOW_REVERB_COEFFICIENT_WRITE
     For AuralAttributes component objects, specifies that this object allows the writing of it's reverb coefficient.
final public static  intALLOW_REVERB_DELAY_READ
     For AuralAttributes component objects, specifies that this object allows the reading of it's reverberation delay information.
final public static  intALLOW_REVERB_DELAY_WRITE
     For AuralAttributes component objects, specifies that this object allows the writing of it's reverberation delay information.
final public static  intALLOW_REVERB_ORDER_READ
     For AuralAttributes component objects, specifies that this object allows the reading of it's reverb order (feedback loop) information.
final public static  intALLOW_REVERB_ORDER_WRITE
     For AuralAttributes component objects, specifies that this object allows the writing of it's reverb order (feedback loop) information.
final public static  intALLOW_ROLLOFF_READ
     For AuralAttributes component objects, specifies that this object allows the reading of it's atmospheric rolloff.
final public static  intALLOW_ROLLOFF_WRITE
     For AuralAttributes component objects, specifies that this object allows the writing of it's atmospheric rolloff.
final public static  intALLOW_VELOCITY_SCALE_FACTOR_READ
     For AuralAttributes component objects, specifies that this object allows the reading of it's velocity scale factor information.
final public static  intALLOW_VELOCITY_SCALE_FACTOR_WRITE
     For AuralAttributes component objects, specifies that this object allows the writing of it's velocity scale factor information.

Constructor Summary
public  AuralAttributes()
     Constructs and initializes a new AuralAttributes object using default parameters.
public  AuralAttributes(float gain, float rolloff, float reflectionCoefficient, float reverbDelay, int reverbOrder, Point2f[] distanceFilter, float frequencyScaleFactor, float velocityScaleFactor)
     Constructs and initializes a new AuralAttributes object using specified parameters including an array of Point2f for the distanceFilter.
public  AuralAttributes(float gain, float rolloff, float reflectionCoefficient, float reverbDelay, int reverbOrder, float[] distance, float[] frequencyCutoff, float frequencyScaleFactor, float velocityScaleFactor)
     Constructs and initializes a new AuralAttributes object using specified parameters with separate float arrays for components of distanceFilter.
public  AuralAttributes(float gain, float rolloff, float reflectionCoefficient, float reflectionDelay, float reverbCoefficient, float reverbDelay, float decayTime, float decayFilter, float diffusion, float density, float[] distance, float[] frequencyCutoff, float frequencyScaleFactor, float velocityScaleFactor)
     Constructs and initializes a new AuralAttributes object using specified parameters with separate float arrays for components of distanceFilter and full reverb parameters.

Method Summary
public  NodeComponentcloneNodeComponent()
    
 voidcreateRetained()
     Creates the retained mode AuralAttributesRetained object that this component object will point to.
 voidduplicateAttributes(NodeComponent originalNodeComponent, boolean forceDuplicate)
     Copies all AuralAttributes information from originalNodeComponent into the current node.
public  floatgetAttributeGain()
     Retrieve Attribute Gain (amplitude).
public  floatgetDecayFilter()
     Retrieve Decay Filter.
public  floatgetDecayTime()
     Retrieve Decay Time.
public  floatgetDensity()
     Retrieve Density.
public  floatgetDiffusion()
     Retrieve Diffusion.
public  voidgetDistanceFilter(Point2f[] attenuation)
     Retrieve Distance Filter as a single array containing distances and frequency cutoff.
public  voidgetDistanceFilter(float[] distance, float[] frequencyCutoff)
     Retrieve Distance Filter in separate distance and frequency cutoff arrays.
public  intgetDistanceFilterLength()
     Retrieve Distance Filter array length.
public  floatgetFrequencyScaleFactor()
     Retrieve Frequency Scale Factor.
public  floatgetReflectionCoefficient()
     Retrieve Reflective Coefficient.
public  floatgetReflectionDelay()
     Retrieve Reflection Delay Time.
public  BoundsgetReverbBounds()
     Retrieve Reverberation Delay Bounds volume.
public  floatgetReverbCoefficient()
     Retrieve Reverb Coefficient. late reflection coeff.
public  floatgetReverbDelay()
     Retrieve Reverberation Delay Time.
public  intgetReverbOrder()
    
public  floatgetRolloff()
     Retrieve Attribute Gain Rolloff.
public  floatgetVelocityScaleFactor()
     Retrieve Velocity Scale Factor used to calculate Doppler Effect.
public  voidsetAttributeGain(float gain)
     Set Attribute Gain (amplitude) scale factor.
public  voidsetDecayFilter(float frequencyCutoff)
     Set Decay Filter In this form, reverberation decay filtering is defined as a low-pass filter, starting at the given reference frequency.
public  voidsetDecayTime(float decayTime)
     Set Decay Time Length of time from the start of late reflections reverberation volume takes to decay to effective zero (-60 dB of initial signal amplitude).
public  voidsetDensity(float ratio)
     Set Density.
public  voidsetDiffusion(float ratio)
     Set Diffusion.
public  voidsetDistanceFilter(Point2f[] attenuation)
     Set Distance Filter using a single array containing distances and frequency cutoff as pairs of values as a single array of Point2f.
public  voidsetDistanceFilter(float[] distance, float[] frequencyCutoff)
     Set Distance Filter using separate arrays for distances and frequency cutoff.
public  voidsetFrequencyScaleFactor(float frequencyScaleFactor)
     This parameter specifies a scale factor applied to the frequency of sound during rendering playback.
public  voidsetReflectionCoefficient(float coefficient)
     Set Reflective Coefficient.
public  voidsetReflectionDelay(float reflectionDelay)
     Set early Refection Delay Time.
public  voidsetReverbBounds(Bounds reverbVolume)
     Set Reverberation Bounds volume. In this form, the reverberation bounds volume parameter is used to calculate the reverberation Delay and Decay times.
public  voidsetReverbCoefficient(float coefficient)
     Set Reverb Coefficient.
public  voidsetReverbDelay(float reverbDelay)
     Set Reverberation Delay Time. In this form, the parameter specifies the time between the start of the direct, unreflected sound and the start of reverberation.
public  voidsetReverbDelay(Bounds reverbVolume)
    
public  voidsetReverbOrder(int reverbOrder)
     Set Reverberation Order This parameter limits the number of times reflections are added to the reverberation being rendered.
public  voidsetRolloff(float rolloff)
     Set Attribute Gain Rolloff.
public  voidsetVelocityScaleFactor(float velocityScaleFactor)
     Set Velocity scale factor applied during Doppler Effect calculation. This parameter specifies a scale factor applied to the velocity of the sound relative to the listener's position and movement in relation to the sound's position and movement.

Field Detail
ALLOW_ATTRIBUTE_GAIN_READ
final public static int ALLOW_ATTRIBUTE_GAIN_READ(Code)
For AuralAttributes component objects, specifies that this object allows the reading of it's attribute gain scale factor information.



ALLOW_ATTRIBUTE_GAIN_WRITE
final public static int ALLOW_ATTRIBUTE_GAIN_WRITE(Code)
For AuralAttributes component objects, specifies that this object allows the writing of it's attribute gain scale factor information.



ALLOW_DECAY_FILTER_READ
final public static int ALLOW_DECAY_FILTER_READ(Code)
For AuralAttributes component objects, specifies that this object allows the reading of it's reverb decay filter information.
since:
   Java 3D 1.3



ALLOW_DECAY_FILTER_WRITE
final public static int ALLOW_DECAY_FILTER_WRITE(Code)
For AuralAttributes component objects, specifies that this object allows the writing of it's reverb decay filter information.
since:
   Java 3D 1.3



ALLOW_DECAY_TIME_READ
final public static int ALLOW_DECAY_TIME_READ(Code)
For AuralAttributes component objects, specifies that this object allows the reading of it's reverb decay time information.
since:
   Java 3D 1.3



ALLOW_DECAY_TIME_WRITE
final public static int ALLOW_DECAY_TIME_WRITE(Code)
For AuralAttributes component objects, specifies that this object allows the writing of it's reverb decay time information.
since:
   Java 3D 1.3



ALLOW_DENSITY_READ
final public static int ALLOW_DENSITY_READ(Code)
For AuralAttributes component objects, specifies that this object allows the reading of it's reverb density information.
since:
   Java 3D 1.3



ALLOW_DENSITY_WRITE
final public static int ALLOW_DENSITY_WRITE(Code)
For AuralAttributes component objects, specifies that this object allows the writing of it's reverb density information.
since:
   Java 3D 1.3



ALLOW_DIFFUSION_READ
final public static int ALLOW_DIFFUSION_READ(Code)
For AuralAttributes component objects, specifies that this object allows the reading of it's reverb diffusion information.
since:
   Java 3D 1.3



ALLOW_DIFFUSION_WRITE
final public static int ALLOW_DIFFUSION_WRITE(Code)
For AuralAttributes component objects, specifies that this object allows the writing of it's reverb diffusion information.
since:
   Java 3D 1.3



ALLOW_DISTANCE_FILTER_READ
final public static int ALLOW_DISTANCE_FILTER_READ(Code)
For AuralAttributes component objects, specifies that this object allows the reading of it's frequency cutoff information.



ALLOW_DISTANCE_FILTER_WRITE
final public static int ALLOW_DISTANCE_FILTER_WRITE(Code)
For AuralAttributes component objects, specifies that this object allows the writing of it's frequency cutoff information.



ALLOW_FREQUENCY_SCALE_FACTOR_READ
final public static int ALLOW_FREQUENCY_SCALE_FACTOR_READ(Code)
For AuralAttributes component objects, specifies that this object allows the reading of it's frequency scale factor information.



ALLOW_FREQUENCY_SCALE_FACTOR_WRITE
final public static int ALLOW_FREQUENCY_SCALE_FACTOR_WRITE(Code)
For AuralAttributes component objects, specifies that this object allows the writing of it's frequency scale factor information.



ALLOW_REFLECTION_COEFFICIENT_READ
final public static int ALLOW_REFLECTION_COEFFICIENT_READ(Code)
For AuralAttributes component objects, specifies that this object allows the reading of it's reflection coefficient.



ALLOW_REFLECTION_COEFFICIENT_WRITE
final public static int ALLOW_REFLECTION_COEFFICIENT_WRITE(Code)
For AuralAttributes component objects, specifies that this object allows the writing of it's reflection coefficient.



ALLOW_REFLECTION_DELAY_READ
final public static int ALLOW_REFLECTION_DELAY_READ(Code)
For AuralAttributes component objects, specifies that this object allows the reading of it's reflection delay information.
since:
   Java 3D 1.3



ALLOW_REFLECTION_DELAY_WRITE
final public static int ALLOW_REFLECTION_DELAY_WRITE(Code)
For AuralAttributes component objects, specifies that this object allows the writing of it's reflection delay information.
since:
   Java 3D 1.3



ALLOW_REVERB_COEFFICIENT_READ
final public static int ALLOW_REVERB_COEFFICIENT_READ(Code)
For AuralAttributes component objects, specifies that this object allows the reading of it's reverb coefficient.
since:
   Java 3D 1.3



ALLOW_REVERB_COEFFICIENT_WRITE
final public static int ALLOW_REVERB_COEFFICIENT_WRITE(Code)
For AuralAttributes component objects, specifies that this object allows the writing of it's reverb coefficient.
since:
   Java 3D 1.3



ALLOW_REVERB_DELAY_READ
final public static int ALLOW_REVERB_DELAY_READ(Code)
For AuralAttributes component objects, specifies that this object allows the reading of it's reverberation delay information.



ALLOW_REVERB_DELAY_WRITE
final public static int ALLOW_REVERB_DELAY_WRITE(Code)
For AuralAttributes component objects, specifies that this object allows the writing of it's reverberation delay information.



ALLOW_REVERB_ORDER_READ
final public static int ALLOW_REVERB_ORDER_READ(Code)
For AuralAttributes component objects, specifies that this object allows the reading of it's reverb order (feedback loop) information.



ALLOW_REVERB_ORDER_WRITE
final public static int ALLOW_REVERB_ORDER_WRITE(Code)
For AuralAttributes component objects, specifies that this object allows the writing of it's reverb order (feedback loop) information.



ALLOW_ROLLOFF_READ
final public static int ALLOW_ROLLOFF_READ(Code)
For AuralAttributes component objects, specifies that this object allows the reading of it's atmospheric rolloff.



ALLOW_ROLLOFF_WRITE
final public static int ALLOW_ROLLOFF_WRITE(Code)
For AuralAttributes component objects, specifies that this object allows the writing of it's atmospheric rolloff.



ALLOW_VELOCITY_SCALE_FACTOR_READ
final public static int ALLOW_VELOCITY_SCALE_FACTOR_READ(Code)
For AuralAttributes component objects, specifies that this object allows the reading of it's velocity scale factor information.



ALLOW_VELOCITY_SCALE_FACTOR_WRITE
final public static int ALLOW_VELOCITY_SCALE_FACTOR_WRITE(Code)
For AuralAttributes component objects, specifies that this object allows the writing of it's velocity scale factor information.




Constructor Detail
AuralAttributes
public AuralAttributes()(Code)
Constructs and initializes a new AuralAttributes object using default parameters. The following default values are used:
    attribute gain: 1.0
    rolloff: 1.0
    reflection coeff: 0.0
    reflection delay: 20.0
    reverb coeff: 1.0
    reverb delay: 40.0
    decay time: 1000.0
    decay filter: 5000.0<> diffusion: 1.0
    density: 1.0
    reverb bounds: null
    reverb order: 0
    distance filtering: null (no filtering performed)
    frequency scale factor: 1.0
    velocity scale factor: 0.0



AuralAttributes
public AuralAttributes(float gain, float rolloff, float reflectionCoefficient, float reverbDelay, int reverbOrder, Point2f[] distanceFilter, float frequencyScaleFactor, float velocityScaleFactor)(Code)
Constructs and initializes a new AuralAttributes object using specified parameters including an array of Point2f for the distanceFilter.
Parameters:
  gain - amplitude scale factor
Parameters:
  rolloff - atmospheric (changing speed of sound) scale factor
Parameters:
  reflectionCoefficient - reflective/absorptive factor applied to reflections
Parameters:
  reverbDelay - delay time before start of reverberation
Parameters:
  reverbOrder - limit to number of reflections added to reverb signal
Parameters:
  distanceFilter - frequency cutoff
Parameters:
  frequencyScaleFactor - applied to change of pitch
Parameters:
  velocityScaleFactor - applied to velocity of sound in relation to listener



AuralAttributes
public AuralAttributes(float gain, float rolloff, float reflectionCoefficient, float reverbDelay, int reverbOrder, float[] distance, float[] frequencyCutoff, float frequencyScaleFactor, float velocityScaleFactor)(Code)
Constructs and initializes a new AuralAttributes object using specified parameters with separate float arrays for components of distanceFilter.
Parameters:
  gain - amplitude scale factor
Parameters:
  rolloff - atmospheric (changing speed of sound) scale factor
Parameters:
  reflectionCoefficient - reflection/absorption factor applied to reflections
Parameters:
  reverbDelay - delay time before start of reverberation
Parameters:
  reverbOrder - limit to number of reflections added to reverb signal
Parameters:
  distance - filter frequency cutoff distances
Parameters:
  frequencyCutoff - distance filter frequency cutoff
Parameters:
  frequencyScaleFactor - applied to velocity/wave-length
Parameters:
  velocityScaleFactor - applied to velocity of sound in relation to listener



AuralAttributes
public AuralAttributes(float gain, float rolloff, float reflectionCoefficient, float reflectionDelay, float reverbCoefficient, float reverbDelay, float decayTime, float decayFilter, float diffusion, float density, float[] distance, float[] frequencyCutoff, float frequencyScaleFactor, float velocityScaleFactor)(Code)
Constructs and initializes a new AuralAttributes object using specified parameters with separate float arrays for components of distanceFilter and full reverb parameters.
Parameters:
  gain - amplitude scale factor
Parameters:
  rolloff - atmospheric (changing speed of sound) scale factor
Parameters:
  reflectionCoefficient - factor applied to early reflections
Parameters:
  reflectionDelay - delay time before start of early reflections
Parameters:
  reverbCoefficient - factor applied to late reflections
Parameters:
  reverbDelay - delay time before start of late reverberation
Parameters:
  decayTime - time (in milliseconds) reverb takes to decay to -60bD
Parameters:
  decayFilter - reverb decay filter frequency cutoff
Parameters:
  diffusion - percentage of echo dispersement between min and max
Parameters:
  density - percentage of modal density between min and max
Parameters:
  distance - filter frequency cutoff distances
Parameters:
  frequencyCutoff - distance filter frequency cutoff
Parameters:
  frequencyScaleFactor - applied to velocity/wave-length
Parameters:
  velocityScaleFactor - applied to velocity of sound in relation to listener
since:
   Java 3D 1.3




Method Detail
cloneNodeComponent
public NodeComponent cloneNodeComponent()(Code)



createRetained
void createRetained()(Code)
Creates the retained mode AuralAttributesRetained object that this component object will point to.



duplicateAttributes
void duplicateAttributes(NodeComponent originalNodeComponent, boolean forceDuplicate)(Code)
Copies all AuralAttributes information from originalNodeComponent into the current node. This method is called from the duplicateNode method. This routine does the actual duplication of all "local data" (any data defined in this object).
Parameters:
  originalNodeComponent - 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.
See Also:   Node.cloneTree
See Also:   NodeComponent.setDuplicateOnCloneTree



getAttributeGain
public float getAttributeGain()(Code)
Retrieve Attribute Gain (amplitude). gain amplitude scale factor
exception:
  CapabilityNotSetException - if appropriate capability is not set and this object is part of live or compiled scene graph



getDecayFilter
public float getDecayFilter()(Code)
Retrieve Decay Filter. reverb decay filter cutoff frequency
exception:
  CapabilityNotSetException - if appropriate capability is not set and this object is part of live or compiled scene graph
since:
   Java 3D 1.3



getDecayTime
public float getDecayTime()(Code)
Retrieve Decay Time. reverb decay time
exception:
  CapabilityNotSetException - if appropriate capability is not set and this object is part of live or compiled scene graph
since:
   Java 3D 1.3



getDensity
public float getDensity()(Code)
Retrieve Density. reverb density
exception:
  CapabilityNotSetException - if appropriate capability is not set and this object is part of live or compiled scene graph
since:
   Java 3D 1.3



getDiffusion
public float getDiffusion()(Code)
Retrieve Diffusion. reverb diffusion ratio
exception:
  CapabilityNotSetException - if appropriate capability is not set and this object is part of live or compiled scene graph
since:
   Java 3D 1.3



getDistanceFilter
public void getDistanceFilter(Point2f[] attenuation)(Code)
Retrieve Distance Filter as a single array containing distances and frequency cutoff. The distance filter is copied into the specified array. The array must be large enough to hold all of the points. The individual array elements must be allocated by the caller.
Parameters:
  attenuation - array of pairs of distance and frequency cutoff values
exception:
  CapabilityNotSetException - if appropriate capability isnot set and this object is part of live or compiled scene graph



getDistanceFilter
public void getDistanceFilter(float[] distance, float[] frequencyCutoff)(Code)
Retrieve Distance Filter in separate distance and frequency cutoff arrays. The arrays must be large enough to hold all of the distance and frequency cutoff values.
Parameters:
  distance - array
Parameters:
  frequencyCutoff - cutoff array
exception:
  CapabilityNotSetException - if appropriate capability is not set and this object is part of live or compiled scene graph



getDistanceFilterLength
public int getDistanceFilterLength()(Code)
Retrieve Distance Filter array length. attenuation array length
exception:
  CapabilityNotSetException - if appropriate capability is not set and this object is part of live or compiled scene graph



getFrequencyScaleFactor
public float getFrequencyScaleFactor()(Code)
Retrieve Frequency Scale Factor. scaleFactor factor applied to change of frequency
exception:
  CapabilityNotSetException - if appropriate capability is not set and this object is part of live or compiled scene graph



getReflectionCoefficient
public float getReflectionCoefficient()(Code)
Retrieve Reflective Coefficient. reflection coeff reflection/absorption factor
exception:
  CapabilityNotSetException - if appropriate capability is not set and this object is part of live or compiled scene graph



getReflectionDelay
public float getReflectionDelay()(Code)
Retrieve Reflection Delay Time. reflection delay time
exception:
  CapabilityNotSetException - if appropriate capability is not set and this object is part of live or compiled scene graph
since:
   Java 3D 1.3



getReverbBounds
public Bounds getReverbBounds()(Code)
Retrieve Reverberation Delay Bounds volume. reverb bounds volume that defines the Reverberation space andindirectly the delay/decayALLOW_REVERB_DELAY_READ flag used setting capability of this method.
exception:
  CapabilityNotSetException - if appropriate capability is not set and this object is part of live or compiled scene graph
since:
   Java 3D 1.2



getReverbCoefficient
public float getReverbCoefficient()(Code)
Retrieve Reverb Coefficient. late reflection coeff. reflection/absorption factor
exception:
  CapabilityNotSetException - if appropriate capability is not set and this object is part of live or compiled scene graph
since:
   Java 3D 1.3



getReverbDelay
public float getReverbDelay()(Code)
Retrieve Reverberation Delay Time. reverb delay time
exception:
  CapabilityNotSetException - if appropriate capability is not set and this object is part of live or compiled scene graph



getReverbOrder
public int getReverbOrder()(Code)
Retrieve Reverberation Order reverb order
exception:
  CapabilityNotSetException - if appropriate capability is not set and this object is part of live or compiled scene graph



getRolloff
public float getRolloff()(Code)
Retrieve Attribute Gain Rolloff. rolloff atmospheric gain scale factor (changing speed of sound)
exception:
  CapabilityNotSetException - if appropriate capability is not set and this object is part of live or compiled scene graph



getVelocityScaleFactor
public float getVelocityScaleFactor()(Code)
Retrieve Velocity Scale Factor used to calculate Doppler Effect. scale factor applied to Doppler velocity of sound
exception:
  CapabilityNotSetException - if appropriate capability is not set and this object is part of live or compiled scene graph



setAttributeGain
public void setAttributeGain(float gain)(Code)
Set Attribute Gain (amplitude) scale factor.
Parameters:
  gain - scale factor applied to amplitude of direct and reflected sound
exception:
  CapabilityNotSetException - if appropriate capability is not set and this object is part of live or compiled scene graph



setDecayFilter
public void setDecayFilter(float frequencyCutoff)(Code)
Set Decay Filter In this form, reverberation decay filtering is defined as a low-pass filter, starting at the given reference frequency. This allows for higher frequencies to be attenuated at a different (typically faster) rate than lower frequencies.
Parameters:
  frequencyCutoff - of reverberation decay low-pass filter
exception:
  CapabilityNotSetException - if appropriate capability is not set and this object is part of live or compiled scene graph
since:
   Java 3D 1.3



setDecayTime
public void setDecayTime(float decayTime)(Code)
Set Decay Time Length of time from the start of late reflections reverberation volume takes to decay to effective zero (-60 dB of initial signal amplitude).
Parameters:
  decayTime - of late reflections (reverb) in milliseconds
exception:
  CapabilityNotSetException - if appropriate capability is not set and this object is part of live or compiled scene graph
since:
   Java 3D 1.3



setDensity
public void setDensity(float ratio)(Code)
Set Density. Sets the density of reverberation to an amount between the minimum (0.0) to the maximum (1.0) available. Changing this effects the spectral coloration (timbre) of late reflections.
Parameters:
  ratio - reverberation modal density factor
exception:
  CapabilityNotSetException - if appropriate capability is not set and this object is part of live or compiled scene graph
since:
   Java 3D 1.3



setDiffusion
public void setDiffusion(float ratio)(Code)
Set Diffusion. Sets the echo dispersement of reverberation to an amount between the minimum (0.0) to the maximum (1.0) available. Changing this increases/decreases the 'smoothness' of reverb decay.
Parameters:
  ratio - reverberation echo dispersement factor
exception:
  CapabilityNotSetException - if appropriate capability is not set and this object is part of live or compiled scene graph
since:
   Java 3D 1.3



setDistanceFilter
public void setDistanceFilter(Point2f[] attenuation)(Code)
Set Distance Filter using a single array containing distances and frequency cutoff as pairs of values as a single array of Point2f.
Parameters:
  attenuation - array of pairs of distance and frequency cutoff
exception:
  CapabilityNotSetException - if appropriate capability is not set and this object is part of live or compiled scene graph



setDistanceFilter
public void setDistanceFilter(float[] distance, float[] frequencyCutoff)(Code)
Set Distance Filter using separate arrays for distances and frequency cutoff. The distance and frequencyCutoff arrays should be of the same length. If the frequencyCutoff array length is greater than the distance array length, the frequencyCutoff array elements beyond the length of the distance array are ignored. If the frequencyCutoff array is shorter than the distance array, the last frequencyCutoff array value is repeated to fill an array of length equal to distance array.
Parameters:
  distance - array of float distance with corresponding cutoff values
Parameters:
  frequencyCutoff - array of frequency cutoff values in Hertz
exception:
  CapabilityNotSetException - if appropriate capability is not set and this object is part of live or compiled scene graph



setFrequencyScaleFactor
public void setFrequencyScaleFactor(float frequencyScaleFactor)(Code)
This parameter specifies a scale factor applied to the frequency of sound during rendering playback. If the Doppler effect is disabled, this scale factor can be used to increase or decrease the original pitch of the sound. During rendering, this scale factor expands or contracts the usual frequency shift applied to the sound source due to Doppler calculations. Valid values are >= 0.0. A value of zero causes playing sounds to pause.
Parameters:
  frequencyScaleFactor - factor applied to change of frequency
exception:
  CapabilityNotSetException - if appropriate capability is not set and this object is part of live or compiled scene graph



setReflectionCoefficient
public void setReflectionCoefficient(float coefficient)(Code)
Set Reflective Coefficient. Scales the amplitude of the early reflections of reverberated sounds
Parameters:
  coefficient - reflection/absorption factor applied to reflections
exception:
  CapabilityNotSetException - if appropriate capability is not set and this object is part of live or compiled scene graph



setReflectionDelay
public void setReflectionDelay(float reflectionDelay)(Code)
Set early Refection Delay Time. In this form, the parameter specifies the time between the start of the direct, unreflected sound and the start of first order early reflections. In this method, this time is explicitly given in milliseconds.
Parameters:
  reflectionDelay - delay time before start of reverberation
exception:
  CapabilityNotSetException - if appropriate capability is not set and this object is part of live or compiled scene graph
since:
   Java 3D 1.3



setReverbBounds
public void setReverbBounds(Bounds reverbVolume)(Code)
Set Reverberation Bounds volume. In this form, the reverberation bounds volume parameter is used to calculate the reverberation Delay and Decay times. Specification of a non-null bounding volume causes the explicit values given for Reverb Delay and Decay to be overridden by the implicit values calculated from these bounds. ALLOW_REVERB_DELAY_WRITE flag used setting capability of this method.
Parameters:
  reverbVolume - the bounding region
exception:
  CapabilityNotSetException - if appropriate capability is not set and this object is part of live or compiled scene graph
since:
   Java 3D 1.2



setReverbCoefficient
public void setReverbCoefficient(float coefficient)(Code)
Set Reverb Coefficient. Scale the amplitude of the late reflections including the decaying tail of reverberated sound.
Parameters:
  coefficient - reflective/absorptive factor applied to late reflections
exception:
  CapabilityNotSetException - if appropriate capability is not set and this object is part of live or compiled scene graph
since:
   Java 3D 1.3



setReverbDelay
public void setReverbDelay(float reverbDelay)(Code)
Set Reverberation Delay Time. In this form, the parameter specifies the time between the start of the direct, unreflected sound and the start of reverberation. In this method, this time is explicitly given in milliseconds.
Parameters:
  reverbDelay - delay time before start of reverberation
exception:
  CapabilityNotSetException - if appropriate capability is not set and this object is part of live or compiled scene graph



setReverbDelay
public void setReverbDelay(Bounds reverbVolume)(Code)



setReverbOrder
public void setReverbOrder(int reverbOrder)(Code)
Set Reverberation Order This parameter limits the number of times reflections are added to the reverberation being rendered. A non-positive value specifies an unbounded number of reflections.
Parameters:
  reverbOrder - limit to the number of times reflections added to reverb signal
exception:
  CapabilityNotSetException - if appropriate capability is not set and this object is part of live or compiled scene graph



setRolloff
public void setRolloff(float rolloff)(Code)
Set Attribute Gain Rolloff.
Parameters:
  rolloff - atmospheric gain scale factor (changing speed of sound)
exception:
  CapabilityNotSetException - if appropriate capability is not set and this object is part of live or compiled scene graph



setVelocityScaleFactor
public void setVelocityScaleFactor(float velocityScaleFactor)(Code)
Set Velocity scale factor applied during Doppler Effect calculation. This parameter specifies a scale factor applied to the velocity of the sound relative to the listener's position and movement in relation to the sound's position and movement. This scale factor is multipled by the calculated velocity portion of the Doppler effect equation used during sound rendering. A value of zero disables Doppler calculations.
Parameters:
  velocityScaleFactor - applied to velocity of sound in relation to listener
exception:
  CapabilityNotSetException - if appropriate capability is not set and this object is part of live or compiled scene graph



Fields inherited from javax.media.j3d.NodeComponent
boolean forceDuplicate(Code)(Java Doc)

Methods inherited from javax.media.j3d.NodeComponent
final void checkDuplicateNodeComponent(NodeComponent originalNodeComponent)(Code)(Java Doc)
public NodeComponent cloneNodeComponent()(Code)(Java Doc)
public NodeComponent cloneNodeComponent(boolean forceDuplicate)(Code)(Java Doc)
void createRetained()(Code)(Java Doc)
void duplicateAttributes(NodeComponent originalNode, boolean forceDuplicate)(Code)(Java Doc)
boolean duplicateChild()(Code)(Java Doc)
public void duplicateNodeComponent(NodeComponent originalNodeComponent)(Code)(Java Doc)
public void duplicateNodeComponent(NodeComponent originalNodeComponent, boolean forceDuplicate)(Code)(Java Doc)
public boolean getDuplicateOnCloneTree()(Code)(Java Doc)
public void setDuplicateOnCloneTree(boolean duplicate)(Code)(Java Doc)
void validateImageIllegalSharing(ImageComponent image)(Code)(Java Doc)

Fields inherited from javax.media.j3d.SceneGraphObject
Hashtable nodeHashtable(Code)(Java Doc)
SceneGraphObjectRetained retained(Code)(Java Doc)

Methods inherited from javax.media.j3d.SceneGraphObject
final boolean capabilityBitsEmpty()(Code)(Java Doc)
final void checkForLiveOrCompiled()(Code)(Java Doc)
final public void clearCapability(int bit)(Code)(Java Doc)
final public void clearCapabilityIsFrequent(int bit)(Code)(Java Doc)
final void clearLive()(Code)(Java Doc)
void createRetained()(Code)(Java Doc)
protected void duplicateSceneGraphObject(SceneGraphObject originalNode)(Code)(Java Doc)
final public boolean getCapability(int bit)(Code)(Java Doc)
final public boolean getCapabilityIsFrequent(int bit)(Code)(Java Doc)
public String getName()(Code)(Java Doc)
String getNamePrefix()(Code)(Java Doc)
NodeComponent getNodeComponent(NodeComponent originalNodeComponent, boolean forceDuplicate, Hashtable hashtable)(Code)(Java Doc)
public Object getUserData()(Code)(Java Doc)
final public boolean isCompiled()(Code)(Java Doc)
final public boolean isLive()(Code)(Java Doc)
final boolean isLiveOrCompiled()(Code)(Java Doc)
final public void setCapability(int bit)(Code)(Java Doc)
final public void setCapabilityIsFrequent(int bit)(Code)(Java Doc)
final void setCompiled()(Code)(Java Doc)
void setDefaultReadCapabilities(int[] bits)(Code)(Java Doc)
final void setLive()(Code)(Java Doc)
public void setName(String name)(Code)(Java Doc)
public void setUserData(Object userData)(Code)(Java Doc)
public String toString()(Code)(Java Doc)
public void updateNodeReferences(NodeReferenceTable referenceTable)(Code)(Java Doc)

Methods inherited from java.lang.Object
native protected Object clone() throws CloneNotSupportedException(Code)(Java Doc)
public boolean equals(Object obj)(Code)(Java Doc)
protected void finalize() throws Throwable(Code)(Java Doc)
final native public Class getClass()(Code)(Java Doc)
native public int hashCode()(Code)(Java Doc)
final native public void notify()(Code)(Java Doc)
final native public void notifyAll()(Code)(Java Doc)
public String toString()(Code)(Java Doc)
final native public void wait(long timeout) throws InterruptedException(Code)(Java Doc)
final public void wait(long timeout, int nanos) throws InterruptedException(Code)(Java Doc)
final public void wait() throws InterruptedException(Code)(Java Doc)

www.java2java.com | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.