blender/intern/audaspace/FX/AUD_FaderFactory.h
Joerg Mueller 7296600434 Audaspace: HUGE Refactor.
Some points of the refactor not sorted by importance:

* Fixed immutability of readers and factories (there are exceptions...)
* Fixed copy constructors and = operators
* Removed messaging system
* Removed reader types
* Added const where possible
* Using initalisers when possible
* Avoided use of pointers when possible
* Removed AUD_NEW and AUD_DELETE macros
* Removed useless NULL pointer checks
* Fixed exception catching
* Fixed some yet unknown bugs
* Lots of other stuff
2010-07-28 09:36:03 +00:00

89 lines
2.1 KiB
C++

/*
* $Id$
*
* ***** BEGIN LGPL LICENSE BLOCK *****
*
* Copyright 2009 Jörg Hermann Müller
*
* This file is part of AudaSpace.
*
* AudaSpace is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* AudaSpace is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with AudaSpace. If not, see <http://www.gnu.org/licenses/>.
*
* ***** END LGPL LICENSE BLOCK *****
*/
#ifndef AUD_FADERFACTORY
#define AUD_FADERFACTORY
#include "AUD_EffectFactory.h"
/**
* 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.
*/
class AUD_FaderFactory : public AUD_EffectFactory
{
private:
/**
* The fading type.
*/
const AUD_FadeType m_type;
/**
* The fading start.
*/
const float m_start;
/**
* The fading length.
*/
const float m_length;
// hide copy constructor and operator=
AUD_FaderFactory(const AUD_FaderFactory&);
AUD_FaderFactory& operator=(const AUD_FaderFactory&);
public:
/**
* Creates a new fader factory.
* \param factory The input factory.
* \param type The fading type.
* \param start The time where fading should start in seconds.
* \param length How long fading should last in seconds.
*/
AUD_FaderFactory(AUD_IFactory* factory,
AUD_FadeType type = AUD_FADE_IN,
float start = 0.0f, float length = 1.0f);
/**
* Returns the fading type.
*/
AUD_FadeType getType() const;
/**
* Returns the fading start.
*/
float getStart() const;
/**
* Returns the fading length.
*/
float getLength() const;
virtual AUD_IReader* createReader() const;
};
#endif //AUD_FADERFACTORY