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 #define MC_FRAME_PERIOD 800  // in ms
  29
  30 #define MC_STATES_NB 3
  31 enum {
  32   MC_NORMAL,
  33   MC_CLICK,
  34   MC_LINK,
  35   MC_HIDE
  36 };
  37
  38 /// Mouse cursor.
  39 /** Used to create mouse cursors.
  40     The mouse cursors can be animated
  41     and can be used in four different states.
  42     (MC_NORMAL, MC_CLICK, MC_LINK or MC_HIDE) */
  43 class MouseCursor
  44 {
  45 public:
  46   /// Constructor of MouseCursor.
  47   /** Expects an imagefile for the cursor and  the number of animation frames it contains. */
  48   MouseCursor(std::string cursor_file, int frames);
  49   ~MouseCursor();
  50   /// Get MouseCursor state.
  51   /** (MC_NORMAL, MC_CLICK, MC_LINK or MC_HIDE) */
  52   int state();
  53   /// Set MouseCursor state.
  54   /** (MC_NORMAL, MC_CLICK, MC_LINK or MC_HIDE) */
  55   void set_state(int nstate);
  56   /// Define the middle of a MouseCursor.
  57   /** Useful for cross mouse cursor images in example. */
  58   void set_mid(int x, int y);
  59
  60   /// Draw MouseCursor on screen.
  61   void draw(DrawingContext& context);
  62
  63   /// Return the current cursor.
  64   static MouseCursor* current() { return current_; };
  65   /// Set current cursor.
  66   static void set_current(MouseCursor* pcursor) {  current_ = pcursor; };
  67
  68 private:
  69   int mid_x, mid_y;
  70   static MouseCursor* current_;
  71   int state_before_click;
  72   int cur_state;
  73   int cur_frame, tot_frames;
  74   Surface* cursor;
  75   Timer timer;
  76 };
  77
  78 #endif /*SUPERTUX_MOUSECURSOR_H*/