Tweak icecrusher draw layers to avoid objects (such as coins) from appearing inside...
[supertux.git] / src / video / drawing_context.hpp
index fee4981..53e171a 100644 (file)
@@ -1,12 +1,10 @@
-//  $Id$
-//
 //  SuperTux
 //  Copyright (C) 2006 Matthias Braun <matze@braunis.de>
 //
-//  This program is free software; you can redistribute it and/or
-//  modify it under the terms of the GNU General Public License
-//  as published by the Free Software Foundation; either version 2
-//  of the License, or (at your option) any later version.
+//  This program is free software: you can redistribute it and/or modify
+//  it under the terms of the GNU General Public License as published by
+//  the Free Software Foundation, either version 3 of the License, or
+//  (at your option) any later version.
 //
 //  This program is distributed in the hope that it will be useful,
 //  but WITHOUT ANY WARRANTY; without even the implied warranty of
 //  GNU General Public License for more details.
 //
 //  You should have received a copy of the GNU General Public License
-//  along with this program; if not, write to the Free Software
-//  Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
+//  along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
-#ifndef SUPERTUX_DRAWINGCONTEXT_H
-#define SUPERTUX_DRAWINGCONTEXT_H
+#ifndef HEADER_SUPERTUX_VIDEO_DRAWING_CONTEXT_HPP
+#define HEADER_SUPERTUX_VIDEO_DRAWING_CONTEXT_HPP
 
-#include <vector>
+#include <memory>
 #include <string>
+#include <vector>
 #include <stdint.h>
+#include <obstack.h>
 
-#include <GL/gl.h>
-#include <SDL.h>
-#include <stdint.h>
-#include <memory>
-
+#include "math/rectf.hpp"
 #include "math/vector.hpp"
-#include "math/rect.hpp"
-#include "surface.hpp"
-#include "font.hpp"
-#include "color.hpp"
+#include "video/color.hpp"
+#include "video/font.hpp"
+#include "video/font_ptr.hpp"
+#include "video/texture.hpp"
 
+struct DrawingRequest;
 class Surface;
 class Texture;
+class VideoSystem;
 
 // some constants for predefined layer values
 enum {
+  // Image/gradient backgrounds (should cover entire screen)
   LAYER_BACKGROUND0 = -300,
+  // Particle backgrounds
   LAYER_BACKGROUND1 = -200,
+  // Tilemap backgrounds
   LAYER_BACKGROUNDTILES = -100,
+  // Solid tilemaps
   LAYER_TILES = 0,
+  // Ordinary objects
   LAYER_OBJECTS = 50,
+  // Objects that pass through walls
   LAYER_FLOATINGOBJECTS = 150,
+  //
   LAYER_FOREGROUNDTILES = 200,
+  //
   LAYER_FOREGROUND0 = 300,
+  //
   LAYER_FOREGROUND1 = 400,
+  // Hitpoints, time, coins, etc.
   LAYER_HUD = 500,
+  // Menus, mouse, console etc.
   LAYER_GUI         = 600
 };
 
@@ -68,6 +76,10 @@ public:
   {}
 };
 
+enum Target {
+  NORMAL, LIGHTMAP
+};
+
 /**
  * This class provides functions for drawing things on screen. It also
  * maintains a stack of transforms that are applied to graphics.
@@ -75,34 +87,41 @@ public:
 class DrawingContext
 {
 public:
-  DrawingContext();
+  DrawingContext(VideoSystem& video_system);
   ~DrawingContext();
 
   /// Adds a drawing request for a surface into the request list.
-  void draw_surface(const Surface* surface, const Vector& position,
+  void draw_surface(SurfacePtr surface, const Vector& position,
                     int layer);
   /// Adds a drawing request for a surface into the request list.
-  void draw_surface(const Surface* surface, const Vector& position,
+  void draw_surface(SurfacePtr surface, const Vector& position,
                     float angle, const Color& color, const Blend& blend,
                     int layer);
   /// Adds a drawing request for part of a surface.
-  void draw_surface_part(const Surface* surface, const Vector& source,
-                         const Vector& size, const Vector& dest, int layer);
+  void draw_surface_part(SurfacePtr surface,
+                         const Rectf& srcrect, const Rectf& dstrect,
+                         int layer);
   /// Draws a text.
-  void draw_text(const Font* font, const std::string& text,
-                 const Vector& position, FontAlignment alignment, int layer);
+  void draw_text(FontPtr font, const std::string& text,
+                 const Vector& position, FontAlignment alignment, int layer, Color color = Color(1.0,1.0,1.0));
 
   /// Draws text on screen center (feed Vector.x with a 0).
   /// This is the same as draw_text() with a SCREEN_WIDTH/2 position and
-  /// alignment set to LEFT_ALLIGN
-  void draw_center_text(const Font* font, const std::string& text,
-                        const Vector& position, int layer);
+  /// alignment set to LEFT_ALIGN
+  void draw_center_text(FontPtr font, const std::string& text,
+                        const Vector& position, int layer, Color color = Color(1.0,1.0,1.0));
   /// Draws a color gradient onto the whole screen */
   void draw_gradient(const Color& from, const Color& to, int layer);
   /// Fills a rectangle.
   void draw_filled_rect(const Vector& topleft, const Vector& size,
                         const Color& color, int layer);
-  void draw_filled_rect(const Rect& rect, const Color& color, int layer);
+  void draw_filled_rect(const Rectf& rect, const Color& color, int layer);
+  void draw_filled_rect(const Rectf& rect, const Color& color, float radius, int layer);
+
+  void draw_inverse_ellipse(const Vector& pos, const Vector& size, const Color& color, int layer);
+
+  /// Returns the visible area in world coordinates
+  Rectf get_cliprect() const;
 
   /// Processes all pending drawing requests and flushes the list.
   void do_drawing();
@@ -125,15 +144,29 @@ public:
   /// return currently set alpha
   float get_alpha() const;
 
-  enum Target {
-    NORMAL, LIGHTMAP
-  };
+  /// on next update, set color to lightmap's color at position
+  void get_light(const Vector& position, Color* color );
+
+  typedef ::Target Target;
+  static const Target NORMAL = ::NORMAL;
+  static const Target LIGHTMAP = ::LIGHTMAP;
   void push_target();
   void pop_target();
   void set_target(Target target);
-  
+
   void set_ambient_color( Color new_color );
 
+  /**
+   * requests that a screenshot be taken after the next frame has been rendered
+   */
+  void take_screenshot();
+
+private:
+  typedef std::vector<DrawingRequest*> DrawingRequests;
+
+private:
+  void handle_drawing_requests(DrawingRequests& requests);
+
 private:
   class Transform
   {
@@ -142,8 +175,10 @@ private:
     DrawingEffect drawing_effect;
     float alpha;
 
-    Transform()
-      : drawing_effect(NO_EFFECT), alpha(1.0f)
+    Transform() :
+      translation(),
+      drawing_effect(NO_EFFECT),
+      alpha(1.0f)
     { }
 
     Vector apply(const Vector& v) const
@@ -152,6 +187,11 @@ private:
     }
   };
 
+  void clear_drawing_requests(DrawingRequests& requests);
+
+private:
+  VideoSystem& video_system;
+
   /// the transform stack
   std::vector<Transform> transformstack;
   /// the currently active transform
@@ -160,83 +200,25 @@ private:
   std::vector<Blend> blend_stack;
   Blend blend_mode;
 
-  enum RequestType
-  {
-    SURFACE, SURFACE_PART, TEXT, GRADIENT, FILLRECT, LIGHTMAPREQUEST
-  };
-
-  struct SurfacePartRequest
-  {
-    const Surface* surface;
-    Vector source, size;
-  };
-
-  struct TextRequest
-  {
-    const Font* font;
-    std::string text;
-    FontAlignment alignment;
-  };
-
-  struct GradientRequest
-  {
-    Color top, bottom;
-    Vector size;
-  };
-
-  struct FillRectRequest
-  {
-    Color color;
-    Vector size;
-  };
-
-  struct DrawingRequest
-  {
-    RequestType type;
-    Vector pos;
-
-    int layer;
-    DrawingEffect drawing_effect;
-    float alpha;
-    Blend blend;
-    float angle;
-    Color color;
-
-    void* request_data;
-
-    DrawingRequest()
-      : angle(0.0f),
-        color(1.0f, 1.0f, 1.0f, 1.0f)
-    {}
-
-    bool operator<(const DrawingRequest& other) const
-    {
-      return layer < other.layer;
-    }
-  };
-
-  typedef std::vector<DrawingRequest> DrawingRequests;
-
-  void handle_drawing_requests(DrawingRequests& requests);
-  void draw_surface_part(DrawingRequest& request);
-  void draw_text(DrawingRequest& request);
-  void draw_text_center(DrawingRequest& request);
-  void draw_gradient(DrawingRequest& request);
-  void draw_filled_rect(DrawingRequest& request);
-  void draw_lightmap(DrawingRequest& request);
-
   DrawingRequests drawing_requests;
   DrawingRequests lightmap_requests;
 
   DrawingRequests* requests;
   Color ambient_color;
 
-  SDL_Surface* screen;
   Target target;
   std::vector<Target> target_stack;
-  Texture* lightmap;
-  int lightmap_width, lightmap_height;
-  float lightmap_uv_right, lightmap_uv_bottom;
+
+  /* obstack holding the memory of the drawing requests */
+  struct obstack obst;
+
+  bool screenshot_requested; /**< true if a screenshot should be taken after the next frame has been rendered */
+
+private:
+  DrawingContext(const DrawingContext&);
+  DrawingContext& operator=(const DrawingContext&);
 };
 
 #endif
+
+/* EOF */