Fission FSN
Loading...
Searching...
No Matches
gfILensComponent.h
Go to the documentation of this file.
1/********************************************************************
2*
3* File: gfILensComponent.h
4*
5* Purpose: Interface class for all screen type interactions
6* Used as cover over normal game objects to control
7* user input and pass it on down the line to a target
8* entity - normally the current active sub scene, but
9* over ridable if need be
10*
11*********************************************************************/
12
13#ifndef gfILensComponenthdr
14#define gfILensComponenthdr
15
17
18struct fsPoint;
19
21{
22public:
23
24 void updatePos(fsPoint const& pPos, fsF32 pCurrentZoom, fsF32 pMinZoom);
25
26 void init(const fsPoint& pDimensions, const fsPoint& pScrollWindow, const fsPoint& pDragEnable,
27 const fsPoint& pLookAt);
28
29 fsPoint const& focusPointGet() const { return mFocusPoint; }
30 fsBool focusPointSet(fsPoint const& pPos);
31 fsBool focusPointUpdate(fsS32 pDeltaMS, fsF32 pCurrentZoom, fsF32 pMinZoom);
32 void focusPointCalculate(fsPoint const& pTapPos, fsF32 pCurrentZoom);
33
34 fsPoint scrollRangeCalculate(fsF32 pCurrentZoom, fsF32 pMinZoom);
35
36 void enabledAxisSet(const fsPoint& pPoint) { mEnabledAxis = pPoint; }
37
38 void startSet(fsPoint pStartPos);
39 void endSet(fsPoint pEndPos);
40 void clear();
41
42 fsCDrag();
43
44protected:
45
46private:
47
48 void moveSet(fsPoint pPos);
49 fsBool draggingInertiaGet() const { return mDragVelocity.x != 0.0f || mDragVelocity.y != 0.0f; }
50
51 fsPoint overScrollCalculate(fsF32 pCurrentZoom, fsF32 pMinZoom);
52 void scrollSnapBack(fsPoint const& pOverScroll);
53 void overDragDampen(fsPoint const& pOverScroll);
54 void deltaClear();
55 void dragDampen(fsPoint const& pOverScroll);
56
57 fsPoint mFocusPoint;
58 fsVec2d mFocusPointVelocity;
59
60 fsPoint mEnabledAxis;
61 fsBool mDragging;
62
63 fsPoint mPrevPos;
64 fsPoint mStartPos;
65 fsPoint mTouchDelta;
66
67 fsVec2d mDragVelocity;
68
69 fsPoint mDisplayDimensions;
70 fsPoint mDimensions;
71 fsPoint mScrollWindow;
72};
73
74
76{
77public:
78
79 void zoomSet(fsF32 pMin, fsF32 pMax, fsF32 pCurr);
80
82
83 fsF32 minZoomGet() const { return mMinScale; }
84 fsBool maxScale() const { return mMaxScale == mCurrScale; }
85 fsBool scaleUpdate(fsS32 pDeltaTime);
86 fsBool reset();
87 void toggle();
88
89 fsF32 currentScaleGet() const { return mCurrScale; }
90
91 void pinchZoomClear() { mPinchZoom = 0.0f; }
92
93 fsBool zoomingGet() const { return mZooming; }
94 void start(const fsPoint& pStartPosPointA, const fsPoint& pStartPosPointB);
95 void update(const fsPoint& pCurrPos, const fsPoint& pDelta, fsS32 pPointID);
96 void end(const fsPoint& pCurrPos, const fsPoint& pDelta, fsS32 pPointID);
97
98 fsCZoom();
99
100protected:
101private:
102
103 void pinchZoomCalculate();
104
105 fsBool mZooming;
106
107 fsPoint mPinchPrevPosA;
108 fsPoint mPinchPrevPosB;
109 fsF32 mPinchZoom;
110
111 fsF32 mMaxScale;
112 fsF32 mMinScale;
113 fsF32 mCurrScale;
114};
115
116
118{
119public:
120
122
127
128 void zoomSet(fsF32 pMin, fsF32 pMax, fsF32 pCurr);
129 void zoomClear();
130
131 // True while a second tap would count as a double tap and toggle the zoom.
133
134 virtual ~gfILensComponent();
135
136protected:
137
138 fsCEntity* const targetGet();
139 virtual fsCEntity* const targetGetDo();
140
141 void zoomAndScrollReset();
142
143 void updateDo(fsS32 pDeltaMs) override;
144
145 virtual void doOnTap(const fsPoint& pTapPos);
146
147 virtual void doOnDragStart(const fsPoint& pStartPos);
148 virtual void doOnDragMove(const fsPoint& pCurrPos);
149 virtual void doOnDragEnd(const fsPoint& pEndPos);
150
151 virtual void doOnPinchStart(const fsPoint& pStartPosPointA, const fsPoint& pStartPosPointB);
152 virtual void doOnPinchMove(const fsPoint& pCurrPos, const fsPoint& pDelta, fsS32 pPointID);
153 virtual void doOnPinchEnd(const fsPoint& pCurrPos, const fsPoint& pDelta, fsS32 pPointID);
154
155 gfILensComponent(fsCEntity* pParent, fsBool pHandleTaps, fsBool pHandleDragEvent, fsBool pHandlePinchEvents);
156
159
160 std::unique_ptr<fsCDrag> mDrag;
161 std::unique_ptr<fsCZoom> mZoom;
162
164
165 // The active subscene's authored position is its home; the drag focus point is a
166 // scroll offset applied on top of it, so an off-centre subscene keeps its placement
167 // instead of being slammed to (0,0) when the lens first takes it as a target.
169 fsVec2d mHomePos{0.0f, 0.0f};
170
171private:
172
173 void dragMessageBroadcast(const fsPoint& pCurrentPot);
174
175 void activeSubSceneUpdate();
176 fsS32 mySubsceneGroupID() const;
177
178 void onTap(const fsPoint& pTapPos) override;
179
180 void cheatTaps();
181 void masterCheatMenuToggle();
182
183 void onDragStart(const fsPoint& pStartPos) override;
184 void onDragMove(const fsPoint& pCurrPos) override;
185 void onDragEnd(const fsPoint& pEndPos) override;
186
187 void onPinchStart(const fsPoint& pStartPosPointA, const fsPoint& pStartPosPointB) override;
188 void onPinchMove(const fsPoint& pCurrPos, const fsPoint& pDelta, fsS32 pPointID) override;
189 void onPinchEnd(const fsPoint& pCurrPos, const fsPoint& pDelta, fsS32 pPointID) override;
190
191 fsS32 mDoubleTapTime;
192 fsS32 mCheatMenuCount;
193 fsS32 mCheatMenuTapTime;
194};
195
196#endif
void init(const fsPoint &pDimensions, const fsPoint &pScrollWindow, const fsPoint &pDragEnable, const fsPoint &pLookAt)
Definition gfILensComponent.cpp:652
void enabledAxisSet(const fsPoint &pPoint)
Definition gfILensComponent.h:36
void clear()
Definition gfILensComponent.cpp:619
void updatePos(fsPoint const &pPos, fsF32 pCurrentZoom, fsF32 pMinZoom)
Definition gfILensComponent.cpp:369
fsBool focusPointSet(fsPoint const &pPos)
Definition gfILensComponent.cpp:645
void focusPointCalculate(fsPoint const &pTapPos, fsF32 pCurrentZoom)
Definition gfILensComponent.cpp:626
void startSet(fsPoint pStartPos)
Definition gfILensComponent.cpp:604
fsCDrag()
Definition gfILensComponent.cpp:661
fsPoint scrollRangeCalculate(fsF32 pCurrentZoom, fsF32 pMinZoom)
Definition gfILensComponent.cpp:511
void endSet(fsPoint pEndPos)
Definition gfILensComponent.cpp:588
fsPoint const & focusPointGet() const
Definition gfILensComponent.h:29
fsBool focusPointUpdate(fsS32 pDeltaMS, fsF32 pCurrentZoom, fsF32 pMinZoom)
Definition gfILensComponent.cpp:416
Definition fsCEntity.h:39
Definition fsCUniqueId.h:21
fsBool maxScale() const
Definition gfILensComponent.h:84
void pinchZoomClear()
Definition gfILensComponent.h:91
fsF32 currentScaleGet() const
Definition gfILensComponent.h:89
fsCZoom()
Definition gfILensComponent.cpp:767
fsBool reset()
Definition gfILensComponent.cpp:699
fsBool zoomingGet() const
Definition gfILensComponent.h:93
void toggle()
Definition gfILensComponent.cpp:706
void end(const fsPoint &pCurrPos, const fsPoint &pDelta, fsS32 pPointID)
Definition gfILensComponent.cpp:754
fsPoint pinchZoomCentrePointGet()
Definition gfILensComponent.cpp:726
fsF32 minZoomGet() const
Definition gfILensComponent.h:83
void update(const fsPoint &pCurrPos, const fsPoint &pDelta, fsS32 pPointID)
Definition gfILensComponent.cpp:741
fsBool scaleUpdate(fsS32 pDeltaTime)
Definition gfILensComponent.cpp:686
void zoomSet(fsF32 pMin, fsF32 pMax, fsF32 pCurr)
Definition gfILensComponent.cpp:679
void start(const fsPoint &pStartPosPointA, const fsPoint &pStartPosPointB)
Definition gfILensComponent.cpp:732
fsIGestureHandlingComponent(fsCEntity *pParent, fsBool pHandleTaps, fsBool pHandleDragEvent, fsBool pHandlePinchEvents)
Definition fsIGestureHandlingComponent.cpp:521
fsPoint mDragPos
Definition gfILensComponent.h:157
virtual fsCEntity *const targetGetDo()
Definition gfILensComponent.cpp:113
fsS32 mRunningTime
Definition gfILensComponent.h:158
void updateDo(fsS32 pDeltaMs) override
Definition gfILensComponent.cpp:69
fsVec2d mHomePos
Definition gfILensComponent.h:169
fsCEntity *const targetGet()
Definition gfILensComponent.cpp:108
virtual void doOnDragEnd(const fsPoint &pEndPos)
Definition gfILensComponent.cpp:276
std::unique_ptr< fsCDrag > mDrag
Definition gfILensComponent.h:160
virtual void doOnTap(const fsPoint &pTapPos)
Definition gfILensComponent.cpp:184
std::unique_ptr< fsCZoom > mZoom
Definition gfILensComponent.h:161
virtual ~gfILensComponent()
Definition gfILensComponent.cpp:365
virtual void doOnPinchStart(const fsPoint &pStartPosPointA, const fsPoint &pStartPosPointB)
Definition gfILensComponent.cpp:215
fsCEntity * mHomeTarget
Definition gfILensComponent.h:168
void zoomClear()
Definition gfILensComponent.cpp:60
virtual void doOnDragStart(const fsPoint &pStartPos)
Definition gfILensComponent.cpp:243
virtual void doOnPinchEnd(const fsPoint &pCurrPos, const fsPoint &pDelta, fsS32 pPointID)
Definition gfILensComponent.cpp:235
fsBool doubleTapPendingGet() const
Definition gfILensComponent.cpp:179
void zoomSet(fsF32 pMin, fsF32 pMax, fsF32 pCurr)
Definition gfILensComponent.cpp:55
virtual void doOnPinchMove(const fsPoint &pCurrPos, const fsPoint &pDelta, fsS32 pPointID)
Definition gfILensComponent.cpp:227
virtual void doOnDragMove(const fsPoint &pCurrPos)
Definition gfILensComponent.cpp:267
static const fsCUniqueId mDragMessage
Definition gfILensComponent.h:121
void zoomAndScrollReset()
Definition gfILensComponent.cpp:133
gfILensComponent(fsCEntity *pParent, fsBool pHandleTaps, fsBool pHandleDragEvent, fsBool pHandlePinchEvents)
Definition gfILensComponent.cpp:353
fsCEntity * mInitialisedTarget
Definition gfILensComponent.h:163
bool fsBool
Definition fsBaseTypes.h:26
int fsS32
Definition fsBaseTypes.h:20
float fsF32
Definition fsBaseTypes.h:28
Definition fsIMessageDispatcher.h:32
Definition fsPoint.h:17
Definition fsVec2d.h:16
fsF32 y
Definition fsVec2d.h:34
fsF32 x
Definition fsVec2d.h:33
Definition gfILensComponent.h:124
fsPoint mDragDelta
Definition gfILensComponent.h:125