src/object/tilemap.cpp

   1 //  SuperTux
   2 //  Copyright (C) 2006 Matthias Braun <matze@braunis.de>
   3 //
   4 //  This program is free software: you can redistribute it and/or modify
   5 //  it under the terms of the GNU General Public License as published by
   6 //  the Free Software Foundation, either version 3 of the License, or
   7 //  (at your option) any later version.
   8 //
   9 //  This program is distributed in the hope that it will be useful,
  10 //  but WITHOUT ANY WARRANTY; without even the implied warranty of
  11 //  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12 //  GNU General Public License for more details.
  13 //
  14 //  You should have received a copy of the GNU General Public License
  15 //  along with this program.  If not, see <http://www.gnu.org/licenses/>.
  16
  17 #include <math.h>
  18
  19 #include "object/tilemap.hpp"
  20 #include "scripting/squirrel_util.hpp"
  21 #include "scripting/tilemap.hpp"
  22 #include "supertux/globals.hpp"
  23 #include "supertux/object_factory.hpp"
  24 #include "supertux/tile_manager.hpp"
  25 #include "supertux/tile_set.hpp"
  26 #include "util/reader.hpp"
  27
  28 TileMap::TileMap(const TileSet *new_tileset) :
  29   tileset(new_tileset),
  30   tiles(),
  31   real_solid(false),
  32   effective_solid(false),
  33   speed_x(1),
  34   speed_y(1),
  35   width(0),
  36   height(0),
  37   z_pos(0),
  38   offset(Vector(0,0)),
  39   movement(0,0),
  40   drawing_effect(NO_EFFECT),
  41   alpha(1.0),
  42   current_alpha(1.0),
  43   remaining_fade_time(0),
  44   path(),
  45   walker(),
  46   draw_target(DrawingContext::NORMAL)
  47 {
  48 }
  49
  50 TileMap::TileMap(const Reader& reader) :
  51   tileset(),
  52   tiles(),
  53   real_solid(false),
  54   effective_solid(false),
  55   speed_x(1),
  56   speed_y(1),
  57   width(-1),
  58   height(-1),
  59   z_pos(0),
  60   offset(Vector(0,0)),
  61   movement(Vector(0,0)),
  62   drawing_effect(NO_EFFECT),
  63   alpha(1.0),
  64   current_alpha(1.0),
  65   remaining_fade_time(0),
  66   path(),
  67   walker(),
  68   draw_target(DrawingContext::NORMAL)
  69 {
  70   tileset = current_tileset;
  71   assert(tileset != NULL);
  72
  73   reader.get("name",   name);
  74   reader.get("solid",  real_solid);
  75   reader.get("speed",  speed_x);
  76   reader.get("speed-y", speed_y);
  77
  78   z_pos = reader_get_layer (reader, /* default = */ 0);
  79
  80   if(real_solid && ((speed_x != 1) || (speed_y != 1))) {
  81     log_warning << "Speed of solid tilemap is not 1. fixing" << std::endl;
  82     speed_x = 1;
  83     speed_y = 1;
  84   }
  85
  86   const lisp::Lisp* pathLisp = reader.get_lisp("path");
  87   if (pathLisp) {
  88     path.reset(new Path());
  89     path->read(*pathLisp);
  90     walker.reset(new PathWalker(path.get(), /*running*/false));
  91     Vector v = path->get_base();
  92     set_offset(v);
  93   }
  94
  95   std::string draw_target_s = "normal";
  96   reader.get("draw-target", draw_target_s);
  97   if (draw_target_s == "normal") draw_target = DrawingContext::NORMAL;
  98   if (draw_target_s == "lightmap") draw_target = DrawingContext::LIGHTMAP;
  99
 100   if (reader.get("alpha", alpha)) {
 101     current_alpha = alpha;
 102   }
 103
 104   /* Initialize effective_solid based on real_solid and current_alpha. */
 105   effective_solid = real_solid;
 106   update_effective_solid ();
 107
 108   reader.get("width", width);
 109   reader.get("height", height);
 110   if(width < 0 || height < 0)
 111     throw std::runtime_error("Invalid/No width/height specified in tilemap.");
 112
 113   if(!reader.get("tiles", tiles))
 114     throw std::runtime_error("No tiles in tilemap.");
 115
 116   if(int(tiles.size()) != width*height) {
 117     throw std::runtime_error("wrong number of tiles in tilemap.");
 118   }
 119
 120   bool empty = true;
 121
 122   // make sure all tiles used on the tilemap are loaded and tilemap isn't empty
 123   for(Tiles::iterator i = tiles.begin(); i != tiles.end(); ++i) {
 124     if(*i != 0) {
 125       empty = false;
 126     }
 127
 128     tileset->get(*i);
 129   }
 130
 131   if(empty)
 132     log_info << "Tilemap '" << name << "', z-pos '" << z_pos << "' is empty." << std::endl;
 133 }
 134
 135 TileMap::TileMap(const TileSet *new_tileset, std::string name, int z_pos,
 136                  bool solid, size_t width, size_t height) :
 137   tileset(new_tileset),
 138   tiles(),
 139   real_solid(solid),
 140   effective_solid(solid),
 141   speed_x(1),
 142   speed_y(1),
 143   width(0),
 144   height(0),
 145   z_pos(z_pos),
 146   offset(Vector(0,0)),
 147   movement(Vector(0,0)),
 148   drawing_effect(NO_EFFECT),
 149   alpha(1.0),
 150   current_alpha(1.0),
 151   remaining_fade_time(0),
 152   path(),
 153   walker(),
 154   draw_target(DrawingContext::NORMAL)
 155 {
 156   this->name = name;
 157
 158   if (this->z_pos > (LAYER_GUI - 100))
 159     this->z_pos = LAYER_GUI - 100;
 160
 161   resize(width, height);
 162 }
 163
 164 TileMap::~TileMap()
 165 {
 166 }
 167
 168 void
 169 TileMap::update(float elapsed_time)
 170 {
 171   // handle tilemap fading
 172   if (current_alpha != alpha) {
 173     remaining_fade_time = std::max(0.0f, remaining_fade_time - elapsed_time);
 174     if (remaining_fade_time == 0.0f) {
 175       current_alpha = alpha;
 176     } else {
 177       float amt = (alpha - current_alpha) / (remaining_fade_time / elapsed_time);
 178       if (amt > 0) current_alpha = std::min(current_alpha + amt, alpha);
 179       if (amt < 0) current_alpha = std::max(current_alpha + amt, alpha);
 180     }
 181     update_effective_solid ();
 182   }
 183
 184   movement = Vector(0,0);
 185   // if we have a path to follow, follow it
 186   if (walker.get()) {
 187     Vector v = walker->advance(elapsed_time);
 188     movement = v - get_offset();
 189     set_offset(v);
 190   }
 191 }
 192
 193 void
 194 TileMap::draw(DrawingContext& context)
 195 {
 196   // skip draw if current opacity is 0.0
 197   if (current_alpha == 0.0) return;
 198
 199   context.push_transform();
 200   if(draw_target != DrawingContext::NORMAL) {
 201     context.push_target();
 202     context.set_target(draw_target);
 203   }
 204
 205   if(drawing_effect != 0) context.set_drawing_effect(drawing_effect);
 206   if(current_alpha != 1.0) context.set_alpha(current_alpha);
 207
 208   /* Force the translation to be an integer so that the tiles appear sharper.
 209    * For consistency (i.e., to avoid 1-pixel gaps), this needs to be done even
 210    * for solid tilemaps that are guaranteed to have speed 1.
 211    * FIXME Force integer translation for all graphics, not just tilemaps. */
 212   float trans_x = roundf(context.get_translation().x);
 213   float trans_y = roundf(context.get_translation().y);
 214   context.set_translation(Vector(int(trans_x * speed_x),
 215                                  int(trans_y * speed_y)));
 216
 217   Rectf draw_rect = Rectf(context.get_translation(),
 218         context.get_translation() + Vector(SCREEN_WIDTH, SCREEN_HEIGHT));
 219   Rect t_draw_rect = get_tiles_overlapping(draw_rect);
 220   Vector start = get_tile_position(t_draw_rect.left, t_draw_rect.top);
 221
 222   Vector pos;
 223   int tx, ty;
 224
 225   for(pos.x = start.x, tx = t_draw_rect.left; tx < t_draw_rect.right; pos.x += 32, ++tx) {
 226     for(pos.y = start.y, ty = t_draw_rect.top; ty < t_draw_rect.bottom; pos.y += 32, ++ty) {
 227       int index = ty*width + tx;
 228       assert (index >= 0);
 229       assert (index < (width * height));
 230
 231       if (tiles[index] == 0) continue;
 232       const Tile* tile = tileset->get(tiles[index]);
 233       assert(tile != 0);
 234       tile->draw(context, pos, z_pos);
 235     } /* for (pos y) */
 236   } /* for (pos x) */
 237
 238   if(draw_target != DrawingContext::NORMAL) {
 239     context.pop_target();
 240   }
 241   context.pop_transform();
 242 }
 243
 244 void
 245 TileMap::goto_node(int node_no)
 246 {
 247   if (!walker.get()) return;
 248   walker->goto_node(node_no);
 249 }
 250
 251 void
 252 TileMap::start_moving()
 253 {
 254   if (!walker.get()) return;
 255   walker->start_moving();
 256 }
 257
 258 void
 259 TileMap::stop_moving()
 260 {
 261   if (!walker.get()) return;
 262   walker->stop_moving();
 263 }
 264
 265 void
 266 TileMap::expose(HSQUIRRELVM vm, SQInteger table_idx)
 267 {
 268   if (name.empty()) return;
 269   scripting::TileMap* _this = new scripting::TileMap(this);
 270   expose_object(vm, table_idx, _this, name, true);
 271 }
 272
 273 void
 274 TileMap::unexpose(HSQUIRRELVM vm, SQInteger table_idx)
 275 {
 276   if (name.empty()) return;
 277   scripting::unexpose_object(vm, table_idx, name);
 278 }
 279
 280 void
 281 TileMap::set(int newwidth, int newheight, const std::vector<unsigned int>&newt,
 282              int new_z_pos, bool newsolid)
 283 {
 284   if(int(newt.size()) != newwidth * newheight)
 285     throw std::runtime_error("Wrong tilecount count.");
 286
 287   width  = newwidth;
 288   height = newheight;
 289
 290   tiles.resize(newt.size());
 291   tiles = newt;
 292
 293   if (new_z_pos > (LAYER_GUI - 100))
 294     z_pos = LAYER_GUI - 100;
 295   else
 296     z_pos  = new_z_pos;
 297   real_solid  = newsolid;
 298   update_effective_solid ();
 299
 300   // make sure all tiles are loaded
 301   for(Tiles::iterator i = tiles.begin(); i != tiles.end(); ++i)
 302     tileset->get(*i);
 303 }
 304
 305 void
 306 TileMap::resize(int new_width, int new_height, int fill_id)
 307 {
 308   if(new_width < width) {
 309     // remap tiles for new width
 310     for(int y = 0; y < height && y < new_height; ++y) {
 311       for(int x = 0; x < new_width; ++x) {
 312         tiles[y * new_width + x] = tiles[y * width + x];
 313       }
 314     }
 315   }
 316
 317   tiles.resize(new_width * new_height, fill_id);
 318
 319   if(new_width > width) {
 320     // remap tiles
 321     for(int y = std::min(height, new_height)-1; y >= 0; --y) {
 322       for(int x = new_width-1; x >= 0; --x) {
 323         if(x >= width) {
 324           tiles[y * new_width + x] = fill_id;
 325           continue;
 326         }
 327
 328         tiles[y * new_width + x] = tiles[y * width + x];
 329       }
 330     }
 331   }
 332
 333   height = new_height;
 334   width = new_width;
 335 }
 336
 337 Rect
 338 TileMap::get_tiles_overlapping(const Rectf &rect) const
 339 {
 340   Rectf rect2 = rect;
 341   rect2.move(-offset);
 342
 343   int t_left   = std::max(0     , int(floorf(rect2.get_left  () / 32)));
 344   int t_right  = std::min(width , int(ceilf (rect2.get_right () / 32)));
 345   int t_top    = std::max(0     , int(floorf(rect2.get_top   () / 32)));
 346   int t_bottom = std::min(height, int(ceilf (rect2.get_bottom() / 32)));
 347   return Rect(t_left, t_top, t_right, t_bottom);
 348 }
 349
 350 void
 351 TileMap::set_solid(bool solid)
 352 {
 353   this->real_solid = solid;
 354   update_effective_solid ();
 355 }
 356
 357 uint32_t
 358 TileMap::get_tile_id(int x, int y) const
 359 {
 360   if(x < 0 || x >= width || y < 0 || y >= height) {
 361     //log_warning << "tile outside tilemap requested" << std::endl;
 362     return 0;
 363   }
 364
 365   return tiles[y*width + x];
 366 }
 367
 368 const Tile*
 369 TileMap::get_tile(int x, int y) const
 370 {
 371   uint32_t id = get_tile_id(x, y);
 372   return tileset->get(id);
 373 }
 374
 375 uint32_t
 376 TileMap::get_tile_id_at(const Vector& pos) const
 377 {
 378   Vector xy = (pos - offset) / 32;
 379   return get_tile_id(int(xy.x), int(xy.y));
 380 }
 381
 382 const Tile*
 383 TileMap::get_tile_at(const Vector& pos) const
 384 {
 385   uint32_t id = get_tile_id_at(pos);
 386   return tileset->get(id);
 387 }
 388
 389 void
 390 TileMap::change(int x, int y, uint32_t newtile)
 391 {
 392   assert(x >= 0 && x < width && y >= 0 && y < height);
 393   tiles[y*width + x] = newtile;
 394 }
 395
 396 void
 397 TileMap::change_at(const Vector& pos, uint32_t newtile)
 398 {
 399   Vector xy = (pos - offset) / 32;
 400   change(int(xy.x), int(xy.y), newtile);
 401 }
 402
 403 void
 404 TileMap::change_all(uint32_t oldtile, uint32_t newtile)
 405 {
 406   for (size_t x = 0; x < get_width(); x++) {
 407     for (size_t y = 0; y < get_height(); y++) {
 408       if (get_tile_id(x,y) != oldtile)
 409         continue;
 410
 411       change(x,y,newtile);
 412     }
 413   }
 414 }
 415
 416 void
 417 TileMap::fade(float alpha, float seconds)
 418 {
 419   this->alpha = alpha;
 420   this->remaining_fade_time = seconds;
 421 }
 422
 423 void
 424 TileMap::set_alpha(float alpha)
 425 {
 426   this->alpha = alpha;
 427   this->current_alpha = alpha;
 428   this->remaining_fade_time = 0;
 429   update_effective_solid ();
 430 }
 431
 432 float
 433 TileMap::get_alpha()
 434 {
 435   return this->current_alpha;
 436 }
 437
 438 /*
 439  * Private methods
 440  */
 441 void
 442 TileMap::update_effective_solid (void)
 443 {
 444   if (!real_solid)
 445     effective_solid = false;
 446   else if (effective_solid && (current_alpha < .25))
 447     effective_solid = false;
 448   else if (!effective_solid && (current_alpha >= .75))
 449     effective_solid = true;
 450 }
 451
 452 /* EOF */