Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: orxonox.OLD/trunk/src/lib/sound/sound_source.h @ 8112

Last change on this file since 8112 was 7810, checked in by bensch, 19 years ago

orxonox/trunk: merged the Weather effects back here

File size: 2.2 KB
Line 
1/*!
2 * @file sound_source.h
3 * @brief Definition of the SoundSource.
4*/
5
6#ifndef _SOUND_SOURCE_H
7#define _SOUND_SOURCE_H
8
9#include "base_object.h"
10#include "alincl.h"
11
12// FORWARD DECLARATION
13class PNode;
14namespace OrxSound
15{
16  class SoundBuffer;
17  //! A class that represents a SoundSource
18  class SoundSource : public BaseObject
19  {
20  public:
21    SoundSource(const PNode* sourceNode = NULL, const SoundBuffer* buffer = NULL);
22    SoundSource(const SoundSource& source);
23    SoundSource& operator=(const SoundSource& source);
24    bool operator==(const SoundSource& source);
25
26    virtual ~SoundSource();
27
28    // user interaction
29    void play();
30    void play(const SoundBuffer* buffer);
31    void loop();
32    void loop(const SoundBuffer* buffer);
33    void stop();
34    void pause();
35    void rewind();
36
37    // development functions
38    /** @returns The ID of this Source */
39    inline ALuint getID() const { return this->sourceID; };
40    /** @returns true, if the Source is Playing */
41    inline bool   isPlaying() const { return this->bPlay; };
42    void setSourceNode(const PNode* sourceNode);
43    /** @returns the SoundBuffer of this Source */
44    inline const SoundBuffer* getBuffer() const { return this->buffer; };
45    /** @returns the SourceNode of this Source */
46    inline const PNode* getNode() const { return this->sourceNode; };
47    /** @param resident if the Source is Resident */
48    inline void setResident(bool resident) { this->resident = resident; };
49    /** @returns true if the alSource is Resident */
50    inline bool isResident() const { return this->resident; };
51
52    void setRolloffFactor(ALfloat rolloffFactor);
53
54    static void resetSource(ALuint sourceID);
55
56  private:
57    bool retrieveSource();
58
59  private:
60    bool                   bPlay;                 //!< If the Source is Playing.
61    bool                   resident;              //!< If the alSource should be resident (if true, the alSource will be returned on deletion).
62    ALuint                 sourceID;              //!< The ID of the Source
63    const SoundBuffer*     buffer;                //!< The buffer to play in this source.
64    const PNode*           sourceNode;            //!< The SourceNode representing the position/velocity... of this source.
65  };
66}
67#endif /* _SOUND_SOURCE_H */
Note: See TracBrowser for help on using the repository browser.