Changeset 4206 in orxonox.OLD for orxonox/branches/openAL/src

Timestamp:

May 17, 2005, 2:30:10 AM (20 years ago)

Author:

bensch

Message:

orxonox/branches/openAL: doxygen-Tags

Location:

orxonox/branches/openAL/src/lib/sound

Files:

• sound_engine.cc (modified) (10 diffs)
• sound_engine.h (modified) (4 diffs)

orxonox/branches/openAL/src/lib/sound/sound_engine.cc

@@ -21 +21 @@
 #include "sound_engine.h"
 
+//#include <AL/alc.h> // maybe later
+
 #include "p_node.h"
 #include "list.h"
-#include "AL/alc.h"
 #include "resource_manager.h"
 using namespace std;
@@ -104 +105 @@
 
 
+/**
+   \brief Plays back a SoundSource
+*/
 void SoundSource::play()
 {
   alSourcePlay(this->sourceID);
 }
+
+/**
+   \brief Stops playback of a SoundSource
+*/
 void SoundSource::stop()
 {
   alSourceStop(this->sourceID);
 }
+
+/**
+   \brief Pauses Playback of a SoundSource
+*/
 void SoundSource::pause()
 {
@@ -117 +129 @@
 }
 
+/**
+   \brief Rewinds Playback of a SoundSource
+*/
+void SoundSource::rewind()
+{
+  alSourceRewind(this->sourceID);
+}
+
+/**
+   \brief sets the RolloffFactor of the Sound emitted from the SoundSource
+   \param rolloffFactor The Factor described
+
+   this tells openAL how fast the Sounds decay outward from the Source
+*/
 void SoundSource::setRolloffFactor(ALfloat rolloffFactor)
 {
@@ -187 +213 @@
    \brief creates a new SoundSource.
    \param fileName The Name to load the SoundBuffer from
-   \param The sourceNode to bind this SoundSource to.
+   \param sourceNode The sourceNode to bind this SoundSource to.
    \returns The newly created SoundSource
 
@@ -206 +232 @@
 }
 
-
+/**
+   \brief adds a SoundBuffer to the bufferList of the SoundEngine
+   \param buffer The buffer to add to the bufferList
+*/
 void SoundEngine::addBuffer(SoundBuffer* buffer)
 {
@@ -212 +241 @@
 }
 
+/**
+   \brief removes a SoundBuffer from the bufferList of the SoundEngine
+   \param buffer The buffer to delete from the SoundEngine
+*/
 void SoundEngine::removeBuffer(SoundBuffer* buffer)
 {
@@ -217 +250 @@
 }
 
+/**
+   \brief adds a SoundSource to the sourceList of the SoundEngine
+   \param source The source to add to the sourceList
+*/
 void SoundEngine::addSource(SoundSource* source)
 {
   this->sourceList->add(source);
 }
+
+/**
+   \brief removes a SoundSource from the sourceList of the SoundEngine
+   \param source The source to delete from the SoundEngine
+*/
 void SoundEngine::removeSource(SoundSource* source)
 {
@@ -284 +326 @@
 }
 
+/**
+   \brief Transforms AL-errors into something readable
+   \param err The error found
+*/
 void SoundEngine::PrintALErrorString(ALenum err)
 {
@@ -314 +360 @@
 }
 
-
+/*
 void SoundEngine::PrintALCErrorString(ALenum err)
 {
@@ -344 +390 @@
     };
 }
+*/

orxonox/branches/openAL/src/lib/sound/sound_engine.h

@@ -12 +12 @@
 
 
-#define SOUND_DOPPLER_FACTOR     0.01
-#define SOUND_DOPPLER_VELOCITY   500000000
+#define SOUND_DOPPLER_FACTOR     0.01          //!< A factor for the audible doppler effect
+#define SOUND_DOPPLER_VELOCITY   500000000     //!< A factor for the TravelSpeed of sound
 
 // FORWARD DEFINITION
@@ -27 +27 @@
   ~SoundBuffer(void);
 
+  /** \returns the ID of the buffer */
   inline ALuint getID(void) { return this->bufferID; }
 
@@ -47 +48 @@
   void stop();
   void pause();
+  void rewind();
 
   // development functions
-  /** \retruns The ID of the Source */
+  /** \returns The ID of the Source */
   inline ALuint getID(void) { return this->sourceID; }
   /** \returns the SourceNode of this Source */
@@ -86 +88 @@
   // error handling:
   static void PrintALErrorString(ALenum err);
-  static void PrintALCErrorString(ALenum err);
+  //  static void PrintALCErrorString(ALenum err);
 
  private: