include/IParticleGravityAffector.h

   1 // Copyright (C) 2002-2012 Nikolaus Gebhardt\r
   2 // This file is part of the "Irrlicht Engine".\r
   3 // For conditions of distribution and use, see copyright notice in irrlicht.h\r
   4 \r
   5 #ifndef __I_PARTICLE_GRAVITY_AFFECTOR_H_INCLUDED__\r
   6 #define __I_PARTICLE_GRAVITY_AFFECTOR_H_INCLUDED__\r
   7 \r
   8 #include "IParticleAffector.h"\r
   9 \r
  10 namespace irr\r
  11 {\r
  12 namespace scene\r
  13 {\r
  14 \r
  15 //! A particle affector which applies gravity to particles.\r
  16 class IParticleGravityAffector : public IParticleAffector\r
  17 {\r
  18 public:\r
  19 \r
  20         //! Set the time in milliseconds when the gravity force is totally lost\r
  21         /** At that point the particle does not move any more. */\r
  22         virtual void setTimeForceLost( f32 timeForceLost ) = 0;\r
  23 \r
  24         //! Set the direction and force of gravity in all 3 dimensions.\r
  25         virtual void setGravity( const core::vector3df& gravity ) = 0;\r
  26 \r
  27         //! Get the time in milliseconds when the gravity force is totally lost\r
  28         virtual f32 getTimeForceLost() const = 0;\r
  29 \r
  30         //! Get the direction and force of gravity.\r
  31         virtual const core::vector3df& getGravity() const = 0;\r
  32 \r
  33         //! Get emitter type\r
  34         virtual E_PARTICLE_AFFECTOR_TYPE getType() const _IRR_OVERRIDE_ { return EPAT_GRAVITY; }\r
  35 };\r
  36 \r
  37 } // end namespace scene\r
  38 } // end namespace irr\r
  39 \r
  40 \r
  41 #endif // __I_PARTICLE_GRAVITY_AFFECTOR_H_INCLUDED__\r
  42 \r