Aviatrix3D
2.1.0

org.j3d.aviatrix3d
Class PointSound

java.lang.Object
  extended by org.j3d.aviatrix3d.SceneGraphObject
      extended by org.j3d.aviatrix3d.Node
          extended by org.j3d.aviatrix3d.Leaf
              extended by org.j3d.aviatrix3d.Sound
                  extended by org.j3d.aviatrix3d.PointSound
All Implemented Interfaces:
java.lang.Comparable, AudioUpdateListener, AudioRenderable, Cullable, LeafCullable, Renderable
Direct Known Subclasses:
ConeSound

public class PointSound
extends Sound

A PointSound class which emits sound in all directions from a point.

The sound will attenuate by distance based on the refDistance and maxDistance parameters.

Version:
$Revision: 1.8 $
Author:
Alan Hudson

Field Summary
protected  float maxDistance
          Maximum distance of a source.
protected  float refDistance
          The distance when gain rolloff starts
protected  float rolloffFactor
          How quickly does the sound decrease over distance.
 
Fields inherited from class org.j3d.aviatrix3d.Sound
buffer, dataChanged, enabled, format, freq, loop, paramsChanged, paused, pitch, playChanged, playing, seq, soundSource, values
 
Fields inherited from class org.j3d.aviatrix3d.Node
bounds, implicitBounds, INVALID_BOUNDS, parent
 
Fields inherited from class org.j3d.aviatrix3d.SceneGraphObject
alive, LISTENER_SET_TIMING_ERR_PROP, updateHandler
 
Fields inherited from interface org.j3d.aviatrix3d.rendering.LeafCullable
AUDIO_CULLABLE, CLIP_CULLABLE, FOG_CULLABLE, GEOMETRY_CULLABLE, LIGHT_CULLABLE, OVERRIDE_CULLABLE
 
Constructor Summary
PointSound()
          Creates a sound.
 
Method Summary
 int compareTo(java.lang.Object o)
          Compares this object with the specified object for order.
 int compareTo(PointSound ps)
          Compares this object with the specified object for order.
 boolean equals(java.lang.Object o)
          Compare this object for equality to the given object.
 boolean equals(PointSound ps)
          Compares this object with the specified object to check for equivalence.
 void postRender(net.java.games.joal.AL al)
          This method is called after a node has been rendered.
 void render(net.java.games.joal.AL al, javax.vecmath.Matrix4f transform)
          This method is called to render this node.
 void setMaxDistance(float distance)
          Set the distance when gain rolloff reaches zero.
 void setRefDistance(float distance)
          Set the distance when gain rolloff starts.
 void setRolloffFactor(float factor)
          Set the rollloffFactor.
 
Methods inherited from class org.j3d.aviatrix3d.Sound
audioUpdated, compareTo, equals, getBounds, getCullableType, getRenderable, isEnabled, isPaused, isPlaying, isSpatialised, markBoundsDirty, paramsUpdated, pauseSound, recomputeBounds, setAudioSource, setEnabled, startSound, stopSound
 
Methods inherited from class org.j3d.aviatrix3d.Node
boundsChanged, checkForCyclicParent, getParent, removeParent, requestBoundsUpdate, setBounds, setParent, updateBounds, updateParentBounds
 
Methods inherited from class org.j3d.aviatrix3d.SceneGraphObject
checkForCyclicChild, dataChanged, getAppUpdateWriteTimingMessage, getBoundsWriteTimingMessage, getDataWriteTimingMessage, getUserData, isLive, setLive, setUpdateHandler, setUserData
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

refDistance

protected float refDistance
The distance when gain rolloff starts


maxDistance

protected float maxDistance
Maximum distance of a source. Used to clamp distance attenuation


rolloffFactor

protected float rolloffFactor
How quickly does the sound decrease over distance.

Constructor Detail

PointSound

public PointSound()
Creates a sound.

Method Detail

render

public void render(net.java.games.joal.AL al,
                   javax.vecmath.Matrix4f transform)
This method is called to render this node. All openGL commands needed to render the node should be executed. Any transformations needed should be added to the transformation stack premultiplied. This method must be re-entrant as it can be called from multiple places at once.

Parameters:
al - The al context to render with
transform - The transformation stack to this node

postRender

public void postRender(net.java.games.joal.AL al)
Description copied from interface: AudioRenderable
This method is called after a node has been rendered. This method must be re-entrant.

Parameters:
al - The al context to draw with

compareTo

public int compareTo(java.lang.Object o)
              throws java.lang.ClassCastException
Compares this object with the specified object for order. Returns a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

Parameters:
o - The objec to be compared
Returns:
-1, 0 or 1 depending on order
Throws:
java.lang.ClassCastException - The specified object's type prevents it from being compared to this Object

equals

public boolean equals(java.lang.Object o)
Compare this object for equality to the given object.

Specified by:
equals in interface Renderable
Overrides:
equals in class java.lang.Object
Parameters:
o - The object to be compared
Returns:
True if these represent the same values

setRefDistance

public void setRefDistance(float distance)
Set the distance when gain rolloff starts.

Parameters:
distance - The distance in units
Throws:
InvalidWriteTimingException - This was not called during the data changed callback time

setMaxDistance

public void setMaxDistance(float distance)
Set the distance when gain rolloff reaches zero.

Parameters:
distance - The distance in units
Throws:
InvalidWriteTimingException - This was not called during the data changed callback time

setRolloffFactor

public void setRolloffFactor(float factor)
Set the rollloffFactor.

Parameters:
factor -
Throws:
InvalidWriteTimingException - This was not called during the data changed callback time

compareTo

public int compareTo(PointSound ps)
Compares this object with the specified object for order. Returns a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

Parameters:
ps - The argument instance to be compared
Returns:
-1, 0 or 1 depending on order

equals

public boolean equals(PointSound ps)
Compares this object with the specified object to check for equivalence.

Parameters:
ps - The background instance to be compared
Returns:
true if the objects represent identical values

Aviatrix3D
2.1.0

Latest Info from http://aviatrix3d.j3d.org/
Copyright © 2003 - 2009 j3d.org