AUD_FaderFactory Class Reference

#include <AUD_FaderFactory.h>

Inheritance diagram for AUD_FaderFactory:

List of all members.

Public Member Functions
	AUD_FaderFactory (AUD_Reference< AUD_IFactory > factory, AUD_FadeType type=AUD_FADE_IN, float start=0.0f, float length=1.0f)
AUD_FadeType	getType () const
float	getStart () const
float	getLength () const
virtual AUD_Reference < AUD_IReader >	createReader ()

---

Detailed Description

This factory fades another factory. If the fading type is AUD_FADE_IN, everything before the fading start will be silenced, for AUD_FADE_OUT that's true for everything after fading ends.

Definition at line 40 of file AUD_FaderFactory.h.

---

Constructor & Destructor Documentation

AUD_FaderFactory::AUD_FaderFactory	(	AUD_Reference< AUD_IFactory >	factory,
		AUD_FadeType	type = AUD_FADE_IN,
		float	start = 0.0f,
		float	length = 1.0f
	)

Creates a new fader factory.

Parameters:

factory	The input factory.
type	The fading type.
start	The time where fading should start in seconds.
length	How long fading should last in seconds.

Definition at line 33 of file AUD_FaderFactory.cpp.

---

Member Function Documentation

AUD_Reference< AUD_IReader > AUD_FaderFactory::createReader

(

)

[virtual]

Creates a reader for playback of the sound source.

Returns:

A pointer to an AUD_IReader object or NULL if there has been an error.

Exceptions:

AUD_Exception

An exception may be thrown if there has been a more unexpected error during reader creation.

Implements AUD_IFactory.

Definition at line 57 of file AUD_FaderFactory.cpp.

References AUD_EffectFactory::getReader().

float AUD_FaderFactory::getLength

(

)

const

Returns the fading length.

Definition at line 52 of file AUD_FaderFactory.cpp.

float AUD_FaderFactory::getStart

(

)

const

Returns the fading start.

Definition at line 47 of file AUD_FaderFactory.cpp.

AUD_FadeType AUD_FaderFactory::getType

(

void

)

const

Returns the fading type.

Definition at line 42 of file AUD_FaderFactory.cpp.

---

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

• AUD_FaderFactory.h
• AUD_FaderFactory.cpp