Changeset 7854 for code/trunk/src

Timestamp:

Feb 11, 2011, 1:03:47 PM (14 years ago)

Author:

landauf

Message:

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.

Location:

code/trunk/src/orxonox

Files:

• OrxonoxPrereqs.h (modified) (1 diff)
• gamestates/GSLevel.cc (modified) (1 diff)
• gamestates/GSMainMenu.cc (modified) (1 diff)
• sound/AmbientSound.cc (modified) (3 diffs)
• sound/AmbientSound.h (modified) (3 diffs)
• sound/BaseSound.h (modified) (1 diff)
• sound/CMakeLists.txt (modified) (1 diff)
• sound/WorldAmbientSound.cc (added)
• sound/WorldAmbientSound.h (added)
• sound/WorldSound.h (modified) (1 diff)

code/trunk/src/orxonox/OrxonoxPrereqs.h

@@ -151 +151 @@
     class SoundStreamer;
     class WorldSound;
+    class WorldAmbientSound;
 
     // weaponsystem

code/trunk/src/orxonox/gamestates/GSLevel.cc

@@ -154 +154 @@
             if (find == this->staticObjects_.end())
             {
-                COUT(3) << ++i << ": " << it->getIdentifier()->getName() << " (" << *it << ')' << std::endl;
+                COUT(3) << ++i << ": " << it->getIdentifier()->getName() << " (" << *it << "), references: " << it->getReferenceCount() << std::endl;
             }
         }

code/trunk/src/orxonox/gamestates/GSMainMenu.cc

@@ -77 +77 @@
         {
             // Load sound
-            this->ambient_ = new AmbientSound(0);
-            this->ambient_->setSyncMode(0x0);
+            this->ambient_ = new AmbientSound();
         }
     }

code/trunk/src/orxonox/sound/AmbientSound.cc

@@ -29 +29 @@
 #include "AmbientSound.h"
 
-#include "core/CoreIncludes.h"
-#include "core/EventIncludes.h"
 #include "core/GameMode.h"
 #include "core/Resource.h"
-#include "core/XMLPort.h"
 #include "SoundManager.h"
 
 namespace orxonox
 {
-    CreateFactory(AmbientSound);
-
-    AmbientSound::AmbientSound(BaseObject* creator)
-        : BaseObject(creator)
-        , Synchronisable(creator)
-        , bPlayOnLoad_(false)
+    AmbientSound::AmbientSound()
+        : bPlayOnLoad_(false)
     {
-        RegisterObject(AmbientSound);
-
         // Ambient sounds always fade in
         this->setVolume(0);
-        this->registerVariables();
     }
 
@@ -59 +49 @@
             SoundManager::getInstance().unregisterAmbientSound(this);
         }
-    }
-
-    void AmbientSound::registerVariables()
-    {
-        registerVariable(ambientSource_, ObjectDirection::ToClient, new NetworkCallback<AmbientSound>(this, &AmbientSound::ambientSourceChanged));
-        registerVariable(bLooping_,      ObjectDirection::ToClient, new NetworkCallback<AmbientSound>(this, &AmbientSound::loopingChanged));
-        registerVariable(pitch_,         ObjectDirection::ToClient, new NetworkCallback<AmbientSound>(this, &AmbientSound::pitchChanged));
-        registerVariable(bPlayOnLoad_,   ObjectDirection::ToClient, new NetworkCallback<AmbientSound>(this, &AmbientSound::playOnLoadChanged));
-    }
-
-    void AmbientSound::XMLPort(Element& xmlelement, XMLPort::Mode mode)
-    {
-        SUPER(AmbientSound, XMLPort, xmlelement, mode);
-        BaseSound::XMLPortExtern(xmlelement, mode);
-        XMLPortParam(AmbientSound, "ambientSource", setAmbientSource, getAmbientSource, xmlelement, mode);
-        XMLPortParam(AmbientSound, "playOnLoad", setPlayOnLoad, getPlayOnLoad, xmlelement, mode);
-    }
-
-    void AmbientSound::XMLEventPort(Element& xmlelement, XMLPort::Mode mode)
-    {
-        SUPER(AmbientSound, XMLEventPort, xmlelement, mode);
-        XMLPortEventState(AmbientSound, BaseObject, "play", play, xmlelement, mode);
     }
 
@@ -132 +100 @@
             this->play();
     }
-
-    void AmbientSound::changedActivity()
-    {
-        SUPER(AmbientSound, changedActivity);
-        if (this->isActive())
-            this->play();
-        else
-            this->stop();
-    }
 }

code/trunk/src/orxonox/sound/AmbientSound.h

@@ -33 +33 @@
 #include "OrxonoxPrereqs.h"
 
-#include "core/BaseObject.h"
-#include "network/synchronisable/Synchronisable.h"
 #include "BaseSound.h"
 #include "MoodManager.h"
@@ -41 +39 @@
 {
     /**
-     * The AmbientSound class is the base class for all sound file loader classes.
-     * It server as main interface to the OpenAL library.
-     *
+     * The AmbientSound class is used to play background music. It can not be placed
+     * directly in a level file, use WorldAmbientSound instead.
      */
-    class _OrxonoxExport AmbientSound : public BaseSound, public BaseObject, public Synchronisable, public MoodListener
+    class _OrxonoxExport AmbientSound : public BaseSound, public MoodListener
     {
         friend class SoundManager;
+        friend class WorldAmbientSound;
 
     public:
-        AmbientSound(BaseObject* creator);
-
-        void XMLPort(Element& xmlelement, XMLPort::Mode mode);
-        void XMLEventPort(Element& xmlelement, XMLPort::Mode mode);
-        void changedActivity();
+        AmbientSound();
 
         void play();
@@ -73 +67 @@
     private:
         void preDestroy();
-        void registerVariables();
         float getRealVolume();
         void moodChanged(const std::string& mood);

code/trunk/src/orxonox/sound/BaseSound.h

@@ -41 +41 @@
     /**
      * The BaseSound class is the base class for all sound file loader classes.
-     * It server as main interface to the OpenAL library.
-     *
+     * It serves as main interface to the OpenAL library.
      */
     class _OrxonoxExport BaseSound : virtual public OrxonoxClass

code/trunk/src/orxonox/sound/CMakeLists.txt

@@ -1 +1 @@
 ADD_SOURCE_FILES(ORXONOX_SRC_FILES
-    AmbientSound.cc
-    BaseSound.cc
-    SoundBuffer.cc
-    SoundManager.cc
-    WorldSound.cc
-    SoundStreamer.cc
+  AmbientSound.cc
+  BaseSound.cc
+  SoundBuffer.cc
+  SoundManager.cc
+  SoundStreamer.cc
+  WorldAmbientSound.cc
+  WorldSound.cc
 )
 

code/trunk/src/orxonox/sound/WorldSound.h

@@ -38 +38 @@
 namespace orxonox
 {
-    /*
+    /**
     @brief
         The WorldSound class is to be used for sounds with position and orientation.