src/video/drawing_context.hpp

   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 #ifndef SUPERTUX_DRAWINGCONTEXT_H
  20 #define SUPERTUX_DRAWINGCONTEXT_H
  21
  22 #include <vector>
  23 #include <string>
  24 #include <memory>
  25
  26 #include <stdint.h>
  27
  28 #include <SDL_video.h>
  29
  30 #include "glutil.hpp"
  31 #include "obstack/obstack.h"
  32 #include "math/vector.hpp"
  33 #include "math/rect.hpp"
  34 #include "drawing_request.hpp"
  35 #include "font.hpp"
  36 #include "color.hpp"
  37
  38 class Surface;
  39 class Texture;
  40 struct DrawingRequest;
  41 class Renderer;
  42 class Lightmap;
  43
  44 /**
  45  * This class provides functions for drawing things on screen. It also
  46  * maintains a stack of transforms that are applied to graphics.
  47  */
  48 class DrawingContext
  49 {
  50 public:
  51   DrawingContext();
  52   ~DrawingContext();
  53
  54   void init_renderer();
  55
  56   /// Adds a drawing request for a surface into the request list.
  57   void draw_surface(const Surface* surface, const Vector& position,
  58                     int layer);
  59   /// Adds a drawing request for a surface into the request list.
  60   void draw_surface(const Surface* surface, const Vector& position,
  61                     float angle, const Color& color, const Blend& blend,
  62                     int layer);
  63   /// Adds a drawing request for part of a surface.
  64   void draw_surface_part(const Surface* surface, const Vector& source,
  65                          const Vector& size, const Vector& dest, int layer);
  66   /// Draws a text.
  67   void draw_text(const Font* font, const std::string& text,
  68                  const Vector& position, FontAlignment alignment, int layer);
  69
  70   /// Draws text on screen center (feed Vector.x with a 0).
  71   /// This is the same as draw_text() with a SCREEN_WIDTH/2 position and
  72   /// alignment set to LEFT_ALLIGN
  73   void draw_center_text(const Font* font, const std::string& text,
  74                         const Vector& position, int layer);
  75   /// Draws a color gradient onto the whole screen */
  76   void draw_gradient(const Color& from, const Color& to, int layer);
  77   /// Fills a rectangle.
  78   void draw_filled_rect(const Vector& topleft, const Vector& size,
  79                         const Color& color, int layer);
  80   void draw_filled_rect(const Rect& rect, const Color& color, int layer);
  81   void draw_filled_rect(const Rect& rect, const Color& color, float radius, int layer);
  82
  83   /// Processes all pending drawing requests and flushes the list.
  84   void do_drawing();
  85
  86   const Vector& get_translation() const
  87   {  return transform.translation;  }
  88
  89   void set_translation(const Vector& newtranslation)
  90   {  transform.translation = newtranslation;  }
  91
  92   void push_transform();
  93   void pop_transform();
  94
  95   /// Apply that effect in the next draws (effects are listed on surface.h).
  96   void set_drawing_effect(DrawingEffect effect);
  97   /// return currently applied drawing effect
  98   DrawingEffect get_drawing_effect() const;
  99   /// apply that alpha in the next draws (1.0 means fully opaque) */
 100   void set_alpha(float alpha);
 101   /// return currently set alpha
 102   float get_alpha() const;
 103
 104   /// on next update, set color to lightmap's color at position
 105   void get_light(const Vector& position, Color* color );
 106
 107   typedef ::Target Target;
 108   static const Target NORMAL = ::NORMAL;
 109   static const Target LIGHTMAP = ::LIGHTMAP;
 110   void push_target();
 111   void pop_target();
 112   void set_target(Target target);
 113
 114   void set_ambient_color( Color new_color );
 115
 116   /**
 117    * requests that a screenshot be taken after the next frame has been rendered
 118    */
 119   void take_screenshot();
 120
 121 private:
 122   class Transform
 123   {
 124   public:
 125     Vector translation;
 126     DrawingEffect drawing_effect;
 127     float alpha;
 128
 129     Transform()
 130       : drawing_effect(NO_EFFECT), alpha(1.0f)
 131     { }
 132
 133     Vector apply(const Vector& v) const
 134     {
 135       return v - translation;
 136     }
 137   };
 138
 139   Renderer *renderer;
 140   Lightmap *lightmap;
 141
 142   /// the transform stack
 143   std::vector<Transform> transformstack;
 144   /// the currently active transform
 145   Transform transform;
 146
 147   std::vector<Blend> blend_stack;
 148   Blend blend_mode;
 149
 150   typedef std::vector<DrawingRequest*> DrawingRequests;
 151
 152   void handle_drawing_requests(DrawingRequests& requests);
 153
 154   DrawingRequests drawing_requests;
 155   DrawingRequests lightmap_requests;
 156
 157   DrawingRequests* requests;
 158   Color ambient_color;
 159
 160   Target target;
 161   std::vector<Target> target_stack;
 162
 163   /* obstack holding the memory of the drawing requests */
 164   struct obstack obst;
 165
 166   bool screenshot_requested; /**< true if a screenshot should be taken after the next frame has been rendered */
 167 };
 168
 169 #endif
 170