gemrb/core/EffectMgr.h

   1 /* GemRB - Infinity Engine Emulator
   2  * Copyright (C) 2003 The GemRB Project
   3  *
   4  * This program is free software; you can redistribute it and/or
   5  * modify it under the terms of the GNU General Public License
   6  * as published by the Free Software Foundation; either version 2
   7  * of the License, or (at your option) any later version.
   8  *
   9  * This program is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  * GNU General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU General Public License
  15  * along with this program; if not, write to the Free Software
  16  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  17  *
  18  *
  19  */
  20
  21 /**
  22  * @file EffectMgr.h
  23  * Declares EffectMgr class, loader for Effect objects
  24  * @author The GemRB Project
  25  */
  26
  27
  28 #ifndef EFFECTMGR_H
  29 #define EFFECTMGR_H
  30
  31 #include "Effect.h"
  32 #include "Plugin.h"
  33 #include "System/DataStream.h"
  34
  35 /**
  36  * @class EffectMgr
  37  * Abstract loader for Effect objects
  38  */
  39
  40 class GEM_EXPORT EffectMgr : public Plugin {
  41 public:
  42         EffectMgr(void);
  43         virtual ~EffectMgr(void);
  44         virtual bool Open(DataStream* stream, bool autoFree = true) = 0;
  45
  46         /** Fills fx with Effect data loaded from the stream */
  47         virtual Effect* GetEffect(Effect *fx) = 0;
  48         /** Fills fx with Effect v1 data loaded from the stream*/
  49         virtual Effect* GetEffectV1(Effect *fx) = 0;
  50         /** Fills fx with Effect v2.0 data loaded from the stream*/
  51         virtual Effect* GetEffectV20(Effect *fx) = 0;
  52 };
  53
  54 #endif