com.threerings.openal.config
Class SounderConfig.Original

java.lang.Object
  com.threerings.util.DeepObject
      com.threerings.openal.config.SounderConfig.Implementation
          com.threerings.openal.config.SounderConfig.Original

All Implemented Interfaces:

Exportable, Copyable, Cloneable

Direct Known Subclasses:

SounderConfig.Fixed, SounderConfig.Variable

Enclosing class:

SounderConfig

public abstract static class SounderConfig.Original
extends SounderConfig.Implementation

The superclass of the implementations describing an original sounder, as opposed to one derived from another configuration.

Field Summary

float	coneInnerAngle The inner angle of the sound cone.
float	coneOuterAngle The outer angle of the sound cone.
float	coneOuterGain The gain when outside the oriented cone.
boolean	directional Whether or not the sound is directional.
float	maxDistance The distance at which attenuation stops.
float	maxGain The maximum gain for the source.
float	minGain The minimum gain for the source.
float	referenceDistance The distance at which the volume would normally drop by half (before being influenced by the rolloff factor or the maximum distance).
float	rolloffFactor The rolloff rate.
boolean	sourceRelative Whether or not the position of the sound is relative to the listener.

Constructor Summary

SounderConfig.Original()

Method Summary

abstract float	getGain() Returns the base gain (volume).
abstract float	getPitch() Returns the pitch multiplier.

Methods inherited from class com.threerings.openal.config.SounderConfig.Implementation

getSounderImplementation, getUpdateReferences, getUpdateResources, invalidate

Methods inherited from class com.threerings.util.DeepObject

clone, copy, copy, equals, hashCode, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Field Detail

sourceRelative

@Editable(hgroup="s",
          weight=-2.0)
public boolean sourceRelative

Whether or not the position of the sound is relative to the listener.

directional

@Editable(hgroup="s",
          weight=-2.0)
public boolean directional

Whether or not the sound is directional.

minGain

@Editable(min=0.0,
          max=1.0,
          step=0.01,
          hgroup="m")
public float minGain

The minimum gain for the source.

maxGain

@Editable(min=0.0,
          max=1.0,
          step=0.01,
          hgroup="m")
public float maxGain

The maximum gain for the source.

referenceDistance

@Editable(min=0.0,
          step=0.01,
          hgroup="r")
public float referenceDistance

The distance at which the volume would normally drop by half (before being influenced by the rolloff factor or the maximum distance).

rolloffFactor

@Editable(min=0.0,
          step=0.01,
          hgroup="r")
public float rolloffFactor

The rolloff rate.

maxDistance

@Editable(min=0.0,
          step=0.01,
          hgroup="m")
public float maxDistance

The distance at which attenuation stops.

coneOuterGain

@Editable(min=0.0,
          max=1.0,
          step=0.01,
          hgroup="m")
public float coneOuterGain

The gain when outside the oriented cone.

coneInnerAngle

@Editable(min=-360.0,
          max=360.0,
          hgroup="c")
public float coneInnerAngle

The inner angle of the sound cone.

coneOuterAngle

@Editable(min=-360.0,
          max=360.0,
          hgroup="c")
public float coneOuterAngle

The outer angle of the sound cone.

Constructor Detail

SounderConfig.Original

public SounderConfig.Original()

Method Detail

getGain

public abstract float getGain()

Returns the base gain (volume).

getPitch

public abstract float getPitch()

Returns the pitch multiplier.