SequenceData Class Reference

This class represents sequenced entries to play a sound scene. More...

#include <SequenceData.h>

Inheritance diagram for SequenceData:

Public Member Functions
	SequenceData (Specs specs, float fps, bool muted)
	Creates a new sound scene.
virtual void	lock ()
	Locks the sequence.
virtual void	unlock ()
	Unlocks the previously locked sequence.
Specs	getSpecs ()
	Retrieves the audio output specification.
void	setSpecs (Specs specs)
	Sets the audio output specification.
float	getFPS () const
	Retrieves the scene's FPS.
void	setFPS (float fps)
	Sets the scene's FPS.
void	mute (bool muted)
	Sets the muting state of the scene.
bool	isMuted () const
	Retrieves the muting state of the scene.
float	getSpeedOfSound () const
	Retrieves the speed of sound.
void	setSpeedOfSound (float speed)
	Sets the speed of sound.
float	getDopplerFactor () const
	Retrieves the doppler factor.
void	setDopplerFactor (float factor)
	Sets the doppler factor.
DistanceModel	getDistanceModel () const
	Retrieves the distance model.
void	setDistanceModel (DistanceModel model)
	Sets the distance model.
AnimateableProperty *	getAnimProperty (AnimateablePropertyType type)
	Retrieves one of the animated properties of the sequence.
std::shared_ptr< SequenceEntry >	add (std::shared_ptr< ISound > sound, std::shared_ptr< SequenceData > sequence_data, double begin, double end, double skip)
	Adds a new entry to the scene.
void	remove (std::shared_ptr< SequenceEntry > entry)
	Removes an entry from the scene.

Friends
class	SequenceReader

Detailed Description

This class represents sequenced entries to play a sound scene.

Constructor & Destructor Documentation

SequenceData()

SequenceData::SequenceData	(	Specs	specs,
		float	fps,
		bool	muted )

Creates a new sound scene.

Parameters

specs	The output audio data specification.
fps	The FPS of the scene.
muted	Whether the whole scene is muted.

Member Function Documentation

add()

std::shared_ptr< SequenceEntry > SequenceData::add	(	std::shared_ptr< ISound >	sound,
		std::shared_ptr< SequenceData >	sequence_data,
		double	begin,
		double	end,
		double	skip )

Adds a new entry to the scene.

Parameters

sound	The sound this entry should play.
sequence_data	Reference to sequence_data. Mainly needed to get the FPS of the scene.
begin	The start time.
end	The end time or a negative value if determined by the sound.
skip	How much seconds should be skipped at the beginning.

Returns

The entry added.

getAnimProperty()

AnimateableProperty * SequenceData::getAnimProperty

(

AnimateablePropertyType

type

)

Retrieves one of the animated properties of the sequence.

Parameters

type	Which animated property to retrieve.

Returns

A pointer to the animated property, valid as long as the sequence is.

getDistanceModel()

DistanceModel SequenceData::getDistanceModel

(

)

const

Retrieves the distance model.

Returns

The distance model.

getDopplerFactor()

float SequenceData::getDopplerFactor

(

)

const

Retrieves the doppler factor.

This value is a scaling factor for the velocity vectors of sources and listener which is used while calculating the doppler effect.

Returns

The doppler factor.

getFPS()

float SequenceData::getFPS

(

)

const

Retrieves the scene's FPS.

Returns

The scene's FPS.

getSpecs()

Specs SequenceData::getSpecs

(

)

Retrieves the audio output specification.

Returns

The specification.

getSpeedOfSound()

float SequenceData::getSpeedOfSound

(

)

const

Retrieves the speed of sound.

This value is needed for doppler effect calculation.

Returns

The speed of sound.

isMuted()

bool SequenceData::isMuted

(

)

const

Retrieves the muting state of the scene.

Returns

Whether the scene is muted.

lock()

virtual void SequenceData::lock ( )

virtual

Locks the sequence.

Implements ILockable.

mute()

void SequenceData::mute

(

bool

muted

)

Sets the muting state of the scene.

Parameters

muted

Whether the scene is muted.

remove()

void SequenceData::remove

(

std::shared_ptr< SequenceEntry >

entry

)

Removes an entry from the scene.

Parameters

entry

The entry to remove.

setDistanceModel()

void SequenceData::setDistanceModel

(

DistanceModel

model

)

Sets the distance model.

Parameters

model

distance model.

setDopplerFactor()

void SequenceData::setDopplerFactor

(

float

factor

)

Sets the doppler factor.

This value is a scaling factor for the velocity vectors of sources and listener which is used while calculating the doppler effect.

Parameters

factor

The new doppler factor.

setFPS()

void SequenceData::setFPS

(

float

fps

)

Sets the scene's FPS.

Parameters

fps	The new FPS.

setSpecs()

void SequenceData::setSpecs

(

Specs

specs

)

Sets the audio output specification.

Parameters

specs

The new specification.

setSpeedOfSound()

void SequenceData::setSpeedOfSound

(

float

speed

)

Sets the speed of sound.

This value is needed for doppler effect calculation.

Parameters

speed

The new speed of sound.

unlock()

virtual void SequenceData::unlock ( )

virtual

Unlocks the previously locked sequence.

Implements ILockable.

---

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

• sequence/SequenceData.h