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