Changeset 6767 for code/branches/sound5/src/orxonox/sound/AmbientSound.h

Timestamp:

Apr 20, 2010, 8:31:12 PM (15 years ago)

Author:

youngk

Message:

Added descriptions and missing documentation to the classes I edited last semester. Thanks!

File:

• code/branches/sound5/src/orxonox/sound/AmbientSound.h (modified) (2 diffs)

code/branches/sound5/src/orxonox/sound/AmbientSound.h

@@ -22 +22 @@
  *   Author:
  *      Reto Grieder
+ *      
+ *   Co-authors:
  *      Kevin Young
- *   Co-authors:
- *      ...
  *
  */
@@ -43 +43 @@
 {
     /**
-     * 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.
      *
      */