svn merge -r39781:39792 https://svn.blender.org/svnroot/bf-blender/trunk/blender...
[blender-staging.git] / intern / audaspace / FX / AUD_EffectFactory.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_EffectFactory.h
28  *  \ingroup audfx
29  */
30
31
32 #ifndef AUD_EFFECTFACTORY
33 #define AUD_EFFECTFACTORY
34
35 #include "AUD_IFactory.h"
36
37 /**
38  * This factory is a base class for all effect factories that take one other
39  * factory as input.
40  */
41 class AUD_EffectFactory : public AUD_IFactory
42 {
43 private:
44         // hide copy constructor and operator=
45         AUD_EffectFactory(const AUD_EffectFactory&);
46         AUD_EffectFactory& operator=(const AUD_EffectFactory&);
47
48 protected:
49         /**
50          * If there is no reader it is created out of this factory.
51          */
52         AUD_Reference<AUD_IFactory> m_factory;
53
54         /**
55          * Returns the reader created out of the factory.
56          * This method can be used for the createReader function of the implementing
57          * classes.
58          * \return The reader created out of the factory.
59          */
60         inline AUD_Reference<AUD_IReader> getReader() const
61         {
62                 return m_factory->createReader();
63         }
64
65 public:
66         /**
67          * Creates a new factory.
68          * \param factory The input factory.
69          */
70         AUD_EffectFactory(AUD_Reference<AUD_IFactory> factory);
71
72         /**
73          * Destroys the factory.
74          */
75         virtual ~AUD_EffectFactory();
76
77         /**
78          * Returns the saved factory.
79          * \return The factory or NULL if there has no factory been saved.
80          */
81         AUD_Reference<AUD_IFactory> getFactory() const;
82 };
83
84 #endif //AUD_EFFECTFACTORY