SoundSource.hpp

//
// SFML - Simple and Fast Multimedia Library
// Copyright (C) 2007-2009 Laurent Gomila (laurent.gom@gmail.com)
//
// This software is provided 'as-is', without any express or implied warranty.
// In no event will the authors be held liable for any damages arising from the use of this software.
//
// Permission is granted to anyone to use this software for any purpose,
// including commercial applications, and to alter it and redistribute it freely,
// subject to the following restrictions:
//
// 1. The origin of this software must not be misrepresented;
//    you must not claim that you wrote the original software.
//    If you use this software in a product, an acknowledgment
//    in the product documentation would be appreciated but is not required.
//
// 2. Altered source versions must be plainly marked as such,
//    and must not be misrepresented as being the original software.
//
// 3. This notice may not be removed or altered from any source distribution.
//

#ifndef SFML_SOUNDSOURCE_HPP
#define SFML_SOUNDSOURCE_HPP

// Headers
#include <SFML/Config.hpp>
#include <SFML/System/Vector3.hpp>


namespace sf
{
class SFML_API SoundSource
{
public :

    enum Status
    {
        Stopped, 
        Paused,  
        Playing  
    };

    SoundSource(const SoundSource& copy);

    virtual ~SoundSource();

    void SetPitch(float pitch);

    void SetVolume(float volume);

    void SetPosition(float x, float y, float z);

    void SetPosition(const Vector3f& position);

    void SetRelativeToListener(bool relative);

    void SetMinDistance(float distance);

    void SetAttenuation(float attenuation);

    float GetPitch() const;

    float GetVolume() const;

    Vector3f GetPosition() const;

    bool IsRelativeToListener() const;

    float GetMinDistance() const;

    float GetAttenuation() const;

protected :

    SoundSource();

    Status GetStatus() const;

    // Member data
    unsigned int mySource; 
};

} // namespace sf


#endif // SFML_SOUNDSOURCE_HPP

 ::  Copyright © 2007-2008 Laurent Gomila, all rights reserved  ::  Documentation generated by doxygen 1.5.2  ::