Massive copyright update. I'm sorry if I'm crediting Matze for something he didn...
[supertux.git] / src / tile.hpp
1 //  $Id$
2 //
3 //  SuperTux
4 //  Copyright (C) 2004 Tobias Glaesser <tobi.web@gmx.de>
5 //  Copyright (C) 2006 Matthias Braun <matze@braunis.de>
6 //
7 //  This program is free software; you can redistribute it and/or
8 //  modify it under the terms of the GNU General Public License
9 //  as published by the Free Software Foundation; either version 2
10 //  of the License, or (at your option) any later version.
11 //
12 //  This program is distributed in the hope that it will be useful,
13 //  but WITHOUT ANY WARRANTY; without even the implied warranty of
14 //  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15 //  GNU General Public License for more details.
16 //
17 //  You should have received a copy of the GNU General Public License
18 //  along with this program; if not, write to the Free Software
19 //  Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
20 //  02111-1307, USA.
21 #ifndef TILE_H
22 #define TILE_H
23
24 #include <vector>
25 #include <SDL.h>
26 #include <stdint.h>
27 #include "video/surface.hpp"
28 #include "math/rect.hpp"
29 #include "lisp/lisp.hpp"
30
31 class DrawingContext;
32
33 /**
34 Tile Class
35 */
36 class Tile
37 {
38 public:
39   /// bitset for tile attributes
40   enum {
41     /** solid tile that is indestructable by Tux */                         
42     SOLID     = 0x0001,
43     /** uni-directional solid tile */
44     UNISOLID  = 0x0002,
45     /** a brick that can be destroyed by jumping under it */
46     BRICK     = 0x0004,
47     /** the level should be finished when touching a goaltile.
48      * if data is 0 then the endsequence should be triggered, if data is 1
49      * then we can finish the level instantly.
50      */
51     GOAL      = 0x0008,
52     /** slope tile */
53     SLOPE     = 0x0010,
54     /** Bonusbox, content is stored in \a data */
55     FULLBOX   = 0x0020,
56     /** Tile is a coin */
57     COIN      = 0x0040,
58
59     /* interesting flags (the following are passed to gameobjects) */
60     FIRST_INTERESTING_FLAG = 0x0100,
61     
62     /** an ice brick that makes tux sliding more than usual */
63     ICE       = 0x0100,
64     /** a water tile in which tux starts to swim */                         
65     WATER     = 0x0200,
66     /** a tile that hurts the player if he touches it */
67     HURTS     = 0x0400,
68   };
69
70   /// worldmap flags
71   enum {
72     WORLDMAP_NORTH = 0x0001,
73     WORLDMAP_SOUTH = 0x0002,
74     WORLDMAP_EAST  = 0x0004,
75     WORLDMAP_WEST  = 0x0008,
76
77     WORLDMAP_STOP  = 0x0010,
78
79     // convenience values ("C" stands for crossroads)
80     WORLDMAP_CNSE  = WORLDMAP_NORTH | WORLDMAP_SOUTH | WORLDMAP_EAST,
81     WORLDMAP_CNSW  = WORLDMAP_NORTH | WORLDMAP_SOUTH | WORLDMAP_WEST,
82     WORLDMAP_CNEW  = WORLDMAP_NORTH | WORLDMAP_EAST  | WORLDMAP_WEST,
83     WORLDMAP_CSEW  = WORLDMAP_SOUTH | WORLDMAP_EAST  | WORLDMAP_WEST,
84     WORLDMAP_CNSEW = WORLDMAP_NORTH | WORLDMAP_SOUTH | WORLDMAP_EAST | WORLDMAP_WEST
85   };
86   
87   struct ImageSpec {
88     ImageSpec(const std::string& newfile, const Rect& newrect)
89       : file(newfile), rect(newrect)
90     { }
91
92     std::string file;
93     Rect rect;
94   };
95
96 private:
97   unsigned int id;
98
99   std::vector<ImageSpec> imagespecs;
100   std::vector<Surface*> images;
101
102   std::string editor_imagefile;
103   Surface* editor_image;
104   
105   /** tile attributes */
106   uint32_t attributes;
107   
108   /** General purpose data attached to a tile (content of a box, type of coin)*/
109   int data;
110   
111   float anim_fps;
112
113 public:
114   ~Tile();
115   
116   /** Draw a tile on the screen */
117   void draw(DrawingContext& context, const Vector& pos, int layer) const;
118
119   Surface* get_editor_image() const;
120
121   unsigned int getID() const
122   { return id; }
123
124   uint32_t getAttributes() const
125   { return attributes; }
126
127   int getData() const
128   { return data; }
129
130   /// returns the width of the tile in pixels
131   int getWidth() const
132   { 
133     if(!images.size())
134       return 0;
135     return (int) images[0]->get_width();
136   }
137
138   /// returns the height of the tiles in pixels
139   int getHeight() const
140   {
141     if(!images.size())
142       return 0;
143     return (int) images[0]->get_height();
144   }
145
146 protected:
147   friend class TileManager;
148   Tile();
149   Tile(unsigned int id, Uint32 attributes, const ImageSpec& imagespec);
150
151   void load_images(const std::string& tilesetpath);
152
153   /// parses the tile and returns it's id number
154   void parse(const lisp::Lisp& reader);
155   void parse_images(const lisp::Lisp& cur);
156 };
157
158 #endif