Nz::ParticleEmitter Class Reference

Graphics class that represents an emitter of particles. More...

Inheritance diagram for Nz::ParticleEmitter:

Public Member Functions
	ParticleEmitter ()
	Constructs a ParticleEmitter object by default.
	ParticleEmitter (const ParticleEmitter &emitter)
	ParticleEmitter (ParticleEmitter &&emitter)
virtual void	Emit (ParticleGroup &system, float elapsedTime) const
	Emits particles according to the delta time between the previous frame. More...
void	EnableLagCompensation (bool enable)
	Enables the lag compensation. More...
std::size_t	GetEmissionCount () const
	Gets the emission count. More...
float	GetEmissionRate () const
	Gets the emission rate. More...
bool	IsLagCompensationEnabled () const
	Checks whether the lag compensation is enabled. More...
void	SetEmissionCount (std::size_t count)
	Sets the emission count. More...
void	SetEmissionRate (float rate)
	Sets the emission rate. More...
ParticleEmitter &	operator= (const ParticleEmitter &emitter)=default
ParticleEmitter &	operator= (ParticleEmitter &&emitter)
	NazaraSignal (OnParticleEmitterMove, ParticleEmitter *, ParticleEmitter *)
	NazaraSignal (OnParticleEmitterRelease, const ParticleEmitter *)

Detailed Description

Graphics class that represents an emitter of particles.

Member Function Documentation

Emit()

void Nz::ParticleEmitter::Emit ( ParticleGroup &  system, float  elapsedTime  ) const

virtual

Emits particles according to the delta time between the previous frame.

Parameters

system	Particle system to work on
elapsedTime	Delta time between the previous frame

EnableLagCompensation()

void Nz::ParticleEmitter::EnableLagCompensation

(

bool

enable

)

Enables the lag compensation.

Parameters

enable

Should lag compensation be enabled

GetEmissionCount()

std::size_t Nz::ParticleEmitter::GetEmissionCount

(

)

const

Gets the emission count.

Returns

Current emission count

GetEmissionRate()

float Nz::ParticleEmitter::GetEmissionRate

(

)

const

Gets the emission rate.

Returns

Current emission rate

IsLagCompensationEnabled()

bool Nz::ParticleEmitter::IsLagCompensationEnabled

(

)

const

Checks whether the lag compensation is enabled.

Returns

true If it is the case

SetEmissionCount()

void Nz::ParticleEmitter::SetEmissionCount

(

std::size_t

count

)

Sets the emission count.

Parameters

count

Emission count

SetEmissionRate()

void Nz::ParticleEmitter::SetEmissionRate

(

float

rate

)

Sets the emission rate.

Parameters

rate	Emission rate

---

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

• include/Nazara/Graphics/ParticleEmitter.hpp
• src/Nazara/Graphics/ParticleEmitter.cpp