Class RingModulatorEffect

java.lang.Object

com.blackrook.gloop.openal.OALObject

com.blackrook.gloop.openal.OALEffect

com.blackrook.gloop.openal.effect.RingModulatorEffect

public class RingModulatorEffect
extends OALEffect

Ring modulator effect for sources.

Author:

Matthew Tropiano

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	RingModulatorEffect.WaveForm	WaveForm type enumeration.

Field Summary

Fields

Modifier and Type	Field	Description
protected float	frequency	Ring modulator frequency.
protected float	highPassCutoff	Ring modulator high-pass cutoff in Hertz.
protected RingModulatorEffect.WaveForm	waveForm	Ring modulator waveform.

Constructor Summary

Constructors

Constructor	Description
RingModulatorEffect(OALContext context)

Method Summary

Modifier and Type	Method	Description
final float	getFrequency()
final float	getHighPassCutoff()
final RingModulatorEffect.WaveForm	getWaveform()
final void	setFrequency(float frequency)	Set frequency shifter frequency (0.0 to 8000.0).
final void	setHighPassCutoff(float highPassCutoff)	Set ring modulator high-pass cutoff in Hertz (0.0 to 24000.0).
final void	setWaveform(RingModulatorEffect.WaveForm waveform)	Set ring modulator waveform.

Methods inherited from class OALEffect

allocate, free

Methods inherited from class OALObject

clearError, destroy, equals, equals, errorCheck, getName, hashCode, requestContext, toString

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

frequency

protected float frequency

Ring modulator frequency.

highPassCutoff

protected float highPassCutoff

Ring modulator high-pass cutoff in Hertz.

waveForm

protected RingModulatorEffect.WaveForm waveForm

Ring modulator waveform.

Constructor Details

RingModulatorEffect

public RingModulatorEffect(OALContext context)

Method Details

getWaveform

public final RingModulatorEffect.WaveForm getWaveform()

Returns:

the current ring modulator waveform.

setWaveform

public final void setWaveform(RingModulatorEffect.WaveForm waveform)

Set ring modulator waveform.

Parameters:

waveform - the new value.

getFrequency

public final float getFrequency()

Returns:

the current ring modulator shifter frequency.

setFrequency

public final void setFrequency(float frequency)

Set frequency shifter frequency (0.0 to 8000.0).

Parameters:

frequency - the new value.

getHighPassCutoff

public final float getHighPassCutoff()

Returns:

the current ring modulator high-pass cutoff in Hertz.

setHighPassCutoff

public final void setHighPassCutoff(float highPassCutoff)

Set ring modulator high-pass cutoff in Hertz (0.0 to 24000.0).

Parameters:

highPassCutoff - the new value.