Plasma Engine  2.0
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | Protected Member Functions | Protected Attributes | Friends | List of all members
plProcessingStreamProcessor Class Referenceabstract

Base class for all stream processor implementations. More...

#include <ProcessingStreamProcessor.h>

Inheritance diagram for plProcessingStreamProcessor:
Inheritance graph
[legend]

Public Member Functions

 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.
 

Public Attributes

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

Protected Member Functions

virtual plResult UpdateStreamBindings ()=0
 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.
 
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.
 

Protected Attributes

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();.
 

Friends

class plProcessingStreamGroup
 

Additional Inherited Members

- Static Public Member Functions inherited from plNoBase
static const plRTTI * GetStaticRTTI ()
 

Detailed Description

Base class for all stream processor implementations.

Member Function Documentation

◆ InitializeElements()

virtual void plProcessingStreamProcessor::InitializeElements ( plUInt64 uiStartIndex,
plUInt64 uiNumElements )
protectedpure virtual

This method needs to be implemented in order to initialize new elements to specific values.

Implemented in plParticleBehavior, plParticleBehavior_ColorGradient, plParticleBehavior_SizeCurve, plParticleEmitter_Burst, plParticleEmitter_Continuous, plParticleEmitter_Distance, plParticleEmitter_OnEvent, plParticleFinalizer, plParticleFinalizer_Age, plParticleInitializer_BoxPosition, plParticleInitializer_CylinderPosition, plParticleInitializer_RandomColor, plParticleInitializer_RandomRotationSpeed, plParticleInitializer_RandomSize, plParticleInitializer_SpherePosition, plParticleInitializer_VelocityCone, plParticleStream, plParticleStream_Axis, plParticleStream_Color, plParticleStream_Position, plParticleStream_Size, plParticleStream_Variation, plParticleStream_Velocity, plParticleType, plParticleTypeMesh, plParticleTypeQuad, plParticleTypeTrail, and plProcessingStreamSpawnerZeroInitialized.

◆ Process()

virtual void plProcessingStreamProcessor::Process ( plUInt64 uiNumElements)
protectedpure virtual

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

Implemented in plParticleBehavior_Bounds, plParticleBehavior_ColorGradient, plParticleBehavior_FadeOut, plParticleBehavior_Flies, plParticleBehavior_Gravity, plParticleBehavior_PullAlong, plParticleBehavior_Raycast, plParticleBehavior_SizeCurve, plParticleBehavior_Velocity, plParticleEmitter, plParticleFinalizer_Age, plParticleFinalizer_ApplyVelocity, plParticleFinalizer_LastPosition, plParticleFinalizer_Volume, plParticleInitializer, plParticleStream, plParticleTypeEffect, plParticleTypeLight, plParticleTypeMesh, plParticleTypePoint, plParticleTypeQuad, plParticleTypeTrail, and plProcessingStreamSpawnerZeroInitialized.

◆ UpdateStreamBindings()

virtual plResult plProcessingStreamProcessor::UpdateStreamBindings ( )
protectedpure virtual

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.

Implemented in plParticleModule, plParticleStream, and plProcessingStreamSpawnerZeroInitialized.

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