zoom_graphic_context.hxx

   1 //  $Id: zoom_graphic_context.hxx,v 1.13 2003/07/24 21:33:11 grumbel Exp $
   2 //
   3 //  Construo - A wire-frame construction game
   4 //  Copyright (C) 2002 Ingo Ruhnke <grumbel@gmx.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
  20 #ifndef HEADER_ZOOM_GRAPHIC_CONTEXT_HXX
  21 #define HEADER_ZOOM_GRAPHIC_CONTEXT_HXX
  22
  23 #include "vector2d.hxx"
  24 #include "graphic_context.hxx"
  25
  26 /** A GraphicContext, that wraps another GraphicContext and adds
  27     coordinate translation like zoom and scrolling */
  28 class ZoomGraphicContext : public GraphicContext
  29 {
  30 private:
  31   int x1;
  32   int y1;
  33   int x2;
  34   int y2;
  35
  36   GraphicContext* parent_gc;
  37
  38   float x_offset;
  39   float y_offset;
  40   float zoom;
  41
  42   int translate_x (int);
  43   int translate_y (int);
  44 public:
  45   ZoomGraphicContext ();
  46   ZoomGraphicContext (int x1_, int y1_, int x2_, int y2_);
  47
  48   void set_clip_rect (int x1_, int y1_, int x2_, int y2_);
  49
  50   /** Sets the clipping rectangles needed for the GC */
  51   void lock ();
  52
  53   /** Resets the clipping to the old state */
  54   void unlock ();
  55
  56   void draw_lines (std::vector<Line>& lines, Color color, int wide = 0);
  57   void draw_line(float x1, float y1, float x2, float y2, Color color, int wide = 0);
  58   void draw_rect(float x1, float y1, float x2, float y2, Color color);
  59   void draw_circle(float x, float y, float r, Color color);
  60   void draw_circles(std::vector<Circle>& circles, Color color);
  61   void draw_fill_circle(float x, float y, float r, Color color);
  62   void draw_fill_rect(float x1, float y1, float x2, float y2, Color color);
  63   void draw_string(float x, float y, const std::string& str, Color color = Color (0xFFFFFFFF));
  64   void draw_string_centered(float x, float y, const std::string& str, Color color = Color (0xFFFFFFFF));
  65
  66   int get_width ();
  67   int get_height ();
  68
  69   void clear ()  { parent_gc->clear (); }
  70
  71   /** FIXME: flip should be handled outsite of GraphicContext */
  72   void flip () { parent_gc->flip (); }
  73
  74   void set_parent_gc (GraphicContext* gc);
  75
  76   /**
  77    * Zoom Out the GraphicContext by one 'unit', using the x and y
  78    * position as center.
  79    *
  80    * @param x x in screen coordinates
  81    * @param y y in screen coordinates
  82    *
  83    * @return true if zoom was successfull, false if zoom boundaries
  84    * have been reached
  85    */
  86   bool zoom_in (int x, int y);
  87
  88   /**
  89    * Zoom Into the GraphicContext by one 'unit', using the x and y
  90    * position as center.
  91    *
  92    * @param x x in screen coordinates
  93    * @param y y in screen coordinates
  94    *
  95    * @return true if zoom was successfull, false if zoom boundaries
  96    * have been reached
  97    */
  98   bool zoom_out (int x, int y);
  99
 100   /**
 101    * Zoom into the given area, all coordinates in world units
 102    *
 103    * @param x1 left border in world coordinates
 104    * @param y1 top border in world coordinates
 105    * @param x2 right border in world coordinates
 106    * @param y2 bottom border in world coordinates
 107    */
 108   void zoom_to (int x1, int y1, int x2, int y2);
 109
 110   /** Move to the given x and y world coordinates to the center of the
 111       screen */
 112   void move_to (float x, float y);
 113
 114   /** Allows a client application to make use of the partent GC in
 115       case it wants to draw elements which should not get scaled */
 116   GraphicContext* get_parent_gc () { return parent_gc; }
 117
 118   /** Move the current position relativly x/y width */
 119   void translate_offset (int x, int y);
 120
 121  /** FIXME: What exactly is an offset?! */
 122   void set_offset (float x, float y);
 123
 124   /** FIXME: What exactly is an offset?! */
 125   float get_x_offset () { return x_offset; }
 126
 127   /** FIXME: What exactly is an offset?! */
 128   float get_y_offset () { return y_offset; }
 129
 130   /** @return current zoom factor in use */
 131   float get_zoom () const { return zoom; }
 132
 133   /** Set the zoom factor, if zoom is to large/small false will
 134       returned and zoom will be set to lowest/highest possible
 135       value */
 136   bool  set_zoom (const float& z);
 137
 138   /** Convert a coordinate from screen units to world units */
 139   float screen_to_world_x (float x);
 140
 141   /** Convert a coordinate from screen units to world units */
 142   float screen_to_world_y (float y);
 143
 144   /** Convert a coordinate from world units to screen units */
 145   float world_to_screen_x (float x);
 146
 147   /** Convert a coordinate from world units to screen units */
 148   float world_to_screen_y (float y);
 149
 150   /** Convert a coordinate from screen units to world units */
 151   Vector2d screen_to_world (const Vector2d&);
 152
 153   /** Convert a coordinate from world units to screen units */
 154   Vector2d world_to_screen (const Vector2d&);
 155
 156   void flip (int x1, int y1, int x2, int y2);
 157
 158   void push_quick_draw() { parent_gc->push_quick_draw(); }
 159   void pop_quick_draw()  { parent_gc->pop_quick_draw(); }
 160 };
 161
 162 #endif
 163
 164 /* EOF */