rna polygon access to loop vertex indicies.
[blender-staging.git] / intern / audaspace / FX / AUD_FaderFactory.h
1 /*
2  * $Id$
3  *
4  * ***** BEGIN GPL LICENSE BLOCK *****
5  *
6  * Copyright 2009-2011 Jörg Hermann Müller
7  *
8  * This file is part of AudaSpace.
9  *
10  * Audaspace is free software; you can redistribute it and/or modify
11  * it under the terms of the GNU General Public License as published by
12  * the Free Software Foundation; either version 2 of the License, or
13  * (at your option) any later version.
14  *
15  * AudaSpace is distributed in the hope that it will be useful,
16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18  * GNU General Public License for more details.
19  *
20  * You should have received a copy of the GNU General Public License
21  * along with Audaspace; if not, write to the Free Software Foundation,
22  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
23  *
24  * ***** END GPL LICENSE BLOCK *****
25  */
26
27 /** \file audaspace/FX/AUD_FaderFactory.h
28  *  \ingroup audfx
29  */
30
31
32 #ifndef AUD_FADERFACTORY
33 #define AUD_FADERFACTORY
34
35 #include "AUD_EffectFactory.h"
36
37 /**
38  * This factory fades another factory.
39  * If the fading type is AUD_FADE_IN, everything before the fading start will be
40  * silenced, for AUD_FADE_OUT that's true for everything after fading ends.
41  */
42 class AUD_FaderFactory : public AUD_EffectFactory
43 {
44 private:
45         /**
46          * The fading type.
47          */
48         const AUD_FadeType m_type;
49
50         /**
51          * The fading start.
52          */
53         const float m_start;
54
55         /**
56          * The fading length.
57          */
58         const float m_length;
59
60         // hide copy constructor and operator=
61         AUD_FaderFactory(const AUD_FaderFactory&);
62         AUD_FaderFactory& operator=(const AUD_FaderFactory&);
63
64 public:
65         /**
66          * Creates a new fader factory.
67          * \param factory The input factory.
68          * \param type The fading type.
69          * \param start The time where fading should start in seconds.
70          * \param length How long fading should last in seconds.
71          */
72         AUD_FaderFactory(AUD_IFactory* factory,
73                                           AUD_FadeType type = AUD_FADE_IN,
74                                           float start = 0.0f, float length = 1.0f);
75
76         /**
77          * Returns the fading type.
78          */
79         AUD_FadeType getType() const;
80
81         /**
82          * Returns the fading start.
83          */
84         float getStart() const;
85
86         /**
87          * Returns the fading length.
88          */
89         float getLength() const;
90
91         virtual AUD_IReader* createReader() const;
92 };
93
94 #endif //AUD_FADERFACTORY