lib/gui/mousecursor.h

   1 //  $Id$
   2 //
   3 //  SuperTux -  A Jump'n Run
   4 //  Copyright (C) 2004 Ricardo Cruz <rick2@aeiou.pt>
   5 //
   6 //  This program is free software; you can redistribute it and/or
   7 //  modify it under the terms of the GNU General Public License
   8 //  as published by the Free Software Foundation; either version 2
   9 //  of the License, or (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 Free Software
  18 //  Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
  19
  20 #ifndef SUPERTUX_MOUSECURSOR_H
  21 #define SUPERTUX_MOUSECURSOR_H
  22
  23 #include <string>
  24
  25 #include "special/timer.h"
  26 #include "video/surface.h"
  27
  28 namespace SuperTux
  29   {
  30
  31   #define MC_FRAME_PERIOD 800  // in ms
  32
  33   #define MC_STATES_NB 3
  34
  35   enum {
  36     MC_NORMAL,
  37     MC_CLICK,
  38     MC_LINK,
  39     MC_HIDE
  40   };
  41
  42   /// Mouse cursor.
  43   /** Used to create mouse cursors.
  44       The mouse cursors can be animated
  45       and can be used in four different states.
  46       (MC_NORMAL, MC_CLICK, MC_LINK or MC_HIDE) */
  47   class MouseCursor
  48     {
  49     public:
  50       /// Constructor of MouseCursor.
  51       /** Expects an imagefile for the cursor and  the number of animation frames it contains. */
  52       MouseCursor(std::string cursor_file, int frames);
  53       ~MouseCursor();
  54       /// Get MouseCursor state.
  55       /** (MC_NORMAL, MC_CLICK, MC_LINK or MC_HIDE) */
  56       int state();
  57       /// Set MouseCursor state.
  58       /** (MC_NORMAL, MC_CLICK, MC_LINK or MC_HIDE) */
  59       void set_state(int nstate);
  60       /// Define the middle of a MouseCursor.
  61       /** Useful for cross mouse cursor images in example. */
  62       void set_mid(int x, int y);
  63
  64       /// Draw MouseCursor on screen.
  65       void draw(DrawingContext& context);
  66
  67       /// Return the current cursor.
  68       static MouseCursor* current()
  69       {        return current_;      };
  70       /// Set current cursor.
  71       static void set_current(MouseCursor* pcursor)
  72       {        current_ = pcursor;      };
  73
  74     private:
  75       int mid_x, mid_y;
  76       static MouseCursor* current_;
  77       int state_before_click;
  78       int cur_state;
  79       int cur_frame, tot_frames;
  80       Surface* cursor;
  81       Timer timer;
  82     };
  83
  84 } // namespace SuperTux
  85
  86 #endif /*SUPERTUX_MOUSECURSOR_H*/