A flim sound. More...

#include <flimSound.h>

Inheritance diagram for flimSound:

Collaboration diagram for flimSound:

Public Member Functions
	flimSound (SoundCallID id, bool is3DSound=false, bool occ=false)
	Constructor. More...

	flimSound ()=delete

	flimSound (const flimSound &)=default

flimSound &	operator= (const flimSound &)=default

	~flimSound ()

snd_err	getOrientation (Vect &out) const

snd_err	setOrientation (const Vect &orient)

snd_err	getPosition (Vect &out) const
	Gets a position. More...

snd_err	setPosition (const Vect &orient)
	Sets a position. More...

snd_err	SetOrientation (const Vect &vect, float xU=0.0f, float yU=1.0f, float zU=0.0f)
	Sets an orientation. More...

snd_err	getDistanceCurve (DistanceCurve &out)
	Gets distance curve. More...

snd_err	setDistanceCurve (const DistanceCurve &distCurve)
	Sets distance curve. More...

snd_err	getReverb (flimReverb &out) const
	Gets a reverb. More...

snd_err	getFilter (flimFilter &out) const
	Gets a filter. More...

snd_err	Pan (float p, int triggerTime=0)
	Pans. More...

snd_err	Pan (float from, float to, float time, int triggerTime=0)
	Pans. More...

snd_err	Loop (bool toLoop, int triggerTime=0)
	Loops. More...

snd_err	Pitch (float p, int triggerTime=0)
	Pitches. More...

snd_err	Pitch (float from, float to, float time, int triggerTime=0)
	Pitches. More...

snd_err	Volume (float p, int triggerTime=0)
	Volumes. More...

snd_err	Volume (float from, float to, float time, int triggerTime=0)
	Volumes. More...

snd_err	Play (bool toLoop=false, int t=0, int _priority=0)
	Plays. More...

snd_err	Stop (int t=0)
	Stops the given t. More...

snd_err	Pause (int t=0)
	Pauses the given t. More...

snd_err	IsPlaying (bool &)
	Is playing. More...

snd_err	GetTimeSinceStarted (int &)
	Gets time since started. More...

snd_err	GetVolume (float &)
	Gets a volume. More...

snd_err	GetPitch (float &)
	Gets a pitch. More...

snd_err	GetPan (float &)
	Gets a pan. More...

snd_err	GetPriority (int &)
	Gets a priority. More...

snd_err	GetLoop (bool &)
	Gets a loop. More...

snd_err	SubmitSoundEndedCallback (CallbackCommand *cmd)
	Callback, called when the submit sound ended. More...

errcode	Update () override
	Called every frame. More...

errcode	Collision (GameObject *)
	Collisions the given parameter 1. More...

errcode	Collision (Collidable *) override
	Collisions the given parameter 1. More...

errcode	CollisionTerrain (const CollisionVolumeAABB &aabb) override
	Collision terrain. More...

errcode	CollisionEnter (Collidable *)
	Collision enter. More...

errcode	CollisionExit ()
	Collision exit. More...

errcode	SetReverbLevel (float level)
	Sets reverb level. More...

errcode	SetReverbTime (float time)
	Sets reverb time. More...

errcode	SetReverbPreDelay (float time)
	Sets reverb pre delay. More...

errcode	SetReverbSize (float size)
	Sets reverb size. More...

errcode	SetReverbDensity (float density)
	Sets reverb density. More...

Public Member Functions inherited from GameObject
	GameObject ()

virtual	~GameObject ()

GameObject &	operator= (const GameObject &)=default

	GameObject (const GameObject &)=default

errcode	SubmitEntry ()
	Submit entry to the scene. More...

errcode	SubmitExit ()
	Submit exit to the scene. More...

Public Member Functions inherited from Updatable
	Updatable ()

virtual	~Updatable ()

	Updatable (const Updatable &)=delete

const Updatable &	operator= (const Updatable &)=delete

errcode	SubmitUpdateRegistration ()
	Submit update registration. More...

errcode	SubmitUpdateDeregistration ()
	Submit update deregistration. More...

Public Member Functions inherited from Drawable
	Drawable ()

virtual	~Drawable ()

	Drawable (const Drawable &)=delete

const Drawable &	operator= (const Drawable &)=delete

virtual errcode	Draw ()
	Draw callback to override. More...

virtual errcode	Draw2D ()

errcode	SubmitDrawRegistration ()
	Submit draw registration. More...

errcode	SubmitDrawDeregistration ()
	Submit draw deregistration. More...

std::list< Drawable * >::iterator	GetDeletionIterator ()

errcode	SetDeletionIterator (std::list< Drawable *>::iterator in)

Public Member Functions inherited from Inputable
	Inputable ()

virtual	~Inputable ()

	Inputable (const Inputable &)=delete

const Inputable &	operator= (const Inputable &)=delete

virtual errcode	KeyPressed (AZUL_KEY key)
	Key pressed callback. More...

virtual errcode	KeyReleased (AZUL_KEY key)
	Key released. More...

errcode	SubmitInputRegistration (AZUL_KEY key, input_type type)
	Submit input registration. More...

errcode	SubmitInputDeregistration (AZUL_KEY key, input_type type)
	Submit input deregistration. More...

std::list< Inputable * >::iterator	GetDeletionIterator ()

errcode	SetDeletionIterator (std::list< Inputable *>::iterator in)

Public Member Functions inherited from Alarmable
	Alarmable ()

Alarmable &	operator= (const Alarmable &)

virtual	~Alarmable ()

	Alarmable (const Alarmable &)

errcode	SubmitAlarmDeregistration (AlarmableManager::ALARM_ID id)
	Submit alarm deregistration. More...

errcode	SubmitAlarmRegistration (float t, AlarmableManager::ALARM_ID id)
	Submit alarm registration. More...

virtual void	Alarm0 ()
	Alarm 0 callback. More...

virtual void	Alarm1 ()
	Alarm 1 callback. More...

virtual void	Alarm2 ()
	Alarm 2 callback. More...

float	TimeLeft (AlarmableManager::ALARM_ID id)
	Time left on one of the alarms. More...

errcode	ChangeTime (float t, AlarmableManager::ALARM_ID id)
	Change time. More...

errcode	AddTime (float t, AlarmableManager::ALARM_ID id)
	Adds a time to 'id'. More...

errcode	SubtractTime (float t, AlarmableManager::ALARM_ID id)
	Subtract time. More...

bool	IsRegistered (AlarmableManager::ALARM_ID id)
	Query if 'id' is registered. More...

errcode	SetDeletionIter (int alarmNumber, std::multimap< float, AlarmableManager::AlarmEvent >::const_iterator iter)

std::multimap< float, AlarmableManager::AlarmEvent >::const_iterator	GetDeletionIter (int alarmNumber)

errcode	SetRegistrationState (int alarmNumber, RegistrationState state)

Public Member Functions inherited from Collidable
	Collidable ()

virtual	~Collidable ()

	Collidable (const Collidable &)=delete

const Collidable &	operator= (const Collidable &)=delete

template<typename C >
errcode	SubmitCollisionRegistration (C *c)
	Submit collision registration of your type. More...

template<typename C >
errcode	SubmitCollisionDeregistration (C *c)
	Submit collision deregistration for your type. More...

const CollisionVolume &	GetCollisionVolume () const

errcode	SetColliderModel (Model *mod, VolumeType vol)
	Sets collider model. More...

errcode	UpdateCollisionData (Matrix &mat)
	Updates the collision data described by matrix. More...

std::list< Collidable * >::iterator	GetDeletionIter ()

errcode	SetDeletionIter (std::list< Collidable *>::iterator in)

bool	getColliding () const

void	setColliding (bool coll)

const CollisionVolumeBSphere &	getBSphere () const

Private Attributes
SoundCallID	sndID

SoundCall *	snd

bool	is3D

bool	occlusionEnabled

Model *	occlusionSphere

Vect	position

Vect	orientation

DistanceCurve	distanceCurve

SourceType	sourceType

flimReverb	reverb

flimFilter	filter

Additional Inherited Members
Public Attributes inherited from Updatable
std::list< Updatable * >::iterator	deleteIter

Detailed Description

A flim sound.

Author: Jack Campbell

Date: 6/1/2017

Constructor & Destructor Documentation

◆ flimSound() [1/2]

flimSound::flimSound ( )

delete

◆ flimSound() [2/2]

flimSound::flimSound ( const flimSound & )

default

◆ ~flimSound()

flimSound::~flimSound ( )

Member Function Documentation

◆ CollisionExit()

errcode flimSound::CollisionExit ( )

virtual

Collision exit.

Author: Jack Campbell

Date: 6/1/2017

Returns: An errcode.

Reimplemented from Collidable.

◆ getOrientation()

snd_err flimSound::getOrientation ( Vect & out ) const

◆ operator=()

flimSound& flimSound::operator= ( const flimSound & )

default

◆ setOrientation()

snd_err flimSound::setOrientation ( const Vect & orient )

◆ Update()

errcode flimSound::Update ( )

overridevirtual

Called every frame.

Author: Jack Campbell

Date: 3/5/2017

Update is called once a frame on objects that have been registered to update.

     errcode Frigate::Update()
{
    // Place frame related content here. This code moves the ship's graphics object.
    // Ship translation movement (not using time-based values for simplicity)
    if (Keyboard::GetKeyState(AZUL_KEY::KEY_W))
    {
        ShipPos += Vect(0, 0, 1) * ShipRot * ShipTransSpeed;
    }
    else if (Keyboard::GetKeyState(AZUL_KEY::KEY_S))
    {
        ShipPos += Vect(0, 0, 1) * ShipRot * -ShipTransSpeed;
    }
    // Spaceship adjust matrix
    Matrix world = ShipScale * ShipRot * Matrix(TRANS, ShipPos);
    pGObj_SpaceFrigateLight->SetWorld(world);
    return errcode::success;
}

Returns: An errcode.

Reimplemented from Updatable.

Member Data Documentation

◆ distanceCurve

DistanceCurve flimSound::distanceCurve

private

◆ filter

flimFilter flimSound::filter

private

◆ is3D

bool flimSound::is3D

private

◆ occlusionEnabled

bool flimSound::occlusionEnabled

private

◆ occlusionSphere

Model* flimSound::occlusionSphere

private

◆ orientation

Vect flimSound::orientation

private

◆ position

Vect flimSound::position

private

◆ reverb

flimReverb flimSound::reverb

private

◆ snd

SoundCall* flimSound::snd

private

◆ sndID

SoundCallID flimSound::sndID

private

◆ sourceType

SourceType flimSound::sourceType

private

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

Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ flimSound() [1/2]

◆ flimSound() [2/2]

◆ ~flimSound()

Member Function Documentation

◆ CollisionExit()

◆ getOrientation()

◆ operator=()

◆ setOrientation()

◆ Update()

Member Data Documentation

◆ distanceCurve

◆ filter

◆ is3D

◆ occlusionEnabled

◆ occlusionSphere

◆ orientation

◆ position

◆ reverb

◆ snd

◆ sndID

◆ sourceType