Changeset 4506 in orxonox.OLD for orxonox/trunk/src/lib/sound/sound_engine.h

Timestamp:

Jun 4, 2005, 12:49:24 AM (19 years ago)

Author:

bensch

Message:

orxonox/trunk: building the SoundEngine as a lib

File:

• orxonox/trunk/src/lib/sound/sound_engine.h (modified) (6 diffs)

orxonox/trunk/src/lib/sound/sound_engine.h

@@ -11 +11 @@
 
 
-#define SOUND_DOPPLER_FACTOR     0.001          //!< A factor for the audible doppler effect
-#define SOUND_DOPPLER_VELOCITY   5000000     //!< A factor for the TravelSpeed of sound
+#define SOUND_DOPPLER_FACTOR       0.001          //!< A factor for the audible doppler effect
+#define SOUND_DOPPLER_VELOCITY     5000000        //!< A factor for the TravelSpeed of sound
 
 // FORWARD DEFINITION
@@ -26 +26 @@
   ~SoundBuffer(void);
 
-  /** \returns the ID of the buffer */
+  /** \returns the ID of the buffer used in this SoundBuffer */
   inline ALuint getID(void) { return this->bufferID; }
 
  private:
-  ALuint bufferID;              //!< The address of the Buffer.
+  ALuint        bufferID;             //!< The address of the Buffer.
 
-  ALsizei size;                 //!< The size of the Buffer.
-  ALboolean loop;               //!< loop information.
+  ALsizei       size;                 //!< The size of the Buffer.
+  ALboolean     loop;                 //!< loop information.
 };
 
@@ -42 +42 @@
   SoundSource(SoundBuffer* buffer, PNode* sourceNode = NULL);
   ~SoundSource(void);
-
+  
   // user interaction
   void play();
@@ -48 +48 @@
   void pause();
   void rewind();
-
+  
   // development functions
   /** \returns The ID of this Source */
@@ -60 +60 @@
 
  private:
-  ALuint sourceID;              //!< The ID of the Source
-  SoundBuffer* buffer;          //!< The buffer to play in this source.
-  PNode* sourceNode;            //!< The SourceNode represente the position/velocity... of this source.
+  ALuint           sourceID;              //!< The ID of the Source
+  SoundBuffer*     buffer;                //!< The buffer to play in this source.
+  PNode*           sourceNode;            //!< The SourceNode represente the position/velocity... of this source.
 };
 
@@ -99 +99 @@
  private:
   SoundEngine(void);
-  static SoundEngine* singletonRef;
+  static SoundEngine*      singletonRef;             //!< Reference to this class
 
 
-  PNode* listener;                 //!< The listener of the Scene
-  tList<SoundBuffer>* bufferList;  //!< A list of buffers
-  tList<SoundSource>* sourceList;  //!< A list for all the sources in the scene.
+  PNode*                   listener;                 //!< The listener of the Scene
+  tList<SoundBuffer>*      bufferList;               //!< A list of buffers
+  tList<SoundSource>*      sourceList;               //!< A list for all the sources in the scene.
 
 };