Fission FSN
Loading...
Searching...
No Matches
fsIAnimatingSprite.h
Go to the documentation of this file.
1/********************************************************************
2*
3* File: fsIAnimatingSprite.h
4*
5* Purpose: Interface for animating sprites
6*
7*********************************************************************/
8
9#ifndef fsIAnimatingSpritehdr
10#define fsIAnimatingSpritehdr
11
12#include <memory>
13
14#include <fsCore/fsBaseTypes.h>
15
16#include "fsAnimationEvent.h"
17#include "fsIRenderable.h"
19
20class fsCResourceName;
21class fsAffineMtx2d;
22class fsStr;
25class fsCSpriteFrame;
26struct fsPoint;
27class fsSColour;
28class fsCSprite;
29class fsCBrush;
30
31
33{
34 friend std::shared_ptr<fsIAnimatingSprite> const fsCAnimationDataManager::createAnimationInstance(
35 std::shared_ptr<fsIAnimationData>, fsCSprite* pAnimatingRootSprt);
36
37public:
38
39 void animationPlay(const fsStr& pAnimation);
40 fsBool animationQueue(const fsStr& pAnimation);
41 fsBool animationTrackPlay(fsS32 pTrackIndex, const fsStr& pAnimation);
42 fsBool animationTrackQueue(fsS32 pTrackIndex, const fsStr& pAnimation);
43 fsBool animationTrackClear(fsS32 pTrackIndex);
45 void animationMixDurationSet(fsS32 pDurationMs);
46 fsBool skinSet(const fsStr& pSkin);
47 fsBool attachmentSet(const fsStr& pSlot, const fsStr& pAttachment);
49
52
53 void stop();
54
55 std::shared_ptr<fsCBrush> brushGet() const;
56 fsBool hitTest(const fsPoint& pPoint, fsBool pRequireHitMap) const;
57
58 fsS32 currentFrameGet() const;
59
60 void update(fsS32 pDeltaMS);
61
62 fsBool animatingGet() const;
63 fsBool loopingGet() const;
64
65
66 void reset();
67
68 fsIAnimatingSprite(fsCSprite* pAnimatingRootSprt);
69 ~fsIAnimatingSprite() override;
70
71protected:
72
73 void animationDataSet(std::shared_ptr<fsIAnimationData> pAnimData);
74 void animationEventDispatch(const fsSAnimationEvent& pEvent) const;
75 void colourSetDo(const fsSColour4B& pColour) override;
76
77 virtual void animationPlayDo(const fsStr& pAnimation)
78 {
79 };
81 {
82 return false;
83 }
85 {
86 return false;
87 }
89 {
90 return false;
91 }
93 {
94 return false;
95 }
97 {
98 }
100 {
101 }
102 virtual fsBool skinSetDo(const fsStr&)
103 {
104 return false;
105 }
106 virtual fsBool attachmentSetDo(const fsStr&, const fsStr&)
107 {
108 return false;
109 }
110
111 virtual void colourApplyToSpriteFrames(const fsSColour4B& pColour) = 0;
112 virtual void animationDataSetDo(std::shared_ptr<fsIAnimationData> pAnimData) = 0;
113
114 virtual fsS32 currentFrameHeightGetDo() const = 0;
115 virtual fsPoint currentFramePosGetDo() const = 0;
116
117 virtual std::shared_ptr<fsCBrush> brushGetDo() const;
118 virtual fsBool hitTestDo(const fsPoint& pPoint, fsBool pRequireHitMap) const = 0;
119
120 virtual fsS32 currentFrameGetDo() const = 0;
121 virtual void updateDo(fsS32 pDeltaMS) = 0;
122
123 virtual fsBool loopingGetDo() const = 0;
124 virtual void resetDo() = 0;
125
128
129private:
130 fsTAnimationEventCallback mAnimationEventCallback;
131};
132
133#endif
Definition fsAffineMtx2d.h:27
std::shared_ptr< fsIAnimatingSprite > const createAnimationInstance(std::shared_ptr< fsIAnimationData >, fsCSprite *pAnimatingRootSprt)
Definition fsCAnimationDataManager.cpp:42
Definition fsCAnimationTimeline.h:25
Definition fsCBrush.h:26
Definition fsCResourceName.h:32
Definition fsCSpriteFrame.h:30
Definition fsCSprite.h:24
void reset()
Definition fsIAnimatingSprite.cpp:127
virtual fsBool animationQueueDo(const fsStr &)
Definition fsIAnimatingSprite.h:80
virtual fsBool attachmentSetDo(const fsStr &, const fsStr &)
Definition fsIAnimatingSprite.h:106
void update(fsS32 pDeltaMS)
Definition fsIAnimatingSprite.cpp:112
virtual void animationTracksClearDo()
Definition fsIAnimatingSprite.h:96
virtual void colourApplyToSpriteFrames(const fsSColour4B &pColour)=0
virtual fsBool animationTrackClearDo(fsS32)
Definition fsIAnimatingSprite.h:92
virtual std::shared_ptr< fsCBrush > brushGetDo() const
Definition fsIAnimatingSprite.cpp:9
fsBool animationTrackClear(fsS32 pTrackIndex)
Definition fsIAnimatingSprite.cpp:39
virtual void updateDo(fsS32 pDeltaMS)=0
fsBool animationTrackPlay(fsS32 pTrackIndex, const fsStr &pAnimation)
Definition fsIAnimatingSprite.cpp:29
fsIAnimatingSprite(fsCSprite *pAnimatingRootSprt)
Definition fsIAnimatingSprite.cpp:132
fsBool animationTrackQueue(fsS32 pTrackIndex, const fsStr &pAnimation)
Definition fsIAnimatingSprite.cpp:34
void animationTracksClear()
Definition fsIAnimatingSprite.cpp:44
fsBool loopingGet() const
Definition fsIAnimatingSprite.cpp:122
virtual fsBool animationTrackPlayDo(fsS32, const fsStr &)
Definition fsIAnimatingSprite.h:84
virtual fsS32 currentFrameGetDo() const =0
void animationPlay(const fsStr &pAnimation)
Definition fsIAnimatingSprite.cpp:19
void stop()
Definition fsIAnimatingSprite.cpp:97
virtual fsPoint currentFramePosGetDo() const =0
virtual void animationPlayDo(const fsStr &pAnimation)
Definition fsIAnimatingSprite.h:77
fsS32 currentFrameGet() const
Definition fsIAnimatingSprite.cpp:107
virtual fsS32 currentFrameHeightGetDo() const =0
fsBool animationQueue(const fsStr &pAnimation)
Definition fsIAnimatingSprite.cpp:24
virtual void animationDataSetDo(std::shared_ptr< fsIAnimationData > pAnimData)=0
virtual fsBool loopingGetDo() const =0
fsBool attachmentSet(const fsStr &pSlot, const fsStr &pAttachment)
Definition fsIAnimatingSprite.cpp:59
void animationEventCallbackSet(fsTAnimationEventCallback pCallback)
Definition fsIAnimatingSprite.cpp:64
virtual fsBool animationTrackQueueDo(fsS32, const fsStr &)
Definition fsIAnimatingSprite.h:88
std::shared_ptr< fsCBrush > brushGet() const
Definition fsIAnimatingSprite.cpp:14
~fsIAnimatingSprite() override
Definition fsIAnimatingSprite.cpp:138
virtual void animationMixDurationSetDo(fsS32)
Definition fsIAnimatingSprite.h:99
fsCSprite * mAnimationRootSprt
Definition fsIAnimatingSprite.h:127
virtual fsBool skinSetDo(const fsStr &)
Definition fsIAnimatingSprite.h:102
void colourSetDo(const fsSColour4B &pColour) override
Definition fsIAnimatingSprite.cpp:77
virtual void resetDo()=0
virtual fsBool hitTestDo(const fsPoint &pPoint, fsBool pRequireHitMap) const =0
void animationMixDurationSet(fsS32 pDurationMs)
Definition fsIAnimatingSprite.cpp:49
fsPoint currentFramePosGet() const
Definition fsIAnimatingSprite.cpp:92
fsBool animatingGet() const
Definition fsIAnimatingSprite.cpp:117
void animationEventDispatch(const fsSAnimationEvent &pEvent) const
Definition fsIAnimatingSprite.cpp:69
fsS32 currentFrameHeightGet() const
Definition fsIAnimatingSprite.cpp:87
fsBool skinSet(const fsStr &pSkin)
Definition fsIAnimatingSprite.cpp:54
fsBool hitTest(const fsPoint &pPoint, fsBool pRequireHitMap) const
Definition fsIAnimatingSprite.cpp:102
fsBool mActive
Definition fsIAnimatingSprite.h:126
void animationDataSet(std::shared_ptr< fsIAnimationData > pAnimData)
Definition fsIAnimatingSprite.cpp:82
Definition fsIAnimationData.h:18
fsIRenderable()=default
Definition fsSColour.h:20
Definition fsStr.h:23
std::function< void(const fsSAnimationEvent &)> fsTAnimationEventCallback
Definition fsAnimationEvent.h:34
bool fsBool
Definition fsBaseTypes.h:26
int fsS32
Definition fsBaseTypes.h:20
Definition fsPoint.h:17
Definition fsAnimationEvent.h:11
Definition fsSColour.h:54