D:/work/nytro/include/audio/nySoundSource.h

Go to the documentation of this file.

#ifndef __NYTRO_SoundSource_H
#define __NYTRO_SoundSource_H

//*****************************************************************************
// Nytro GameEngine
//
// © Copyright 7thFACTOR Entertainment
// All rights reserved
//*****************************************************************************

#include "system/nyCommon.h"
#include "system/nyResource.h"
#include "math/nyMath.h"
#include "scene/nySceneNode.h"

namespace Nytro
{
    namespace Audio
    {
        using namespace Core;
        using namespace Scene;

        class NYTRO_API SoundBufferData : public Resource
        {
            public:

                SoundBufferData();
                virtual ~SoundBufferData();
        };

        class NYTRO_API SoundSource : public SceneNode
        {
            public:

                enum ESoundMode
                {
                    eSoundMode_2D = 0,
                    eSoundMode_3D
                };

                enum ESoundLoopMode
                {
                    eSoundLoop_Off = 0,
                    eSoundLoop_Repeat
                };

                SoundSource();
                virtual ~SoundSource();

                //
                // Actions
                //
                virtual void                playSound();
                virtual void                stopSound();
                virtual void                pauseSound();
                virtual void                resumeSound();
                
                //
                // Setters
                //
                virtual void                setVolume( float32 aValue );
                virtual void                setTime( uint32 aValue );
                virtual void                setFrequency( uint32 aValue );
                virtual void                setPan( float32 aValue );
                virtual void                setLoopMode( ESoundLoopMode aValue );
                virtual void                setPitch( float32 aValue );
                virtual void                setVelocity( const Vector3D& rVel );
                virtual void                setPriority( int32 aValue );
                virtual void                setMinSoundDistance( float32 aValue );
                virtual void                setMaxSoundDistance( float32 aValue );
                virtual void                setSoundMode( ESoundMode aMode );

                //
                // Getters
                //
                virtual float32             getVolume();
                virtual uint32              getTime();
                virtual uint32              getLength();
                virtual uint32              getFrequency();
                virtual void                getOutputLevels( float32& rLeft, float32& rRight );
                virtual float32             getPitch();
                virtual float32             getPan();
                virtual const Vector3D&     getVelocity();
                virtual int32               getPriority();
                virtual bool                isPaused();
                virtual bool                isPlaying();
                virtual float32             getMinSoundDistance();
                virtual float32             getMaxSoundDistance();
                virtual ESoundMode          getSoundMode();
                virtual ESoundLoopMode      getLoopMode();

            protected:
                
                Vector3D                    m_soundVelocity;
                ESoundMode                  m_soundMode;
                ESoundLoopMode              m_soundLoopMode;
                int32                       m_soundPriority;
                float32                     m_minSoundDistance, m_maxSoundDistance;
                float32                     m_volume, m_pitch, m_pan;

        };
    };
};

#endif