dcpp::scene::IParticleEmitter Class Reference

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

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

Inheritance diagram for dcpp::scene::IParticleEmitter:

Collaboration diagram for dcpp::scene::IParticleEmitter:

Public Member Functions
virtual dcpp::int32_kt	emitt (dcpp::uint32_kt now, dcpp::uint32_kt timeSinceLastCall, SParticle *&outArray)=0
	Prepares an array with new particles to emit into the system.
virtual void	setDirection (const dcpp::nub::vector3df &newDirection)=0
	Set direction the emitter emits particles.
virtual void	setMinParticlesPerSecond (dcpp::uint32_kt minPPS)=0
	Set minimum number of particles the emitter emits per second.
virtual void	setMaxParticlesPerSecond (dcpp::uint32_kt maxPPS)=0
	Set maximum number of particles the emitter emits per second.
virtual void	setMinStartColor (const dcpp::video::SColor &color)=0
	Set minimum starting color for particles.
virtual void	setMaxStartColor (const dcpp::video::SColor &color)=0
	Set maximum starting color for particles.
virtual void	setMaxStartSize (const dcpp::nub::dimension2df &size)=0
	Set the maximum starting size for particles.
virtual void	setMinStartSize (const dcpp::nub::dimension2df &size)=0
	Set the minimum starting size for particles.
virtual void	setMinLifeTime (dcpp::uint32_kt lifeTimeMin)=0
	Set the minimum particle life-time in milliseconds.
virtual void	setMaxLifeTime (dcpp::uint32_kt lifeTimeMax)=0
	Set the maximum particle life-time in milliseconds.
virtual void	setMaxAngleDegrees (dcpp::int32_kt maxAngleDegrees)=0
	Set maximal random derivation from the direction.
virtual const dcpp::nub::vector3df &	getDirection () const =0
	Get direction the emitter emits particles.
virtual dcpp::uint32_kt	getMinParticlesPerSecond () const =0
	Get the minimum number of particles the emitter emits per second.
virtual dcpp::uint32_kt	getMaxParticlesPerSecond () const =0
	Get the maximum number of particles the emitter emits per second.
virtual const dcpp::video::SColor &	getMinStartColor () const =0
	Get the minimum starting color for particles.
virtual const dcpp::video::SColor &	getMaxStartColor () const =0
	Get the maximum starting color for particles.
virtual const dcpp::nub::dimension2df &	getMaxStartSize () const =0
	Get the maximum starting size for particles.
virtual const dcpp::nub::dimension2df &	getMinStartSize () const =0
	Get the minimum starting size for particles.
virtual dcpp::uint32_kt	getMinLifeTime () const =0
	Get the minimum particle life-time in milliseconds.
virtual dcpp::uint32_kt	getMaxLifeTime () const =0
	Get the maximum particle life-time in milliseconds.
virtual dcpp::int32_kt	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 dcpp::io::IAttributeExchangingObject
virtual void	serializeAttributes (dcpp::io::IAttributes *out, dcpp::io::SAttributeReadWriteOptions *options=0) const
	Writes attributes of the object.
virtual void	deserializeAttributes (dcpp::io::IAttributes *in, dcpp::io::SAttributeReadWriteOptions *options=0)
	Reads attributes of the object.
Public Member Functions inherited from dcpp::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.
dcpp::int32_kt	getReferenceCount () const
	Get the reference count.
const dcpp::char_kt *	getDebugName () const
	Returns the debug name of the object.

Additional Inherited Members
Protected Member Functions inherited from dcpp::IReferenceCounted
void	setDebugName (const dcpp::char_kt *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 dcpp::int32_kt dcpp::scene::IParticleEmitter::emitt ( dcpp::uint32_kt  now, dcpp::uint32_kt  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 dcpp::scene::IParticleEmitter::getType ( ) const

inlinevirtual

Get emitter type.

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

---

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

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