Debian Codegraph @

engine/core/audio/soundsource.h

raw
1 /***************************************************************************
2 * Copyright (C) 2005-2019 by the FIFE team *
3 * http://www.fifengine.net *
4 * This file is part of FIFE. *
5 * *
6 * FIFE is free software; you can redistribute it and/or *
7 * modify it under the terms of the GNU Lesser General Public *
8 * License as published by the Free Software Foundation; either *
9 * version 2.1 of the License, or (at your option) any later version. *
10 * *
11 * This library is distributed in the hope that it will be useful, *
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of *
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU *
14 * Lesser General Public License for more details. *
15 * *
16 * You should have received a copy of the GNU Lesser General Public *
17 * License along with this library; if not, write to the *
18 * Free Software Foundation, Inc., *
19 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA *
20 ***************************************************************************/
21
22 #ifndef FIFE_SOUNDSOURCE_H
23 #define FIFE_SOUNDSOURCE_H
24
25 // Standard C++ library includes
26
27 // Platform specific includes
28
29 // 3rd party library includes
30
31 // FIFE includes
32 // These includes are split up in two parts, separated by one empty line
33 // First block: files included from the FIFE root src directory
34 // Second block: files included from the same folder
35
36 namespace FIFE {
37
38 class ActionAudio;
39 class Instance;
40 class SoundChangeListener;
41 class SoundEmitter;
42
43 /** Interface class between Instance / ActionAudio and SoundEmitter.
44 */
45 class SoundSource {
46 public:
47
48 SoundSource(Instance* instance);
49 ~SoundSource();
50
51 /** Sets the ActionAudio. Owned by Object.
52 */
53 void setActionAudio(ActionAudio* audio);
54
55 /** Return ActionAudio. Owned by Object.
56 */
57 ActionAudio* getActionAudio() const;
58
59 /** Sets the positon of the SoundEmitter, called from Instance.
60 */
61 void setPosition();
62
63 /** Sets the direction of the SoundEmitter, called from Instance.
64 */
65 void setDirection();
66
67 private:
68 /** Moves data from ActionAudio to SoundEmitter.
69 */
70 void updateSoundEmitter();
71
72 //! Associated Instance
73 Instance* m_instance;
74 //! Actual ActionAudio
75 ActionAudio* m_audio;
76 //! Related SoundEmitter
77 SoundEmitter* m_emitter;
78 //! InstanceChangeListener for position and direction
79 SoundChangeListener* m_listener;
80
81
82 };
83 }
84
85 #endif