org.j3d.aviatrix3d
Class BackgroundSound

java.lang.Object
  org.j3d.aviatrix3d.SceneGraphObject
      org.j3d.aviatrix3d.Node
          org.j3d.aviatrix3d.Leaf
              org.j3d.aviatrix3d.Sound
                  org.j3d.aviatrix3d.BackgroundSound

All Implemented Interfaces:

java.lang.Comparable, AudioUpdateListener, AudioRenderable, Cullable, LeafCullable, Renderable

public class BackgroundSound
extends Sound

A BackgroundSound class whichs emits a sound which doesn't change by distance or orientation.

Version:

$Revision: 1.8 $

Author:

Alan Hudson

Field Summary

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

BackgroundSound()
Creates a new background sound.

Method Summary

int	compareTo(BackgroundSound bg) Compares this object with the specified object for order.
int	compareTo(java.lang.Object o) Compares this object with the specified object for order.
boolean	equals(BackgroundSound bg) Compares this object with the specified object to check for equivalence.
boolean	equals(java.lang.Object o) Compare this object for equality to the given object.
boolean	isSpatialised() Check to see if this renderable is spatialised in any way.
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.

Methods inherited from class org.j3d.aviatrix3d.Sound

audioUpdated, compareTo, equals, getBounds, getCullableType, getRenderable, isEnabled, isPaused, isPlaying, 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

Constructor Detail

BackgroundSound

public BackgroundSound()

Creates a new background sound.

Method Detail

isSpatialised

public boolean isSpatialised()

Check to see if this renderable is spatialised in any way. Spatialised means it would require proper head tracking, where non-spatialised just represents a basic noise such as background sound.

Background sound is never spatialised.

Specified by:

isSpatialised in interface AudioRenderable

Overrides:

isSpatialised in class Sound

Returns:

false always

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)

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

compareTo

public int compareTo(BackgroundSound bg)

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:

bg - The argument instance to be compared

Returns:

-1, 0 or 1 depending on order

equals

public boolean equals(BackgroundSound bg)

Compares this object with the specified object to check for equivalence.

Parameters:

bg - The background instance to be compared

Returns:

true if the objects represent identical values