Irrlicht 3D Engine
IParticleEmitter.h
Go to the documentation of this file.
1 // Copyright (C) 2002-2012 Nikolaus Gebhardt
2 // This file is part of the "Irrlicht Engine".
3 // For conditions of distribution and use, see copyright notice in irrlicht.h
4 
5 #ifndef __I_PARTICLE_EMITTER_H_INCLUDED__
6 #define __I_PARTICLE_EMITTER_H_INCLUDED__
7 
9 #include "SParticle.h"
10 
11 namespace irr
12 {
13 namespace scene
14 {
15 
18 {
27 };
28 
30 const c8* const ParticleEmitterTypeNames[] =
31 {
32  "Point",
33  "AnimatedMesh",
34  "Box",
35  "Cylinder",
36  "Mesh",
37  "Ring",
38  "Sphere",
39  0
40 };
41 
43 
46 {
47 public:
48 
50 
55  virtual s32 emitt(u32 now, u32 timeSinceLastCall, SParticle*& outArray) = 0;
56 
58  virtual void setDirection( const core::vector3df& newDirection ) = 0;
59 
61  virtual void setMinParticlesPerSecond( u32 minPPS ) = 0;
62 
64  virtual void setMaxParticlesPerSecond( u32 maxPPS ) = 0;
65 
67  virtual void setMinStartColor( const video::SColor& color ) = 0;
68 
70  virtual void setMaxStartColor( const video::SColor& color ) = 0;
71 
73  virtual void setMaxStartSize( const core::dimension2df& size ) = 0;
74 
76  virtual void setMinStartSize( const core::dimension2df& size ) = 0;
77 
79  virtual void setMinLifeTime( u32 lifeTimeMin ) = 0;
80 
82  virtual void setMaxLifeTime( u32 lifeTimeMax ) = 0;
83 
85  virtual void setMaxAngleDegrees( s32 maxAngleDegrees ) = 0;
86 
88  virtual const core::vector3df& getDirection() const = 0;
89 
91  virtual u32 getMinParticlesPerSecond() const = 0;
92 
94  virtual u32 getMaxParticlesPerSecond() const = 0;
95 
97  virtual const video::SColor& getMinStartColor() const = 0;
98 
100  virtual const video::SColor& getMaxStartColor() const = 0;
101 
103  virtual const core::dimension2df& getMaxStartSize() const = 0;
104 
106  virtual const core::dimension2df& getMinStartSize() const = 0;
107 
109  virtual u32 getMinLifeTime() const = 0;
110 
112  virtual u32 getMaxLifeTime() const = 0;
113 
115  virtual s32 getMaxAngleDegrees() const = 0;
116 
117 
119  virtual E_PARTICLE_EMITTER_TYPE getType() const { return EPET_POINT; }
120 };
121 
123 
124 } // end namespace scene
125 } // end namespace irr
126 
127 
128 #endif
129 
irr::scene::EPET_SPHERE
@ EPET_SPHERE
Definition: IParticleEmitter.h:25
irr::scene::IParticleEmitter::emitt
virtual s32 emitt(u32 now, u32 timeSinceLastCall, SParticle *&outArray)=0
Prepares an array with new particles to emitt into the system.
irr::scene::IParticleEmitter
A particle emitter for using with particle systems.
Definition: IParticleEmitter.h:45
irr::scene::ParticleEmitterTypeNames
const c8 *const ParticleEmitterTypeNames[]
Names for built in particle emitters.
Definition: IParticleEmitter.h:30
irr::c8
char c8
8 bit character variable.
Definition: irrTypes.h:31
irr::scene::IParticleEmitter::setMaxParticlesPerSecond
virtual void setMaxParticlesPerSecond(u32 maxPPS)=0
Set maximum number of particles the emitter emits per second.
irr::scene::IParticleEmitter::getMaxStartSize
virtual const core::dimension2df & getMaxStartSize() const =0
Get the maximum starting size for particles.
irr::scene::IParticleEmitter::getType
virtual E_PARTICLE_EMITTER_TYPE getType() const
Get emitter type.
Definition: IParticleEmitter.h:119
irr::io::IAttributeExchangingObject
An object which is able to serialize and deserialize its attributes into an attributes object.
Definition: IAttributeExchangingObject.h:51
irr::scene::IParticleEmitter::getMinLifeTime
virtual u32 getMinLifeTime() const =0
Get the minimum particle life-time in milliseconds.
irr::scene::IParticleEmitter::setMaxStartSize
virtual void setMaxStartSize(const core::dimension2df &size)=0
Set the maximum starting size for particles.
irr::scene::IParticleEmitter::getMinStartSize
virtual const core::dimension2df & getMinStartSize() const =0
Get the minimum starting size for particles.
irr::scene::IParticleEmitter::getMinStartColor
virtual const video::SColor & getMinStartColor() const =0
Get the minimum starting color for particles.
irr::scene::IParticleEmitter::setMinParticlesPerSecond
virtual void setMinParticlesPerSecond(u32 minPPS)=0
Set minimum number of particles the emitter emits per second.
irr::s32
signed int s32
32 bit signed variable.
Definition: irrTypes.h:66
SParticle.h
irr::scene::IParticleEmitter::getMaxLifeTime
virtual u32 getMaxLifeTime() const =0
Get the maximum particle life-time in milliseconds.
irr::scene::SParticle
Struct for holding particle data.
Definition: SParticle.h:17
irr::scene::E_PARTICLE_EMITTER_TYPE
E_PARTICLE_EMITTER_TYPE
Types of built in particle emitters.
Definition: IParticleEmitter.h:17
irr::core::dimension2d
Specifies a 2 dimensional size.
Definition: dimension2d.h:20
irr::scene::EPET_CYLINDER
@ EPET_CYLINDER
Definition: IParticleEmitter.h:22
irr::scene::IParticleEmitter::getMinParticlesPerSecond
virtual u32 getMinParticlesPerSecond() const =0
Get the minimum number of particles the emitter emits per second.
irr::scene::EPET_RING
@ EPET_RING
Definition: IParticleEmitter.h:24
IAttributeExchangingObject.h
irr::scene::IParticlePointEmitter
IParticleEmitter IParticlePointEmitter
Definition: IParticleEmitter.h:122
irr::scene::IParticleEmitter::setMaxStartColor
virtual void setMaxStartColor(const video::SColor &color)=0
Set maximum starting color for particles.
irr::scene::IParticleEmitter::setMaxLifeTime
virtual void setMaxLifeTime(u32 lifeTimeMax)=0
Set the maximum particle life-time in milliseconds.
irr
Everything in the Irrlicht Engine can be found in this namespace.
Definition: aabbox3d.h:12
irr::scene::IParticleEmitter::getMaxAngleDegrees
virtual s32 getMaxAngleDegrees() const =0
Get maximal random derivation from the direction.
irr::scene::EPET_MESH
@ EPET_MESH
Definition: IParticleEmitter.h:23
irr::scene::EPET_COUNT
@ EPET_COUNT
Definition: IParticleEmitter.h:26
irr::u32
unsigned int u32
32 bit unsigned variable.
Definition: irrTypes.h:58
irr::scene::IParticleEmitter::setMinStartColor
virtual void setMinStartColor(const video::SColor &color)=0
Set minimum starting color for particles.
irr::scene::IParticleEmitter::getMaxParticlesPerSecond
virtual u32 getMaxParticlesPerSecond() const =0
Get the maximum number of particles the emitter emits per second.
irr::scene::IParticleEmitter::setMaxAngleDegrees
virtual void setMaxAngleDegrees(s32 maxAngleDegrees)=0
Set maximal random derivation from the direction.
irr::scene::EPET_BOX
@ EPET_BOX
Definition: IParticleEmitter.h:21
irr::scene::IParticleEmitter::setMinStartSize
virtual void setMinStartSize(const core::dimension2df &size)=0
Set the minimum starting size for particles.
irr::scene::EPET_ANIMATED_MESH
@ EPET_ANIMATED_MESH
Definition: IParticleEmitter.h:20
irr::scene::IParticleEmitter::getDirection
virtual const core::vector3df & getDirection() const =0
Get direction the emitter emits particles.
irr::scene::IParticleEmitter::getMaxStartColor
virtual const video::SColor & getMaxStartColor() const =0
Get the maximum starting color for particles.
irr::scene::EPET_POINT
@ EPET_POINT
Definition: IParticleEmitter.h:19
irr::video::SColor
Class representing a 32 bit ARGB color.
Definition: SColor.h:201
irr::core::vector3d< f32 >
irr::scene::IParticleEmitter::setMinLifeTime
virtual void setMinLifeTime(u32 lifeTimeMin)=0
Set the minimum particle life-time in milliseconds.
irr::scene::IParticleEmitter::setDirection
virtual void setDirection(const core::vector3df &newDirection)=0
Set direction the emitter emits particles.