Plasma Engine  2.0
Loading...
Searching...
No Matches
plParticleTypeEffect Class Referencefinal
Inheritance diagram for plParticleTypeEffect:

Public Member Functions

virtual void CreateRequiredStreams () override
 
virtual void ExtractTypeRenderData (plMsgExtractRenderData &ref_msg, const plTransform &instanceTransform) const override
 
virtual float GetMaxParticleRadius (float fParticleSize) const override
 
- Public Member Functions inherited from plParticleModule
virtual void QueryOptionalStreams ()
 
void Reset (plParticleSystemInstance *pOwner)
 
virtual void OnFinalize ()
 Called after everything is set up.
 
plParticleSystemInstanceGetOwnerSystem ()
 
const plParticleSystemInstanceGetOwnerSystem () const
 
plParticleEffectInstanceGetOwnerEffect () 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 plRTTIGetDynamicRTTI () 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.
 

Public Attributes

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

Protected Member Functions

virtual void OnReset () override
 Called by Reset()
 
virtual void Process (plUInt64 uiNumElements) override
 The actual method which processes the data, will be called with the number of elements to process.
 
void OnParticleDeath (const plStreamGroupElementRemovedEvent &e)
 
void ClearEffects (bool bInterruptImmediately)
 
- Protected Member Functions inherited from plParticleType
virtual void InitializeElements (plUInt64 uiStartIndex, plUInt64 uiNumElements) override
 This method needs to be implemented in order to initialize new elements to specific values.
 
virtual void StepParticleSystem (const plTime &tDiff, plUInt32 uiNumNewParticles)
 
- Protected Member Functions inherited from plParticleModule
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.
 
plRandomGetRNG () const
 

Protected Attributes

float m_fMaxEffectRadius = 1.0f
 
plProcessingStreamm_pStreamPosition = nullptr
 
plProcessingStreamm_pStreamEffectID = nullptr
 
- Protected Attributes inherited from plParticleType
plTime m_TimeDiff
 
plUInt64 m_uiLastExtractedFrame
 
- Protected Attributes inherited from plProcessingStreamProcessor
plProcessingStreamGroupm_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();.
 

Friends

class plParticleTypeEffectFactory
 

Additional Inherited Members

- Static Public Member Functions inherited from plNoBase
static const plRTTIGetStaticRTTI ()
 
- Static Protected Member Functions inherited from plParticleType
static plUInt32 ComputeSortingKey (plParticleTypeRenderMode::Enum mode, plUInt32 uiTextureHash)
 

Member Function Documentation

◆ CreateRequiredStreams()

void plParticleTypeEffect::CreateRequiredStreams ( )
overridevirtual

Implements plParticleModule.

◆ ExtractTypeRenderData()

void plParticleTypeEffect::ExtractTypeRenderData ( plMsgExtractRenderData & ref_msg,
const plTransform & instanceTransform ) const
overridevirtual

Implements plParticleType.

◆ GetMaxParticleRadius()

virtual float plParticleTypeEffect::GetMaxParticleRadius ( float fParticleSize) const
inlineoverridevirtual

Reimplemented from plParticleType.

◆ OnReset()

void plParticleTypeEffect::OnReset ( )
overrideprotectedvirtual

Called by Reset()

Reimplemented from plParticleModule.

◆ Process()

void plParticleTypeEffect::Process ( plUInt64 uiNumElements)
overrideprotectedvirtual

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

Implements plProcessingStreamProcessor.


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