minimize some #includes and replace with forward decls
[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
30 namespace lisp { class Lisp; }
31
32 class DrawingContext;
33
34 /**
35 Tile Class
36 */
37 class Tile
38 {
39 public:
40   /// bitset for tile attributes
41   enum {
42     /** solid tile that is indestructable by Tux */
43     SOLID     = 0x0001,
44     /** uni-directional solid tile */
45     UNISOLID  = 0x0002,
46     /** a brick that can be destroyed by jumping under it */
47     BRICK     = 0x0004,
48     /** the level should be finished when touching a goaltile.
49      * if data is 0 then the endsequence should be triggered, if data is 1
50      * then we can finish the level instantly.
51      */
52     GOAL      = 0x0008,
53     /** slope tile */
54     SLOPE     = 0x0010,
55     /** Bonusbox, content is stored in \a data */
56     FULLBOX   = 0x0020,
57     /** Tile is a coin */
58     COIN      = 0x0040,
59
60     /* interesting flags (the following are passed to gameobjects) */
61     FIRST_INTERESTING_FLAG = 0x0100,
62
63     /** an ice brick that makes tux sliding more than usual */
64     ICE       = 0x0100,
65     /** a water tile in which tux starts to swim */
66     WATER     = 0x0200,
67     /** a tile that hurts the player if he touches it */
68     HURTS     = 0x0400,
69     /** for lava: WATER, HURTS, FIRE */
70     FIRE      = 0x0800
71   };
72
73   /// worldmap flags
74   enum {
75     WORLDMAP_NORTH = 0x0001,
76     WORLDMAP_SOUTH = 0x0002,
77     WORLDMAP_EAST  = 0x0004,
78     WORLDMAP_WEST  = 0x0008,
79         WORLDMAP_DIR_MASK = 0x000f,
80
81     WORLDMAP_STOP  = 0x0010,
82
83     // convenience values ("C" stands for crossroads)
84     WORLDMAP_CNSE  = WORLDMAP_NORTH | WORLDMAP_SOUTH | WORLDMAP_EAST,
85     WORLDMAP_CNSW  = WORLDMAP_NORTH | WORLDMAP_SOUTH | WORLDMAP_WEST,
86     WORLDMAP_CNEW  = WORLDMAP_NORTH | WORLDMAP_EAST  | WORLDMAP_WEST,
87     WORLDMAP_CSEW  = WORLDMAP_SOUTH | WORLDMAP_EAST  | WORLDMAP_WEST,
88     WORLDMAP_CNSEW = WORLDMAP_NORTH | WORLDMAP_SOUTH | WORLDMAP_EAST | WORLDMAP_WEST
89   };
90
91   struct ImageSpec {
92     ImageSpec(const std::string& newfile, const Rect& newrect)
93       : file(newfile), rect(newrect)
94     { }
95
96     std::string file;
97     Rect rect;
98   };
99
100 private:
101   unsigned int id;
102
103   std::vector<ImageSpec> imagespecs;
104   std::vector<Surface*> images;
105
106   /// tile attributes
107   uint32_t attributes;
108
109   /** General purpose data attached to a tile (content of a box, type of coin)*/
110   int data;
111
112   float anim_fps;
113
114 public:
115   ~Tile();
116
117   /** Draw a tile on the screen */
118   void draw(DrawingContext& context, const Vector& pos, int z_pos) const;
119
120   unsigned int getID() const
121   { return id; }
122
123   uint32_t getAttributes() const
124   { return attributes; }
125
126   int getData() const
127   { return data; }
128
129   /// returns the width of the tile in pixels
130   int getWidth() const
131   {
132     if(!images.size())
133       return 0;
134     return (int) images[0]->get_width();
135   }
136
137   /// returns the height of the tiles in pixels
138   int getHeight() const
139   {
140     if(!images.size())
141       return 0;
142     return (int) images[0]->get_height();
143   }
144
145 protected:
146   friend class TileManager;
147   Tile();
148   Tile(unsigned int id, Uint32 attributes, const ImageSpec& imagespec);
149
150   void load_images(const std::string& tilesetpath);
151
152   /// parses the tile and returns it's id number
153   void parse(const lisp::Lisp& reader);
154   void parse_images(const lisp::Lisp& cur);
155 };
156
157 #endif