fsCParticleEmitterComponent Class Reference

#include <fsCParticleEmitterComponent.h>

Inheritance diagram for fsCParticleEmitterComponent:

Public Member Functions
fsS32	remainingParticleCountGet () const
const fsStr &	collectableTypeGet () const
fsBool	collectableGet () const
fsS32	photoScoreGet (const fsRect &pScreenRect) const
fsBool	hitTestAndCollect (const fsPoint &pPointerPos, std::function< void(fsIParticle *pParticle)> pCallBack) const
fsBool	hitTest (const fsPoint &pPointerPos) const
void	shortCircuit ()
fsBool	activeGet () const
void	visibleSet (fsBool pState)
void	particleEmitterParentEntSet (fsCEntity *pParent=nullptr) const
void	particelDataLoad (const fsCResourceName &pFileName)
Public Member Functions inherited from fsIComponent
template<typename TInterface>
std::vector< fsCEntity * >	appSceneEntitiesWithComponentOfFamilyType () const
template<typename TInterface>
fsCEntity *	appSceneFirstEntityWithComponentOfFamilyType () const
fsCEntity *	appSceneEntityNamed (const fsStr &pName) const
void	reset ()
void	update (fsS32 pDeltaMs)
void	render ()
void	matrixApply ()
void	postLoad ()
void	deserialise ()
void	serialise ()
void	initialiseFromVariableTable (const fsCVariableTable &pVars)
void	initialise ()
void	finalise ()
fsCEntity *	parentGet () const
fsCEntity *	grandparentGet () const

Static Public Attributes
static const fsStr	mEntityPrefix
static const fsCUniqueId	mTypeId

Protected Member Functions
virtual void	particelDataLoadDo (const fsCResourceName &pFileName)
void	initialiseFromVariableTableDo (const fsCVariableTable &pVars) override
void	updateDo (fsS32 pDeltaMs) override
void	renderDo () override
void	matrixApplyDo () override
void	finaliseDo () override
	fsCParticleEmitterComponent (fsCEntity *pParent)
virtual	~fsCParticleEmitterComponent ()
Protected Member Functions inherited from fsIRenderableComponent
	fsIRenderableComponent (fsCEntity *pParent)
virtual	~fsIRenderableComponent ()
Protected Member Functions inherited from fsIComponent
virtual void	resetDo ()
virtual void	postLoadDo ()
virtual void	deserialiseDo ()
virtual void	serialiseDo ()
virtual void	initialiseDo ()
virtual	~fsIComponent ()
	fsIComponent (fsCEntity *pParent)

Static Protected Member Functions
static fsIComponent *	create (fsCEntity *pParent)

Protected Attributes
std::unique_ptr< fsCParticleEmitter >	mEmitter

Friends
class	fsCComponentFactory

Constructor & Destructor Documentation

fsCParticleEmitterComponent()

fsCParticleEmitterComponent::fsCParticleEmitterComponent ( fsCEntity * pParent )

protected

~fsCParticleEmitterComponent()

fsCParticleEmitterComponent::~fsCParticleEmitterComponent ( )

protectedvirtual

Member Function Documentation

activeGet()

fsBool fsCParticleEmitterComponent::activeGet

(

)

const

collectableGet()

fsBool fsCParticleEmitterComponent::collectableGet

(

)

const

collectableTypeGet()

const fsStr & fsCParticleEmitterComponent::collectableTypeGet

(

)

const

create()

fsIComponent * fsCParticleEmitterComponent::create ( fsCEntity * pParent )

staticprotected

finaliseDo()

void fsCParticleEmitterComponent::finaliseDo ( )

overrideprotectedvirtual

Reimplemented from fsIComponent.

hitTest()

fsBool fsCParticleEmitterComponent::hitTest

(

const fsPoint &

pPointerPos

)

const

hitTestAndCollect()

fsBool fsCParticleEmitterComponent::hitTestAndCollect	(	const fsPoint &	pPointerPos,
		std::function< void(fsIParticle *pParticle)>	pCallBack ) const

initialiseFromVariableTableDo()

void fsCParticleEmitterComponent::initialiseFromVariableTableDo ( const fsCVariableTable & pVars )

overrideprotectedvirtual

Reimplemented from fsIComponent.

matrixApplyDo()

void fsCParticleEmitterComponent::matrixApplyDo ( )

overrideprotectedvirtual

Reimplemented from fsIComponent.

particelDataLoad()

void fsCParticleEmitterComponent::particelDataLoad

(

const fsCResourceName &

pFileName

)

particelDataLoadDo()

void fsCParticleEmitterComponent::particelDataLoadDo ( const fsCResourceName & pFileName )

protectedvirtual

Reimplemented in fsCParticleCloudEmitterComponent.

particleEmitterParentEntSet()

void fsCParticleEmitterComponent::particleEmitterParentEntSet

(

fsCEntity *

pParent = nullptr

)

const

photoScoreGet()

fsS32 fsCParticleEmitterComponent::photoScoreGet

(

const fsRect &

pScreenRect

)

const

remainingParticleCountGet()

fsS32 fsCParticleEmitterComponent::remainingParticleCountGet

(

)

const

renderDo()

void fsCParticleEmitterComponent::renderDo ( )

overrideprotectedvirtual

Reimplemented from fsIComponent.

shortCircuit()

void fsCParticleEmitterComponent::shortCircuit

(

)

updateDo()

void fsCParticleEmitterComponent::updateDo ( fsS32 pDeltaMs )

overrideprotectedvirtual

Reimplemented from fsIComponent.

visibleSet()

void fsCParticleEmitterComponent::visibleSet

(

fsBool

pState

)

Friends And Related Symbol Documentation

fsCComponentFactory

friend class fsCComponentFactory

friend

Member Data Documentation

mEmitter

std::unique_ptr<fsCParticleEmitter> fsCParticleEmitterComponent::mEmitter

protected

mEntityPrefix

const fsStr fsCParticleEmitterComponent::mEntityPrefix

static

mTypeId

const fsCUniqueId fsCParticleEmitterComponent::mTypeId

static

---

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

• /home/runner/work/fission/fission/libs/fsRenderer/src/components/fsCParticleEmitterComponent.h
• /home/runner/work/fission/fission/libs/fsRenderer/src/components/fsCParticleEmitterComponent.cpp