--- /dev/null
+// Copyright (C) 2006 Ulf Lorenz
+// Copyright (C) 2007, 2008, 2009 Ben Asselstine
+// Copyright (C) 2007 Ole Laursen
+//
+// 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
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+// GNU Library 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., 51 Franklin Street, Fifth Floor, Boston, MA
+// 02110-1301, USA.
+
+#ifndef OVERVIEWMAP_H
+#define OVERVIEWMAP_H
+
+#include <sigc++/trackable.h>
+#include <gtkmm.h>
+#include "vector.h"
+#include "rectangle.h"
+#include "Tile.h"
+#include "SmallTile.h"
+
+class Maptile;
+class Player;
+
+//! Generates a miniature graphic of the game map.
+/**
+ * This is a base class that draws the terrain, ruins, temples, and roads
+ * onto a Gdk::Pixmap.
+ * This class is responsible for drawing terrain features using the correct
+ * pattern, as specified in Tile::Pattern. Ruins and Temples are drawn as
+ * white dots, and roads are drawn as brown lines.
+ * If a tile on the game map is obscured due to fog of war on a hidden map,
+ * it appears as black.
+ * This class provides a method for optionally drawing cities onto the map.
+ * Derived classes can add their own stuff to the map by overriding the
+ * after_draw method that is called by OverviewMap::draw.
+ */
+class OverviewMap : public sigc::trackable
+{
+ public:
+ //! Default constructor.
+ /**
+ * Make a new overview map. This constructor doesn't do anything, the
+ * real work is done in the OverviewMap::resize and OverviewMap::draw
+ * methods.
+ * This constructor is not normally called by itself, usually it is
+ * called by a derived class.
+ */
+ OverviewMap();
+
+ //! Destructor.
+ virtual ~OverviewMap();
+
+
+ //! Draw and scale the miniature map graphic to the given size.
+ /**
+ * This method is responsible for drawing the terrain (e.g. grass, water,
+ * etc), but not the terrain features (roads, ruins, etc).
+ * It will draw a map that is max_dimensions large, but will keep it's
+ * aspect ratio.
+ * This method should be called before the draw method.
+ *
+ * @param max_dimensions Two integers; the first of which dictates the
+ * width of the map graphic, and the second dictates
+ * the height.
+ *
+ */
+ void resize(Vector<int> max_dimensions);
+
+ //! Draw and scale the mini map graphic to the correct size of the game map.
+ /**
+ * @note This method depends on the map being one of the 3 sizes as
+ * defined in the GamePreferencesDialog.
+ * This method should be called before the draw method.
+ */
+ void resize();
+
+ //! Draw the terrain features (roads, ruins, etc) on the map.
+ /**
+ * Draws the roads, cities, ruins, temples and roads onto the map in the
+ * correct aspect ratio.
+ *
+ * @param player draw the map from the given player's perspective.
+ *
+ *
+ * The aspect ratio for the terrain features is governed by the dimensions
+ * passed to the OverviewMap::resize method.
+ *
+ * This method calls the after_draw method from the derived classes.
+ */
+ void draw(Player *player);
+
+ //! Redraw a portion of the map graphic.
+ /**
+ * This method draws the terrain (water, grass, etc) for the given
+ * portion of the screen.
+ *
+ * @note This method redraws all terrain features (roads, ruins, etc),
+ * including the features outside of the given portion.
+ *
+ * @param tiles The rectangle to redraw.
+ */
+ void redraw_tiles(Rectangle tiles);
+
+ //! Returns the map graphic.
+ /**
+ * It only makes sense to get the surface after OverviewMap::resize and
+ * OverviewMap::draw have been called.
+ */
+ Glib::RefPtr<Gdk::Pixmap> get_surface();
+
+
+ static void draw_terrain_tile (Glib::RefPtr<Gdk::Pixmap> surf,
+ Glib::RefPtr<Gdk::GC> gc,
+ SmallTile::Pattern pattern,
+ Gdk::Color first,
+ Gdk::Color second,
+ Gdk::Color third,
+ int i, int j, bool shadowed);
+
+ static void draw_pixel(Glib::RefPtr<Gdk::Pixmap> surf, Glib::RefPtr<Gdk::GC> gc, int x, int y, Gdk::Color color);
+
+
+ void draw_filled_rect(int x, int y, int width, int height, Gdk::Color color);
+
+ void draw_rect(int x, int y, int width, int height, Gdk::Color color);
+
+ void draw_line( int src_x, int src_y, int dst_x, int dst_y, Gdk::Color color);
+
+ //! Make the map go black.
+ void blank(bool on);
+
+ private:
+ //! An SDL surface of the terrain without the features.
+ /**
+ * This is the cached surface after the resize method was called.
+ * It is cached so that we don't have recalculate it.
+ */
+ Glib::RefPtr<Gdk::Pixmap> static_surface;
+ Glib::RefPtr<Gdk::GC> static_surface_gc;
+
+ //! Returns whether or not the given pixel appears sunken (Tile::SUNKEN).
+ /**
+ * The leftmost and bottommost pixels of a sunken terrain type are shaded
+ * in a different colour. This method returns whether or not a given pixel
+ * should be shaded.
+ *
+ * @param type The tile associated with the pixel location must be of
+ * this type. If not, then this method always returns false.
+ * @param i The pixel on the horizontal axis on the map graphic that
+ * we're querying.
+ * @param j The pixel on the vertical axis on the map graphic that
+ * we're querying.
+ *
+ * @return True if the given pixel location should be shaded, false if not.
+ */
+ bool isShadowed(guint32 type, int i, int j);
+
+ //! Draw the given tile at the given pixel location on the map.
+ /**
+ * This method draws a square that is Overviewmap::pixels_per_tile pixels
+ * in height and width. It draws it at position (i,j) on the graphic.
+ * This method uses the pattern assocaited the given Maptile to know
+ * what this box should look like.
+ *
+ * @param tile The tile of the game map we're trying to draw.
+ * @param i The pixel on the horizontal axis of the map graphic. This
+ * value must be a multiple of OverviewMap::pixels_per_tile.
+ * @param j The pixel on the vertical axis of the map graphic. This
+ * value must be a multiple of OverviewMap::pixels_per_tile.
+ */
+ void draw_terrain_tile (Maptile *tile, int i, int j);
+
+
+ void choose_surface(bool front, Glib::RefPtr<Gdk::Pixmap> &surf,
+ Glib::RefPtr<Gdk::GC> &gc);
+ void draw_filled_rect(bool front, int x, int y, int width, int height, Gdk::Color color);
+
+ void draw_rect(bool front, int x, int y, int width, int height, Gdk::Color color);
+
+ void draw_line(bool front, int src_x, int src_y, int dst_x, int dst_y, Gdk::Color color);
+ protected:
+
+ //! Every pixel on the graphic is this wide and tall.
+ double pixels_per_tile;
+
+ //! Maps the given point in graphic coordinates to a game map coordinate.
+ Vector<int> mapFromScreen(Vector<int> pos);
+
+ //! And the other way round. Map a map coordinate to a surface pixel.
+ Vector<int> mapToSurface(Vector<int> pos);
+
+ //! A hook method for derived classes to put features on the map.
+ virtual void after_draw();
+
+ //! This method draws the cities onto the map.
+ /**
+ * Scan through all of the cities in the citylist, and draw each one with
+ * a small shield graphic belonging to the owner of that city.
+ *
+ * Derived classes may call this method in their after_draw method.
+ *
+ * @param all_razed Show each city as if it were razed.
+ */
+ void draw_cities(bool all_razed);
+
+ //! Redraw the specified region.
+ void draw_terrain_tiles(Rectangle r);
+
+ int calculateResizeFactor();
+
+ //! The surface containing the drawn map.
+ Glib::RefPtr<Gdk::Pixmap> surface;
+ Glib::RefPtr<Gdk::GC> surface_gc;
+
+
+ bool blank_screen;
+};
+
+#endif // OVERVIEWMAP_H
projects / lordsawar / blobdiff