particle_manager.h

Go to the documentation of this file.

//            Copyright (C) 2004-2007 by The Allacrost Project
//                         All Rights Reserved
//
// This code is licensed under the GNU GPL version 2. It is free software 
// and you may modify it and/or redistribute it under the terms of this license.
// See http://www.gnu.org/copyleft/gpl.html for details.

/*!****************************************************************************
 * \file    particle_manager.h
 * \author  Raj Sharma, roos@allacrost.org
 * \brief   Header file for particle manager
 *
 * The particle manager is very simple. Every time you want to draw an effect,
 * you call AddEffect() with a pointer to the effect definition structure.
 * Then every frame, call Update() and Draw() to draw all the effects.
 *****************************************************************************/

#ifndef __PARTICLE_MANAGER_HEADER__
#define __PARTICLE_MANAGER_HEADER__

#include "defs.h"
#include "utils.h"

typedef int32 ParticleEffectID;

const ParticleEffectID VIDEO_INVALID_EFFECT = -1;

namespace hoa_video
{

namespace private_video
{

#include "utils.h"


/*!***************************************************************************
 *  \brief ParticleManager, used internally by video engine to store/update/draw 
 *         all particle effects.
 *****************************************************************************/

class ParticleManager
{
public:
  
  ParticleManager()  { _current_id = 0; }

  ParticleEffectDef *LoadEffect(const std::string &filename);

  
  ParticleEffectID AddEffect(const ParticleEffectDef *def, float x, float y); 


  bool Draw();


  bool Update(int32 frame_time);


  void StopAll(bool kill_immediate = false);
  
  
  ParticleEffect *GetEffect(ParticleEffectID id);


  int32 GetNumParticles();
  
  
  void Destroy();

private:

  ParticleEffect *_CreateEffect(const ParticleEffectDef *def);

  std::map<ParticleEffectID, ParticleEffect *> _effects;
  
  int32 _current_id;
  
  int32 _num_particles;
};

}  // namespace private_video
}  // namespace hoa_video

#endif // !__PARTICLE_MANAGER_HEADER

---