org.j3d.aviatrix3d.rendering
Interface AudioRenderable

All Superinterfaces:

java.lang.Comparable, Renderable

All Known Implementing Classes:

BackgroundSound, ConeSound, PointSound, Sound

public interface AudioRenderable
extends Renderable

Marker interface for all objects that would like to be capable of rendering themself using an audio renderer.

This interface should generally not be directly used. It is a base description for derived types that provide the specific types of information through specific methods. It is used to provide a single common interface so that the implementing instance can be placed in the AudioDetails.

Version:

$Revision: 2.2 $

Author:

Alan Hudson

Method Summary

boolean	isEnabled() State check to see whether the sound is enabled.
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 interface org.j3d.aviatrix3d.rendering.Renderable

equals

Methods inherited from interface java.lang.Comparable

compareTo

Method Detail

isEnabled

boolean isEnabled()

State check to see whether the sound is enabled.

Returns:

true if the sound has something to render

isSpatialised

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.

Returns:

true if this is a spatialised source, false otherwise

render

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

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