src/video/drawing_context.cpp

   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  02111-1307, USA.
  19 #include <config.h>
  20
  21 #include <functional>
  22 #include <algorithm>
  23 #include <cassert>
  24 #include <iostream>
  25 #include <SDL_image.h>
  26 #include <sstream>
  27 #include <iomanip>
  28 #include <physfs.h>
  29
  30 #include "drawing_context.hpp"
  31 #include "drawing_request.hpp"
  32 #include "video_systems.hpp"
  33 #include "renderer.hpp"
  34 #include "lightmap.hpp"
  35 #include "surface.hpp"
  36 #include "main.hpp"
  37 #include "gameconfig.hpp"
  38 #include "texture.hpp"
  39 #include "texture_manager.hpp"
  40 #include "obstack/obstackpp.hpp"
  41
  42 static inline int next_po2(int val)
  43 {
  44   int result = 1;
  45   while(result < val)
  46     result *= 2;
  47
  48   return result;
  49 }
  50
  51 DrawingContext::DrawingContext() :
  52   renderer(0), lightmap(0), ambient_color(1.0f, 1.0f, 1.0f, 1.0f), target(NORMAL), screenshot_requested(false)
  53 {
  54   requests = &drawing_requests;
  55   obstack_init(&obst);
  56 }
  57
  58 DrawingContext::~DrawingContext()
  59 {
  60   delete renderer;
  61   delete lightmap;
  62
  63   obstack_free(&obst, NULL);
  64 }
  65
  66 void
  67 DrawingContext::init_renderer()
  68 {
  69   delete renderer;
  70   delete lightmap;
  71
  72   renderer = new_renderer();
  73   lightmap = new_lightmap();
  74 }
  75
  76 void
  77 DrawingContext::draw_surface(const Surface* surface, const Vector& position,
  78                              float angle, const Color& color, const Blend& blend,
  79                              int layer)
  80 {
  81   assert(surface != 0);
  82
  83   DrawingRequest* request = new(obst) DrawingRequest();
  84
  85   request->target = target;
  86   request->type = SURFACE;
  87   request->pos = transform.apply(position);
  88
  89   if(request->pos.x >= SCREEN_WIDTH || request->pos.y >= SCREEN_HEIGHT
  90       || request->pos.x + surface->get_width() < 0
  91       || request->pos.y + surface->get_height() < 0)
  92     return;
  93
  94   request->layer = layer;
  95   request->drawing_effect = transform.drawing_effect;
  96   request->alpha = transform.alpha;
  97   request->angle = angle;
  98   request->color = color;
  99   request->blend = blend;
 100
 101   request->request_data = const_cast<Surface*> (surface);
 102
 103   requests->push_back(request);
 104 }
 105
 106 void
 107 DrawingContext::draw_surface(const Surface* surface, const Vector& position,
 108     int layer)
 109 {
 110   draw_surface(surface, position, 0.0f, Color(1.0f, 1.0f, 1.0f), Blend(), layer);
 111 }
 112
 113 void
 114 DrawingContext::draw_surface_part(const Surface* surface, const Vector& source,
 115     const Vector& size, const Vector& dest, int layer)
 116 {
 117   assert(surface != 0);
 118
 119   DrawingRequest* request = new(obst) DrawingRequest();
 120
 121   request->target = target;
 122   request->type = SURFACE_PART;
 123   request->pos = transform.apply(dest);
 124   request->layer = layer;
 125   request->drawing_effect = transform.drawing_effect;
 126   request->alpha = transform.alpha;
 127
 128   SurfacePartRequest* surfacepartrequest = new(obst) SurfacePartRequest();
 129   surfacepartrequest->size = size;
 130   surfacepartrequest->source = source;
 131   surfacepartrequest->surface = surface;
 132
 133   // clip on screen borders
 134   if(request->pos.x < 0) {
 135     surfacepartrequest->size.x += request->pos.x;
 136     if(surfacepartrequest->size.x <= 0)
 137       return;
 138     surfacepartrequest->source.x -= request->pos.x;
 139     request->pos.x = 0;
 140   }
 141   if(request->pos.y < 0) {
 142     surfacepartrequest->size.y += request->pos.y;
 143     if(surfacepartrequest->size.y <= 0)
 144       return;
 145     surfacepartrequest->source.y -= request->pos.y;
 146     request->pos.y = 0;
 147   }
 148   request->request_data = surfacepartrequest;
 149
 150   requests->push_back(request);
 151 }
 152
 153 void
 154 DrawingContext::draw_text(const Font* font, const std::string& text,
 155     const Vector& position, FontAlignment alignment, int layer)
 156 {
 157   DrawingRequest* request = new(obst) DrawingRequest();
 158
 159   request->target = target;
 160   request->type = TEXT;
 161   request->pos = transform.apply(position);
 162   request->layer = layer;
 163   request->drawing_effect = transform.drawing_effect;
 164   request->alpha = transform.alpha;
 165
 166   TextRequest* textrequest = new(obst) TextRequest();
 167   textrequest->font = font;
 168   textrequest->text = text;
 169   textrequest->alignment = alignment;
 170   request->request_data = textrequest;
 171
 172   requests->push_back(request);
 173 }
 174
 175 void
 176 DrawingContext::draw_center_text(const Font* font, const std::string& text,
 177     const Vector& position, int layer)
 178 {
 179   draw_text(font, text, Vector(position.x + SCREEN_WIDTH/2, position.y),
 180       ALIGN_CENTER, layer);
 181 }
 182
 183 void
 184 DrawingContext::draw_gradient(const Color& top, const Color& bottom, int layer)
 185 {
 186   DrawingRequest* request = new(obst) DrawingRequest();
 187
 188   request->target = target;
 189   request->type = GRADIENT;
 190   request->pos = Vector(0,0);
 191   request->layer = layer;
 192
 193   request->drawing_effect = transform.drawing_effect;
 194   request->alpha = transform.alpha;
 195
 196   GradientRequest* gradientrequest = new(obst) GradientRequest();
 197   gradientrequest->top = top;
 198   gradientrequest->bottom = bottom;
 199   request->request_data = gradientrequest;
 200
 201   requests->push_back(request);
 202 }
 203
 204 void
 205 DrawingContext::draw_filled_rect(const Vector& topleft, const Vector& size,
 206                                  const Color& color, int layer)
 207 {
 208   DrawingRequest* request = new(obst) DrawingRequest();
 209
 210   request->target = target;
 211   request->type = FILLRECT;
 212   request->pos = transform.apply(topleft);
 213   request->layer = layer;
 214
 215   request->drawing_effect = transform.drawing_effect;
 216   request->alpha = transform.alpha;
 217
 218   FillRectRequest* fillrectrequest = new(obst) FillRectRequest();
 219   fillrectrequest->size = size;
 220   fillrectrequest->color = color;
 221   fillrectrequest->color.alpha = color.alpha * transform.alpha;
 222   request->request_data = fillrectrequest;
 223
 224   requests->push_back(request);
 225 }
 226
 227 void
 228 DrawingContext::draw_filled_rect(const Rect& rect, const Color& color,
 229                                  int layer)
 230 {
 231   DrawingRequest* request = new(obst) DrawingRequest();
 232
 233   request->target = target;
 234   request->type = FILLRECT;
 235   request->pos = transform.apply(rect.p1);
 236   request->layer = layer;
 237
 238   request->drawing_effect = transform.drawing_effect;
 239   request->alpha = transform.alpha;
 240
 241   FillRectRequest* fillrectrequest = new(obst) FillRectRequest;
 242   fillrectrequest->size = Vector(rect.get_width(), rect.get_height());
 243   fillrectrequest->color = color;
 244   fillrectrequest->color.alpha = color.alpha * transform.alpha;
 245   request->request_data = fillrectrequest;
 246
 247   requests->push_back(request);
 248 }
 249
 250 void
 251 DrawingContext::get_light(const Vector& position, Color* color)
 252 {
 253   if( ambient_color.red == 1.0f && ambient_color.green == 1.0f
 254       && ambient_color.blue  == 1.0f ) {
 255     *color = Color( 1.0f, 1.0f, 1.0f);
 256     return;
 257   }
 258
 259   DrawingRequest* request = new(obst) DrawingRequest();
 260   request->target = target;
 261   request->type = GETLIGHT;
 262   request->pos = transform.apply(position);
 263
 264   //There is no light offscreen.
 265   if(request->pos.x >= SCREEN_WIDTH || request->pos.y >= SCREEN_HEIGHT
 266       || request->pos.x < 0 || request->pos.y < 0){
 267     *color = Color( 0, 0, 0);
 268     return;
 269   }
 270
 271   request->layer = LAYER_GUI; //make sure all get_light requests are handled last.
 272   GetLightRequest* getlightrequest = new(obst) GetLightRequest();
 273   getlightrequest->color_ptr = color;
 274   request->request_data = getlightrequest;
 275   lightmap_requests.push_back(request);
 276 }
 277
 278 void
 279 DrawingContext::do_drawing()
 280 {
 281 #ifdef DEBUG
 282   assert(transformstack.empty());
 283   assert(target_stack.empty());
 284 #endif
 285   transformstack.clear();
 286   target_stack.clear();
 287
 288   //Use Lightmap if ambient color is not white.
 289   bool use_lightmap = ( ambient_color.red != 1.0f   || ambient_color.green != 1.0f ||
 290                         ambient_color.blue  != 1.0f );
 291
 292   // PART1: create lightmap
 293   if(use_lightmap) {
 294     lightmap->start_draw(ambient_color);
 295     handle_drawing_requests(lightmap_requests);
 296     lightmap->end_draw();
 297   }
 298
 299   handle_drawing_requests(drawing_requests);
 300   if(use_lightmap) {
 301     lightmap->do_draw();
 302   }
 303   obstack_free(&obst, NULL);
 304   obstack_init(&obst);
 305
 306   // if a screenshot was requested, take one
 307   if (screenshot_requested) {
 308     renderer->do_take_screenshot();
 309     screenshot_requested = false;
 310   }
 311
 312   renderer->flip();
 313 }
 314
 315 class RequestPtrCompare
 316   :  public std::binary_function<const DrawingRequest*,
 317                                  const DrawingRequest*,
 318                                  bool>
 319 {
 320 public:
 321   bool operator()(const DrawingRequest* r1, const DrawingRequest* r2) const
 322   {
 323     return *r1 < *r2;
 324   }
 325 };
 326
 327 void
 328 DrawingContext::handle_drawing_requests(DrawingRequests& requests)
 329 {
 330   std::stable_sort(requests.begin(), requests.end(), RequestPtrCompare());
 331
 332   DrawingRequests::const_iterator i;
 333   for(i = requests.begin(); i != requests.end(); ++i) {
 334     const DrawingRequest& request = **i;
 335
 336     switch(request.target) {
 337       case NORMAL:
 338         switch(request.type) {
 339           case SURFACE:
 340             renderer->draw_surface(request);
 341             break;
 342           case SURFACE_PART:
 343             renderer->draw_surface_part(request);
 344             break;
 345           case GRADIENT:
 346             renderer->draw_gradient(request);
 347             break;
 348           case TEXT:
 349             {
 350               const TextRequest* textrequest = (TextRequest*) request.request_data;
 351               textrequest->font->draw(renderer, textrequest->text, request.pos,
 352                   textrequest->alignment, request.drawing_effect, request.alpha);
 353             }
 354             break;
 355           case FILLRECT:
 356             renderer->draw_filled_rect(request);
 357             break;
 358           case GETLIGHT:
 359             lightmap->get_light(request);
 360             break;
 361         }
 362         break;
 363       case LIGHTMAP:
 364         switch(request.type) {
 365           case SURFACE:
 366             lightmap->draw_surface(request);
 367             break;
 368           case SURFACE_PART:
 369             lightmap->draw_surface_part(request);
 370             break;
 371           case GRADIENT:
 372             lightmap->draw_gradient(request);
 373             break;
 374           case TEXT:
 375             {
 376               const TextRequest* textrequest = (TextRequest*) request.request_data;
 377               textrequest->font->draw(renderer, textrequest->text, request.pos,
 378                   textrequest->alignment, request.drawing_effect, request.alpha);
 379             }
 380             break;
 381           case FILLRECT:
 382             lightmap->draw_filled_rect(request);
 383             break;
 384           case GETLIGHT:
 385             lightmap->get_light(request);
 386             break;
 387         }
 388         break;
 389     }
 390   }
 391   requests.clear();
 392 }
 393
 394 void
 395 DrawingContext::push_transform()
 396 {
 397   transformstack.push_back(transform);
 398 }
 399
 400 void
 401 DrawingContext::pop_transform()
 402 {
 403   assert(!transformstack.empty());
 404
 405   transform = transformstack.back();
 406   transformstack.pop_back();
 407 }
 408
 409 void
 410 DrawingContext::set_drawing_effect(DrawingEffect effect)
 411 {
 412   transform.drawing_effect = effect;
 413 }
 414
 415 DrawingEffect
 416 DrawingContext::get_drawing_effect() const
 417 {
 418   return transform.drawing_effect;
 419 }
 420
 421 void
 422 DrawingContext::set_alpha(float alpha)
 423 {
 424   transform.alpha = alpha;
 425 }
 426
 427 float
 428 DrawingContext::get_alpha() const
 429 {
 430   return transform.alpha;
 431 }
 432
 433 void
 434 DrawingContext::push_target()
 435 {
 436   target_stack.push_back(target);
 437 }
 438
 439 void
 440 DrawingContext::pop_target()
 441 {
 442   set_target(target_stack.back());
 443   target_stack.pop_back();
 444 }
 445
 446 void
 447 DrawingContext::set_target(Target target)
 448 {
 449   this->target = target;
 450   if(target == LIGHTMAP) {
 451     requests = &lightmap_requests;
 452   } else {
 453     assert(target == NORMAL);
 454     requests = &drawing_requests;
 455   }
 456 }
 457
 458 void
 459 DrawingContext::set_ambient_color( Color new_color )
 460 {
 461   ambient_color = new_color;
 462 }
 463
 464 void
 465 DrawingContext::take_screenshot()
 466 {
 467   screenshot_requested = true;
 468 }
 469