329f225f26f397d35f28c875958ce133c58f5282
[supertux.git] / src / gui / mousecursor.hpp
1 //  SuperTux
2 //  Copyright (C) 2006 Matthias Braun <matze@braunis.de>
3 //
4 //  This program is free software: you can redistribute it and/or modify
5 //  it under the terms of the GNU General Public License as published by
6 //  the Free Software Foundation, either version 3 of the License, or
7 //  (at your option) any later version.
8 //
9 //  This program is distributed in the hope that it will be useful,
10 //  but WITHOUT ANY WARRANTY; without even the implied warranty of
11 //  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12 //  GNU General Public License for more details.
13 //
14 //  You should have received a copy of the GNU General Public License
15 //  along with this program.  If not, see <http://www.gnu.org/licenses/>.
16
17 #ifndef HEADER_SUPERTUX_GUI_MOUSECURSOR_HPP
18 #define HEADER_SUPERTUX_GUI_MOUSECURSOR_HPP
19
20 #include <string>
21
22 #include "math/vector.hpp"
23 #include "video/surface_ptr.hpp"
24
25 #define MC_STATES_NB 3
26
27 enum {
28   MC_NORMAL = 0,
29   MC_CLICK,
30   MC_LINK,
31   MC_HIDE
32 };
33
34 class DrawingContext;
35 class Vector;
36
37 /// Mouse cursor.
38 /** Used to create mouse cursors.
39     The mouse cursors can be animated
40     and can be used in four different states.
41     (MC_NORMAL, MC_CLICK, MC_LINK or MC_HIDE) */
42 class MouseCursor
43 {
44 public:
45   /// Constructor of MouseCursor.
46   /** Expects an imagefile for the cursor and  the number of animation frames it contains. */
47   MouseCursor(std::string cursor_file);
48   ~MouseCursor();
49   /// Get MouseCursor state.
50   /** (MC_NORMAL, MC_CLICK, MC_LINK or MC_HIDE) */
51   int state();
52   /// Set MouseCursor state.
53   /** (MC_NORMAL, MC_CLICK, MC_LINK or MC_HIDE) */
54   void set_state(int nstate);
55   /// Define the middle of a MouseCursor.
56   /** Useful for cross mouse cursor images in example. */
57   void set_mid(int x, int y);
58
59   /** Set the position where the cursor should appear */
60   void set_pos(const Vector& pos);
61
62   /// Draw MouseCursor on screen.
63   void draw(DrawingContext& context);
64
65   /// Return the current cursor.
66   static MouseCursor* current()
67   {        return current_;      };
68   /// Set current cursor.
69   static void set_current(MouseCursor* pcursor)
70   {        current_ = pcursor;      };
71   
72   friend class Resources;
73
74 private:
75   Vector mouse_pos;
76   int mid_x;
77   int mid_y;
78   int state_before_click;
79   int cur_state;
80   SurfacePtr cursor;
81
82 private:
83   static MouseCursor* current_;
84
85 private:
86   MouseCursor(const MouseCursor&);
87   MouseCursor& operator=(const MouseCursor&);
88 };
89
90 #endif /*SUPERTUX_MOUSECURSOR_H*/
91
92 /* EOF */