Audaspace:
[blender.git] / intern / audaspace / FX / AUD_EffectFactory.h
1 /*
2  * ***** BEGIN GPL LICENSE BLOCK *****
3  *
4  * Copyright 2009-2011 Jörg Hermann Müller
5  *
6  * This file is part of AudaSpace.
7  *
8  * Audaspace is free software; you can redistribute it and/or modify
9  * it under the terms of the GNU General Public License as published by
10  * the Free Software Foundation; either version 2 of the License, or
11  * (at your option) any later version.
12  *
13  * AudaSpace is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16  * GNU General Public License for more details.
17  *
18  * You should have received a copy of the GNU General Public License
19  * along with Audaspace; if not, write to the Free Software Foundation,
20  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
21  *
22  * ***** END GPL LICENSE BLOCK *****
23  */
24
25 /** \file audaspace/FX/AUD_EffectFactory.h
26  *  \ingroup audfx
27  */
28
29
30 #ifndef __AUD_EFFECTFACTORY_H__
31 #define __AUD_EFFECTFACTORY_H__
32
33 #include "AUD_IFactory.h"
34
35 /**
36  * This factory is a base class for all effect factories that take one other
37  * factory as input.
38  */
39 class AUD_EffectFactory : public AUD_IFactory
40 {
41 private:
42         // hide copy constructor and operator=
43         AUD_EffectFactory(const AUD_EffectFactory&);
44         AUD_EffectFactory& operator=(const AUD_EffectFactory&);
45
46 protected:
47         /**
48          * If there is no reader it is created out of this factory.
49          */
50         boost::shared_ptr<AUD_IFactory> m_factory;
51
52         /**
53          * Returns the reader created out of the factory.
54          * This method can be used for the createReader function of the implementing
55          * classes.
56          * \return The reader created out of the factory.
57          */
58         inline boost::shared_ptr<AUD_IReader> getReader() const
59         {
60                 return m_factory->createReader();
61         }
62
63 public:
64         /**
65          * Creates a new factory.
66          * \param factory The input factory.
67          */
68         AUD_EffectFactory(boost::shared_ptr<AUD_IFactory> factory);
69
70         /**
71          * Destroys the factory.
72          */
73         virtual ~AUD_EffectFactory();
74
75         /**
76          * Returns the saved factory.
77          * \return The factory or NULL if there has no factory been saved.
78          */
79         boost::shared_ptr<AUD_IFactory> getFactory() const;
80 };
81
82 #endif //__AUD_EFFECTFACTORY_H__