src/video/drawing_context.hpp

   1 //  $Id: drawing_context.h 2334 2005-04-04 16:26:14Z grumbel $
   2 //
   3 //  SuperTux -  A Jump'n Run
   4 //  Copyright (C) 2004 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 #ifndef SUPERTUX_DRAWINGCONTEXT_H
  20 #define SUPERTUX_DRAWINGCONTEXT_H
  21
  22 #include <vector>
  23 #include <string>
  24 #include <stdint.h>
  25
  26 #include <SDL.h>
  27 #include <stdint.h>
  28 #include <memory>
  29
  30 #include "math/vector.hpp"
  31 #include "video/screen.hpp"
  32 #include "video/surface.hpp"
  33 #include "video/font.hpp"
  34
  35 class Surface;
  36 class Texture;
  37
  38 // some constants for predefined layer values
  39 enum {
  40   LAYER_BACKGROUND0 = -300,
  41   LAYER_BACKGROUND1 = -200,
  42   LAYER_BACKGROUNDTILES = -100,
  43   LAYER_TILES = 0,
  44   LAYER_OBJECTS = 100,
  45   LAYER_FOREGROUNDTILES = 200,
  46   LAYER_FOREGROUND0 = 300,
  47   LAYER_FOREGROUND1 = 400,
  48   LAYER_GUI         = 500
  49 };
  50
  51 /**
  52  * This class provides functions for drawing things on screen. It also
  53  * maintains a stack of transforms that are applied to graphics.
  54  */
  55 class DrawingContext
  56 {
  57 public:
  58   DrawingContext();
  59   ~DrawingContext();
  60
  61   /// Adds a drawing request for a surface into the request list.
  62   void draw_surface(const Surface* surface, const Vector& position,
  63                     int layer);
  64   /// Adds a drawing request for part of a surface.
  65   void draw_surface_part(const Surface* surface, const Vector& source,
  66                          const Vector& size, const Vector& dest, int layer);
  67   /// Draws a text.
  68   void draw_text(const Font* font, const std::string& text,
  69                  const Vector& position, FontAlignment alignment, int layer);
  70
  71   /// Draws text on screen center (feed Vector.x with a 0).
  72   /// This is the same as draw_text() with a SCREEN_WIDTH/2 position and
  73   /// alignment set to LEFT_ALLIGN
  74   void draw_center_text(const Font* font, const std::string& text,
  75                         const Vector& position, int layer);
  76   /// Draws a color gradient onto the whole screen */
  77   void draw_gradient(Color from, Color to, int layer);
  78   /// Fills a rectangle.
  79   void draw_filled_rect(const Vector& topleft, const Vector& size,
  80                         Color color, int layer);
  81
  82   /// Processes all pending drawing requests and flushes the list.
  83   void do_drawing();
  84
  85   const Vector& get_translation() const
  86   {  return transform.translation;  }
  87
  88   void set_translation(const Vector& newtranslation)
  89   {  transform.translation = newtranslation;  }
  90
  91   void push_transform();
  92   void pop_transform();
  93
  94   /// Apply that effect in the next draws (effects are listed on surface.h).
  95   void set_drawing_effect(uint32_t effect);
  96   /// return currently applied drawing effect
  97   uint32_t get_drawing_effect() const;
  98   /// apply that zoom in the next draws */
  99   void set_zooming(float zoom);
 100   /// apply that alpha in the next draws */
 101   void set_alpha(uint8_t alpha);
 102   /// return currently set alpha
 103   uint8_t get_alpha() const;
 104
 105   enum Target {
 106     NORMAL, LIGHTMAP
 107   };
 108   void push_target();
 109   void pop_target();
 110   void set_target(Target target);
 111
 112 private:
 113   class Transform
 114   {
 115   public:
 116     Vector translation;
 117     uint32_t drawing_effect;
 118     float zoom;
 119     uint8_t alpha;
 120
 121     Transform()
 122       : drawing_effect(NONE_EFFECT), zoom(1), alpha(255)
 123     { }
 124
 125     Vector apply(const Vector& v) const
 126     {
 127       return v - translation;
 128     }
 129   };
 130
 131   /// the transform stack
 132   std::vector<Transform> transformstack;
 133   /// the currently active transform
 134   Transform transform;
 135
 136   class Blend
 137   {
 138   public:
 139     GLenum sfactor;
 140     GLenum dfactor;
 141
 142     Blend()
 143       : sfactor(GL_SRC_ALPHA), dfactor(GL_ONE_MINUS_SRC_ALPHA)
 144     {}
 145   };
 146   std::vector<Blend> blend_stack;
 147   Blend blend_mode;
 148
 149   enum RequestType
 150   {
 151     SURFACE, SURFACE_PART, TEXT, GRADIENT, FILLRECT
 152   };
 153
 154   struct SurfacePartRequest
 155   {
 156     const Surface* surface;
 157     Vector source, size;
 158   };
 159
 160   struct TextRequest
 161   {
 162     const Font* font;
 163     std::string text;
 164     FontAlignment alignment;
 165   };
 166
 167   struct GradientRequest
 168   {
 169     Color top, bottom;
 170     Vector size;
 171   };
 172
 173   struct FillRectRequest
 174   {
 175     Color color;
 176     Vector size;
 177   };
 178
 179   struct DrawingRequest
 180   {
 181     RequestType type;
 182     Vector pos;
 183
 184     int layer;
 185     uint32_t drawing_effect;
 186     float zoom;
 187     int alpha;
 188     Blend blend;
 189
 190     void* request_data;
 191
 192     bool operator<(const DrawingRequest& other) const
 193     {
 194       return layer < other.layer;
 195     }
 196   };
 197
 198   typedef std::vector<DrawingRequest> DrawingRequests;
 199
 200   void handle_drawing_requests(DrawingRequests& requests);
 201   void draw_surface_part(DrawingRequest& request);
 202   void draw_text(DrawingRequest& request);
 203   void draw_text_center(DrawingRequest& request);
 204   void draw_gradient(DrawingRequest& request);
 205   void draw_filled_rect(DrawingRequest& request);
 206
 207   DrawingRequests drawing_requests;
 208   DrawingRequests lightmap_requests;
 209
 210   DrawingRequests* requests;
 211
 212   SDL_Surface* screen;
 213   Target target;
 214   std::vector<Target> target_stack;
 215   std::auto_ptr<Texture> lightmap;
 216   int lightmap_width, lightmap_height;
 217   float lightmap_uv_right, lightmap_uv_bottom;
 218 };
 219
 220 #endif