particle_effect.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_effect.h
 * \author  Raj Sharma, roos@allacrost.org
 * \brief   Header file for particle effects
 *
 * Particle effects are basically nothing more than a collection of particle
 * systems. Many effects are just one system. However, for example, if you think
 * about a campfire effect, that might actually consist of fire + smoke + embers.
 * So, that's an example of an effect that consists of 3 systems.
 *
 * This file contains two classes: ParticleEffectDef, and ParticleEffect.
 *
 * ParticleEffectDef is a "definition" class, which holds a list of
 *    ParticleSystemDefs.
 *
 * ParticleEffect is an "instance" class, which holds a list of
 *    ParticleSystems.
 *
 *
 * This way, if you have 100 explosions, the properties of the
 * effect are stored only once in a ParticleEffectDef, and the only thing that 
 * gets repeated 100 times is the ParticleEffect, which holds instance-specific stuff.
 *****************************************************************************/

#ifndef __PARTICLE_EFFECT_HEADER__
#define __PARTICLE_EFFECT_HEADER__

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

namespace hoa_video
{

using private_video::ParticleSystem;
using private_video::ParticleSystemDef;

/*!***************************************************************************
 *  \brief particle effect definition, just consists of each of its subsystems'
 *         definitions. This is basically just a struct, except it has a
 *         function to load the structure from a particle file (.lua/.hoa)
 *****************************************************************************/

class ParticleEffectDef
{
public:
  
  std::list<ParticleSystemDef *> _systems;
};


/*!***************************************************************************
 *  \brief particle effect, basically one coherent "effect" like an explosion,
 *         or snow falling from the sky. Consists of one or more ParticleSystems.
 *         An example of using multiple systems to create one effect would be
 *         a campfire where you have fire + smoke + glowing embers.
 *****************************************************************************/

class ParticleEffect
{
public:

  ParticleEffect();
  

  void Move(float x, float y);
  

  void MoveRelative(float dx, float dy);
  

  void SetOrientation(float angle);
  
  
  void SetAttractorPoint(float x, float y);


  bool IsAlive();
  
  
  void Stop(bool kill_immediate = false);


  int32 GetNumParticles() const;
  

  void  GetPosition(float &x, float &y) const;


  float GetAge() const;

private:

  bool _Draw();


  bool _Update(float frame_time);


  void _Destroy();
  
  
  const ParticleEffectDef *_effect_def; 
  
  std::list <ParticleSystem *> _systems;
  
  float _x, _y;

  float _attractor_x, _attractor_y;
  
  float _orientation;
  
  bool  _alive;
  
  float _age; 
  
  int32 _num_particles;
  
  friend class private_video::ParticleManager;
  
}; // class ParticleEffect

}  // namespace hoa_video

#endif  

---