src/smallmap_gui.h

   1 /* $Id$ */
   2
   3 /*
   4  * This file is part of OpenTTD.
   5  * OpenTTD 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, version 2.
   6  * OpenTTD 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.
   7  * See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with OpenTTD. If not, see <http://www.gnu.org/licenses/>.
   8  */
   9
  10 /** @file smallmap_gui.h Smallmap GUI functions. */
  11
  12 #ifndef SMALLMAP_GUI_H
  13 #define SMALLMAP_GUI_H
  14
  15 #include "industry_type.h"
  16 #include "window_gui.h"
  17 #include "strings_func.h"
  18 #include "blitter/factory.hpp"
  19 #include "linkgraph/linkgraph_gui.h"
  20 #include "widgets/smallmap_widget.h"
  21
  22 /* set up the cargos to be displayed in the smallmap's route legend */
  23 void BuildLinkStatsLegend();
  24
  25 void BuildIndustriesLegend();
  26 void ShowSmallMap();
  27 void BuildLandLegend();
  28 void BuildOwnerLegend();
  29
  30 /** Structure for holding relevant data for legends in small map */
  31 struct LegendAndColour {
  32         uint8 colour;              ///< Colour of the item on the map.
  33         StringID legend;           ///< String corresponding to the coloured item.
  34         IndustryType type;         ///< Type of industry. Only valid for industry entries.
  35         uint8 height;              ///< Height in tiles. Only valid for height legend entries.
  36         CompanyID company;         ///< Company to display. Only valid for company entries of the owner legend.
  37         bool show_on_map;          ///< For filtering industries, if \c true, industry is shown on the map in colour.
  38         bool end;                  ///< This is the end of the list.
  39         bool col_break;            ///< Perform a column break and go further at the next column.
  40 };
  41
  42 /** Class managing the smallmap window. */
  43 class SmallMapWindow : public Window {
  44 protected:
  45         /** Types of legends in the #WID_SM_LEGEND widget. */
  46         enum SmallMapType {
  47                 SMT_CONTOUR,
  48                 SMT_VEHICLES,
  49                 SMT_INDUSTRY,
  50                 SMT_LINKSTATS,
  51                 SMT_ROUTES,
  52                 SMT_VEGETATION,
  53                 SMT_OWNER,
  54         };
  55
  56         /** Available kinds of zoomlevel changes. */
  57         enum ZoomLevelChange {
  58                 ZLC_INITIALIZE, ///< Initialize zoom level.
  59                 ZLC_ZOOM_OUT,   ///< Zoom out.
  60                 ZLC_ZOOM_IN,    ///< Zoom in.
  61         };
  62
  63         static SmallMapType map_type; ///< Currently displayed legends.
  64         static bool show_towns;       ///< Display town names in the smallmap.
  65
  66         static const uint LEGEND_BLOB_WIDTH = 8;              ///< Width of the coloured blob in front of a line text in the #WID_SM_LEGEND widget.
  67         static const uint INDUSTRY_MIN_NUMBER_OF_COLUMNS = 2; ///< Minimal number of columns in the #WID_SM_LEGEND widget for the #SMT_INDUSTRY legend.
  68         static const uint FORCE_REFRESH_PERIOD = 0x1F; ///< map is redrawn after that many ticks
  69         static const uint BLINK_PERIOD         = 0x0F; ///< highlight blinking interval
  70
  71         uint min_number_of_columns;    ///< Minimal number of columns in legends.
  72         uint min_number_of_fixed_rows; ///< Minimal number of rows in the legends for the fixed layouts only (all except #SMT_INDUSTRY).
  73         uint column_width;             ///< Width of a column in the #WID_SM_LEGEND widget.
  74
  75         int32 scroll_x;  ///< Horizontal world coordinate of the base tile left of the top-left corner of the smallmap display.
  76         int32 scroll_y;  ///< Vertical world coordinate of the base tile left of the top-left corner of the smallmap display.
  77         int32 subscroll; ///< Number of pixels (0..3) between the right end of the base tile and the pixel at the top-left corner of the smallmap display.
  78         int zoom;        ///< Zoom level. Bigger number means more zoom-out (further away).
  79
  80         uint8 refresh;   ///< Refresh counter, zeroed every FORCE_REFRESH_PERIOD ticks.
  81         LinkGraphOverlay *overlay;
  82
  83         Point SmallmapRemapCoords(int x, int y) const;
  84
  85         /**
  86          * Draws vertical part of map indicator
  87          * @param x X coord of left/right border of main viewport
  88          * @param y Y coord of top border of main viewport
  89          * @param y2 Y coord of bottom border of main viewport
  90          */
  91         static inline void DrawVertMapIndicator(int x, int y, int y2)
  92         {
  93                 GfxFillRect(x, y,      x, y + 3, PC_VERY_LIGHT_YELLOW);
  94                 GfxFillRect(x, y2 - 3, x, y2,    PC_VERY_LIGHT_YELLOW);
  95         }
  96
  97         /**
  98          * Draws horizontal part of map indicator
  99          * @param x X coord of left border of main viewport
 100          * @param x2 X coord of right border of main viewport
 101          * @param y Y coord of top/bottom border of main viewport
 102          */
 103         static inline void DrawHorizMapIndicator(int x, int x2, int y)
 104         {
 105                 GfxFillRect(x,      y, x + 3, y, PC_VERY_LIGHT_YELLOW);
 106                 GfxFillRect(x2 - 3, y, x2,    y, PC_VERY_LIGHT_YELLOW);
 107         }
 108
 109         /**
 110          * Compute minimal required width of the legends.
 111          * @return Minimally needed width for displaying the smallmap legends in pixels.
 112          */
 113         inline uint GetMinLegendWidth() const
 114         {
 115                 return WD_FRAMERECT_LEFT + this->min_number_of_columns * this->column_width;
 116         }
 117
 118         /**
 119          * Return number of columns that can be displayed in \a width pixels.
 120          * @return Number of columns to display.
 121          */
 122         inline uint GetNumberColumnsLegend(uint width) const
 123         {
 124                 return width / this->column_width;
 125         }
 126
 127         /**
 128          * Compute height given a number of columns.
 129          * @param num_columns Number of columns.
 130          * @return Needed height for displaying the smallmap legends in pixels.
 131          */
 132         inline uint GetLegendHeight(uint num_columns) const
 133         {
 134                 return WD_FRAMERECT_TOP + WD_FRAMERECT_BOTTOM +
 135                                 this->GetNumberRowsLegend(num_columns) * FONT_HEIGHT_SMALL;
 136         }
 137
 138         uint GetNumberRowsLegend(uint columns) const;
 139         void SelectLegendItem(int click_pos, LegendAndColour *legend, int end_legend_item, int begin_legend_item = 0);
 140         void SwitchMapType(SmallMapType map_type);
 141         void SetNewScroll(int sx, int sy, int sub);
 142
 143         void DrawMapIndicators() const;
 144         void DrawSmallMapColumn(void *dst, uint xc, uint yc, int pitch, int reps, int start_pos, int end_pos, Blitter *blitter) const;
 145         void DrawVehicles(const DrawPixelInfo *dpi, Blitter *blitter) const;
 146         void DrawTowns(const DrawPixelInfo *dpi) const;
 147         void DrawSmallMap(DrawPixelInfo *dpi) const;
 148
 149         Point RemapTile(int tile_x, int tile_y) const;
 150         Point PixelToTile(int px, int py, int *sub, bool add_sub = true) const;
 151         Point ComputeScroll(int tx, int ty, int x, int y, int *sub);
 152         void SetZoomLevel(ZoomLevelChange change, const Point *zoom_pt);
 153         void SetOverlayCargoMask();
 154         void SetupWidgetData();
 155         uint32 GetTileColours(const TileArea &ta) const;
 156
 157         int GetPositionOnLegend(Point pt);
 158
 159 public:
 160         friend class NWidgetSmallmapDisplay;
 161
 162         SmallMapWindow(WindowDesc *desc, int window_number);
 163         virtual ~SmallMapWindow() { delete this->overlay; }
 164
 165         void SmallMapCenterOnCurrentPos();
 166         Point GetStationMiddle(const Station *st) const;
 167
 168         virtual void SetStringParameters(int widget) const;
 169         virtual void OnInit();
 170         virtual void OnPaint();
 171         virtual void DrawWidget(const Rect &r, int widget) const;
 172         virtual void OnClick(Point pt, int widget, int click_count);
 173         virtual void OnInvalidateData(int data = 0, bool gui_scope = true);
 174         virtual bool OnRightClick(Point pt, int widget);
 175         virtual void OnMouseWheel(int wheel);
 176         virtual void OnTick();
 177         virtual void OnScroll(Point delta);
 178         virtual void OnMouseOver(Point pt, int widget);
 179 };
 180
 181 #endif /* SMALLMAP_GUI_H */