Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: code/trunk/src/orxonox/sound/WorldAmbientSound.h @ 9015

Last change on this file since 9015 was 7854, checked in by landauf, 14 years ago

detached AmbientSound from BaseObject - AmbientSound can not be placed directly in a level file anymore
instead added WorldAmbientSound, a BaseObject which can be placed in a level file to create and control ambient sound

with this change, the level can be destroyed completely because WorldAmbientSound can be deleted immediately at the end of the level, while the AmbientSound remains active until it faded out.

  • Property svn:eol-style set to native
File size: 1.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 *      Fabian 'x3n' Landau
24 *   Co-authors:
25 *      ...
26 *
27 */
28
29#ifndef _WorldAmbientSound_H__
30#define _WorldAmbientSound_H__
31
32#include "OrxonoxPrereqs.h"
33
34#include "core/BaseObject.h"
35#include "network/synchronisable/Synchronisable.h"
36
37namespace orxonox
38{
39    /**
40        @brief This class is used to play and control ambient sound in a level file. See AmbientSound for the
41        actual implementation of the background music player.
42    */
43    class _OrxonoxExport WorldAmbientSound : public BaseObject, public Synchronisable
44    {
45        public:
46            WorldAmbientSound(BaseObject* creator);
47            virtual ~WorldAmbientSound();
48
49            void XMLPort(Element& xmlelement, XMLPort::Mode mode);
50            void XMLEventPort(Element& xmlelement, XMLPort::Mode mode);
51
52            virtual void changedActivity();
53
54            void play();
55
56        private:
57            void registerVariables();
58
59            AmbientSound* ambientSound_;
60    };
61}
62
63#endif /* _WorldAmbientSound_H__ */
Note: See TracBrowser for help on using the repository browser.