Fission FSN
Loading...
Searching...
No Matches
Public Member Functions | Protected Member Functions | Protected Attributes | Friends | List of all members
fsIAnimatingSprite Class Referenceabstract

#include <fsIAnimatingSprite.h>

Inheritance diagram for fsIAnimatingSprite:
Inheritance graph
[legend]

Public Member Functions

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

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)
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 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, fsCAnimatingSpriteSpine, 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, fsCAnimatingSpriteSpine, and fsCAnimatingSpriteSpriter.

◆ animationEventCallbackSet()

void fsIAnimatingSprite::animationEventCallbackSet ( fsTAnimationEventCallback pCallback)

◆ animationEventDispatch()

void fsIAnimatingSprite::animationEventDispatch ( const fsSAnimationEvent & pEvent) const
protected

◆ animationMixDurationSet()

void fsIAnimatingSprite::animationMixDurationSet ( fsS32 pDurationMs)

◆ animationMixDurationSetDo()

virtual void fsIAnimatingSprite::animationMixDurationSetDo ( fsS32 )
inlineprotectedvirtual

Reimplemented in fsCAnimatingSpriteSpine.

◆ animationPlay() [1/2]

void fsIAnimatingSprite::animationPlay ( const fsStr & pAnimation)

◆ animationPlay() [2/2]

void fsIAnimatingSprite::animationPlay ( const fsStr & pAnimation,
fsBool pLooping )

◆ animationPlayDo() [1/2]

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

Reimplemented in fsCAnimatingSpriteSpine, and fsCAnimatingSpriteSpriter.

◆ animationPlayDo() [2/2]

virtual void fsIAnimatingSprite::animationPlayDo ( const fsStr & pAnimation,
fsBool  )
inlineprotectedvirtual

Reimplemented in fsCAnimatingSpriteSpine.

◆ animationQueue()

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

◆ animationQueueDo()

virtual fsBool fsIAnimatingSprite::animationQueueDo ( const fsStr & ,
fsBool  )
inlineprotectedvirtual

Reimplemented in fsCAnimatingSpriteSpine.

◆ animationTrackClear()

fsBool fsIAnimatingSprite::animationTrackClear ( fsS32 pTrackIndex)

◆ animationTrackClearDo()

virtual fsBool fsIAnimatingSprite::animationTrackClearDo ( fsS32 )
inlineprotectedvirtual

Reimplemented in fsCAnimatingSpriteSpine.

◆ animationTrackPlay()

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

◆ animationTrackPlayDo()

virtual fsBool fsIAnimatingSprite::animationTrackPlayDo ( fsS32 ,
const fsStr & ,
fsBool  )
inlineprotectedvirtual

Reimplemented in fsCAnimatingSpriteSpine.

◆ animationTrackQueue()

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

◆ animationTrackQueueDo()

virtual fsBool fsIAnimatingSprite::animationTrackQueueDo ( fsS32 ,
const fsStr & ,
fsBool  )
inlineprotectedvirtual

Reimplemented in fsCAnimatingSpriteSpine.

◆ animationTracksClear()

void fsIAnimatingSprite::animationTracksClear ( )

◆ animationTracksClearDo()

virtual void fsIAnimatingSprite::animationTracksClearDo ( )
inlineprotectedvirtual

Reimplemented in fsCAnimatingSpriteSpine.

◆ attachmentSet()

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

◆ attachmentSetDo()

virtual fsBool fsIAnimatingSprite::attachmentSetDo ( const fsStr & ,
const fsStr &  )
inlineprotectedvirtual

Reimplemented in fsCAnimatingSpriteSpine.

◆ brushGet()

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

◆ brushGetDo()

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

Reimplemented in fsCAnimatingSpritePlayfirst, and fsCAnimatingSpriteSpine.

◆ colourApplyToSpriteFrames()

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

Implemented in fsCAnimatingSpritePlayfirst, fsCAnimatingSpriteSpine, 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, fsCAnimatingSpriteSpine, and fsCAnimatingSpriteSpriter.

◆ currentFrameHeightGet()

fsS32 fsIAnimatingSprite::currentFrameHeightGet ( ) const

◆ currentFrameHeightGetDo()

virtual fsS32 fsIAnimatingSprite::currentFrameHeightGetDo ( ) const
protectedpure virtual

Implemented in fsCAnimatingSpritePlayfirst, fsCAnimatingSpriteSpine, and fsCAnimatingSpriteSpriter.

◆ currentFramePosGet()

fsPoint fsIAnimatingSprite::currentFramePosGet ( ) const

◆ currentFramePosGetDo()

virtual fsPoint fsIAnimatingSprite::currentFramePosGetDo ( ) const
protectedpure virtual

Implemented in fsCAnimatingSpritePlayfirst, fsCAnimatingSpriteSpine, 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, fsCAnimatingSpriteSpine, and fsCAnimatingSpriteSpriter.

◆ loopingGet()

fsBool fsIAnimatingSprite::loopingGet ( ) const

◆ loopingGetDo()

virtual fsBool fsIAnimatingSprite::loopingGetDo ( ) const
protectedpure virtual

Implemented in fsCAnimatingSpritePlayfirst, fsCAnimatingSpriteSpine, and fsCAnimatingSpriteSpriter.

◆ reset()

void fsIAnimatingSprite::reset ( )

◆ resetDo()

virtual void fsIAnimatingSprite::resetDo ( )
protectedpure virtual

Implemented in fsCAnimatingSpritePlayfirst, fsCAnimatingSpriteSpine, and fsCAnimatingSpriteSpriter.

◆ skinSet()

fsBool fsIAnimatingSprite::skinSet ( const fsStr & pSkin)

◆ skinSetDo()

virtual fsBool fsIAnimatingSprite::skinSetDo ( const fsStr & )
inlineprotectedvirtual

Reimplemented in fsCAnimatingSpriteSpine.

◆ stop()

void fsIAnimatingSprite::stop ( )

◆ update()

void fsIAnimatingSprite::update ( fsS32 pDeltaMS)

◆ updateDo()

virtual void fsIAnimatingSprite::updateDo ( fsS32 pDeltaMS)
protectedpure virtual

Implemented in fsCAnimatingSpritePlayfirst, fsCAnimatingSpriteSpine, and fsCAnimatingSpriteSpriter.

◆ 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:
Generated on for Fission by doxygen 1.16.1