fsIAnimatingSprite Class Reference

#include <fsIAnimatingSprite.h>

Inheritance diagram for fsIAnimatingSprite:

Public Member Functions
void	animationPlay (const fsStr &pAnimation)
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
void	animationDataSet (std::shared_ptr< fsIAnimationData > pAnimData)
void	colourSetDo (const fsSColour4B &pColour) override
virtual void	animationPlayDo (const fsStr &pAnimation)
virtual void	activeSet (fsBool pVisibility)=0
virtual void	colourApplyToSpriteFrames (const fsSColour4B &pColour)=0
virtual void	animationDataSetDo (std::shared_ptr< fsIAnimationData > pAnimData)=0
virtual fsS32	currentFrameHeightGetDo () const =0
virtual fsPoint	currentFramePosGetDo () const =0
virtual std::shared_ptr< fsCBrush >	brushGetDo () const
virtual fsBool	hitTestDo (const fsPoint &pPoint, fsBool pRequireHitMap) const =0
virtual fsS32	currentFrameGetDo () const =0
virtual void	updateDo (fsS32 pDeltaMS)=0
virtual fsBool	loopingGetDo () const =0
virtual void	resetDo ()=0
Protected Member Functions inherited from fsIRenderable
virtual void	matrixApplyDo (const fsAffineMtx2d &pRenderMatrix)=0
virtual void	renderDo ()=0
	fsIRenderable ()=default
virtual	~fsIRenderable ()=default

Protected Attributes
fsBool	mActive
fsCSprite *	mAnimationRootSprt
Protected Attributes inherited from fsIRenderable
fsAffineMtx2d	mRenderMtx

Friends
std::shared_ptr< fsIAnimatingSprite > const	fsCAnimationDataManager::createAnimationInstance (std::shared_ptr< fsIAnimationData >, fsCSprite *pAnimatingRootSprt)

Constructor & Destructor Documentation

fsIAnimatingSprite() [1/2]

fsIAnimatingSprite::fsIAnimatingSprite	(	const fsCResourceName &	pFileName,
		fsBool	pHitMap,
		fsCSprite *	pAnimatingSpriteRoot )

fsIAnimatingSprite() [2/2]

fsIAnimatingSprite::fsIAnimatingSprite

(

fsCSprite *

pAnimatingRootSprt

)

~fsIAnimatingSprite()

fsIAnimatingSprite::~fsIAnimatingSprite ( )

virtual

Member Function Documentation

activeSet()

virtual void fsIAnimatingSprite::activeSet ( fsBool pVisibility )

protectedpure virtual

Implemented in fsCAnimatingSpritePlayfirst, and fsCAnimatingSpriteSpriter.

animatingGet()

fsBool fsIAnimatingSprite::animatingGet

(

)

const

animationDataSet()

void fsIAnimatingSprite::animationDataSet ( std::shared_ptr< fsIAnimationData > pAnimData )

protected

animationDataSetDo()

virtual void fsIAnimatingSprite::animationDataSetDo ( std::shared_ptr< fsIAnimationData > pAnimData )

protectedpure virtual

Implemented in fsCAnimatingSpritePlayfirst, and fsCAnimatingSpriteSpriter.

animationPlay()

void fsIAnimatingSprite::animationPlay

(

const fsStr &

pAnimation

)

animationPlayDo()

virtual void fsIAnimatingSprite::animationPlayDo ( const fsStr & pAnimation )

inlineprotectedvirtual

Reimplemented in fsCAnimatingSpriteSpriter.

brushGet()

std::shared_ptr< fsCBrush > fsIAnimatingSprite::brushGet

(

)

const

brushGetDo()

std::shared_ptr< fsCBrush > fsIAnimatingSprite::brushGetDo ( ) const

protectedvirtual

Reimplemented in fsCAnimatingSpritePlayfirst.

colourApplyToSpriteFrames()

virtual void fsIAnimatingSprite::colourApplyToSpriteFrames ( const fsSColour4B & pColour )

protectedpure virtual

Implemented in fsCAnimatingSpritePlayfirst, and fsCAnimatingSpriteSpriter.

colourSetDo()

void fsIAnimatingSprite::colourSetDo ( const fsSColour4B & pColour )

overrideprotectedvirtual

Reimplemented from fsIRenderable.

currentFrameGet()

fsS32 fsIAnimatingSprite::currentFrameGet

(

)

const

currentFrameGetDo()

virtual fsS32 fsIAnimatingSprite::currentFrameGetDo ( ) const

protectedpure virtual

Implemented in fsCAnimatingSpritePlayfirst, and fsCAnimatingSpriteSpriter.

currentFrameHeightGet()

fsS32 fsIAnimatingSprite::currentFrameHeightGet

(

)

const

currentFrameHeightGetDo()

virtual fsS32 fsIAnimatingSprite::currentFrameHeightGetDo ( ) const

protectedpure virtual

Implemented in fsCAnimatingSpritePlayfirst, and fsCAnimatingSpriteSpriter.

currentFramePosGet()

fsPoint fsIAnimatingSprite::currentFramePosGet

(

)

const

currentFramePosGetDo()

virtual fsPoint fsIAnimatingSprite::currentFramePosGetDo ( ) const

protectedpure virtual

Implemented in fsCAnimatingSpritePlayfirst, and fsCAnimatingSpriteSpriter.

hitTest()

fsBool fsIAnimatingSprite::hitTest	(	const fsPoint &	pPoint,
		fsBool	pRequireHitMap ) const

hitTestDo()

virtual fsBool fsIAnimatingSprite::hitTestDo ( const fsPoint & pPoint, fsBool pRequireHitMap ) const

protectedpure virtual

Implemented in fsCAnimatingSpritePlayfirst, and fsCAnimatingSpriteSpriter.

loopingGet()

fsBool fsIAnimatingSprite::loopingGet

(

)

const

loopingGetDo()

virtual fsBool fsIAnimatingSprite::loopingGetDo ( ) const

protectedpure virtual

Implemented in fsCAnimatingSpritePlayfirst, and fsCAnimatingSpriteSpriter.

reset()

void fsIAnimatingSprite::reset

(

)

resetDo()

virtual void fsIAnimatingSprite::resetDo ( )

protectedpure virtual

Implemented in fsCAnimatingSpritePlayfirst, and fsCAnimatingSpriteSpriter.

stop()

void fsIAnimatingSprite::stop

(

)

update()

void fsIAnimatingSprite::update

(

fsS32

pDeltaMS

)

updateDo()

virtual void fsIAnimatingSprite::updateDo ( fsS32 pDeltaMS )

protectedpure virtual

Implemented in fsCAnimatingSpritePlayfirst, and fsCAnimatingSpriteSpriter.

Friends And Related Symbol Documentation

fsCAnimationDataManager::createAnimationInstance

std::shared_ptr< fsIAnimatingSprite > const fsCAnimationDataManager::createAnimationInstance ( std::shared_ptr< fsIAnimationData > , fsCSprite * pAnimatingRootSprt )

friend

Member Data Documentation

mActive

fsBool fsIAnimatingSprite::mActive

protected

mAnimationRootSprt

fsCSprite* fsIAnimatingSprite::mAnimationRootSprt

protected

---

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

• /home/runner/work/fission/fission/libs/fsRenderer/fsIAnimatingSprite.h
• /home/runner/work/fission/fission/libs/fsRenderer/fsIAnimatingSprite.cpp