Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: code/trunk/src/orxonox/sound/AmbientSound.h @ 6417

Last change on this file since 6417 was 6417, checked in by rgrieder, 14 years ago

Merged presentation2 branch back to trunk.
Major new features:

  • Actual GUI with settings, etc.
  • Improved space ship steering (human interaction)
  • Rocket fire and more particle effects
  • Advanced sound framework
  • Property svn:eol-style set to native
File size: 2.6 KB
Line 
1/*
2 *   ORXONOX - the hottest 3D action shooter ever to exist
3 *                    > www.orxonox.net <
4 *
5 *
6 *   License notice:
7 *
8 *   This program is free software; you can redistribute it and/or
9 *   modify it under the terms of the GNU General Public License
10 *   as published by the Free Software Foundation; either version 2
11 *   of the License, or (at your option) any later version.
12 *
13 *   This program is distributed in the hope that it will be useful,
14 *   but WITHOUT ANY WARRANTY; without even the implied warranty of
15 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16 *   GNU General Public License for more details.
17 *
18 *   You should have received a copy of the GNU General Public License
19 *   along with this program; if not, write to the Free Software
20 *   Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
21 *
22 *   Author:
23 *      Reto Grieder
24 *      Kevin Young
25 *   Co-authors:
26 *      ...
27 *
28 */
29
30#ifndef _AmbientSound_H__
31#define _AmbientSound_H__
32
33#include "OrxonoxPrereqs.h"
34
35#include "core/BaseObject.h"
36#include "network/synchronisable/Synchronisable.h"
37#include "BaseSound.h"
38#include "MoodManager.h"
39
40namespace orxonox
41{
42    /**
43     * The AmbientSound class is the base class for all sound file loader classes.
44     * It server as main interface to the OpenAL library.
45     *
46     */
47    class _OrxonoxExport AmbientSound : public BaseSound, public BaseObject, public Synchronisable, public MoodListener
48    {
49        friend class SoundManager;
50
51    public:
52        AmbientSound(BaseObject* creator);
53
54        void XMLPort(Element& xmlelement, XMLPort::Mode mode);
55        void XMLEventPort(Element& xmlelement, XMLPort::Mode mode);
56        void changedActivity();
57
58        void play();
59        void stop();
60        void pause();
61
62        void setAmbientSource(const std::string& source);
63        inline const std::string& getAmbientSource() const
64            { return this->ambientSource_; }
65
66        void setPlayOnLoad(bool val);
67        bool getPlayOnLoad() const
68            { return this->bPlayOnLoad_; }
69
70    protected:
71        ~AmbientSound() { }
72
73    private:
74        void preDestroy();
75        void registerVariables();
76        float getRealVolume();
77        void moodChanged(const std::string& mood);
78        inline void ambientSourceChanged()
79            { this->setAmbientSource(this->ambientSource_); }
80        inline void playOnLoadChanged()
81            { this->setPlayOnLoad(this->bPlayOnLoad_); }
82
83        std::string ambientSource_; //!< Analogous to source_, but mood independent
84        bool        bPlayOnLoad_;   //!< Play the sound immediately when loaded
85    };
86}
87
88#endif /* _AmbientSound_H__ */
Note: See TracBrowser for help on using the repository browser.