fsCAnimatingSpriteComponent Class Reference

#include <fsCAnimatingSpriteComponent.h>

Inheritance diagram for fsCAnimatingSpriteComponent:

Public Member Functions
fsS32	heightGet () const
void	animationPlay (const fsStr &pAnimation)
fsBool	animationQueue (const fsStr &pAnimation, fsBool pLooping)
fsBool	animationTrackPlay (fsS32 pTrackIndex, const fsStr &pAnimation, fsBool pLooping)
fsBool	animationTrackQueue (fsS32 pTrackIndex, const fsStr &pAnimation, fsBool pLooping)
fsBool	animationTrackClear (fsS32 pTrackIndex)
void	animationTracksClear ()
void	animationMixDurationSet (fsS32 pDurationMs)
fsBool	skinSet (const fsStr &pSkin)
fsBool	attachmentSet (const fsStr &pSlot, const fsStr &pAttachment)
void	animationEventCallbackSet (fsTAnimationEventCallback pCallback)
void	animationSpeedSet (fsF32 pSpeed)
void	animationStartOffsetSet (fsS32 pOffsetMs)
fsBool	animatingGet () const
void	stop ()
void	initialise (const fsStr &pFolderName, fsBool pHitMap)
void	animationDataSet (const fsCResourceName &pAnimationFilename, fsBool pHitmap)
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 fsCUniqueId	mTypeId
static const fsStr	mEntityPrefix

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

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

Friends
class	fsCComponentFactory

Constructor & Destructor Documentation

fsCAnimatingSpriteComponent()

fsCAnimatingSpriteComponent::fsCAnimatingSpriteComponent ( fsCEntity * pParent )

protected

~fsCAnimatingSpriteComponent()

fsCAnimatingSpriteComponent::~fsCAnimatingSpriteComponent ( )

protectedvirtual

Member Function Documentation

animatingGet()

fsBool fsCAnimatingSpriteComponent::animatingGet

(

)

const

animationDataSet()

void fsCAnimatingSpriteComponent::animationDataSet	(	const fsCResourceName &	pAnimationFilename,
		fsBool	pHitmap )

animationEventCallbackSet()

void fsCAnimatingSpriteComponent::animationEventCallbackSet

(

fsTAnimationEventCallback

pCallback

)

animationMixDurationSet()

void fsCAnimatingSpriteComponent::animationMixDurationSet

(

fsS32

pDurationMs

)

animationPlay()

void fsCAnimatingSpriteComponent::animationPlay

(

const fsStr &

pAnimation

)

animationQueue()

fsBool fsCAnimatingSpriteComponent::animationQueue	(	const fsStr &	pAnimation,
		fsBool	pLooping )

animationSpeedSet()

void fsCAnimatingSpriteComponent::animationSpeedSet

(

fsF32

pSpeed

)

animationStartOffsetSet()

void fsCAnimatingSpriteComponent::animationStartOffsetSet

(

fsS32

pOffsetMs

)

animationTrackClear()

fsBool fsCAnimatingSpriteComponent::animationTrackClear

(

fsS32

pTrackIndex

)

animationTrackPlay()

fsBool fsCAnimatingSpriteComponent::animationTrackPlay	(	fsS32	pTrackIndex,
		const fsStr &	pAnimation,
		fsBool	pLooping )

animationTrackQueue()

fsBool fsCAnimatingSpriteComponent::animationTrackQueue	(	fsS32	pTrackIndex,
		const fsStr &	pAnimation,
		fsBool	pLooping )

animationTracksClear()

void fsCAnimatingSpriteComponent::animationTracksClear

(

)

attachmentSet()

fsBool fsCAnimatingSpriteComponent::attachmentSet	(	const fsStr &	pSlot,
		const fsStr &	pAttachment )

create()

fsIComponent * fsCAnimatingSpriteComponent::create ( fsCEntity * pParent )

staticprotected

deserialiseDo()

void fsCAnimatingSpriteComponent::deserialiseDo ( )

overrideprotectedvirtual

Reimplemented from fsIComponent.

heightGet()

fsS32 fsCAnimatingSpriteComponent::heightGet

(

)

const

initialise()

void fsCAnimatingSpriteComponent::initialise	(	const fsStr &	pFolderName,
		fsBool	pHitMap )

initialiseFromVariableTableDo()

void fsCAnimatingSpriteComponent::initialiseFromVariableTableDo ( const fsCVariableTable & pVars )

overrideprotectedvirtual

Reimplemented from fsIComponent.

matrixApplyDo()

void fsCAnimatingSpriteComponent::matrixApplyDo ( )

overrideprotectedvirtual

Reimplemented from fsIComponent.

renderDo()

void fsCAnimatingSpriteComponent::renderDo ( )

overrideprotectedvirtual

Reimplemented from fsIComponent.

resetDo()

void fsCAnimatingSpriteComponent::resetDo ( )

overrideprotectedvirtual

Reimplemented from fsIComponent.

skinSet()

fsBool fsCAnimatingSpriteComponent::skinSet

(

const fsStr &

pSkin

)

stop()

void fsCAnimatingSpriteComponent::stop

(

)

updateDo()

void fsCAnimatingSpriteComponent::updateDo ( fsS32 pDeltaMs )

overrideprotectedvirtual

Reimplemented from fsIComponent.

Friends And Related Symbol Documentation

fsCComponentFactory

friend class fsCComponentFactory

friend

Member Data Documentation

mEntityPrefix

const fsStr fsCAnimatingSpriteComponent::mEntityPrefix

static

mTypeId

const fsCUniqueId fsCAnimatingSpriteComponent::mTypeId

static

---

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

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