Inheritance diagram for plParticleModule:

[legend]

Public Member Functions
virtual void	CreateRequiredStreams ()=0

virtual void	QueryOptionalStreams ()

void	Reset (plParticleSystemInstance *pOwner)

virtual void	OnFinalize ()
	Called after everything is set up.

plParticleSystemInstance *	GetOwnerSystem ()

const plParticleSystemInstance *	GetOwnerSystem () const

plParticleEffectInstance *	GetOwnerEffect () const

virtual void	RequestRequiredWorldModulesForCache (plParticleWorldModule *pParticleModule)
	Override this to cache world module pointers for later (through plParticleWorldModule::GetCachedWorldModule()).

Public Member Functions inherited from plProcessingStreamProcessor
	plProcessingStreamProcessor ()
	Base constructor.

virtual	~plProcessingStreamProcessor ()
	Base destructor.

Public Member Functions inherited from plReflectedClass
virtual const plRTTI *	GetDynamicRTTI () const

bool	IsInstanceOf (const plRTTI *pType) const
	Returns whether the type of this instance is of the given type or derived from it.

template<typename T >
PL_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()

void	CreateStream (const char szName, plProcessingStream::DataType Type, plProcessingStream *ppStream, bool bWillInitializeStream)

virtual plResult	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.

plRandom &	GetRNG () const

Protected Member Functions inherited from plProcessingStreamProcessor
virtual void	InitializeElements (plUInt64 uiStartIndex, plUInt64 uiNumElements)=0
	This method needs to be implemented in order to initialize new elements to specific values.

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

Friends
class	plParticleSystemInstance

Additional Inherited Members
Static Public Member Functions inherited from plNoBase
static const plRTTI *	GetStaticRTTI ()

Public Attributes inherited from plProcessingStreamProcessor
float	m_fPriority = 0.0f
	Used for sorting processors, to ensure a certain order. Lower priority == executed first.

Protected Attributes inherited from plProcessingStreamProcessor
plProcessingStreamGroup *	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();.

Member Function Documentation

◆ CreateRequiredStreams()

virtual void plParticleModule::CreateRequiredStreams ( )

pure virtual

Implemented in plParticleTypeLight.

◆ OnFinalize()

virtual void plParticleModule::OnFinalize ( )

inlinevirtual

Called after everything is set up.

Reimplemented in plParticleEmitter_Burst, plParticleEmitter_Continuous, and plParticleEmitter_Distance.

◆ OnReset()

virtual void plParticleModule::OnReset ( )

inlineprotectedvirtual

Called by Reset()

Reimplemented in plParticleTypeEffect.

◆ RequestRequiredWorldModulesForCache()

virtual void plParticleModule::RequestRequiredWorldModulesForCache ( plParticleWorldModule * pParticleModule )

inlinevirtual

Override this to cache world module pointers for later (through plParticleWorldModule::GetCachedWorldModule()).

Reimplemented in plParticleBehavior_Gravity, plParticleBehavior_Raycast, and plParticleBehavior_Velocity.

◆ UpdateStreamBindings()

virtual plResult plParticleModule::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 plProcessingStreamProcessor.

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

Code/EnginePlugins/ParticlePlugin/Module/ParticleModule.h

Public Member Functions

Protected Member Functions