SequenceEntry Class Reference

This class represents a sequenced entry in a sequencer sound. More...

#include <SequenceEntry.h>

Inheritance diagram for SequenceEntry:

Public Member Functions
	SequenceEntry (std::shared_ptr< ISound > sound, double begin, double end, double skip, std::shared_ptr< SequenceData > sequence_data, int id)
	Creates a new sequenced entry.
virtual void	lock ()
	Locks the entry.
virtual void	unlock ()
	Unlocks the previously locked entry.
std::shared_ptr< ISound >	getSound ()
	Retrieves the sound of the entry.
void	setSound (std::shared_ptr< ISound > sound)
	Sets the sound of the entry.
void	move (double begin, double end, double skip)
	Moves the entry.
bool	isMuted ()
	Retrieves the muting state of the entry.
void	mute (bool mute)
	Sets the muting state of the entry.
int	getID () const
	Retrieves the ID of the entry.
AnimateableProperty *	getAnimProperty (AnimateablePropertyType type)
	Retrieves one of the animated properties of the entry.
bool	isRelative ()
	Checks whether the source location, velocity and orientation are relative to the listener.
void	setRelative (bool relative)
	Sets whether the source location, velocity and orientation are relative to the listener.
float	getVolumeMaximum ()
	Retrieves the maximum volume of a source.
void	setVolumeMaximum (float volume)
	Sets the maximum volume of a source.
float	getVolumeMinimum ()
	Retrieves the minimum volume of a source.
void	setVolumeMinimum (float volume)
	Sets the minimum volume of a source.
float	getDistanceMaximum ()
	Retrieves the maximum distance of a source.
void	setDistanceMaximum (float distance)
	Sets the maximum distance of a source.
float	getDistanceReference ()
	Retrieves the reference distance of a source.
void	setDistanceReference (float distance)
	Sets the reference distance of a source.
float	getAttenuation ()
	Retrieves the attenuation of a source.
void	setAttenuation (float factor)
	Sets the attenuation of a source.
float	getConeAngleOuter ()
	Retrieves the outer angle of the cone of a source.
void	setConeAngleOuter (float angle)
	Sets the outer angle of the cone of a source.
float	getConeAngleInner ()
	Retrieves the inner angle of the cone of a source.
void	setConeAngleInner (float angle)
	Sets the inner angle of the cone of a source.
float	getConeVolumeOuter ()
	Retrieves the outer volume of the cone of a source.
void	setConeVolumeOuter (float volume)
	Sets the outer volume of the cone of a source.

Friends
class	SequenceHandle

Detailed Description

This class represents a sequenced entry in a sequencer sound.

Constructor & Destructor Documentation

SequenceEntry()

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

Creates a new sequenced entry.

Parameters

sound	The sound this entry should play.
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.
sequence_data	Reference to sequence_data. Mainly needed to get the FPS of the scene.
id	The ID of the entry.

Member Function Documentation

getAnimProperty()

AnimateableProperty * SequenceEntry::getAnimProperty

(

AnimateablePropertyType

type

)

Retrieves one of the animated properties of the entry.

Parameters

type	Which animated property to retrieve.

Returns

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

getAttenuation()

float SequenceEntry::getAttenuation

(

)

Retrieves the attenuation of a source.

Returns

The attenuation.

getConeAngleInner()

float SequenceEntry::getConeAngleInner

(

)

Retrieves the inner angle of the cone of a source.

Returns

The inner angle of the cone.

getConeAngleOuter()

float SequenceEntry::getConeAngleOuter

(

)

Retrieves the outer angle of the cone of a source.

Returns

The outer angle of the cone.

getConeVolumeOuter()

float SequenceEntry::getConeVolumeOuter

(

)

Retrieves the outer volume of the cone of a source.

The volume between inner and outer angle is interpolated between inner volume and this value.

Returns

The outer volume of the cone.

getDistanceMaximum()

float SequenceEntry::getDistanceMaximum

(

)

Retrieves the maximum distance of a source.

If a source is further away from the reader than this distance, the volume will automatically be set to 0.

Returns

The maximum distance.

getDistanceReference()

float SequenceEntry::getDistanceReference

(

)

Retrieves the reference distance of a source.

Returns

The reference distance.

getID()

int SequenceEntry::getID

(

)

const

Retrieves the ID of the entry.

Returns

The ID of the entry.

getSound()

std::shared_ptr< ISound > SequenceEntry::getSound

(

)

Retrieves the sound of the entry.

Returns

The sound.

getVolumeMaximum()

float SequenceEntry::getVolumeMaximum

(

)

Retrieves the maximum volume of a source.

Returns

The maximum volume.

getVolumeMinimum()

float SequenceEntry::getVolumeMinimum

(

)

Retrieves the minimum volume of a source.

Returns

The minimum volume.

isMuted()

bool SequenceEntry::isMuted

(

)

Retrieves the muting state of the entry.

Returns

Whether the entry should is muted or not.

isRelative()

bool SequenceEntry::isRelative

(

)

Checks whether the source location, velocity and orientation are relative to the listener.

Returns

Whether the source is relative.

lock()

virtual void SequenceEntry::lock ( )

virtual

Locks the entry.

Implements ILockable.

move()

void SequenceEntry::move	(	double	begin,
		double	end,
		double	skip )

Moves the entry.

Parameters

begin	The new start time.
end	The new end time or a negative value if unknown.
skip	How many seconds to skip at the beginning.

mute()

void SequenceEntry::mute

(

bool

mute

)

Sets the muting state of the entry.

Parameters

mute	Whether the entry should be muted or not.

setAttenuation()

void SequenceEntry::setAttenuation

(

float

factor

)

Sets the attenuation of a source.

This value is used for distance calculation.

Parameters

factor

The new attenuation.

Returns

Whether the action succeeded.

setConeAngleInner()

void SequenceEntry::setConeAngleInner

(

float

angle

)

Sets the inner angle of the cone of a source.

Parameters

angle

The new inner angle of the cone.

Returns

Whether the action succeeded.

setConeAngleOuter()

void SequenceEntry::setConeAngleOuter

(

float

angle

)

Sets the outer angle of the cone of a source.

Parameters

angle

The new outer angle of the cone.

Returns

Whether the action succeeded.

setConeVolumeOuter()

void SequenceEntry::setConeVolumeOuter

(

float

volume

)

Sets the outer volume of the cone of a source.

The volume between inner and outer angle is interpolated between inner volume and this value.

Parameters

volume

The new outer volume of the cone.

Returns

Whether the action succeeded.

setDistanceMaximum()

void SequenceEntry::setDistanceMaximum

(

float

distance

)

Sets the maximum distance of a source.

If a source is further away from the reader than this distance, the volume will automatically be set to 0.

Parameters

distance

The new maximum distance.

Returns

Whether the action succeeded.

setDistanceReference()

void SequenceEntry::setDistanceReference

(

float

distance

)

Sets the reference distance of a source.

Parameters

distance

The new reference distance.

Returns

Whether the action succeeded.

setRelative()

void SequenceEntry::setRelative

(

bool

relative

)

Sets whether the source location, velocity and orientation are relative to the listener.

Parameters

relative

Whether the source is relative.

Returns

Whether the action succeeded.

setSound()

void SequenceEntry::setSound

(

std::shared_ptr< ISound >

sound

)

Sets the sound of the entry.

Parameters

sound

The new sound.

setVolumeMaximum()

void SequenceEntry::setVolumeMaximum

(

float

volume

)

Sets the maximum volume of a source.

Parameters

volume

The new maximum volume.

Returns

Whether the action succeeded.

setVolumeMinimum()

void SequenceEntry::setVolumeMinimum

(

float

volume

)

Sets the minimum volume of a source.

Parameters

volume

The new minimum volume.

Returns

Whether the action succeeded.

unlock()

virtual void SequenceEntry::unlock ( )

virtual

Unlocks the previously locked entry.

Implements ILockable.

---

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

• sequence/SequenceEntry.h