SourceTemplate.h

Go to the documentation of this file.

//
// C++ Interface: Audio::SourceTemplate
//
#ifndef __AUDIO_SOURCETEMPLATE_H__INCLUDED__
#define __AUDIO_SOURCETEMPLATE_H__INCLUDED__

#include <string>
#include "Exceptions.h"
#include "Types.h"

#include "vsfilesystem.h"


namespace Audio {


    class SourceTemplate
    {
    private:
        std::string soundName;
        VSFileSystem::VSFileType soundType;
        
        Range<Scalar> cosAngleRange;
        
        PerFrequency<Scalar> pfRadiusRatios;
        PerFrequency<Scalar> referenceFreqs;
        
        Scalar gain;
        
        struct {
            int looping : 1;
            int streaming : 1;
            int attenuated : 1;
            int relative : 1;
        } flags;
        
    public:
        SourceTemplate(
            const std::string &soundName, 
            VSFileSystem::VSFileType type = VSFileSystem::UnknownFile, 
            bool looping = false) throw();
        
        ~SourceTemplate();
        
        std::string getSoundName() const throw() { return soundName; }
        
        void setSoundName(const std::string &newName) throw() { soundName = newName; }
        
        VSFileSystem::VSFileType getSoundType() const throw() { return soundType; }
        
        void setSoundType(VSFileSystem::VSFileType type) throw() { soundType = type; }
        
        Range<Scalar> getAngleRange() const throw();
        
        void setAngleRange(Range<Scalar> r) throw();
        
        Range<Scalar> getCosAngleRange() const throw() { return cosAngleRange; }
        
        void setCosAngleRange(Range<Scalar> r) throw() { cosAngleRange = r; }
        
        PerFrequency<Scalar> getPerFrequencyRadiusRatios() const throw() { return pfRadiusRatios; }
        
        void setPerFrequencyRadiusRatios(PerFrequency<Scalar> val) throw() { pfRadiusRatios = val; }
        
        PerFrequency<Scalar> getReferenceFreqs() const throw() { return referenceFreqs; }
        
        void setReferenceFreqs(PerFrequency<Scalar> val) throw() { referenceFreqs = val; }
        
        Scalar getGain() const throw() { return gain; }
        
        void setGain(Scalar g) throw() { gain = g; }
        
        bool isLooping() const throw() { return flags.looping != 0; }
        
        void setLooping(bool loop) throw() { flags.looping = loop ? 1 : 0; }
        
        bool isRelative() const throw() { return flags.relative != 0; }
        
        void setRelative(bool relative) throw() { flags.relative = relative ? 1 : 0; }
        
        bool isAttenuated() const throw() { return flags.attenuated != 0; }
        
        void setAttenuated(bool loop) throw() { flags.attenuated = (loop ? 1 : 0); }
        
        bool isStreaming() const throw() { return flags.streaming != 0; }
        
        void setStreaming(bool stream) throw() { flags.streaming = stream ? 1 : 0; }
        
    };

};

#endif//__AUDIO_SOURCETEMPLATE_H__INCLUDED__