Interface SoundRolloffFunction

public interface SoundRolloffFunction

Sound rolloff type.

Author:

Matthew Tropiano

Field Summary

Fields

Modifier and Type	Field	Description
static final SoundRolloffFunction	COSINE	Cosine attenuation.
static final SoundRolloffFunction	LINEAR	Linear attenuation.
static final SoundRolloffFunction	NONE	No attenuation.
static final SoundRolloffFunction	SQUARED	Squared attenuation.

Method Summary

Modifier and Type	Method	Description
float	getAttenuationScalar(float distanceScalar)	Calculates the attenuation scalar given a distance scalar.

Field Details

NONE

static final SoundRolloffFunction NONE

No attenuation.

LINEAR

static final SoundRolloffFunction LINEAR

Linear attenuation.

COSINE

static final SoundRolloffFunction COSINE

Cosine attenuation.

SQUARED

static final SoundRolloffFunction SQUARED

Squared attenuation.

Method Details

getAttenuationScalar

float getAttenuationScalar(float distanceScalar)

Calculates the attenuation scalar given a distance scalar.

Parameters:

distanceScalar - the distance scalar (0 = less than reference distance min, 1 = greater than reference distance max).

Returns:

an attenuation scalar value (0 = fully attenuated, 1 = no attenuation).