#include <ParticleTypeLight.h>

Inheritance diagram for ezParticleTypeLight:

[legend]

Public Member Functions
virtual void	CreateRequiredStreams () override

virtual float	GetMaxParticleRadius (float fParticleSize) const override

virtual void	ExtractTypeRenderData (ezMsgExtractRenderData &ref_msg, const ezTransform &instanceTransform) const override

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

Public Attributes
float	m_fSizeFactor

float	m_fIntensity

ezUInt32	m_uiPercentage

ezTempHashedString	m_sTintColorParameter

ezTempHashedString	m_sIntensityParameter

ezTempHashedString	m_sSizeScaleParameter

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

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

Protected Member Functions inherited from ezParticleType
virtual void	InitializeElements (ezUInt64 uiStartIndex, ezUInt64 uiNumElements) override
	This method needs to be implemented in order to initialize new elements to specific values.

virtual void	StepParticleSystem (const ezTime &tDiff, ezUInt32 uiNumNewParticles)

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 Attributes
ezProcessingStream *	m_pStreamPosition

ezProcessingStream *	m_pStreamSize

ezProcessingStream *	m_pStreamColor

ezProcessingStream *	m_pStreamOnOff

Protected Attributes inherited from ezParticleType
ezTime	m_TimeDiff

ezUInt64	m_uiLastExtractedFrame

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

Additional Inherited Members
Static Public Member Functions inherited from ezNoBase
static const ezRTTI *	GetStaticRTTI ()

Static Protected Member Functions inherited from ezParticleType
static ezUInt32	ComputeSortingKey (ezParticleTypeRenderMode::Enum mode, ezUInt64 uiResource1Hash, ezUInt64 uiResource2Hash)

Detailed Description

Renders particles as dynamic point lights.

Each particle creates a point light with range based on particle size. Not all particles need to emit light - the percentage can be controlled to reduce performance cost. Light properties can be modulated by effect parameters.

Member Function Documentation

◆ CreateRequiredStreams()

void ezParticleTypeLight::CreateRequiredStreams ( )

overridevirtual

Todo:: Initialize (instead of during extraction)

Implements ezParticleModule.

◆ ExtractTypeRenderData()

void ezParticleTypeLight::ExtractTypeRenderData	(	ezMsgExtractRenderData &	ref_msg,
		const ezTransform &	instanceTransform
	)		const

overridevirtual

Generates render data for all active particles.

Called during render data extraction to create render objects for this particle type.

Implements ezParticleType.

◆ GetMaxParticleRadius()

virtual float ezParticleTypeLight::GetMaxParticleRadius ( float fParticleSize ) const

inlineoverridevirtual

Returns the maximum radius a particle can occupy for culling purposes.

Used to compute bounding volumes for frustum culling. The default implementation returns half the particle size, assuming spherical particles.

Reimplemented from ezParticleType.

◆ Process()

virtual void ezParticleTypeLight::Process ( ezUInt64 uiNumElements )

inlineoverrideprotectedvirtual

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/Type/Light/ParticleTypeLight.h
/home/runner/work/ezEngine/ezEngine/Code/EnginePlugins/ParticlePlugin/Type/Light/ParticleTypeLight.cpp

Public Member Functions

Public Attributes

Protected Member Functions