mirror
/
OpenTTD
mirror of https://github.com/OpenTTD/OpenTTD
1
0
Fork 0
Code Issues

(svn r25018) -Codechange: Move SmallMapWindow declaration to header (fonsinchen)

release/1.4
rubidium 2013-02-17 20:38:35 +00:00
parent dcf3df65d3
commit 6b68956969
2 changed files with 998 additions and 954 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

305
src/smallmap_gui.cpp
View File

@ -14,20 +14,17 @@
#include "industry.h" #include "industry.h"
#include "station_map.h" #include "station_map.h"
#include "landscape.h" #include "landscape.h"
#include "window_gui.h"
#include "tree_map.h" #include "tree_map.h"
#include "viewport_func.h" #include "viewport_func.h"
#include "town.h" #include "town.h"
#include "blitter/factory.hpp"
#include "tunnelbridge_map.h" #include "tunnelbridge_map.h"
#include "strings_func.h"
#include "core/endian_func.hpp" #include "core/endian_func.hpp"
#include "vehicle_base.h" #include "vehicle_base.h"
#include "sound_func.h" #include "sound_func.h"
#include "window_func.h" #include "window_func.h"
#include "company_base.h" #include "company_base.h"
#include "widgets/smallmap_widget.h" #include "smallmap_gui.h"
#include "table/strings.h" #include "table/strings.h"
@ -64,18 +61,6 @@ static const uint8 PC_WATER = 0xCA; ///< Dark blue palette colour for
*/ */
#define MS(a, b) {a, b, INVALID_INDUSTRYTYPE, 0, INVALID_COMPANY, true, false, true} #define MS(a, b) {a, b, INVALID_INDUSTRYTYPE, 0, INVALID_COMPANY, true, false, true}
/** Structure for holding relevant data for legends in small map */
struct LegendAndColour {
uint8 colour; ///< Colour of the item on the map.
StringID legend; ///< String corresponding to the coloured item.
IndustryType type; ///< Type of industry. Only valid for industry entries.
uint8 height; ///< Height in tiles. Only valid for height legend entries.
CompanyID company; ///< Company to display. Only valid for company entries of the owner legend.
bool show_on_map; ///< For filtering industries, if \c true, industry is shown on the map in colour.
bool end; ///< This is the end of the list.
bool col_break; ///< Perform a column break and go further at the next column.
};
/** Legend text giving the colours to look for on the minimap */ /** Legend text giving the colours to look for on the minimap */
static LegendAndColour _legend_land_contours[] = { static LegendAndColour _legend_land_contours[] = {
/* The colours for the following values are set at BuildLandLegend() based on each colour scheme. */ /* The colours for the following values are set at BuildLandLegend() based on each colour scheme. */
@ -569,58 +554,22 @@ static const byte _vehicle_type_colours[6] = {
}; };
/** Class managing the smallmap window. */ inline Point SmallMapWindow::SmallmapRemapCoords(int x, int y) const
class SmallMapWindow : public Window { {
/** Types of legends in the #WID_SM_LEGEND widget. */
enum SmallMapType {
SMT_CONTOUR,
SMT_VEHICLES,
SMT_INDUSTRY,
SMT_ROUTES,
SMT_VEGETATION,
SMT_OWNER,
};
/** Available kinds of zoomlevel changes. */
enum ZoomLevelChange {
ZLC_INITIALIZE, ///< Initialize zoom level.
ZLC_ZOOM_OUT, ///< Zoom out.
ZLC_ZOOM_IN, ///< Zoom in.
};
static SmallMapType map_type; ///< Currently displayed legends.
static bool show_towns; ///< Display town names in the smallmap.
static const uint LEGEND_BLOB_WIDTH = 8; ///< Width of the coloured blob in front of a line text in the #WID_SM_LEGEND widget.
static const uint INDUSTRY_MIN_NUMBER_OF_COLUMNS = 2; ///< Minimal number of columns in the #WID_SM_LEGEND widget for the #SMT_INDUSTRY legend.
uint min_number_of_fixed_rows; ///< Minimal number of rows in the legends for the fixed layouts only (all except #SMT_INDUSTRY).
uint column_width; ///< Width of a column in the #WID_SM_LEGEND widget.
int32 scroll_x; ///< Horizontal world coordinate of the base tile left of the top-left corner of the smallmap display.
int32 scroll_y; ///< Vertical world coordinate of the base tile left of the top-left corner of the smallmap display.
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.
int zoom; ///< Zoom level. Bigger number means more zoom-out (further away).
static const uint FORCE_REFRESH_PERIOD = 0x1F; ///< map is redrawn after that many ticks
static const uint BLINK_PERIOD = 0x0F; ///< highlight blinking interval
uint8 refresh; ///< refresh counter, zeroed every FORCE_REFRESH_PERIOD ticks
inline Point SmallmapRemapCoords(int x, int y) const
{
Point pt; Point pt;
pt.x = (y - x) * 2; pt.x = (y - x) * 2;
pt.y = y + x; pt.y = y + x;
return pt; return pt;
} }
/** /**
* Remap tile to location on this smallmap. * Remap tile to location on this smallmap.
* @param tile_x X coordinate of the tile. * @param tile_x X coordinate of the tile.
* @param tile_y Y coordinate of the tile. * @param tile_y Y coordinate of the tile.
* @return Position to draw on. * @return Position to draw on.
*/ */
inline Point RemapTile(int tile_x, int tile_y) const inline Point SmallMapWindow::RemapTile(int tile_x, int tile_y) const
{ {
int x_offset = tile_x - this->scroll_x / (int)TILE_SIZE; int x_offset = tile_x - this->scroll_x / (int)TILE_SIZE;
int y_offset = tile_y - this->scroll_y / (int)TILE_SIZE; int y_offset = tile_y - this->scroll_y / (int)TILE_SIZE;
@ -631,9 +580,9 @@ class SmallMapWindow : public Window {
if (y_offset < 0) y_offset -= this->zoom - 1; if (y_offset < 0) y_offset -= this->zoom - 1;
return SmallmapRemapCoords(x_offset / this->zoom, y_offset / this->zoom); return SmallmapRemapCoords(x_offset / this->zoom, y_offset / this->zoom);
} }
/** /**
* Determine the tile relative to the base tile of the smallmap, and the pixel position at * Determine the tile relative to the base tile of the smallmap, and the pixel position at
* that tile for a point in the smallmap. * that tile for a point in the smallmap.
* @param px Horizontal coordinate of the pixel. * @param px Horizontal coordinate of the pixel.
@ -643,8 +592,8 @@ class SmallMapWindow : public Window {
* @return Tile being displayed at the given position relative to #scroll_x and #scroll_y. * @return Tile being displayed at the given position relative to #scroll_x and #scroll_y.
* @note The #subscroll offset is already accounted for. * @note The #subscroll offset is already accounted for.
*/ */
inline Point PixelToTile(int px, int py, int *sub, bool add_sub = true) const inline Point SmallMapWindow::PixelToTile(int px, int py, int *sub, bool add_sub) const
{ {
if (add_sub) px += this->subscroll; // Total horizontal offset. if (add_sub) px += this->subscroll; // Total horizontal offset.
/* For each two rows down, add a x and a y tile, and /* For each two rows down, add a x and a y tile, and
@ -664,9 +613,9 @@ class SmallMapWindow : public Window {
*sub = px; *sub = px;
return pt; return pt;
} }
/** /**
* Compute base parameters of the smallmap such that tile (\a tx, \a ty) starts at pixel (\a x, \a y). * Compute base parameters of the smallmap such that tile (\a tx, \a ty) starts at pixel (\a x, \a y).
* @param tx Tile x coordinate. * @param tx Tile x coordinate.
* @param ty Tile y coordinate. * @param ty Tile y coordinate.
@ -675,8 +624,8 @@ class SmallMapWindow : public Window {
* @param sub [out] Value of #subscroll needed. * @param sub [out] Value of #subscroll needed.
* @return #scroll_x, #scroll_y values. * @return #scroll_x, #scroll_y values.
*/ */
Point ComputeScroll(int tx, int ty, int x, int y, int *sub) Point SmallMapWindow::ComputeScroll(int tx, int ty, int x, int y, int *sub)
{ {
assert(x >= 0 && y >= 0); assert(x >= 0 && y >= 0);
int new_sub; int new_sub;
@ -695,16 +644,16 @@ class SmallMapWindow : public Window {
scroll.y = (ty - 2 * this->zoom) * TILE_SIZE; scroll.y = (ty - 2 * this->zoom) * TILE_SIZE;
} }
return scroll; return scroll;
} }
/** /**
* Initialize or change the zoom level. * Initialize or change the zoom level.
* @param change Way to change the zoom level. * @param change Way to change the zoom level.
* @param zoom_pt Position to keep fixed while zooming. * @param zoom_pt Position to keep fixed while zooming.
* @pre \c *zoom_pt should contain a point in the smallmap display when zooming in or out. * @pre \c *zoom_pt should contain a point in the smallmap display when zooming in or out.
*/ */
void SetZoomLevel(ZoomLevelChange change, const Point *zoom_pt) void SmallMapWindow::SetZoomLevel(ZoomLevelChange change, const Point *zoom_pt)
{ {
static const int zoomlevels[] = {1, 2, 4, 6, 8}; // Available zoom levels. Bigger number means more zoom-out (further away). static const int zoomlevels[] = {1, 2, 4, 6, 8}; // Available zoom levels. Bigger number means more zoom-out (further away).
static const int MIN_ZOOM_INDEX = 0; static const int MIN_ZOOM_INDEX = 0;
static const int MAX_ZOOM_INDEX = lengthof(zoomlevels) - 1; static const int MAX_ZOOM_INDEX = lengthof(zoomlevels) - 1;
@ -742,15 +691,15 @@ class SmallMapWindow : public Window {
this->SetWidgetDisabledState(WID_SM_ZOOM_OUT, this->zoom == zoomlevels[MAX_ZOOM_INDEX]); this->SetWidgetDisabledState(WID_SM_ZOOM_OUT, this->zoom == zoomlevels[MAX_ZOOM_INDEX]);
this->SetDirty(); this->SetDirty();
} }
} }
/** /**
* Decide which colours to show to the user for a group of tiles. * Decide which colours to show to the user for a group of tiles.
* @param ta Tile area to investigate. * @param ta Tile area to investigate.
* @return Colours to display. * @return Colours to display.
*/ */
inline uint32 GetTileColours(const TileArea &ta) const inline uint32 SmallMapWindow::GetTileColours(const TileArea &ta) const
{ {
int importance = 0; int importance = 0;
TileIndex tile = INVALID_TILE; // Position of the most important tile. TileIndex tile = INVALID_TILE; // Position of the most important tile.
TileType et = MP_VOID; // Effective tile type at that position. TileType et = MP_VOID; // Effective tile type at that position.
@ -785,9 +734,9 @@ class SmallMapWindow : public Window {
default: NOT_REACHED(); default: NOT_REACHED();
} }
} }
/** /**
* Draws one column of tiles of the small map in a certain mode onto the screen buffer, skipping the shifted rows in between. * Draws one column of tiles of the small map in a certain mode onto the screen buffer, skipping the shifted rows in between.
* *
* @param dst Pointer to a part of the screen buffer to write to. * @param dst Pointer to a part of the screen buffer to write to.
@ -800,8 +749,8 @@ class SmallMapWindow : public Window {
* @param blitter current blitter * @param blitter current blitter
* @note If pixel position is below \c 0, skip drawing. * @note If pixel position is below \c 0, skip drawing.
*/ */
void DrawSmallMapColumn(void *dst, uint xc, uint yc, int pitch, int reps, int start_pos, int end_pos, Blitter *blitter) const void SmallMapWindow::DrawSmallMapColumn(void *dst, uint xc, uint yc, int pitch, int reps, int start_pos, int end_pos, Blitter *blitter) const
{ {
void *dst_ptr_abs_end = blitter->MoveTo(_screen.dst_ptr, 0, _screen.height); void *dst_ptr_abs_end = blitter->MoveTo(_screen.dst_ptr, 0, _screen.height);
uint min_xy = _settings_game.construction.freeform_edges ? 1 : 0; uint min_xy = _settings_game.construction.freeform_edges ? 1 : 0;
@ -833,15 +782,15 @@ class SmallMapWindow : public Window {
} }
/* Switch to next tile in the column */ /* Switch to next tile in the column */
} while (xc += this->zoom, yc += this->zoom, dst = blitter->MoveTo(dst, pitch, 0), --reps != 0); } while (xc += this->zoom, yc += this->zoom, dst = blitter->MoveTo(dst, pitch, 0), --reps != 0);
} }
/** /**
* Adds vehicles to the smallmap. * Adds vehicles to the smallmap.
* @param dpi the part of the smallmap to be drawn into * @param dpi the part of the smallmap to be drawn into
* @param blitter current blitter * @param blitter current blitter
*/ */
void DrawVehicles(const DrawPixelInfo *dpi, Blitter *blitter) const void SmallMapWindow::DrawVehicles(const DrawPixelInfo *dpi, Blitter *blitter) const
{ {
const Vehicle *v; const Vehicle *v;
FOR_ALL_VEHICLES(v) { FOR_ALL_VEHICLES(v) {
if (v->type == VEH_EFFECT) continue; if (v->type == VEH_EFFECT) continue;
@ -873,14 +822,14 @@ class SmallMapWindow : public Window {
blitter->SetPixel(dpi->dst_ptr, x, y, colour); blitter->SetPixel(dpi->dst_ptr, x, y, colour);
if (!skip) blitter->SetPixel(dpi->dst_ptr, x + 1, y, colour); if (!skip) blitter->SetPixel(dpi->dst_ptr, x + 1, y, colour);
} }
} }
/** /**
* Adds town names to the smallmap. * Adds town names to the smallmap.
* @param dpi the part of the smallmap to be drawn into * @param dpi the part of the smallmap to be drawn into
*/ */
void DrawTowns(const DrawPixelInfo *dpi) const void SmallMapWindow::DrawTowns(const DrawPixelInfo *dpi) const
{ {
const Town *t; const Town *t;
FOR_ALL_TOWNS(t) { FOR_ALL_TOWNS(t) {
/* Remap the town coordinate */ /* Remap the town coordinate */
@ -898,37 +847,13 @@ class SmallMapWindow : public Window {
DrawString(x, x + t->cache.sign.width_small, y, STR_SMALLMAP_TOWN); DrawString(x, x + t->cache.sign.width_small, y, STR_SMALLMAP_TOWN);
} }
} }
} }
/** /**
* Draws vertical part of map indicator
* @param x X coord of left/right border of main viewport
* @param y Y coord of top border of main viewport
* @param y2 Y coord of bottom border of main viewport
*/
static inline void DrawVertMapIndicator(int x, int y, int y2)
{
GfxFillRect(x, y, x, y + 3, PC_VERY_LIGHT_YELLOW);
GfxFillRect(x, y2 - 3, x, y2, PC_VERY_LIGHT_YELLOW);
}
/**
* Draws horizontal part of map indicator
* @param x X coord of left border of main viewport
* @param x2 X coord of right border of main viewport
* @param y Y coord of top/bottom border of main viewport
*/
static inline void DrawHorizMapIndicator(int x, int x2, int y)
{
GfxFillRect(x, y, x + 3, y, PC_VERY_LIGHT_YELLOW);
GfxFillRect(x2 - 3, y, x2, y, PC_VERY_LIGHT_YELLOW);
}
/**
* Adds map indicators to the smallmap. * Adds map indicators to the smallmap.
*/ */
void DrawMapIndicators() const void SmallMapWindow::DrawMapIndicators() const
{ {
/* Find main viewport. */ /* Find main viewport. */
const ViewPort *vp = FindWindowById(WC_MAIN_WINDOW, 0)->viewport; const ViewPort *vp = FindWindowById(WC_MAIN_WINDOW, 0)->viewport;
@ -945,9 +870,9 @@ class SmallMapWindow : public Window {
SmallMapWindow::DrawHorizMapIndicator(tl.x, br.x, tl.y); SmallMapWindow::DrawHorizMapIndicator(tl.x, br.x, tl.y);
SmallMapWindow::DrawHorizMapIndicator(tl.x, br.x, br.y); SmallMapWindow::DrawHorizMapIndicator(tl.x, br.x, br.y);
} }
/** /**
* Draws the small map. * Draws the small map.
* *
* Basically, the small map is draw column of pixels by column of pixels. The pixels * Basically, the small map is draw column of pixels by column of pixels. The pixels
@ -958,8 +883,8 @@ class SmallMapWindow : public Window {
* *
* @param dpi pointer to pixel to write onto * @param dpi pointer to pixel to write onto
*/ */
void DrawSmallMap(DrawPixelInfo *dpi) const void SmallMapWindow::DrawSmallMap(DrawPixelInfo *dpi) const
{ {
Blitter *blitter = BlitterFactoryBase::GetCurrentBlitter(); Blitter *blitter = BlitterFactoryBase::GetCurrentBlitter();
DrawPixelInfo *old_dpi; DrawPixelInfo *old_dpi;
@ -1014,13 +939,13 @@ class SmallMapWindow : public Window {
this->DrawMapIndicators(); this->DrawMapIndicators();
_cur_dpi = old_dpi; _cur_dpi = old_dpi;
} }
/** /**
* Function to set up widgets depending on the information being shown on the smallmap. * Function to set up widgets depending on the information being shown on the smallmap.
*/ */
void SetupWidgetData() void SmallMapWindow::SetupWidgetData()
{ {
StringID legend_tooltip; StringID legend_tooltip;
StringID enable_all_tooltip; StringID enable_all_tooltip;
StringID disable_all_tooltip; StringID disable_all_tooltip;
@ -1052,13 +977,10 @@ class SmallMapWindow : public Window {
this->GetWidget<NWidgetCore>(WID_SM_ENABLE_ALL)->SetDataTip(STR_SMALLMAP_ENABLE_ALL, enable_all_tooltip); this->GetWidget<NWidgetCore>(WID_SM_ENABLE_ALL)->SetDataTip(STR_SMALLMAP_ENABLE_ALL, enable_all_tooltip);
this->GetWidget<NWidgetCore>(WID_SM_DISABLE_ALL)->SetDataTip(STR_SMALLMAP_DISABLE_ALL, disable_all_tooltip); this->GetWidget<NWidgetCore>(WID_SM_DISABLE_ALL)->SetDataTip(STR_SMALLMAP_DISABLE_ALL, disable_all_tooltip);
this->GetWidget<NWidgetStacked>(WID_SM_SELECT_BUTTONS)->SetDisplayedPlane(plane); this->GetWidget<NWidgetStacked>(WID_SM_SELECT_BUTTONS)->SetDisplayedPlane(plane);
} }
public: SmallMapWindow::SmallMapWindow(const WindowDesc *desc, int window_number) : Window(), refresh(FORCE_REFRESH_PERIOD)
uint min_number_of_columns; ///< Minimal number of columns in legends. {
SmallMapWindow(const WindowDesc *desc, int window_number) : Window(), refresh(FORCE_REFRESH_PERIOD)
{
_smallmap_industry_highlight = INVALID_INDUSTRYTYPE; _smallmap_industry_highlight = INVALID_INDUSTRYTYPE;
this->InitNested(desc, window_number); this->InitNested(desc, window_number);
this->LowerWidget(this->map_type + WID_SM_CONTOUR); this->LowerWidget(this->map_type + WID_SM_CONTOUR);
@ -1072,48 +994,30 @@ public:
this->SetZoomLevel(ZLC_INITIALIZE, NULL); this->SetZoomLevel(ZLC_INITIALIZE, NULL);
this->SmallMapCenterOnCurrentPos(); this->SmallMapCenterOnCurrentPos();
} }
/** /**
* Compute minimal required width of the legends.
* @return Minimally needed width for displaying the smallmap legends in pixels.
*/
inline uint GetMinLegendWidth() const
{
return WD_FRAMERECT_LEFT + this->min_number_of_columns * this->column_width;
}
/**
* Return number of columns that can be displayed in \a width pixels.
* @return Number of columns to display.
*/
inline uint GetNumberColumnsLegend(uint width) const
{
return width / this->column_width;
}
/**
* Compute height given a number of columns. * Compute height given a number of columns.
* @param num_columns Number of columns. * @param num_columns Number of columns.
* @return Needed height for displaying the smallmap legends in pixels. * @return Needed height for displaying the smallmap legends in pixels.
*/ */
uint GetLegendHeight(uint num_columns) const uint SmallMapWindow::GetLegendHeight(uint num_columns) const
{ {
uint num_rows = max(this->min_number_of_fixed_rows, CeilDiv(max(_smallmap_company_count, _smallmap_industry_count), num_columns)); uint num_rows = max(this->min_number_of_fixed_rows, CeilDiv(max(_smallmap_company_count, _smallmap_industry_count), num_columns));
return WD_FRAMERECT_TOP + WD_FRAMERECT_BOTTOM + num_rows * FONT_HEIGHT_SMALL; return WD_FRAMERECT_TOP + WD_FRAMERECT_BOTTOM + num_rows * FONT_HEIGHT_SMALL;
} }
virtual void SetStringParameters(int widget) const /* virtual */ void SmallMapWindow::SetStringParameters(int widget) const
{ {
switch (widget) { switch (widget) {
case WID_SM_CAPTION: case WID_SM_CAPTION:
SetDParam(0, STR_SMALLMAP_TYPE_CONTOURS + this->map_type); SetDParam(0, STR_SMALLMAP_TYPE_CONTOURS + this->map_type);
break; break;
} }
} }
virtual void OnInit() /* virtual */ void SmallMapWindow::SmallMapWindow::OnInit()
{ {
uint min_width = 0; uint min_width = 0;
this->min_number_of_columns = INDUSTRY_MIN_NUMBER_OF_COLUMNS; this->min_number_of_columns = INDUSTRY_MIN_NUMBER_OF_COLUMNS;
this->min_number_of_fixed_rows = 0; this->min_number_of_fixed_rows = 0;
@ -1157,10 +1061,10 @@ public:
/* The width of a column is the minimum width of all texts + the size of the blob + some spacing */ /* The width of a column is the minimum width of all texts + the size of the blob + some spacing */
this->column_width = min_width + LEGEND_BLOB_WIDTH + WD_FRAMERECT_LEFT + WD_FRAMERECT_RIGHT; this->column_width = min_width + LEGEND_BLOB_WIDTH + WD_FRAMERECT_LEFT + WD_FRAMERECT_RIGHT;
} }
virtual void OnPaint() /* virtual */ void SmallMapWindow::OnPaint()
{ {
if (this->map_type == SMT_OWNER) { if (this->map_type == SMT_OWNER) {
for (const LegendAndColour *tbl = _legend_table[this->map_type]; !tbl->end; ++tbl) { for (const LegendAndColour *tbl = _legend_table[this->map_type]; !tbl->end; ++tbl) {
if (tbl->company != INVALID_COMPANY && !Company::IsValidID(tbl->company)) { if (tbl->company != INVALID_COMPANY && !Company::IsValidID(tbl->company)) {
@ -1173,10 +1077,10 @@ public:
} }
this->DrawWidgets(); this->DrawWidgets();
} }
virtual void DrawWidget(const Rect &r, int widget) const /* virtual */ void SmallMapWindow::DrawWidget(const Rect &r, int widget) const
{ {
switch (widget) { switch (widget) {
case WID_SM_MAP: { case WID_SM_MAP: {
DrawPixelInfo new_dpi; DrawPixelInfo new_dpi;
@ -1250,14 +1154,14 @@ public:
} }
} }
} }
} }
/** /**
* Select a new map type. * Select a new map type.
* @param map_type New map type. * @param map_type New map type.
*/ */
void SwitchMapType(SmallMapType map_type) void SmallMapWindow::SwitchMapType(SmallMapType map_type)
{ {
this->RaiseWidget(this->map_type + WID_SM_CONTOUR); this->RaiseWidget(this->map_type + WID_SM_CONTOUR);
this->map_type = map_type; this->map_type = map_type;
this->LowerWidget(this->map_type + WID_SM_CONTOUR); this->LowerWidget(this->map_type + WID_SM_CONTOUR);
@ -1265,15 +1169,15 @@ public:
this->SetupWidgetData(); this->SetupWidgetData();
this->SetDirty(); this->SetDirty();
} }
/** /**
* Determines the mouse position on the legend. * Determines the mouse position on the legend.
* @param pt Mouse position. * @param pt Mouse position.
* @return Legend item under the mouse. * @return Legend item under the mouse.
*/ */
int GetPositionOnLegend(Point pt) int SmallMapWindow::GetPositionOnLegend(Point pt)
{ {
const NWidgetBase *wi = this->GetWidget<NWidgetBase>(WID_SM_LEGEND); const NWidgetBase *wi = this->GetWidget<NWidgetBase>(WID_SM_LEGEND);
uint line = (pt.y - wi->pos_y - WD_FRAMERECT_TOP) / FONT_HEIGHT_SMALL; uint line = (pt.y - wi->pos_y - WD_FRAMERECT_TOP) / FONT_HEIGHT_SMALL;
uint columns = this->GetNumberColumnsLegend(wi->current_x); uint columns = this->GetNumberColumnsLegend(wi->current_x);
@ -1286,10 +1190,10 @@ public:
uint column = (x - WD_FRAMERECT_LEFT) / this->column_width; uint column = (x - WD_FRAMERECT_LEFT) / this->column_width;
return (column * number_of_rows) + line; return (column * number_of_rows) + line;
} }
virtual void OnMouseOver(Point pt, int widget) /* virtual */ void SmallMapWindow::OnMouseOver(Point pt, int widget)
{ {
IndustryType new_highlight = INVALID_INDUSTRYTYPE; IndustryType new_highlight = INVALID_INDUSTRYTYPE;
if (widget == WID_SM_LEGEND && this->map_type == SMT_INDUSTRY) { if (widget == WID_SM_LEGEND && this->map_type == SMT_INDUSTRY) {
int industry_pos = GetPositionOnLegend(pt); int industry_pos = GetPositionOnLegend(pt);
@ -1303,10 +1207,10 @@ public:
_smallmap_industry_highlight_state = true; _smallmap_industry_highlight_state = true;
this->SetDirty(); this->SetDirty();
} }
} }
virtual void OnClick(Point pt, int widget, int click_count) /* virtual */ void SmallMapWindow::OnClick(Point pt, int widget, int click_count)
{ {
/* User clicked something, notify the industry chain window to stop sending newly selected industries. */ /* User clicked something, notify the industry chain window to stop sending newly selected industries. */
InvalidateWindowClassesData(WC_INDUSTRY_CARGOES, NUM_INDUSTRYTYPES); InvalidateWindowClassesData(WC_INDUSTRY_CARGOES, NUM_INDUSTRYTYPES);
@ -1459,17 +1363,17 @@ public:
this->SetDirty(); this->SetDirty();
break; break;
} }
} }
/** /**
* Some data on this window has become invalid. * Some data on this window has become invalid.
* @param data Information about the changed data. * @param data Information about the changed data.
* - data = 0: Displayed industries at the industry chain window have changed. * - data = 0: Displayed industries at the industry chain window have changed.
* - data = 1: Companies have changed. * - data = 1: Companies have changed.
* @param gui_scope Whether the call is done from GUI scope. You may not do everything when not in GUI scope. See #InvalidateWindowData() for details. * @param gui_scope Whether the call is done from GUI scope. You may not do everything when not in GUI scope. See #InvalidateWindowData() for details.
*/ */
virtual void OnInvalidateData(int data = 0, bool gui_scope = true) /* virtual */ void SmallMapWindow::OnInvalidateData(int data, bool gui_scope)
{ {
if (!gui_scope) return; if (!gui_scope) return;
switch (data) { switch (data) {
case 1: case 1:
@ -1490,18 +1394,18 @@ public:
default: NOT_REACHED(); default: NOT_REACHED();
} }
this->SetDirty(); this->SetDirty();
} }
virtual bool OnRightClick(Point pt, int widget) /* virtual */ bool SmallMapWindow::OnRightClick(Point pt, int widget)
{ {
if (widget != WID_SM_MAP || _scrolling_viewport) return false; if (widget != WID_SM_MAP || _scrolling_viewport) return false;
_scrolling_viewport = true; _scrolling_viewport = true;
return true; return true;
} }
virtual void OnMouseWheel(int wheel) /* virtual */ void SmallMapWindow::OnMouseWheel(int wheel)
{ {
if (_settings_client.gui.scrollwheel_scrolling == 0) { if (_settings_client.gui.scrollwheel_scrolling == 0) {
const NWidgetBase *wid = this->GetWidget<NWidgetBase>(WID_SM_MAP); const NWidgetBase *wid = this->GetWidget<NWidgetBase>(WID_SM_MAP);
int cursor_x = _cursor.pos.x - this->left - wid->pos_x; int cursor_x = _cursor.pos.x - this->left - wid->pos_x;
@ -1511,10 +1415,10 @@ public:
this->SetZoomLevel((wheel < 0) ? ZLC_ZOOM_IN : ZLC_ZOOM_OUT, &pt); this->SetZoomLevel((wheel < 0) ? ZLC_ZOOM_IN : ZLC_ZOOM_OUT, &pt);
} }
} }
} }
virtual void OnTick() /* virtual */ void SmallMapWindow::OnTick()
{ {
/* Update the window every now and then */ /* Update the window every now and then */
if (--this->refresh != 0) return; if (--this->refresh != 0) return;
@ -1522,17 +1426,17 @@ public:
this->refresh = _smallmap_industry_highlight != INVALID_INDUSTRYTYPE ? BLINK_PERIOD : FORCE_REFRESH_PERIOD; this->refresh = _smallmap_industry_highlight != INVALID_INDUSTRYTYPE ? BLINK_PERIOD : FORCE_REFRESH_PERIOD;
this->SetDirty(); this->SetDirty();
} }
/** /**
* Set new #scroll_x, #scroll_y, and #subscroll values after limiting them such that the center * Set new #scroll_x, #scroll_y, and #subscroll values after limiting them such that the center
* of the smallmap always contains a part of the map. * of the smallmap always contains a part of the map.
* @param sx Proposed new #scroll_x * @param sx Proposed new #scroll_x
* @param sy Proposed new #scroll_y * @param sy Proposed new #scroll_y
* @param sub Proposed new #subscroll * @param sub Proposed new #subscroll
*/ */
void SetNewScroll(int sx, int sy, int sub) void SmallMapWindow::SetNewScroll(int sx, int sy, int sub)
{ {
const NWidgetBase *wi = this->GetWidget<NWidgetBase>(WID_SM_MAP); const NWidgetBase *wi = this->GetWidget<NWidgetBase>(WID_SM_MAP);
Point hv = InverseRemapCoords(wi->current_x * ZOOM_LVL_BASE * TILE_SIZE / 2, wi->current_y * ZOOM_LVL_BASE * TILE_SIZE / 2); Point hv = InverseRemapCoords(wi->current_x * ZOOM_LVL_BASE * TILE_SIZE / 2, wi->current_y * ZOOM_LVL_BASE * TILE_SIZE / 2);
hv.x *= this->zoom; hv.x *= this->zoom;
@ -1558,10 +1462,10 @@ public:
this->scroll_x = sx; this->scroll_x = sx;
this->scroll_y = sy; this->scroll_y = sy;
this->subscroll = sub; this->subscroll = sub;
} }
virtual void OnScroll(Point delta) /* virtual */ void SmallMapWindow::OnScroll(Point delta)
{ {
_cursor.fix_at = true; _cursor.fix_at = true;
/* While tile is at (delta.x, delta.y)? */ /* While tile is at (delta.x, delta.y)? */
@ -1570,10 +1474,10 @@ public:
this->SetNewScroll(this->scroll_x + pt.x * TILE_SIZE, this->scroll_y + pt.y * TILE_SIZE, sub); this->SetNewScroll(this->scroll_x + pt.x * TILE_SIZE, this->scroll_y + pt.y * TILE_SIZE, sub);
this->SetDirty(); this->SetDirty();
} }
void SmallMapCenterOnCurrentPos() void SmallMapWindow::SmallMapCenterOnCurrentPos()
{ {
const ViewPort *vp = FindWindowById(WC_MAIN_WINDOW, 0)->viewport; const ViewPort *vp = FindWindowById(WC_MAIN_WINDOW, 0)->viewport;
Point pt = InverseRemapCoords(vp->virtual_left + vp->virtual_width / 2, vp->virtual_top + vp->virtual_height / 2); Point pt = InverseRemapCoords(vp->virtual_left + vp->virtual_width / 2, vp->virtual_top + vp->virtual_height / 2);
@ -1582,8 +1486,7 @@ public:
Point sxy = this->ComputeScroll(pt.x / TILE_SIZE, pt.y / TILE_SIZE, max(0, (int)wid->current_x / 2 - 2), wid->current_y / 2, &sub); Point sxy = this->ComputeScroll(pt.x / TILE_SIZE, pt.y / TILE_SIZE, max(0, (int)wid->current_x / 2 - 2), wid->current_y / 2, &sub);
this->SetNewScroll(sxy.x, sxy.y, sub); this->SetNewScroll(sxy.x, sxy.y, sub);
this->SetDirty(); this->SetDirty();
} }
};
SmallMapWindow::SmallMapType SmallMapWindow::map_type = SMT_CONTOUR; SmallMapWindow::SmallMapType SmallMapWindow::map_type = SMT_CONTOUR;
bool SmallMapWindow::show_towns = true; bool SmallMapWindow::show_towns = true;

141
src/smallmap_gui.h
View File

@ -12,9 +12,150 @@
#ifndef SMALLMAP_GUI_H #ifndef SMALLMAP_GUI_H
#define SMALLMAP_GUI_H #define SMALLMAP_GUI_H
#include "industry_type.h"
#include "window_gui.h"
#include "strings_func.h"
#include "blitter/factory.hpp"
#include "widgets/smallmap_widget.h"
void BuildIndustriesLegend(); void BuildIndustriesLegend();
void ShowSmallMap(); void ShowSmallMap();
void BuildLandLegend(); void BuildLandLegend();
void BuildOwnerLegend(); void BuildOwnerLegend();
/** Structure for holding relevant data for legends in small map */
struct LegendAndColour {
uint8 colour; ///< Colour of the item on the map.
StringID legend; ///< String corresponding to the coloured item.
IndustryType type; ///< Type of industry. Only valid for industry entries.
uint8 height; ///< Height in tiles. Only valid for height legend entries.
CompanyID company; ///< Company to display. Only valid for company entries of the owner legend.
bool show_on_map; ///< For filtering industries, if \c true, industry is shown on the map in colour.
bool end; ///< This is the end of the list.
bool col_break; ///< Perform a column break and go further at the next column.
};
/** Class managing the smallmap window. */
class SmallMapWindow : public Window {
protected:
/** Types of legends in the #WID_SM_LEGEND widget. */
enum SmallMapType {
SMT_CONTOUR,
SMT_VEHICLES,
SMT_INDUSTRY,
SMT_ROUTES,
SMT_VEGETATION,
SMT_OWNER,
};
/** Available kinds of zoomlevel changes. */
enum ZoomLevelChange {
ZLC_INITIALIZE, ///< Initialize zoom level.
ZLC_ZOOM_OUT, ///< Zoom out.
ZLC_ZOOM_IN, ///< Zoom in.
};
static SmallMapType map_type; ///< Currently displayed legends.
static bool show_towns; ///< Display town names in the smallmap.
static const uint LEGEND_BLOB_WIDTH = 8; ///< Width of the coloured blob in front of a line text in the #WID_SM_LEGEND widget.
static const uint INDUSTRY_MIN_NUMBER_OF_COLUMNS = 2; ///< Minimal number of columns in the #WID_SM_LEGEND widget for the #SMT_INDUSTRY legend.
static const uint FORCE_REFRESH_PERIOD = 0x1F; ///< map is redrawn after that many ticks
static const uint BLINK_PERIOD = 0x0F; ///< highlight blinking interval
uint min_number_of_fixed_rows; ///< Minimal number of rows in the legends for the fixed layouts only (all except #SMT_INDUSTRY).
uint column_width; ///< Width of a column in the #WID_SM_LEGEND widget.
int32 scroll_x; ///< Horizontal world coordinate of the base tile left of the top-left corner of the smallmap display.
int32 scroll_y; ///< Vertical world coordinate of the base tile left of the top-left corner of the smallmap display.
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.
int zoom; ///< Zoom level. Bigger number means more zoom-out (further away).
uint8 refresh; ///< Refresh counter, zeroed every FORCE_REFRESH_PERIOD ticks.
Point SmallmapRemapCoords(int x, int y) const;
/**
* Draws vertical part of map indicator
* @param x X coord of left/right border of main viewport
* @param y Y coord of top border of main viewport
* @param y2 Y coord of bottom border of main viewport
*/
static inline void DrawVertMapIndicator(int x, int y, int y2)
{
GfxFillRect(x, y, x, y + 3, PC_VERY_LIGHT_YELLOW);
GfxFillRect(x, y2 - 3, x, y2, PC_VERY_LIGHT_YELLOW);
}
/**
* Draws horizontal part of map indicator
* @param x X coord of left border of main viewport
* @param x2 X coord of right border of main viewport
* @param y Y coord of top/bottom border of main viewport
*/
static inline void DrawHorizMapIndicator(int x, int x2, int y)
{
GfxFillRect(x, y, x + 3, y, PC_VERY_LIGHT_YELLOW);
GfxFillRect(x2 - 3, y, x2, y, PC_VERY_LIGHT_YELLOW);
}
void DrawMapIndicators() const;
void DrawSmallMapColumn(void *dst, uint xc, uint yc, int pitch, int reps, int start_pos, int end_pos, Blitter *blitter) const;
void DrawVehicles(const DrawPixelInfo *dpi, Blitter *blitter) const;
void DrawTowns(const DrawPixelInfo *dpi) const;
void DrawSmallMap(DrawPixelInfo *dpi) const;
Point RemapTile(int tile_x, int tile_y) const;
Point PixelToTile(int px, int py, int *sub, bool add_sub = true) const;
Point ComputeScroll(int tx, int ty, int x, int y, int *sub);
void SetZoomLevel(ZoomLevelChange change, const Point *zoom_pt);
void SetupWidgetData();
uint32 GetTileColours(const TileArea &ta) const;
int GetPositionOnLegend(Point pt);
public:
uint min_number_of_columns; ///< Minimal number of columns in legends.
SmallMapWindow(const WindowDesc *desc, int window_number);
/**
* Compute minimal required width of the legends.
* @return Minimally needed width for displaying the smallmap legends in pixels.
*/
inline uint GetMinLegendWidth() const
{
return WD_FRAMERECT_LEFT + this->min_number_of_columns * this->column_width;
}
/**
* Return number of columns that can be displayed in \a width pixels.
* @return Number of columns to display.
*/
inline uint GetNumberColumnsLegend(uint width) const
{
return width / this->column_width;
}
uint GetLegendHeight(uint num_columns) const;
void SwitchMapType(SmallMapType map_type);
void SetNewScroll(int sx, int sy, int sub);
void SmallMapCenterOnCurrentPos();
virtual void SetStringParameters(int widget) const;
virtual void OnInit();
virtual void OnPaint();
virtual void DrawWidget(const Rect &r, int widget) const;
virtual void OnClick(Point pt, int widget, int click_count);
virtual void OnInvalidateData(int data = 0, bool gui_scope = true);
virtual bool OnRightClick(Point pt, int widget);
virtual void OnMouseWheel(int wheel);
virtual void OnTick();
virtual void OnScroll(Point delta);
virtual void OnMouseOver(Point pt, int widget);
};
#endif /* SMALLMAP_GUI_H */ #endif /* SMALLMAP_GUI_H */