#include <ParticleModule.h>

Inheritance diagram for ezParticleModule:

[legend]

Public Member Functions
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.

Protected Member Functions
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.

virtual void	Process (ezUInt64 uiNumElements)=0
	The actual method which processes the data, will be called with the number of elements to process.

Friends
class	ezParticleSystemInstance

Additional Inherited Members
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 all particle system modules

Modules process particle data through streams. Derived types include emitters, initializers, behaviors, and finalizers.

Member Function Documentation

◆ CreateRequiredStreams()

virtual void ezParticleModule::CreateRequiredStreams ( )

pure virtual

Implemented in ezParticleTypeLight.

◆ OnFinalize()

virtual void ezParticleModule::OnFinalize ( )

inlinevirtual

Called after everything is set up.

Reimplemented in ezParticleEmitter_Burst, ezParticleEmitter_Continuous, and ezParticleEmitter_Distance.

◆ OnReset()

virtual void ezParticleModule::OnReset ( )

inlineprotectedvirtual

Called by Reset() to perform custom cleanup.

Reimplemented in ezParticleTypeEffect.

◆ RequestRequiredWorldModulesForCache()

virtual void ezParticleModule::RequestRequiredWorldModulesForCache ( ezParticleWorldModule * pParticleModule )

inlinevirtual

Override this to cache world module pointers for later access.

Cached modules can be retrieved via ezParticleWorldModule::GetCachedWorldModule().

Reimplemented in ezParticleBehavior_Gravity, ezParticleBehavior_Move, ezParticleBehavior_Raycast, ezParticleBehavior_Velocity, ezParticleBehavior_Wind, and ezParticleTypeMesh.

◆ UpdateStreamBindings()

virtual ezResult ezParticleModule::UpdateStreamBindings ( )

inlinefinaloverrideprotectedvirtual

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.

Implements ezProcessingStreamProcessor.

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

/home/runner/work/ezEngine/ezEngine/Code/EnginePlugins/ParticlePlugin/Module/ParticleModule.h

Public Member Functions

Protected Member Functions

Friends