aboutsummaryrefslogtreecommitdiff
path: root/engines/titanic/support/mouse_cursor.h
blob: 325e31de964fa2498687e1f9398c84d7533c3383 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
/* ScummVM - Graphic Adventure Engine
 *
 * ScummVM is the legal property of its developers, whose names
 * are too numerous to list here. Please refer to the COPYRIGHT
 * file distributed with this source distribution.
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 *
 */

#ifndef TITANIC_MOUSE_CURSOR_H
#define TITANIC_MOUSE_CURSOR_H

#include "common/scummsys.h"
#include "graphics/managed_surface.h"
#include "titanic/support/rect.h"

namespace Titanic {

#define NUM_CURSORS 15

enum CursorId {
	CURSOR_ARROW = 1,
	CURSOR_MOVE_LEFT = 2,
	CURSOR_MOVE_RIGHT = 3,
	CURSOR_MOVE_FORWARD = 4,
	CURSOR_MOVE_UP = 5,
	CURSOR_MOVE_DOWN1 = 6,
	CURSOR_MOVE_FORWARD2 = 7,
	CURSOR_HAND = 8,
	CURSOR_ACTIVATE = 9,
	CURSOR_INVALID = 10,
	CURSOR_MAGNIFIER = 11,
	CURSOR_IGNORE = 12,
	CURSOR_BACKWARDS = 13,
	CURSOR_DOWN = 14,
	CURSOR_HOURGLASS = 15
};

class CScreenManager;
class CVideoSurface;

class CMouseCursor {
	struct CursorEntry {
		CVideoSurface *_videoSurface;
		Graphics::ManagedSurface *_transSurface;
		Common::Point _centroid;

		CursorEntry() : _videoSurface(nullptr), _transSurface(nullptr) {}
		~CursorEntry();
	};
private:
	CScreenManager *_screenManager;
	CursorId _cursorId;
	CursorEntry _cursors[NUM_CURSORS];
	uint _setCursorCount;
	int _hideCounter;
	int _busyCount;
	bool _cursorSuppressed;
	int _fieldE8;
	Common::Point _moveStartPos;
	Common::Point _moveDestPos;
	uint _moveStartTime, _moveEndTime;

	/**
	 * Load the images for each cursor
	 */
	void loadCursorImages();
public:
	bool _inputEnabled;
public:
	CMouseCursor(CScreenManager *screenManager);
	~CMouseCursor();

	/**
	 * Increment the busy count for the cursor, showing an hourglass
	 */
	void incBusyCount();

	/**
	 * Decrements the busy count, resetting back to an arrow cursor
	 * when the count reaches zero
	 */
	void decBusyCount();

	/**
	 * Decrements the hide counter, and shows the mouse if
	 * it's reached zero
	 */
	void incHideCounter();

	/**
	 * Increments the hide counter, hiding the mouse if it's the first call
	 */
	void decHideCounter();

	/**
	 * Suppresses the cursor. When suppressed, the cursor isn't drawn,
	 * even if it's not otherwise being hidden
	 */
	void suppressCursor();

	/**
	 * Unflags the cursor as being suppressed, allowing it to be drawn
	 * again if it's enabled
	 */
	void unsuppressCursor();

	/**
	 * Set the cursor
	 */
	void setCursor(CursorId cursorId);

	/**
	 * Updates the mouse cursor
	 */
	void update();

	/**
	 * Returns the number of times the cursor has been set
	 */
	uint getChangeCount() const { return _setCursorCount; }

	/**
	 * Disables user control of the mouse
	 */
	void disableControl();

	/**
	 * Re-enables user control of the mouse
	 */
	void enableControl();

	/**
	 * Move the mouse to a new position
	 */
	void setPosition(const Point &pt, double duration);
};


} // End of namespace Titanic

#endif /* TITANIC_MOUSE_CURSOR_H */