Sound.hpp

00001 
00002 //
00003 // SFML - Simple and Fast Multimedia Library
00004 // Copyright (C) 2007-2008 Laurent Gomila (laurent.gom@gmail.com)
00005 //
00006 // This software is provided 'as-is', without any express or implied warranty.
00007 // In no event will the authors be held liable for any damages arising from the use of this software.
00008 //
00009 // Permission is granted to anyone to use this software for any purpose,
00010 // including commercial applications, and to alter it and redistribute it freely,
00011 // subject to the following restrictions:
00012 //
00013 // 1. The origin of this software must not be misrepresented;
00014 //    you must not claim that you wrote the original software.
00015 //    If you use this software in a product, an acknowledgment
00016 //    in the product documentation would be appreciated but is not required.
00017 //
00018 // 2. Altered source versions must be plainly marked as such,
00019 //    and must not be misrepresented as being the original software.
00020 //
00021 // 3. This notice may not be removed or altered from any source distribution.
00022 //
00024 
00025 #ifndef SFML_SOUND_HPP
00026 #define SFML_SOUND_HPP
00027 
00029 // Headers
00031 #include <cstdlib>
00032 #include <SFML/Audio/AudioResource.hpp>
00033 #include <SFML/System/Vector3.hpp>
00034 
00035 
00036 namespace sf
00037 {
00038 class SoundBuffer;
00039 
00044 class SFML_API Sound : public AudioResource
00045 {
00046 public :
00047 
00051     enum Status
00052     {
00053         Stopped, 
00054         Paused,  
00055         Playing  
00056     };
00057 
00062     Sound();
00063 
00074     Sound(const SoundBuffer& Buffer, bool Loop = false, float Pitch = 1.f, float Volume = 100.f, const Vector3f& Position = Vector3f(0, 0, 0));
00075 
00082     Sound(const Sound& Copy);
00083 
00088     ~Sound();
00089 
00094     void Play();
00095 
00100     void Pause();
00101 
00106     void Stop();
00107 
00114     void SetBuffer(const SoundBuffer& Buffer);
00115 
00123     void SetLoop(bool Loop);
00124 
00132     void SetPitch(float Pitch);
00133 
00141     void SetVolume(float Volume);
00142 
00150     void SetPosition(float X, float Y, float Z);
00151 
00159     void SetPosition(const Vector3f& Position);
00160 
00169     void SetMinDistance(float MinDistance);
00170 
00179     void SetAttenuation(float Attenuation);
00180 
00187     const SoundBuffer* GetBuffer() const;
00188 
00195     bool GetLoop() const;
00196 
00203     float GetPitch() const;
00204 
00211     float GetVolume() const;
00212 
00219     Vector3f GetPosition() const;
00220 
00227     float GetMinDistance() const;
00228 
00235     float GetAttenuation() const;
00236 
00243     Status GetStatus() const;
00244 
00251     float GetPlayingOffset() const;
00252 
00261     Sound& operator =(const Sound& Other);
00262 
00263 private :
00264 
00265     friend class SoundStream;
00266 
00268     // Member data
00270     unsigned int       mySource; 
00271     const SoundBuffer* myBuffer; 
00272 };
00273 
00274 } // namespace sf
00275 
00276 
00277 #endif // SFML_SOUND_HPP