handle.h

Go to the documentation of this file.

/*
 * handle.h
 *
 * Copyright (C) 2001-2010 Atomic Blue (info@planeshift.it, http://www.planeshift.it)
 *
 * Credits : Saul Leite <leite@engineer.com>
 *           Mathias 'AgY' Voeroes <agy@operswithoutlife.net>
 *           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_HANDLE_H_
#define _SOUND_HANDLE_H_


//====================================================================================
// Crystal Space Includes
//====================================================================================
#include <crystalspace.h>

//====================================================================================
// Local Includes
//====================================================================================
#include "soundctrl.h"

//------------------------------------------------------------------------------------
// Forward Declarations
//------------------------------------------------------------------------------------
class SoundSystemManager;


enum
{
    FADE_DOWN   =   0,
    FADE_UP     =   1,
    FADE_STOP   =   -1
};

class SoundHandle: public scfImplementation1<SoundHandle, iTimerEvent>, public iSoundControlListener
{
public:
    csString                                name;           
    SoundControl*                           sndCtrl;        

    csRef<iSndSysData>                      snddata;        
    csRef<iSndSysStream>                    sndstream;      
    csRef<iSndSysSource>                    sndsource;      
    csRef<iSndSysSource3D>                  sndsource3d;    
    csRef<iSndSysSource3DDirectionalSimple> sndsourcedir;   

    SoundHandle();                                          
    virtual ~SoundHandle();                                 

    void Fade(float volume, int time, int direction);

    void FadeStep();

    virtual bool Init(const char* resname, bool loop,
              float volume_preset, int type,
              SoundControl* &ctrl, bool dopplerEffect);

    virtual bool Perform(iTimerEvent* /*ev*/);

    void ConvertTo3D(float mindist, float maxdist,
                     csVector3 pos, csVector3 dir,
                     float rad);

    bool Is3D();

    bool IsDopplerEffectEnabled();

    bool IsWithinMaximumDistance(csVector3 listenerPos) const;

    uint GetID() const { return id; }

    void SetID(uint identifier) { id = identifier; }

    csVector3 GetSourcePosition();

    void SetAutoRemove(bool toggle);

    bool GetAutoRemove();

    void UnpauseAfterDelay(unsigned int delay);

    void SetCallback(void (*object), void (*function) (void *));
    void RemoveCallback();

    // From iSoundControlListener
    //----------------------------
    virtual void OnSoundChange(SoundControl* sndCtrl);

protected:
    bool dopplerEffect;                
    float currentVolume;               

private:
    uint id;                           
    int  fadeSteps;                    
    bool fadeStop;                     
    float maxDistance;                 
    bool hasCallback;                  
    void (*callbackobject);            
    void (*callbackfunction) (void *); 

    bool autoremove;                   
    bool delayActive;                  

    void Callback();

};

#endif /*_SOUND_HANDLE_H_*/