src/supertux/tile.hpp

   1 //  SuperTux
   2 //  Copyright (C) 2004 Tobias Glaesser <tobi.web@gmx.de>
   3 //  Copyright (C) 2006 Matthias Braun <matze@braunis.de>
   4 //
   5 //  This program is free software: you can redistribute it and/or modify
   6 //  it under the terms of the GNU General Public License as published by
   7 //  the Free Software Foundation, either version 3 of the License, or
   8 //  (at your option) any later version.
   9 //
  10 //  This program is distributed in the hope that it will be useful,
  11 //  but WITHOUT ANY WARRANTY; without even the implied warranty of
  12 //  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13 //  GNU General Public License for more details.
  14 //
  15 //  You should have received a copy of the GNU General Public License
  16 //  along with this program.  If not, see <http://www.gnu.org/licenses/>.
  17
  18 #ifndef HEADER_SUPERTUX_SUPERTUX_TILE_HPP
  19 #define HEADER_SUPERTUX_SUPERTUX_TILE_HPP
  20
  21 #include <vector>
  22 #include <stdint.h>
  23
  24 #include "math/rectf.hpp"
  25 #include "video/surface.hpp"
  26 #include "util/reader_fwd.hpp"
  27
  28 class DrawingContext;
  29
  30 class Tile
  31 {
  32 public:
  33   static bool draw_editor_images;
  34   /// bitset for tile attributes
  35   enum {
  36     /** solid tile that is indestructible by Tux */
  37     SOLID     = 0x0001,
  38     /** uni-directional solid tile */
  39     UNISOLID  = 0x0002,
  40     /** a brick that can be destroyed by jumping under it */
  41     BRICK     = 0x0004,
  42     /** the level should be finished when touching a goaltile.
  43      * if data is 0 then the endsequence should be triggered, if data is 1
  44      * then we can finish the level instantly.
  45      */
  46     GOAL      = 0x0008,
  47     /** slope tile */
  48     SLOPE     = 0x0010,
  49     /** Bonusbox, content is stored in \a data */
  50     FULLBOX   = 0x0020,
  51     /** Tile is a coin */
  52     COIN      = 0x0040,
  53
  54     /* interesting flags (the following are passed to gameobjects) */
  55     FIRST_INTERESTING_FLAG = 0x0100,
  56
  57     /** an ice brick that makes tux sliding more than usual */
  58     ICE       = 0x0100,
  59     /** a water tile in which tux starts to swim */
  60     WATER     = 0x0200,
  61     /** a tile that hurts the player if he touches it */
  62     HURTS     = 0x0400,
  63     /** for lava: WATER, HURTS, FIRE */
  64     FIRE      = 0x0800
  65   };
  66
  67   /// worldmap flags
  68   enum {
  69     WORLDMAP_NORTH = 0x0001,
  70     WORLDMAP_SOUTH = 0x0002,
  71     WORLDMAP_EAST  = 0x0004,
  72     WORLDMAP_WEST  = 0x0008,
  73     WORLDMAP_DIR_MASK = 0x000f,
  74
  75     WORLDMAP_STOP  = 0x0010,
  76
  77     // convenience values ("C" stands for crossroads)
  78     WORLDMAP_CNSE  = WORLDMAP_NORTH | WORLDMAP_SOUTH | WORLDMAP_EAST,
  79     WORLDMAP_CNSW  = WORLDMAP_NORTH | WORLDMAP_SOUTH | WORLDMAP_WEST,
  80     WORLDMAP_CNEW  = WORLDMAP_NORTH | WORLDMAP_EAST  | WORLDMAP_WEST,
  81     WORLDMAP_CSEW  = WORLDMAP_SOUTH | WORLDMAP_EAST  | WORLDMAP_WEST,
  82     WORLDMAP_CNSEW = WORLDMAP_NORTH | WORLDMAP_SOUTH | WORLDMAP_EAST | WORLDMAP_WEST
  83   };
  84
  85   struct ImageSpec {
  86     ImageSpec(const std::string& newfile, const Rectf& newrect)
  87       : file(newfile), rect(newrect)
  88     { }
  89
  90     std::string file;
  91     Rectf rect;
  92   };
  93
  94   enum
  95   {
  96     UNI_DIR_NORTH = 0,
  97     UNI_DIR_SOUTH = 1,
  98     UNI_DIR_WEST  = 2,
  99     UNI_DIR_EAST  = 3,
 100     UNI_DIR_MASK  = 3
 101   };
 102
 103 private:
 104   std::vector<ImageSpec> imagespecs;
 105   std::vector<SurfacePtr>  images;
 106   std::vector<ImageSpec> editor_imagespecs;
 107   std::vector<SurfacePtr>  editor_images;
 108
 109   /// tile attributes
 110   uint32_t attributes;
 111
 112   /** General purpose data attached to a tile (content of a box, type of coin)*/
 113   int data;
 114
 115   float fps;
 116
 117 public:
 118   Tile();
 119   Tile(const std::vector<ImageSpec>& images, const std::vector<ImageSpec>& editor_images,
 120        uint32_t attributes, uint32_t data, float fps);
 121   ~Tile();
 122
 123   /** load Surfaces, if not already loaded */
 124   void load_images();
 125
 126   /** Draw a tile on the screen */
 127   void draw(DrawingContext& context, const Vector& pos, int z_pos) const;
 128
 129   uint32_t getAttributes() const
 130   { return attributes; }
 131
 132   int getData() const
 133   { return data; }
 134
 135   bool is_slope (void) const
 136   {
 137     return ((attributes & SLOPE) != 0);
 138   }
 139
 140   bool is_unisolid (void) const
 141   {
 142     return ((attributes & UNISOLID) != 0);
 143   }
 144
 145   void print_debug(int id) const;
 146
 147 private:
 148   //Correct small oddities in attributes that naive people
 149   //might miss (and rebuke them for it)
 150   void correct_attributes();
 151
 152 private:
 153   Tile(const Tile&);
 154   Tile& operator=(const Tile&);
 155 };
 156
 157 #endif
 158
 159 /* EOF */