soundctrl.h

Go to the documentation of this file.

/*
* soundctrl.h
*
* Copyright (C) 2001-2010 Atomic Blue ([email protected], http://www.planeshift.it)
*
* Credits : Saul Leite <[email protected]>
*           Mathias 'AgY' Voeroes <[email protected]>
*           and all past and present planeshift coders
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
* as published by the Free Software Foundation (version 2 of the License.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
* GNU General Public License for more details.
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
*
*/


#ifndef _SOUND_CONTROL_H_
#define _SOUND_CONTROL_H_


//====================================================================================
// Crystal Space Includes
//====================================================================================
#include <cssysdef.h>
#include <csutil/set.h>

//====================================================================================
// Project Includes
//====================================================================================
#include <isoundctrl.h>

//------------------------------------------------------------------------------------
// Forward Declarations
//------------------------------------------------------------------------------------
class SoundControl;


struct iSoundControlListener
{
    virtual void OnSoundChange(SoundControl* sndCtrl) = 0;
};


class SoundControl: public iSoundControl
{
public:

    SoundControl(int ID);

    virtual ~SoundControl();

    void Subscribe(iSoundControlListener* listener);

    void Unsubscribe(iSoundControlListener* listener);

    virtual int GetID() const;

    virtual void VolumeDampening(float damp);

    virtual bool IsDampened() const;

    virtual float GetVolume() const;

    virtual void SetVolume(float vol);

    virtual void Unmute();

    virtual void Mute();

    virtual bool GetToggle() const;

    virtual void SetToggle(bool value);

    virtual void DeactivateToggle();

    virtual void ActivateToggle(); 

private:
    int     id;                         
    bool    isEnabled;                  
    bool    isMuted;                    
    bool    isDampened;                 
    float   volume;                     
    float   volumeDamp;                         

    csSet<iSoundControlListener*> listeners;   

    void CallListeners();

};

#endif /*_SOUND_CONTROL_H_*/