FIFE  6e1afdbeda11afe9ac53e6023a4be96ef88f1dc6
soundsource.h
Go to the documentation of this file.
1 /***************************************************************************
2  * Copyright (C) 2005-2017 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 
45  class SoundSource {
46  public:
47 
48  SoundSource(Instance* instance);
49  ~SoundSource();
50 
53  void setActionAudio(ActionAudio* audio);
54 
57  ActionAudio* getActionAudio() const;
58 
61  void setPosition();
62 
65  void setDirection();
66 
67  private:
70  void updateSoundEmitter();
71 
80 
81 
82  };
83 }
84 
85 #endif
void setActionAudio(ActionAudio *audio)
Sets the ActionAudio.
Definition: soundsource.cpp:82
Interface class between Instance / ActionAudio and SoundEmitter.
Definition: soundsource.h:45
SoundSource(Instance *instance)
Definition: soundsource.cpp:63
The class for holding audio data per Action.
Definition: actionaudio.h:41
void setPosition()
Sets the positon of the SoundEmitter, called from Instance.
The class for playing audio files.
Definition: soundemitter.h:70
void updateSoundEmitter()
Moves data from ActionAudio to SoundEmitter.
void setDirection()
Sets the direction of the SoundEmitter, called from Instance.
ActionAudio * getActionAudio() const
Return ActionAudio.
Instance * m_instance
Associated Instance.
Definition: soundsource.h:73
ActionAudio * m_audio
Actual ActionAudio.
Definition: soundsource.h:75
SoundChangeListener * m_listener
InstanceChangeListener for position and direction.
Definition: soundsource.h:79
An Instance is an "instantiation" of an Object at a Location.
Definition: instance.h:101
SoundEmitter * m_emitter
Related SoundEmitter.
Definition: soundsource.h:77