irr::scene::IParticleEmitter Class Reference

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

#include <IParticleEmitter.h>

Inheritance diagram for irr::scene::IParticleEmitter:

List of all members.


Public Member Functions
virtual s32	deserializeAttributes (s32 startIndex, io::IAttributes in, io::SAttributeReadWriteOptions options=0)
virtual s32	emitt (u32 now, u32 timeSinceLastCall, SParticle *&outArray)=0
virtual const core::vector3df &	getDirection () const =0
	Get direction the emitter emits particles.
virtual u32	getMaxParticlesPerSecond () const =0
	Get the maximum number of particles the emitter emits per second.
virtual const video::SColor &	getMaxStartColor () const =0
	Get the maximum starting color for particles.
virtual u32	getMinParticlesPerSecond () const =0
	Get the minimum number of particles the emitter emits per second.
virtual const video::SColor &	getMinStartColor () const =0
	Get the minimum starting color for particles.
virtual E_PARTICLE_EMITTER_TYPE	getType () const
	Get emitter type.
virtual void	serializeAttributes (io::IAttributes out, io::SAttributeReadWriteOptions options=0) const
virtual void	setDirection (const core::vector3df &newDirection)=0
	Set direction the emitter emits particles.
virtual void	setMaxParticlesPerSecond (u32 maxPPS)=0
	Set maximum number of particles the emitter emits per second.
virtual void	setMaxStartColor (const video::SColor &color)=0
	Set maximum starting color for particles.
virtual void	setMinParticlesPerSecond (u32 minPPS)=0
	Set minimum number of particles the emitter emits per second.
virtual void	setMinStartColor (const video::SColor &color)=0
	Set minimum starting color for particles.

Detailed Description

A particle emitter for using with particle systems.

A Particle emitter emitts new particles into a particle system.

Definition at line 45 of file IParticleEmitter.h.

Member Function Documentation

virtual s32 irr::scene::IParticleEmitter::deserializeAttributes ( s32 startIndex,

io::IAttributes * in,

io::SAttributeReadWriteOptions * options = 0

) [inline, virtual]

Reads attributes of the object. Implement this to set the attributes of your scene node animator for scripting languages, editors, debuggers or xml deserialization purposes.
Parameters:

startIndex,: start index where to start reading attributes.

in,: The attributes to work with.

options,: Additional options.

Returns:
: returns last index of an attribute read by this affector

Definition at line 100 of file IParticleEmitter.h.

virtual s32 irr::scene::IParticleEmitter::emitt ( u32 now,

u32 timeSinceLastCall,

SParticle *& outArray

) [pure virtual]

Prepares an array with new particles to emitt into the system and returns how much new particles there are.
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:
Returns amount of new particles in the array. Can be 0.

virtual const core::vector3df& irr::scene::IParticleEmitter::getDirection ( ) const [pure virtual]

Get direction the emitter emits particles.

virtual u32 irr::scene::IParticleEmitter::getMaxParticlesPerSecond ( ) const [pure virtual]

Get the maximum number of particles the emitter emits per second.

virtual const video::SColor& irr::scene::IParticleEmitter::getMaxStartColor ( ) const [pure virtual]

Get the maximum starting color for particles.

virtual u32 irr::scene::IParticleEmitter::getMinParticlesPerSecond ( ) const [pure virtual]

Get the minimum number of particles the emitter emits per second.

virtual const video::SColor& irr::scene::IParticleEmitter::getMinStartColor ( ) const [pure virtual]

Get the minimum starting color for particles.

virtual E_PARTICLE_EMITTER_TYPE irr::scene::IParticleEmitter::getType ( ) const [inline, virtual]

Get emitter type.

Reimplemented in irr::scene::IParticleAnimatedMeshSceneNodeEmitter, irr::scene::IParticleBoxEmitter, irr::scene::IParticleCylinderEmitter, irr::scene::IParticleMeshEmitter, irr::scene::IParticleRingEmitter, and irr::scene::IParticleSphereEmitter.
Definition at line 103 of file IParticleEmitter.h.
References irr::scene::EPET_POINT.

virtual void irr::scene::IParticleEmitter::serializeAttributes ( io::IAttributes * out,

io::SAttributeReadWriteOptions * options = 0

) const [inline, virtual]

Writes attributes of the object. Implement this to expose the attributes of your scene node animator for scripting languages, editors, debuggers or xml serialization purposes.
Reimplemented from irr::io::IAttributeExchangingObject.
Definition at line 91 of file IParticleEmitter.h.

virtual void irr::scene::IParticleEmitter::setDirection ( const core::vector3df & newDirection ) [pure virtual]

Set direction the emitter emits particles.

virtual void irr::scene::IParticleEmitter::setMaxParticlesPerSecond ( u32 maxPPS ) [pure virtual]

Set maximum number of particles the emitter emits per second.

virtual void irr::scene::IParticleEmitter::setMaxStartColor ( const video::SColor & color ) [pure virtual]

Set maximum starting color for particles.

virtual void irr::scene::IParticleEmitter::setMinParticlesPerSecond ( u32 minPPS ) [pure virtual]

Set minimum number of particles the emitter emits per second.

virtual void irr::scene::IParticleEmitter::setMinStartColor ( const video::SColor & color ) [pure virtual]

Set minimum starting color for particles.

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

IParticleEmitter.h

irr::scene::IParticleEmitter Class Reference

Public Member Functions

Detailed Description

Member Function Documentation