Changeset 5386 in orxonox.OLD for trunk/src/lib/sound/sound_source.h

Timestamp:

Oct 15, 2005, 11:44:14 PM (19 years ago)

Author:

bensch

Message:

orxonox/trunk: split open the soundengine into
sound_engine: the Handler
sound_source: the sources
sound_buffers: playback-buffers

File:

• trunk/src/lib/sound/sound_source.h (copied) (copied from trunk/src/proto/proto_class.h) (1 diff)

trunk/src/lib/sound/sound_source.h

@@ -1 +1 @@
 /*!
- * @file proto_class.h
- * @brief Definition of ...
+ * @file sound_source.h
+ * @brief Definition of the SoundSource.
 */
 
-#ifndef _PROTO_CLASS_H
-#define _PROTO_CLASS_H
+#ifndef _SOUND_SOURCE_H
+#define _SOUND_SOURCE_H
 
 #include "base_object.h"
+#include "alincl.h"
 
 // FORWARD DECLARATION
+class SoundBuffer;
+class PNode;
 
+//! A class that represents a SoundSource
+class SoundSource : public BaseObject
+{
+  public:
+    SoundSource(const PNode* sourceNode = NULL, const SoundBuffer* buffer = NULL);
+    ~SoundSource();
 
+  // user interaction
+    void play();
+    void play(const SoundBuffer* buffer);
+    void stop();
+    void pause();
+    void rewind();
 
-//! A class for ...
-class ProtoClass : public BaseObject {
+  // development functions
+    /** @returns The ID of this Source */
+    inline ALuint getID() const { return this->sourceID; }
+    /** @returns the SoundBuffer of this Source */
+    inline const SoundBuffer* getBuffer() const { return this->buffer; }
+    /** @returns the SourceNode of this Source */
+    inline const PNode* getNode() const { return this->sourceNode;}
 
- public:
-  ProtoClass();
-  virtual ~ProtoClass();
+    void setRolloffFactor(ALfloat rolloffFactor);
 
-
- private:
-
+  private:
+    ALuint                 sourceID;              //!< The ID of the Source
+    const SoundBuffer*     buffer;                //!< The buffer to play in this source.
+    const PNode*           sourceNode;            //!< The SourceNode represente the position/velocity... of this source.
 };
-
-#endif /* _PROTO_CLASS_H */
+#endif /* _SOUND_SOURCE_H */