E:/Programming/MyProject/K_Game_hg/GameEngine/include/sound/Sound.h

Go to the documentation of this file.

// Copyright 2006-2011 by Kat'Oun

#ifndef _SOUND_H_
#define _SOUND_H_

#include <EngineConfig.h>
#include <core/Types.h>
#include <scene/Node.h>
#include <resource/ResourceEventReceiver.h>

namespace core
{
class vector3d;
}

namespace resource
{
        struct ResourceEvent;
}

namespace sound
{

class SoundData;
class SoundProperties;

class ENGINE_PUBLIC_EXPORT Sound: public scene::Node, public resource::ResourceEventReceiver
{
public:

        Sound(SoundData* soundData);
        Sound(const std::string& name, SoundData* soundData);

        virtual ~Sound();

        void setSoundData(const std::string& filename);
        void setSoundData(SoundData* soundData);

        SoundData* getSoundData() const;

        virtual void play();

        virtual void pause();

        virtual void stop();

        virtual bool isPlaying() const;

        virtual bool isPaused() const;

        virtual bool isStopped() const;

        void setVelocity(f32 x, f32 y, f32 z);
        void setVelocity(const core::vector3d& vec);
        const core::vector3d& getVelocity() const;

        const core::vector3d getDirection() const;

        virtual void setPitch(f32 pitch);
        f32 getPitch() const;

        virtual void setGain(f32 gain);
        f32 getGain() const;

        void setDistanceValues(f32 minDistance, f32 maxDistance);
        virtual void setMinDistance(f32 minDistance);
        virtual void setMaxDistance(f32 maxDistance);
        
        f32 getMinDistance() const;
        f32 getMaxDistance() const;

        void setConeSettings(f32 innerConeAngle, f32 outerConeAngle, f32 outerConeGain);
        
        virtual void setInnerConeAngle(f32 innerConeAngle);
        f32 getInnerConeAngle() const;
        
        virtual void setOuterConeAngle(f32 outerConeAngle);
        f32 getOuterConeAngle() const;

        virtual void setOuterConeGain(f32 outerConeGain);
        f32 getOuterConeGain() const;

        virtual void setLoop(bool loop);
        bool isLooping() const;

        void resourceLoaded(const resource::ResourceEvent& evt);
        void resourceUnloaded(const resource::ResourceEvent& evt);

protected:

        // Incremented count for next index
        static u32 msNextGeneratedSoundIndex;

        void initProperties();

        SoundData* mSoundData;

        core::vector3d mVelocity;

        f32 mPitch;
        f32 mGain;
        f32 mMinDistance;
        f32 mMaxDistance;
        f32 mInnerConeAngle;
        f32 mOuterConeAngle;
        f32 mOuterConeGain;

        bool mLoop;
};

} // end namespace sound

#endif