An Event is used to control most of the eingines behavior. More...

#include <vae_event.hpp>

Collaboration diagram for vae::core::Event:

Public Types
enum class	Action { start = 0 , stop , emit , random }

Public Member Functions
	Event ()
	TODO this isn't exactly pod style but the arrays need to be initialized properly since 0 is a valid event handle. More...

Public Attributes
enum vae::core::Event::Action	action

bool	force_mixer: 1
	Prevents overriding the mixer from chained events or fireEvent. More...

bool	loop: 1
	gapless looping More...

bool	HRTF: 1
	Listener and event has to have hrtf set. More...

bool	spatial: 1
	no spatial rendering at all More...

bool	attenuate: 1
	whether distance is taken into consideration More...

bool	critical: 1
	wheather the voice can be killer More...

MixerHandle	mixer = Mixer::MasterMixerHandle
	Mixer the source gets written to. More...

SourceHandle	source = InvalidSourceHandle
	Handle to a source. More...

EventHandle	id = InvalidEventHandle
	Own id. More...

Sample	gain
	Volume applied to triggered voice. More...

EventHandle	chained_events [StaticConfig::MaxChainedEvents]
	Events called when the source starts playing. More...

EventHandle	on_end
	Event fired once the source is finished, not called when there's no source. More...

NameString	name
	Name for debugging. More...

Detailed Description

An Event is used to control most of the eingines behavior.

Definition at line 14 of file vae_event.hpp.

Member Enumeration Documentation

◆ Action

enum class vae::core::Event::Action

strong

Enumerator
start	Starts a source if defined and every Event in chained_events.
stop	Stops a source if defined and stops every voice started from a event in chained_events.
emit	Emits an event to the EventCallback defined in the engine config.
random	triggers one random chained_events event

Definition at line 15 of file vae_event.hpp.

                          {
            start = 0,      ///< Starts a source if defined and every Event in chained_events
            stop,           ///< Stops a source if defined and stops every voice started from a event in chained_events
            emit,           ///< Emits an event to the EventCallback defined in the engine config
            random          ///< triggers one random chained_events event
        } action : 3;

Constructor & Destructor Documentation

◆ Event()

vae::core::Event::Event ( )

inline

TODO this isn't exactly pod style but the arrays need to be initialized properly since 0 is a valid event handle.

Definition at line 40 of file vae_event.hpp.

                {
            force_mixer = false;
            loop = false;
            HRTF = false;
            spatial = true;
            attenuate = true;
            critical = false;
            gain = 1.0;
            for (auto& i : chained_events) { i = InvalidEventHandle; }
            on_end = InvalidEventHandle;
        }

Member Data Documentation

◆ action

enum vae::core::Event::Action vae::core::Event::action

◆ attenuate

bool vae::core::Event::attenuate

whether distance is taken into consideration

Definition at line 25 of file vae_event.hpp.

◆ chained_events

EventHandle vae::core::Event::chained_events[StaticConfig::MaxChainedEvents]

Events called when the source starts playing.

Definition at line 32 of file vae_event.hpp.

◆ critical

bool vae::core::Event::critical

wheather the voice can be killer

Definition at line 26 of file vae_event.hpp.

◆ force_mixer

bool vae::core::Event::force_mixer

Prevents overriding the mixer from chained events or fireEvent.

Definition at line 21 of file vae_event.hpp.

◆ gain

Sample vae::core::Event::gain

Volume applied to triggered voice.

Definition at line 31 of file vae_event.hpp.

◆ HRTF

bool vae::core::Event::HRTF

Listener and event has to have hrtf set.

Definition at line 23 of file vae_event.hpp.

◆ id

EventHandle vae::core::Event::id = InvalidEventHandle

Own id.

Definition at line 30 of file vae_event.hpp.

◆ loop

bool vae::core::Event::loop

gapless looping

Definition at line 22 of file vae_event.hpp.

◆ mixer

MixerHandle vae::core::Event::mixer = Mixer::MasterMixerHandle

Mixer the source gets written to.

Definition at line 28 of file vae_event.hpp.

◆ name

NameString vae::core::Event::name

Name for debugging.

Definition at line 34 of file vae_event.hpp.

◆ on_end

EventHandle vae::core::Event::on_end

Event fired once the source is finished, not called when there's no source.

Definition at line 33 of file vae_event.hpp.

◆ source

SourceHandle vae::core::Event::source = InvalidSourceHandle

Handle to a source.

Definition at line 29 of file vae_event.hpp.

◆ spatial

bool vae::core::Event::spatial

no spatial rendering at all

Definition at line 24 of file vae_event.hpp.

The documentation for this struct was generated from the following file:

vae_event.hpp

Public Types

Public Member Functions

Public Attributes