Changeset 7299 in orxonox.OLD for trunk/src/lib/sound/sound_engine.cc

Timestamp:

Apr 16, 2006, 5:48:40 PM (18 years ago)

Author:

bensch

Message:

orxonox/trunk: some nice Class-Stuff

File:

• trunk/src/lib/sound/sound_engine.cc (modified) (11 diffs)

trunk/src/lib/sound/sound_engine.cc

@@ -36 +36 @@
 //////////////////
 /**
- *  standard constructor
+ * @brief standard constructor
 */
 SoundEngine::SoundEngine ()
@@ -59 +59 @@
 
 /**
- *  the singleton reference to this class
+ * @brief the singleton reference to this class
 */
 SoundEngine* SoundEngine::singletonRef = NULL;
 
 /**
- *  standard deconstructor
+ * @brief standard destructor
  */
 SoundEngine::~SoundEngine ()
@@ -105 +105 @@
 
 /**
- * loads the settings of the SoundEngine from an ini-file
+ * @brief loads the settings of the SoundEngine from an ini-file
  */
 void SoundEngine::loadSettings()
@@ -120 +120 @@
 
 /**
- *  creates a new SoundSource.
+ * @brief creates a new SoundSource.
  * @param fileName The Name to load the SoundBuffer from
  * @param sourceNode The sourceNode to bind this SoundSource to.
@@ -133 +133 @@
 
 /**
- *  Sets the doppler values of openAL
+ * @brief Sets the doppler values of openAL
  * @param dopplerFactor the extent of the doppler-effect
  * @param dopplerVelocity the Speed the sound travels
@@ -147 +147 @@
 
 
+/**
+ * @brief retrieves an OpenAL Source from the availiable Sources.
+ * @param source the Source to fill with the Value.
+ */
 void SoundEngine::popALSource(ALuint& source)
 {
@@ -158 +162 @@
     this->ALSources.pop();
     SDL_mutexV(this->sourceMutex);
-    printf("Retrieve Source %d\n", source);
-  }
-}
-
+  }
+}
+
+
+/**
+ * @brief Pushes an OpenAL Source back into the Stack of known sources
+ * @param source the Source to push onto the top of the SourceStack
+ */
 void SoundEngine::pushALSource(ALuint& source)
 {
@@ -174 +182 @@
 
 /**
- *  updates all The positions, Directions and Velocities of all Sounds
-*/
+ * @brief updates all The positions, Directions and Velocities of all Sounds
+ */
 void SoundEngine::update()
 {
@@ -239 +247 @@
 }
 
-/**
- *  Removes all the Buffers that are not anymore needed by any Sources
-*/
-void SoundEngine::flushUnusedBuffers()
-{
-  /// FIXME
-  /*  if(this->sourceList && this->bufferList)
-    {
-      tIterator<BaseObject>* bufferIterator = this->bufferList->getIterator();
-      SoundBuffer* enumBuffer = (SoundBuffer*)bufferIterator->firstElement();
-      while (enumBuffer)
-      {
-        tIterator<BaseObject>* sourceIterator = this->sourceList->getIterator();
-        SoundSource* enumSource = (SoundSource*)sourceIterator->firstElement();
-        while (enumSource)
-        {
-          if (enumBuffer == enumSource->getBuffer())
-            break;
-          enumSource = (SoundSource*)sourceIterator->nextElement();
-        }
-        delete sourceIterator;
-        if (enumSource == NULL)
-          ResourceManager::getInstance()->unload(enumBuffer);
-        enumBuffer = (SoundBuffer*)bufferIterator->nextElement();
-      }
-      delete bufferIterator;
-  }*/ /// FIXME
-}
-
-/**
- * flushes all the Buffers
- * deletes them from the BufferList, and also removes them via the ResourceManager.
- */
-void SoundEngine::flushAllBuffers()
-{
-  if (this->bufferList)
-  {
-    while (this->bufferList->size() > 0)
-      ResourceManager::getInstance()->unload(static_cast<SoundBuffer*>(this->bufferList->front()), RP_LEVEL);
-  }
-}
-
-/**
- * deletes all the Sources.
- */
-void SoundEngine::flushAllSources()
-{
-  if (this->sourceList)
-  {
-    while(this->sourceList->size() > 0)
-      delete this->sourceList->front();
-  }
-}
 
 /**
@@ -378 +333 @@
 }
 
+/**
+ * @brief checks for an OpenAL error
+ * @param error the ErrorMessage to display
+ * @param line on what line did the error occure.
+ */
 bool SoundEngine::checkError(const std::string& error, unsigned int line)
 {
@@ -390 +350 @@
 }
 
+/**
+ * @brief check for an ALC error.
+ * @brief error the Error-String to display
+ * @param line on that line, the error occured (debugging mode).
+ */
 bool SoundEngine::checkALCError(const std::string& error, unsigned int line)
 {