tmp
[blender.git] / extern / audaspace / include / fx / Volume.h
1 /*******************************************************************************
2  * Copyright 2009-2016 Jörg Müller
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  *   http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  ******************************************************************************/
16
17 #pragma once
18
19 /**
20  * @file Volume.h
21  * @ingroup fx
22  * The Volume class.
23  */
24
25 #include "fx/Effect.h"
26
27 AUD_NAMESPACE_BEGIN
28
29 /**
30  * This sound changes the volume of another sound.
31  * The set volume should be a value between 0.0 and 1.0, higher values at your
32  * own risk!
33  */
34 class AUD_API Volume : public Effect
35 {
36 private:
37         /**
38          * The volume.
39          */
40         const float m_volume;
41
42         // delete copy constructor and operator=
43         Volume(const Volume&) = delete;
44         Volume& operator=(const Volume&) = delete;
45
46 public:
47         /**
48          * Creates a new volume sound.
49          * \param sound The input sound.
50          * \param volume The desired volume.
51          */
52         Volume(std::shared_ptr<ISound> sound, float volume);
53
54         /**
55          * Returns the volume.
56          * \return The current volume.
57          */
58         float getVolume() const;
59
60         virtual std::shared_ptr<IReader> createReader();
61 };
62
63 AUD_NAMESPACE_END