b12838373b302ec28f728bb10deebd9a48695a81
[blender-staging.git] / intern / audaspace / FX / AUD_VolumeFactory.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_VolumeFactory.h
26  *  \ingroup audfx
27  */
28
29
30 #ifndef __AUD_VOLUMEFACTORY_H__
31 #define __AUD_VOLUMEFACTORY_H__
32
33 #include "AUD_EffectFactory.h"
34
35 /**
36  * This factory changes the volume of another factory.
37  * The set volume should be a value between 0.0 and 1.0, higher values at your
38  * own risk!
39  */
40 class AUD_VolumeFactory : public AUD_EffectFactory
41 {
42 private:
43         /**
44          * The volume.
45          */
46         const float m_volume;
47
48         // hide copy constructor and operator=
49         AUD_VolumeFactory(const AUD_VolumeFactory&);
50         AUD_VolumeFactory& operator=(const AUD_VolumeFactory&);
51
52 public:
53         /**
54          * Creates a new volume factory.
55          * \param factory The input factory.
56          * \param volume The desired volume.
57          */
58         AUD_VolumeFactory(AUD_Reference<AUD_IFactory> factory, float volume);
59
60         /**
61          * Returns the volume.
62          * \return The current volume.
63          */
64         float getVolume() const;
65
66         virtual AUD_Reference<AUD_IReader> createReader();
67 };
68
69 #endif //__AUD_VOLUMEFACTORY_H__