RenderableSource.h

Go to the documentation of this file.

//
// C++ Interface: Audio::RenderableSource
//
#ifndef __AUDIO_RENDERABLESOURCE_H__INCLUDED__
#define __AUDIO_RENDERABLESOURCE_H__INCLUDED__

#include "Exceptions.h"
#include "Types.h"
#include "Format.h"

namespace Audio {

    // Forward declarations
    
    class Source;
    class Listener;
    

    class RenderableSource : public UserData
    {
    private:
        Source *source;
        
    protected:
        RenderableSource(Source *source) throw();
        
    public:
        virtual ~RenderableSource();
        
        enum UpdateFlags {
            UPDATE_ALL          = 0x0F,
            UPDATE_LOCATION     = 0x01,
            UPDATE_ATTRIBUTES   = 0x02,
            UPDATE_EFFECTS      = 0x04,
            UPDATE_GAIN         = 0x08
        };
        
        void startPlaying(Timestamp start = 0) throw(Exception);
        
        void stopPlaying() throw();
        
        bool isPlaying() const throw();
        
        Timestamp getPlayingTime() const throw(Exception);
        
        Source* getSource() const throw() { return source; }
        
        void seek(Timestamp time) throw(Exception);
        
        void update(int flags, const Listener& sceneListener) throw();
        
        // The following section contains all the virtual functions that need be implemented
        // by a concrete Sound class. All are protected, so the interface is independent
        // of implementations.
    protected:
        
        virtual void startPlayingImpl(Timestamp start) throw(Exception) = 0;
        
        virtual void stopPlayingImpl() throw(Exception) = 0;
        
        virtual bool isPlayingImpl() const throw(Exception) = 0;
        
        virtual Timestamp getPlayingTimeImpl() const throw(Exception) = 0;
        
        virtual void updateImpl(int flags, const Listener& sceneListener) throw(Exception) = 0;
        
        virtual void seekImpl(Timestamp time) throw(Exception) = 0;
    };

};

#endif//__AUDIO_RENDERABLESOURCE_H__INCLUDED__