org.achtern.AchternEngine.core.audio.openal.trigger

Class ProximityAudioTrigger

java.lang.Object

org.achtern.AchternEngine.core.audio.openal.trigger.ProximityAudioTrigger

All Implemented Interfaces:

AudioTrigger

public class ProximityAudioTrigger
extends Object
implements AudioTrigger

This will play AudioSources if they are in proximity to the given Node.

Field Summary

Fields

Modifier and Type	Field and Description
protected float	maxDistance
protected AudioSourceState	onExit
protected Node	target

Constructor Summary

Constructors

Constructor and Description
ProximityAudioTrigger(Node target) Creates a new ProximityAudioTrigger with a default maxDistance of 10
ProximityAudioTrigger(Node target, float maxDistance, AudioSourceState onExit)

Method Summary

Modifier and Type	Method and Description
float	getMaxDistance()
AudioSourceState	getOnExit()
Node	getTarget()
AudioSourceState	next(AudioSource as) This tells the AudioEngine the desired state for any given AudioSource.
void	setOnExit(AudioSourceState onExit)
void	setTarget(Node target)

Methods inherited from class java.lang.Object

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

Field Detail

target

protected Node target

maxDistance

protected float maxDistance

onExit

protected AudioSourceState onExit

Constructor Detail

ProximityAudioTrigger

public ProximityAudioTrigger(Node target)

Creates a new ProximityAudioTrigger with a default maxDistance of 10

Parameters:

target - target of the AudioTrigger

ProximityAudioTrigger

@ConstructorProperties(value={"target","maxDistance","onExit"})
 @Generated(value="lombok")
public ProximityAudioTrigger(Node target,
                                                                                                                         float maxDistance,
                                                                                                                         AudioSourceState onExit)

Method Detail

next

public AudioSourceState next(AudioSource as)

This tells the AudioEngine the desired state for any given AudioSource.

Specified by:

next in interface AudioTrigger

Parameters:

as - AudioSource to test

Returns:

desired state

getTarget

@Generated(value="lombok")
public Node getTarget()

setTarget

@Generated(value="lombok")
public void setTarget(Node target)

getMaxDistance

@Generated(value="lombok")
public float getMaxDistance()

getOnExit

@Generated(value="lombok")
public AudioSourceState getOnExit()

setOnExit

@Generated(value="lombok")
public void setOnExit(AudioSourceState onExit)