Overload  1.1
Game engine with editor
Public Member Functions | Static Public Attributes | List of all members
OvAudio::Entities::AudioListener Class Reference

#include <AudioListener.h>

Public Member Functions

 AudioListener ()
 
 AudioListener (OvMaths::FTransform &p_transform)
 
 ~AudioListener ()
 
OvMaths::FTransformGetTransform ()
 
void SetEnabled (bool p_enable)
 
bool IsEnabled () const
 

Static Public Attributes

static OvTools::Eventing::Event< AudioListener & > CreatedEvent
 
static OvTools::Eventing::Event< AudioListener & > DestroyedEvent
 

Detailed Description

Represents the ears of your application. You can have multiple ones but only the last created will be considered by the AudioEngine

Constructor & Destructor Documentation

◆ AudioListener() [1/2]

OvAudio::Entities::AudioListener::AudioListener ( )

AudioListener constructor (Internal transform management)

◆ AudioListener() [2/2]

OvAudio::Entities::AudioListener::AudioListener ( OvMaths::FTransform p_transform)

AudioListener constructor (External transform management)

Parameters
p_transform

◆ ~AudioListener()

OvAudio::Entities::AudioListener::~AudioListener ( )

AudioListener destructor

Member Function Documentation

◆ GetTransform()

OvMaths::FTransform & OvAudio::Entities::AudioListener::GetTransform ( )

Returns the AudioListener FTransform

◆ IsEnabled()

bool OvAudio::Entities::AudioListener::IsEnabled ( ) const

Returns true if the audio listener is enabled

◆ SetEnabled()

void OvAudio::Entities::AudioListener::SetEnabled ( bool  p_enable)

Enable or disable the audio listener

Parameters
p_enable

Member Data Documentation

◆ CreatedEvent

OvTools::Eventing::Event< OvAudio::Entities::AudioListener & > OvAudio::Entities::AudioListener::CreatedEvent
static

@project: Overload

Author
: Overload Tech. @restrictions: This software may not be resold, redistributed or otherwise conveyed to a third party.

◆ DestroyedEvent

OvTools::Eventing::Event< OvAudio::Entities::AudioListener & > OvAudio::Entities::AudioListener::DestroyedEvent
static

The documentation for this class was generated from the following files: