[Orxonox-commit 2051] r6767 - in code/branches/sound5/src/orxonox: . sound weaponsystem

[youngk at orxonox.net]

Author: youngk
Date: 2010-04-20 20:31:12 +0200 (Tue, 20 Apr 2010)
New Revision: 6767

Modified:
   code/branches/sound5/src/orxonox/MoodManager.h
   code/branches/sound5/src/orxonox/sound/AmbientSound.cc
   code/branches/sound5/src/orxonox/sound/AmbientSound.h
   code/branches/sound5/src/orxonox/sound/SoundManager.cc
   code/branches/sound5/src/orxonox/sound/SoundManager.h
   code/branches/sound5/src/orxonox/weaponsystem/WeaponMode.cc
   code/branches/sound5/src/orxonox/weaponsystem/WeaponMode.h
Log:
Added descriptions and missing documentation to the classes I edited last semester. Thanks!

Modified: code/branches/sound5/src/orxonox/MoodManager.h
===================================================================
--- code/branches/sound5/src/orxonox/MoodManager.h	2010-04-20 16:20:27 UTC (rev 6766)
+++ code/branches/sound5/src/orxonox/MoodManager.h	2010-04-20 18:31:12 UTC (rev 6767)
@@ -37,6 +37,13 @@
 
 namespace orxonox
 {
+    /**
+     * The MoodManager class enables the game to set different themes, i.e. audio themes, each
+     * with a set of different audio files. A theme (called mood) is set by the server and applies to
+     * all clients. Existing moods are currently hard-coded in function checkMoodValidity(). Each mood
+     * needs to have a folder with its name in "data_extern/audo/ambient/" containing sound files named like
+     * the ones in mood "default".
+     */
     class _OrxonoxExport MoodListener : virtual public OrxonoxClass
     {
         friend class MoodManager;

Modified: code/branches/sound5/src/orxonox/sound/AmbientSound.cc
===================================================================
--- code/branches/sound5/src/orxonox/sound/AmbientSound.cc	2010-04-20 16:20:27 UTC (rev 6766)
+++ code/branches/sound5/src/orxonox/sound/AmbientSound.cc	2010-04-20 18:31:12 UTC (rev 6767)
@@ -22,7 +22,7 @@
  *   Author:
  *      Reto Grieder
  *   Co-authors:
- *      ...
+ *      Kevin Young
  *
  */
 

Modified: code/branches/sound5/src/orxonox/sound/AmbientSound.h
===================================================================
--- code/branches/sound5/src/orxonox/sound/AmbientSound.h	2010-04-20 16:20:27 UTC (rev 6766)
+++ code/branches/sound5/src/orxonox/sound/AmbientSound.h	2010-04-20 18:31:12 UTC (rev 6767)
@@ -21,9 +21,9 @@
  *
  *   Author:
  *      Reto Grieder
+ *      
+ *   Co-authors:
  *      Kevin Young
- *   Co-authors:
- *      ...
  *
  */
 
@@ -42,8 +42,10 @@
 namespace orxonox
 {
     /**
-     * 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 implements the non-3D sound, i.e. sound files that are used for atmospheric
+     * highlighting.
+     * It interfaces with BaseSound and is controllable by MoodManager.
+     * Ambient sounds are always cross-faded. New sounds are registered and activated/deactivated as needed.
      *
      */
     class _OrxonoxExport AmbientSound : public BaseSound, public BaseObject, public Synchronisable, public MoodListener

Modified: code/branches/sound5/src/orxonox/sound/SoundManager.cc
===================================================================
--- code/branches/sound5/src/orxonox/sound/SoundManager.cc	2010-04-20 16:20:27 UTC (rev 6766)
+++ code/branches/sound5/src/orxonox/sound/SoundManager.cc	2010-04-20 18:31:12 UTC (rev 6767)
@@ -21,10 +21,10 @@
  *
  *   Author:
  *       Erwin 'vaiursch' Herrsche
+ *       
+ *   Co-authors:
  *       Kevin Young
  *       Reto Grieder
- *   Co-authors:
- *      ...
  *
  */
 

Modified: code/branches/sound5/src/orxonox/sound/SoundManager.h
===================================================================
--- code/branches/sound5/src/orxonox/sound/SoundManager.h	2010-04-20 16:20:27 UTC (rev 6766)
+++ code/branches/sound5/src/orxonox/sound/SoundManager.h	2010-04-20 18:31:12 UTC (rev 6767)
@@ -21,10 +21,10 @@
  *
  *   Author:
  *       Erwin 'vaiursch' Herrsche
+ *       
+ *   Co-authors:
  *       Kevin Young
  *       Reto Grieder
- *   Co-authors:
- *      ...
  */
 
 #ifndef _SoundManager_H__

Modified: code/branches/sound5/src/orxonox/weaponsystem/WeaponMode.cc
===================================================================
--- code/branches/sound5/src/orxonox/weaponsystem/WeaponMode.cc	2010-04-20 16:20:27 UTC (rev 6766)
+++ code/branches/sound5/src/orxonox/weaponsystem/WeaponMode.cc	2010-04-20 18:31:12 UTC (rev 6767)
@@ -23,7 +23,7 @@
  *      Martin Polak
  *      Fabian 'x3n' Landau
  *   Co-authors:
- *      ...
+ *      Kevin Young
  *
  */
 

Modified: code/branches/sound5/src/orxonox/weaponsystem/WeaponMode.h
===================================================================
--- code/branches/sound5/src/orxonox/weaponsystem/WeaponMode.h	2010-04-20 16:20:27 UTC (rev 6766)
+++ code/branches/sound5/src/orxonox/weaponsystem/WeaponMode.h	2010-04-20 18:31:12 UTC (rev 6767)
@@ -23,7 +23,7 @@
  *      Martin Polak
  *      Fabian 'x3n' Landau
  *   Co-authors:
- *      ...
+ *      Kevin Young
  *
  */
 
@@ -40,6 +40,11 @@
 
 namespace orxonox
 {
+    /**
+     * The WeaponMode class enables the developer, amongst other things, to attach a sound file
+     * to the firing event of a weapon. The default firing sound is chosen by each weapon (ex.
+     * HsW01), hard-coded for now.
+     */
     class _OrxonoxExport WeaponMode : public BaseObject
     {
         public: