Class SoundSystem.SoundGroup

java.lang.Object

com.blackrook.gloop.openal.util.system.SoundSystem.SoundGroup

All Implemented Interfaces:

SoundGroupType

Enclosing class:

SoundSystem

public static class SoundSystem.SoundGroup
extends Object
implements SoundGroupType

A playback group type.

Author:

Matthew Tropiano

Constructor Summary

Constructors

Constructor	Description
SoundGroup(SoundGroupType parent, boolean occludable, boolean twoDimensional, boolean zeroPosition, int maxVoices)

Method Summary

Modifier and Type	Method	Description
float	getCalculatedEffectGain()
float	getCalculatedGain()
float	getCalculatedHighPassGain()
float	getCalculatedLowPassGain()
float	getCalculatedPitch()
float	getEffectGain()
float	getGain()
float	getHighPassGain()
float	getLowPassGain()
int	getMaximumVoices()
float	getPitch()
boolean	isOccludable()
boolean	isTwoDimensional()
boolean	isZeroPosition()
void	setEffectGain(float gainEffect)
void	setGain(float gain)
void	setHighPassGain(float gainHF)
void	setLowPassGain(float gainLF)
void	setPitch(float pitch)

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

SoundGroup

public SoundGroup(SoundGroupType parent,
 boolean occludable,
 boolean twoDimensional,
 boolean zeroPosition,
 int maxVoices)

Method Details

getCalculatedGain

public float getCalculatedGain()

Specified by:

getCalculatedGain in interface SoundGroupType

Returns:

the combined multiplicative gain for this group.

getCalculatedPitch

public float getCalculatedPitch()

Specified by:

getCalculatedPitch in interface SoundGroupType

Returns:

the combined multiplicative pitch for this group.

getCalculatedLowPassGain

public float getCalculatedLowPassGain()

Specified by:

getCalculatedLowPassGain in interface SoundGroupType

Returns:

the combined multiplicative dry low pass gain for this group.

getCalculatedHighPassGain

public float getCalculatedHighPassGain()

Specified by:

getCalculatedHighPassGain in interface SoundGroupType

Returns:

the combined multiplicative dry high pass gain for this group.

getCalculatedEffectGain

public float getCalculatedEffectGain()

Specified by:

getCalculatedEffectGain in interface SoundGroupType

Returns:

the combined multiplicative wet effect gain for this group.

getGain

public float getGain()

Specified by:

getGain in interface SoundGroupType

Returns:

the gain for this group.

setGain

public void setGain(float gain)

getPitch

public float getPitch()

Specified by:

getPitch in interface SoundGroupType

Returns:

the pitch for this group.

setPitch

public void setPitch(float pitch)

getLowPassGain

public float getLowPassGain()

Specified by:

getLowPassGain in interface SoundGroupType

Returns:

the dry low pass gain for this group.

setLowPassGain

public void setLowPassGain(float gainLF)

getHighPassGain

public float getHighPassGain()

Specified by:

getHighPassGain in interface SoundGroupType

Returns:

the dry high pass gain for this group.

setHighPassGain

public void setHighPassGain(float gainHF)

getEffectGain

public float getEffectGain()

Specified by:

getEffectGain in interface SoundGroupType

Returns:

the wet effect gain for this group.

setEffectGain

public void setEffectGain(float gainEffect)

isOccludable

public boolean isOccludable()

Specified by:

isOccludable in interface SoundGroupType

Returns:

if this group is occludable.

isTwoDimensional

public boolean isTwoDimensional()

Specified by:

isTwoDimensional in interface SoundGroupType

Returns:

if the sounds in this group are supposed to be positioned on a two-dimensional plane in front of the center.

isZeroPosition

public boolean isZeroPosition()

Specified by:

isZeroPosition in interface SoundGroupType

Returns:

if the sounds in this group are supposed to be played from the observer always.

getMaximumVoices

public int getMaximumVoices()

Specified by:

getMaximumVoices in interface SoundGroupType

Returns:

the total amount of voices that this group can use at once.