Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: code/branches/sound5/src/orxonox/sound/AmbientSound.h @ 6511

Last change on this file since 6511 was 6508, checked in by erwin, 15 years ago

Removed unused function declarations

  • Property svn:eol-style set to native
File size: 2.8 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 <boost/thread.hpp>
34
35#include "sound/SoundPrereqs.h"
36
37#include "core/BaseObject.h"
38#include "network/synchronisable/Synchronisable.h"
39#include "BaseSound.h"
40#include "MoodManager.h"
41
42namespace orxonox
43{
44    /**
45     * The AmbientSound class is the base class for all sound file loader classes.
46     * It server as main interface to the OpenAL library.
47     *
48     */
49    class _OrxonoxExport AmbientSound : public BaseSound, public BaseObject, public Synchronisable, public MoodListener
50    {
51        friend class SoundManager;
52
53    public:
54        AmbientSound(BaseObject* creator);
55
56        void XMLPort(Element& xmlelement, XMLPort::Mode mode);
57        void XMLEventPort(Element& xmlelement, XMLPort::Mode mode);
58        void changedActivity();
59
60        void play();
61        void stop();
62        void pause();
63
64        void setAmbientSource(const std::string& source);
65        inline const std::string& getAmbientSource() const
66            { return this->ambientSource_; }
67
68        void setPlayOnLoad(bool val);
69        bool getPlayOnLoad() const
70            { return this->bPlayOnLoad_; }
71
72    protected:
73        ~AmbientSound() { }
74
75        void doStop();
76
77    private:
78        void preDestroy();
79        void registerVariables();
80        float getRealVolume();
81        void moodChanged(const std::string& mood);
82        inline void ambientSourceChanged()
83            { this->setAmbientSource(this->ambientSource_); }
84        inline void playOnLoadChanged()
85            { this->setPlayOnLoad(this->bPlayOnLoad_); }
86
87        std::string ambientSource_; //!< Analogous to source_, but mood independent
88        bool        bPlayOnLoad_;   //!< Play the sound immediately when loaded
89
90        boost::thread soundstreamthread_; // hacky solution for streaming
91        void setStreamSource(const std::string& source);
92    };
93}
94
95#endif /* _AmbientSound_H__ */
Note: See TracBrowser for help on using the repository browser.