Mercurial > fife-parpg

comparison engine/core/video/cursor.h @ 0:4a0efb7baf70

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
* Datasets becomes the new trunk and retires after that :-)
author mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
date Sun, 29 Jun 2008 18:44:17 +0000
parents
children 90005975cdbb
comparison
equal deleted inserted replaced
-1:000000000000 0:4a0efb7baf70
1 /***************************************************************************
2 * Copyright (C) 2005-2008 by the FIFE Team *
3 * http://www.fifengine.de *
4 * This file is part of FIFE. *
5 * *
6 * FIFE is free software; you can redistribute it and/or modify *
7 * it under the terms of the GNU General Public License as published by *
8 * the Free Software Foundation; either version 2 of the License, or *
9 * (at your option) any later version. *
10 * *
11 * This program is distributed in the hope that it will be useful, *
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of *
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
14 * GNU General Public License for more details. *
15 * *
16 * You should have received a copy of the GNU General Public License *
17 * along with this program; if not, write to the *
18 * Free Software Foundation, Inc., *
19 * 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA *
20 ***************************************************************************/
21
22 #ifndef FIFE_CURSOR_H
23 #define FIFE_CURSOR_H
24
25 // Standard C++ library includes
26
27 // 3rd party library includes
28
29 // FIFE includes
30 // These includes are split up in two parts, separated by one empty line
31 // First block: files included from the FIFE root src directory
32 // Second block: files included from the same folder
33
34 namespace FIFE {
35
36 class ImagePool;
37 class AnimationPool;
38 class RenderBackend;
39 class TimeManager;
40
41 /** Defines the type of shown cursor
42 * native -> default cursor
43 * image -> cursor from image pool
44 * animation -> cursor from animation pool
45 */
46 enum MouseCursorType {
47 CURSOR_NONE,
48 CURSOR_NATIVE,
49 CURSOR_IMAGE,
50 CURSOR_ANIMATION
51 };
52
53 /** Cursor class manages mouse cursor handling
54 */
55 class Cursor {
56 public:
57 /** Constructor.
58 */
59 Cursor(ImagePool* imgpool, AnimationPool* animpool, RenderBackend* renderbackend);
60
61 /** Destructor.
62 */
63 virtual ~Cursor() {}
64
65 /** draws cursor on screen
66 */
67 virtual void draw();
68
69 /** Sets the current mouse cursor type and possible pool value
70 * @param ctype cursor type
71 * @param cursor_id pool id for the cursor (either image or animation)
72 */
73 void set(MouseCursorType ctype, unsigned int cursor_id=0);
74
75 /** Sets the current drag cursor type and pool value
76 * @param ctype drag cursor type
77 * @param drag_id pool id for the drag cursor (either image or animation)
78 * @param drag_offset offset of drag image shown with cursor
79 */
80 void setDrag(MouseCursorType ctype, unsigned int drag_id=0, int drag_offset_x=0, int drag_offset_y=0);
81
82 /** Gets the current mouse cursor type
83 */
84 MouseCursorType getType() const { return m_cursor_type; }
85
86 /** Gets the current mouse cursor pool id
87 */
88 unsigned int getId() const { return m_cursor_id; }
89
90 /** Gets the current mouse cursor type
91 */
92 MouseCursorType getDragType() const { return m_drag_type; }
93
94 /** Gets the current mouse cursor pool id
95 */
96 unsigned int getDragId() const { return m_drag_id; }
97
98
99 private:
100 unsigned int m_cursor_id;
101 unsigned int m_drag_id;
102 MouseCursorType m_cursor_type;
103 MouseCursorType m_drag_type;
104
105 RenderBackend* m_renderbackend;
106 ImagePool* m_imgpool;
107 AnimationPool* m_animpool;
108
109 unsigned int m_animtime;
110 unsigned int m_drag_animtime;
111
112 int m_drag_offset_x;
113 int m_drag_offset_y;
114 TimeManager* m_timemanager;
115 };
116
117 } //FIFE
118
119 #endif