ezParticleEmitter Class Reference

#include <ParticleEmitter.h>

Inheritance diagram for ezParticleEmitter:

Protected Member Functions
virtual bool	IsContinuous () const
virtual void	Process (ezUInt64 uiNumElements) final override
	The actual method which processes the data, will be called with the number of elements to process.
virtual ezUInt32	ComputeSpawnCount (const ezTime &tDiff)=0
	Called once per update. Must return how many new particles to spawn.
virtual ezParticleEmitterState	IsFinished ()=0
	Called before ComputeSpawnCount(). Returns whether the emitter will spawn more particles.
virtual void	ProcessEventQueue (ezParticleEventQueue queue)
Protected Member Functions inherited from ezParticleModule
virtual void	OnReset ()
	Called by Reset() to perform custom cleanup.
void	CreateStream (const char *szName, ezProcessingStream::DataType Type, ezProcessingStream **ppStream, bool bWillInitializeStream)
virtual ezResult	UpdateStreamBindings () final override
	Internal method which needs to be implemented, gets the concrete stream bindings. This is called every time the streams are resized. Implementations should check that their required streams exist and are of the correct data types.
ezRandom &	GetRNG () const
Protected Member Functions inherited from ezProcessingStreamProcessor
virtual void	InitializeElements (ezUInt64 uiStartIndex, ezUInt64 uiNumElements)=0
	This method needs to be implemented in order to initialize new elements to specific values.

Friends
class	ezParticleSystemInstance
class	ezParticleEmitterFactory

Additional Inherited Members
Public Member Functions inherited from ezParticleModule
virtual void	CreateRequiredStreams ()=0
virtual void	QueryOptionalStreams ()
void	Reset (ezParticleSystemInstance *pOwner)
virtual void	OnFinalize ()
	Called after everything is set up.
ezParticleSystemInstance *	GetOwnerSystem ()
const ezParticleSystemInstance *	GetOwnerSystem () const
ezParticleEffectInstance *	GetOwnerEffect () const
virtual void	RequestRequiredWorldModulesForCache (ezParticleWorldModule *pParticleModule)
Public Member Functions inherited from ezProcessingStreamProcessor
	ezProcessingStreamProcessor ()
	Base constructor.
virtual	~ezProcessingStreamProcessor ()
	Base destructor.
Public Member Functions inherited from ezReflectedClass
virtual const ezRTTI *	GetDynamicRTTI () const
bool	IsInstanceOf (const ezRTTI *pType) const
	Returns whether the type of this instance is of the given type or derived from it.
template<typename T >
EZ_ALWAYS_INLINE bool	IsInstanceOf () const
	Returns whether the type of this instance is of the given type or derived from it.
Static Public Member Functions inherited from ezNoBase
static const ezRTTI *	GetStaticRTTI ()
Public Attributes inherited from ezProcessingStreamProcessor
float	m_fPriority = 0.0f
	Used for sorting processors, to ensure a certain order. Lower priority == executed first.
Protected Attributes inherited from ezProcessingStreamProcessor
ezProcessingStreamGroup *	m_pStreamGroup = nullptr
	Back pointer to the stream group - will be set to the owner stream group when adding the stream processor to the group. Can be used to get stream pointers in UpdateStreamBindings();.

Detailed Description

Base class for particle emitters

Emitters control when and how many particles are spawned.

Member Function Documentation

ComputeSpawnCount()

virtual ezUInt32 ezParticleEmitter::ComputeSpawnCount ( const ezTime &  tDiff )

protectedpure virtual

Called once per update. Must return how many new particles to spawn.

Implemented in ezParticleEmitter_Burst, ezParticleEmitter_Continuous, ezParticleEmitter_Distance, and ezParticleEmitter_OnEvent.

IsFinished()

virtual ezParticleEmitterState ezParticleEmitter::IsFinished ( )

protectedpure virtual

Called before ComputeSpawnCount(). Returns whether the emitter will spawn more particles.

Implemented in ezParticleEmitter_Burst, ezParticleEmitter_Continuous, ezParticleEmitter_Distance, and ezParticleEmitter_OnEvent.

Process()

void ezParticleEmitter::Process ( ezUInt64  uiNumElements )

finaloverrideprotectedvirtual

The actual method which processes the data, will be called with the number of elements to process.

Implements ezProcessingStreamProcessor.

---

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

• /home/runner/work/ezEngine/ezEngine/Code/EnginePlugins/ParticlePlugin/Emitter/ParticleEmitter.h
• /home/runner/work/ezEngine/ezEngine/Code/EnginePlugins/ParticlePlugin/Emitter/ParticleEmitter.cpp