fsCAnimatingSpriteSpriter Class Reference

#include <fsCAnimatingSpriteSpriter.h>

Inheritance diagram for fsCAnimatingSpriteSpriter:

Public Member Functions
virtual	~fsCAnimatingSpriteSpriter ()
Public Member Functions inherited from fsIAnimatingSprite
void	animationPlay (const fsStr &pAnimation)
void	animationPlay (const fsStr &pAnimation, fsBool pLooping)
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)
fsS32	currentFrameHeightGet () const
fsPoint	currentFramePosGet () const
void	stop ()
std::shared_ptr< fsCBrush >	brushGet () const
fsBool	hitTest (const fsPoint &pPoint, fsBool pRequireHitMap) const
fsS32	currentFrameGet () const
void	update (fsS32 pDeltaMS)
fsBool	animatingGet () const
fsBool	loopingGet () const
void	reset ()
	fsIAnimatingSprite (const fsCResourceName &pFileName, fsBool pHitMap, fsCSprite *pAnimatingSpriteRoot)
	fsIAnimatingSprite (fsCSprite *pAnimatingRootSprt)
virtual	~fsIAnimatingSprite ()
Public Member Functions inherited from fsIRenderable
const fsAffineMtx2d &	renderMatrixGet ()
void	colourSet (const fsSColour4B &pColour)
void	matrixApply (const fsAffineMtx2d &pRenderMatrix)
void	render ()

Protected Member Functions
	fsCAnimatingSpriteSpriter (const fsCResourceName &pFileName, fsBool pHitMap, fsCSprite *const pAnimatingRootSprt)
	fsCAnimatingSpriteSpriter (fsCSprite *const pAnimatingRootSprt)
virtual void	activeSet (fsBool pVisibility) override
virtual void	animationPlayDo (const fsStr &pAnimation) override
virtual void	colourApplyToSpriteFrames (const fsSColour4B &pColour) override
virtual void	animationDataSetDo (std::shared_ptr< fsIAnimationData > pAnimData) override
virtual fsS32	currentFrameHeightGetDo () const override
virtual fsPoint	currentFramePosGetDo () const override
virtual fsBool	hitTestDo (const fsPoint &pPoint, fsBool pRequireHitMap) const override
virtual fsS32	currentFrameGetDo () const override
virtual void	updateDo (fsS32 pDeltaMS) override
virtual fsBool	loopingGetDo () const override
virtual void	resetDo () override
virtual void	matrixApplyDo (const fsAffineMtx2d &pRenderMtx) override
virtual void	renderDo () override
Protected Member Functions inherited from fsIAnimatingSprite
void	animationDataSet (std::shared_ptr< fsIAnimationData > pAnimData)
void	animationEventDispatch (const fsSAnimationEvent &pEvent) const
void	colourSetDo (const fsSColour4B &pColour) override
virtual void	animationPlayDo (const fsStr &pAnimation, fsBool)
virtual fsBool	animationQueueDo (const fsStr &, fsBool)
virtual fsBool	animationTrackPlayDo (fsS32, const fsStr &, fsBool)
virtual fsBool	animationTrackQueueDo (fsS32, const fsStr &, fsBool)
virtual fsBool	animationTrackClearDo (fsS32)
virtual void	animationTracksClearDo ()
virtual void	animationMixDurationSetDo (fsS32)
virtual fsBool	skinSetDo (const fsStr &)
virtual fsBool	attachmentSetDo (const fsStr &, const fsStr &)
virtual std::shared_ptr< fsCBrush >	brushGetDo () const
Protected Member Functions inherited from fsIRenderable
	fsIRenderable ()=default
virtual	~fsIRenderable ()=default

Friends
class	fsCAnimationDataManager
class	fsCAnimationProviderSpriter

Additional Inherited Members
Protected Attributes inherited from fsIAnimatingSprite
fsBool	mActive
fsCSprite *	mAnimationRootSprt
Protected Attributes inherited from fsIRenderable
fsAffineMtx2d	mRenderMtx

Constructor & Destructor Documentation

~fsCAnimatingSpriteSpriter()

fsCAnimatingSpriteSpriter::~fsCAnimatingSpriteSpriter ( )

virtual

fsCAnimatingSpriteSpriter() [1/2]

fsCAnimatingSpriteSpriter::fsCAnimatingSpriteSpriter ( const fsCResourceName & pFileName, fsBool pHitMap, fsCSprite *const pAnimatingRootSprt )

protected

fsCAnimatingSpriteSpriter() [2/2]

fsCAnimatingSpriteSpriter::fsCAnimatingSpriteSpriter ( fsCSprite *const pAnimatingRootSprt )

protected

Member Function Documentation

activeSet()

void fsCAnimatingSpriteSpriter::activeSet ( fsBool pVisibility )

overrideprotectedvirtual

Implements fsIAnimatingSprite.

animationDataSetDo()

void fsCAnimatingSpriteSpriter::animationDataSetDo ( std::shared_ptr< fsIAnimationData > pAnimData )

overrideprotectedvirtual

Implements fsIAnimatingSprite.

animationPlayDo()

void fsCAnimatingSpriteSpriter::animationPlayDo ( const fsStr & pAnimation )

overrideprotectedvirtual

Reimplemented from fsIAnimatingSprite.

colourApplyToSpriteFrames()

void fsCAnimatingSpriteSpriter::colourApplyToSpriteFrames ( const fsSColour4B & pColour )

overrideprotectedvirtual

Implements fsIAnimatingSprite.

currentFrameGetDo()

fsS32 fsCAnimatingSpriteSpriter::currentFrameGetDo ( ) const

overrideprotectedvirtual

Implements fsIAnimatingSprite.

currentFrameHeightGetDo()

fsS32 fsCAnimatingSpriteSpriter::currentFrameHeightGetDo ( ) const

overrideprotectedvirtual

Implements fsIAnimatingSprite.

currentFramePosGetDo()

fsPoint fsCAnimatingSpriteSpriter::currentFramePosGetDo ( ) const

overrideprotectedvirtual

Implements fsIAnimatingSprite.

hitTestDo()

fsBool fsCAnimatingSpriteSpriter::hitTestDo ( const fsPoint & pPoint, fsBool pRequireHitMap ) const

overrideprotectedvirtual

Implements fsIAnimatingSprite.

loopingGetDo()

fsBool fsCAnimatingSpriteSpriter::loopingGetDo ( ) const

overrideprotectedvirtual

Implements fsIAnimatingSprite.

matrixApplyDo()

void fsCAnimatingSpriteSpriter::matrixApplyDo ( const fsAffineMtx2d & pRenderMtx )

overrideprotectedvirtual

Implements fsIRenderable.

renderDo()

void fsCAnimatingSpriteSpriter::renderDo ( )

overrideprotectedvirtual

Implements fsIRenderable.

resetDo()

void fsCAnimatingSpriteSpriter::resetDo ( )

overrideprotectedvirtual

Implements fsIAnimatingSprite.

updateDo()

void fsCAnimatingSpriteSpriter::updateDo ( fsS32 pDeltaMS )

overrideprotectedvirtual

Implements fsIAnimatingSprite.

Friends And Related Symbol Documentation

fsCAnimationDataManager

friend class fsCAnimationDataManager

friend

fsCAnimationProviderSpriter

friend class fsCAnimationProviderSpriter

friend

---

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

• /home/runner/work/fission/fission/libs/fsSpriter/src/fsCAnimatingSpriteSpriter.h
• /home/runner/work/fission/fission/libs/fsSpriter/src/fsCAnimatingSpriteSpriter.cpp