blob: 471e37b5ecf8109839784cdbc0f4b41b0c5ff966 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
|
/*******************************************************************************
* Copyright 2009-2016 Jörg Müller
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
******************************************************************************/
#pragma once
/**
* @file Effect.h
* @ingroup fx
* The Effect class.
*/
#include "ISound.h"
AUD_NAMESPACE_BEGIN
/**
* This sound is a base class for all effect factories that take one other
* sound as input.
*/
class AUD_API Effect : public ISound
{
private:
// delete copy constructor and operator=
Effect(const Effect&) = delete;
Effect& operator=(const Effect&) = delete;
protected:
/**
* If there is no reader it is created out of this sound.
*/
std::shared_ptr<ISound> m_sound;
/**
* Returns the reader created out of the sound.
* This method can be used for the createReader function of the implementing
* classes.
* \return The reader created out of the sound.
*/
inline std::shared_ptr<IReader> getReader() const
{
return m_sound->createReader();
}
public:
/**
* Creates a new sound.
* \param sound The input sound.
*/
Effect(std::shared_ptr<ISound> sound);
/**
* Destroys the sound.
*/
virtual ~Effect();
/**
* Returns the saved sound.
* \return The sound or nullptr if there has no sound been saved.
*/
std::shared_ptr<ISound> getSound() const;
};
AUD_NAMESPACE_END
|