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_

#include <isndsys.h>
#include <csutil/csstring.h>

class SoundControl;
class SoundSystemManager;

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

class SoundHandle
{
    public:
    csString                                name;           
    SoundControl                           *sndCtrl;        
    float                                   preset_volume;  
    int                                     fade;           
    float                                   fade_volume;    
    bool                                    fade_stop;      
    bool                                    autoremove;     

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

    SoundHandle (SoundSystemManager*);                      
    ~SoundHandle ();                                        

    void Fade (float volume, int time, int direction);
    bool Init (const char *resname, bool loop,
               float volume_preset, int type,
               SoundControl* &ctrl);

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

    void SetAutoRemove (bool toggle);
    bool GetAutoRemove ();

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

    private:
    SoundSystemManager* manager;
    bool hasCallback;                  
    void (*callbackobject);            
    void (*callbackfunction) (void *); 

    void Callback ();

};

#endif /*_SOUND_HANDLE_H_*/