nirt::scene::IParticleEmitter Class Reference

A particle emitter for using with particle systems. More...

#include <nirtcpp/core/engine/IParticleEmitter.hpp>

Inheritance diagram for nirt::scene::IParticleEmitter:

Collaboration diagram for nirt::scene::IParticleEmitter:

Public Member Functions
virtual s32	emitt (u32 now, u32 timeSinceLastCall, SParticle *&outArray)=0
	Prepares an array with new particles to emit into the system.
virtual void	setDirection (const core::vector3df &newDirection)=0
	Set direction the emitter emits particles.
virtual void	setMinParticlesPerSecond (u32 minPPS)=0
	Set minimum number of particles the emitter emits per second.
virtual void	setMaxParticlesPerSecond (u32 maxPPS)=0
	Set maximum number of particles the emitter emits per second.
virtual void	setMinStartColor (const video::SColor &color)=0
	Set minimum starting color for particles.
virtual void	setMaxStartColor (const video::SColor &color)=0
	Set maximum starting color for particles.
virtual void	setMaxStartSize (const core::dimension2df &size)=0
	Set the maximum starting size for particles.
virtual void	setMinStartSize (const core::dimension2df &size)=0
	Set the minimum starting size for particles.
virtual void	setMinLifeTime (u32 lifeTimeMin)=0
	Set the minimum particle life-time in milliseconds.
virtual void	setMaxLifeTime (u32 lifeTimeMax)=0
	Set the maximum particle life-time in milliseconds.
virtual void	setMaxAngleDegrees (s32 maxAngleDegrees)=0
	Set maximal random derivation from the direction.
virtual const core::vector3df &	getDirection () const =0
	Get direction the emitter emits particles.
virtual u32	getMinParticlesPerSecond () const =0
	Get the minimum number of particles the emitter emits per second.
virtual u32	getMaxParticlesPerSecond () const =0
	Get the maximum number of particles the emitter emits per second.
virtual const video::SColor &	getMinStartColor () const =0
	Get the minimum starting color for particles.
virtual const video::SColor &	getMaxStartColor () const =0
	Get the maximum starting color for particles.
virtual const core::dimension2df &	getMaxStartSize () const =0
	Get the maximum starting size for particles.
virtual const core::dimension2df &	getMinStartSize () const =0
	Get the minimum starting size for particles.
virtual u32	getMinLifeTime () const =0
	Get the minimum particle life-time in milliseconds.
virtual u32	getMaxLifeTime () const =0
	Get the maximum particle life-time in milliseconds.
virtual s32	getMaxAngleDegrees () const =0
	Get maximal random derivation from the direction.
virtual E_PARTICLE_EMITTER_TYPE	getType () const
	Get emitter type.
Public Member Functions inherited from nirt::io::IAttributeExchangingObject
virtual void	serializeAttributes (io::IAttributes *out, io::SAttributeReadWriteOptions *options=0) const
	Writes attributes of the object.
virtual void	deserializeAttributes (io::IAttributes *in, io::SAttributeReadWriteOptions *options=0)
	Reads attributes of the object.
Public Member Functions inherited from nirt::IReferenceCounted
	IReferenceCounted ()
	Constructor.
virtual	~IReferenceCounted ()
	Destructor.
void	grab () const
	Grabs the object. Increments the reference counter by one.
bool	drop () const
	Drops the object. Decrements the reference counter by one.
s32	getReferenceCount () const
	Get the reference count.
const c8 *	getDebugName () const
	Returns the debug name of the object.

Additional Inherited Members
Protected Member Functions inherited from nirt::IReferenceCounted
void	setDebugName (const c8 *newName)
	Sets the debug name of the object.

Detailed Description

A particle emitter for using with particle systems.

A Particle emitter emits new particles into a particle system.

Member Function Documentation

emitt()

virtual s32 nirt::scene::IParticleEmitter::emitt ( u32  now, u32  timeSinceLastCall, SParticle *&  outArray  )

pure virtual

Prepares an array with new particles to emit into the system.

Parameters

now	Current time.
timeSinceLastCall	Time elapsed since last call, in milliseconds.
outArray	Pointer which will point to the array with the new particles to add into the system.

Returns

Amount of new particles in the array. Can be 0.

getType()

virtual E_PARTICLE_EMITTER_TYPE nirt::scene::IParticleEmitter::getType ( ) const

inlinevirtual

Get emitter type.

Reimplemented in nirt::scene::IParticleAnimatedMeshSceneNodeEmitter, nirt::scene::IParticleBoxEmitter, nirt::scene::IParticleCylinderEmitter, nirt::scene::IParticleMeshEmitter, nirt::scene::IParticleRingEmitter, and nirt::scene::IParticleSphereEmitter.

---

The documentation for this class was generated from the following file:

• include/nirtcpp/core/engine/IParticleEmitter.hpp