Massive copyright update. I'm sorry if I'm crediting Matze for something he didn...
[supertux.git] / src / video / surface.hpp
1 //  $Id$
2 // 
3 //  SuperTux
4 //  Copyright (C) 2006 Matthias Braun <matze@braunis.de>
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
19 //  02111-1307, USA.
20 #ifndef __SURFACE_HPP__
21 #define __SURFACE_HPP__
22
23 #include <string>
24
25 class ImageTexture;
26
27 /// bitset for drawing effects
28 enum DrawingEffect {
29   /** Don't apply anything */
30   NO_EFFECT       = 0x0000,
31   /** Draw the Surface upside down */
32   VERTICAL_FLIP     = 0x0001,
33   /** Draw the Surface from left to down */
34   HORIZONTAL_FLIP   = 0x0002,
35 };
36
37 /**
38  * A rectangular image.
39  * The class basically holds a reference to a texture with additional UV
40  * coordinates that specify a rectangular area on this texture
41  */
42 class Surface
43 {
44 private:
45   friend class DrawingContext;
46   friend class Font;
47   ImageTexture* texture;
48
49   float uv_left;
50   float uv_top;
51   float uv_right;
52   float uv_bottom;
53
54   void draw(float x, float y, float alpha, DrawingEffect effect) const;
55   void draw_part(float src_x, float src_y, float dst_x, float dst_y,
56                  float width, float height,
57                  float alpha, DrawingEffect effect) const;
58
59   float width;
60   float height;
61 public:
62   Surface(const std::string& file);
63   Surface(const std::string& file, int x, int y, int w, int h);
64   Surface(const Surface& other);
65   ~Surface();
66
67   /** flip the surface horizontally */
68   void hflip();
69   
70   const Surface& operator= (const Surface& other);
71
72   float get_width() const
73   {
74     return width;
75   }
76
77   float get_height() const
78   {
79     return height;
80   }
81 };
82
83 #endif