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
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
|
// ____ _ __
// / __ )____ _____ | | / /___ ___________
// / __ / __ \/ ___/ | | /| / / __ `/ ___/ ___/
// / /_/ / /_/ (__ ) | |/ |/ / /_/ / / (__ )
// /_____/\____/____/ |__/|__/\__,_/_/ /____/
//
// A futuristic real-time strategy game.
// This file is part of Bos Wars.
//
/**@name cursor.h - The cursors header file. */
//
// (c) Copyright 1998-2007 by Lutz Sammer
//
// 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; only version 2 of the License.
//
// 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., 59 Temple Place - Suite 330, Boston, MA
// 02111-1307, USA.
#ifndef __CURSOR_H__
#define __CURSOR_H__
//@{
/*----------------------------------------------------------------------------
-- Documentation
----------------------------------------------------------------------------*/
/**
** @class CCursor cursor.h
**
** \#include "cursor.h"
**
** This structure contains all informations about a cursor.
** The cursor changes depending of the current user input state.
** A cursor can have transparent areas and color cycle animated.
**
** The cursor-type structure members:
**
** CCursor::Ident
**
** Unique identifier of the cursor, used to reference it in config
** files and during startup. Don't use this in game, use instead
** the pointer to this structure.
**
** CCursor::HotX CCursor::HotY
**
** Hot spot of the cursor in pixels. Relative to the sprite origin
** (0,0). The hot spot of a cursor is the point to which Stratagus
** refers in tracking the cursor's position.
**
** CCursor::SpriteFrame
**
** Current displayed cursor frame.
** From 0 to CCursor::G::NumFrames.
**
** CCursor::FrameRate
**
** Rate of changing the frames. The "rate" tells the engine how
** many milliseconds to hold each frame of the animation.
**
** @note This is the first time that for timing ms are used! I would
** change it to display frames.
**
** CCursor::G
**
** Contains the sprite of the cursor, loaded from CCursor::File.
** This can be a multicolor image with alpha or transparency.
*/
/**
** @class CursorConfig cursor.h
**
** \#include "cursor.h"
**
** This structure contains all information to reference/use a cursor.
** It is normally used in other config structures.
**
** CursorConfig::Name
**
** Name to reference this cursor-type. Used while initialization.
** (See CCursor::Ident)
**
** CursorConfig::Cursor
**
** Pointer to this cursor-type. Used while runtime.
*/
/*----------------------------------------------------------------------------
-- Includes
----------------------------------------------------------------------------*/
#include <vector>
/*----------------------------------------------------------------------------
-- Declarations
----------------------------------------------------------------------------*/
class CGraphic;
class CUnitType;
/*----------------------------------------------------------------------------
-- Definitions
----------------------------------------------------------------------------*/
/// Private type which specifies the cursor-type
class CCursor {
public:
CCursor() : HotX(0), HotY(0),
SpriteFrame(0), FrameRate(0), G(NULL) {}
std::string Ident; /// Identifier to reference it
int HotX; /// Hot point x
int HotY; /// Hot point y
int SpriteFrame; /// Current displayed cursor frame
int FrameRate; /// Rate of changing the frames
// --- FILLED UP ---
CGraphic *G; /// Cursor sprite image
};
/// Cursor config reference
class CursorConfig {
public:
CursorConfig() : Cursor(NULL) {}
void Load();
std::string Name; /// Config cursor-type name
CCursor *Cursor; /// Cursor-type pointer
};
/// Cursor state
enum CursorStates {
CursorStatePoint, /// Normal cursor
CursorStateSelect, /// Select position
CursorStateRectangle, /// Rectangle selecting
CursorStatePieMenu, /// Displaying Pie Menu
};
/*----------------------------------------------------------------------------
-- Variables
----------------------------------------------------------------------------*/
extern std::vector<CCursor> AllCursors;/// cursor-types description
extern CursorStates CursorState; /// current cursor state (point,...)
extern int CursorAction; /// action for selection
extern int CursorValue; /// value for action (spell type f.e.)
extern CUnitType *CursorBuilding; /// building cursor
extern CCursor *GameCursor; /// cursor-type
extern int CursorX; /// cursor position on screen X
extern int CursorY; /// cursor position on screen Y
extern int CursorStartX; /// rectangle started on screen X
extern int CursorStartY; /// rectangle started on screen Y
extern int CursorStartScrMapX; /// the same in screen map coordinate system
extern int CursorStartScrMapY; /// the same in screen map coordinate system
/*----------------------------------------------------------------------------
-- Functions
----------------------------------------------------------------------------*/
/// Load all cursors
extern void LoadCursors();
/// Cursor by identifier
extern CCursor *CursorByIdent(const std::string &ident);
/// Draw any cursor
extern void DrawCursor(void);
/// Hide the cursor
extern void HideCursor(void);
/// Animate the cursor
extern void CursorAnimate(unsigned ticks);
/// Initialize the cursor module
extern void InitVideoCursors(void);
/// Cleanup the cursor module
extern void CleanCursors(void);
//@}
#endif // !__CURSOR_H__
|
