Effect Class Reference

This sound is a base class for all effect factories that take one other sound as input. More...

#include <Effect.h>

Inheritance diagram for Effect:

Public Member Functions
	Effect (std::shared_ptr< ISound > sound)
	Creates a new sound.
virtual	~Effect ()
	Destroys the sound.
std::shared_ptr< ISound >	getSound () const
	Returns the saved sound.
Public Member Functions inherited from ISound
virtual	~ISound ()
	Destroys the sound.
virtual std::shared_ptr< IReader >	createReader ()=0
	Creates a reader for playback of the sound source.

Protected Member Functions
std::shared_ptr< IReader >	getReader () const
	Returns the reader created out of the sound.

Protected Attributes
std::shared_ptr< ISound >	m_sound
	If there is no reader it is created out of this sound.

Detailed Description

This sound is a base class for all effect factories that take one other sound as input.

Constructor & Destructor Documentation

Effect()

Effect::Effect

(

std::shared_ptr< ISound >

sound

)

Creates a new sound.

Parameters

sound

The input sound.

Member Function Documentation

getReader()

std::shared_ptr< IReader > Effect::getReader ( ) const

inlineprotected

Returns the reader created out of the sound.

This method can be used for the createReader function of the implementing classes.

Returns

The reader created out of the sound.

getSound()

std::shared_ptr< ISound > Effect::getSound

(

)

const

Returns the saved sound.

Returns

The sound or nullptr if there has no sound been saved.

---

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

• fx/Effect.h