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

157
src/smallmap_gui.cpp
View File

@ -14,20 +14,17 @@
#include "industry.h"
#include "station_map.h"
#include "landscape.h"
#include "window_gui.h"
#include "tree_map.h"
#include "viewport_func.h"
#include "town.h"
#include "blitter/factory.hpp"
#include "tunnelbridge_map.h"
#include "strings_func.h"
#include "core/endian_func.hpp"
#include "vehicle_base.h"
#include "sound_func.h"
#include "window_func.h"
#include "company_base.h"
#include "widgets/smallmap_widget.h"
#include "smallmap_gui.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}
/** 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 */
static LegendAndColour _legend_land_contours[] = {
/* The colours for the following values are set at BuildLandLegend() based on each colour scheme. */
@ -569,43 +554,7 @@ static const byte _vehicle_type_colours[6] = {
};
/** Class managing the smallmap window. */
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
inline Point SmallMapWindow::SmallmapRemapCoords(int x, int y) const
{
Point pt;
pt.x = (y - x) * 2;
@ -619,7 +568,7 @@ class SmallMapWindow : public Window {
* @param tile_y Y coordinate of the tile.
* @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 y_offset = tile_y - this->scroll_y / (int)TILE_SIZE;
@ -643,7 +592,7 @@ class SmallMapWindow : public Window {
* @return Tile being displayed at the given position relative to #scroll_x and #scroll_y.
* @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.
@ -675,7 +624,7 @@ class SmallMapWindow : public Window {
* @param sub [out] Value of #subscroll needed.
* @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);
@ -703,7 +652,7 @@ class SmallMapWindow : public Window {
* @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.
*/
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 MIN_ZOOM_INDEX = 0;
@ -749,7 +698,7 @@ class SmallMapWindow : public Window {
* @param ta Tile area to investigate.
* @return Colours to display.
*/
inline uint32 GetTileColours(const TileArea &ta) const
inline uint32 SmallMapWindow::GetTileColours(const TileArea &ta) const
{
int importance = 0;
TileIndex tile = INVALID_TILE; // Position of the most important tile.
@ -800,7 +749,7 @@ class SmallMapWindow : public Window {
* @param blitter current blitter
* @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);
uint min_xy = _settings_game.construction.freeform_edges ? 1 : 0;
@ -840,7 +789,7 @@ class SmallMapWindow : public Window {
* @param dpi the part of the smallmap to be drawn into
* @param blitter current blitter
*/
void DrawVehicles(const DrawPixelInfo *dpi, Blitter *blitter) const
void SmallMapWindow::DrawVehicles(const DrawPixelInfo *dpi, Blitter *blitter) const
{
const Vehicle *v;
FOR_ALL_VEHICLES(v) {
@ -879,7 +828,7 @@ class SmallMapWindow : public Window {
* Adds town names to the smallmap.
* @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;
FOR_ALL_TOWNS(t) {
@ -900,34 +849,10 @@ class SmallMapWindow : public Window {
}
}
/**
* 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.
*/
void DrawMapIndicators() const
void SmallMapWindow::DrawMapIndicators() const
{
/* Find main viewport. */
const ViewPort *vp = FindWindowById(WC_MAIN_WINDOW, 0)->viewport;
@ -958,7 +883,7 @@ class SmallMapWindow : public Window {
*
* @param dpi pointer to pixel to write onto
*/
void DrawSmallMap(DrawPixelInfo *dpi) const
void SmallMapWindow::DrawSmallMap(DrawPixelInfo *dpi) const
{
Blitter *blitter = BlitterFactoryBase::GetCurrentBlitter();
DrawPixelInfo *old_dpi;
@ -1019,7 +944,7 @@ class SmallMapWindow : public Window {
/**
* Function to set up widgets depending on the information being shown on the smallmap.
*/
void SetupWidgetData()
void SmallMapWindow::SetupWidgetData()
{
StringID legend_tooltip;
StringID enable_all_tooltip;
@ -1054,10 +979,7 @@ class SmallMapWindow : public Window {
this->GetWidget<NWidgetStacked>(WID_SM_SELECT_BUTTONS)->SetDisplayedPlane(plane);
}
public:
uint min_number_of_columns; ///< Minimal number of columns in legends.
SmallMapWindow(const WindowDesc *desc, int window_number) : Window(), refresh(FORCE_REFRESH_PERIOD)
SmallMapWindow::SmallMapWindow(const WindowDesc *desc, int window_number) : Window(), refresh(FORCE_REFRESH_PERIOD)
{
_smallmap_industry_highlight = INVALID_INDUSTRYTYPE;
this->InitNested(desc, window_number);
@ -1074,36 +996,18 @@ public:
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.
* @param num_columns Number of columns.
* @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));
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) {
case WID_SM_CAPTION:
@ -1112,7 +1016,7 @@ public:
}
}
virtual void OnInit()
/* virtual */ void SmallMapWindow::SmallMapWindow::OnInit()
{
uint min_width = 0;
this->min_number_of_columns = INDUSTRY_MIN_NUMBER_OF_COLUMNS;
@ -1159,7 +1063,7 @@ public:
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) {
for (const LegendAndColour *tbl = _legend_table[this->map_type]; !tbl->end; ++tbl) {
@ -1175,7 +1079,7 @@ public:
this->DrawWidgets();
}
virtual void DrawWidget(const Rect &r, int widget) const
/* virtual */ void SmallMapWindow::DrawWidget(const Rect &r, int widget) const
{
switch (widget) {
case WID_SM_MAP: {
@ -1256,7 +1160,7 @@ public:
* Select a 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->map_type = map_type;
@ -1272,7 +1176,7 @@ public:
* @param pt Mouse position.
* @return Legend item under the mouse.
*/
int GetPositionOnLegend(Point pt)
int SmallMapWindow::GetPositionOnLegend(Point pt)
{
const NWidgetBase *wi = this->GetWidget<NWidgetBase>(WID_SM_LEGEND);
uint line = (pt.y - wi->pos_y - WD_FRAMERECT_TOP) / FONT_HEIGHT_SMALL;
@ -1288,7 +1192,7 @@ public:
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;
if (widget == WID_SM_LEGEND && this->map_type == SMT_INDUSTRY) {
@ -1305,7 +1209,7 @@ public:
}
}
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. */
InvalidateWindowClassesData(WC_INDUSTRY_CARGOES, NUM_INDUSTRYTYPES);
@ -1468,7 +1372,7 @@ public:
* - 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.
*/
virtual void OnInvalidateData(int data = 0, bool gui_scope = true)
/* virtual */ void SmallMapWindow::OnInvalidateData(int data, bool gui_scope)
{
if (!gui_scope) return;
switch (data) {
@ -1492,7 +1396,7 @@ public:
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;
@ -1500,7 +1404,7 @@ public:
return true;
}
virtual void OnMouseWheel(int wheel)
/* virtual */ void SmallMapWindow::OnMouseWheel(int wheel)
{
if (_settings_client.gui.scrollwheel_scrolling == 0) {
const NWidgetBase *wid = this->GetWidget<NWidgetBase>(WID_SM_MAP);
@ -1513,7 +1417,7 @@ public:
}
}
virtual void OnTick()
/* virtual */ void SmallMapWindow::OnTick()
{
/* Update the window every now and then */
if (--this->refresh != 0) return;
@ -1531,7 +1435,7 @@ public:
* @param sy Proposed new #scroll_y
* @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);
Point hv = InverseRemapCoords(wi->current_x * ZOOM_LVL_BASE * TILE_SIZE / 2, wi->current_y * ZOOM_LVL_BASE * TILE_SIZE / 2);
@ -1560,7 +1464,7 @@ public:
this->subscroll = sub;
}
virtual void OnScroll(Point delta)
/* virtual */ void SmallMapWindow::OnScroll(Point delta)
{
_cursor.fix_at = true;
@ -1572,7 +1476,7 @@ public:
this->SetDirty();
}
void SmallMapCenterOnCurrentPos()
void SmallMapWindow::SmallMapCenterOnCurrentPos()
{
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);
@ -1583,7 +1487,6 @@ public:
this->SetNewScroll(sxy.x, sxy.y, sub);
this->SetDirty();
}
};
SmallMapWindow::SmallMapType SmallMapWindow::map_type = SMT_CONTOUR;
bool SmallMapWindow::show_towns = true;

141
src/smallmap_gui.h
View File

@ -12,9 +12,150 @@
#ifndef 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 ShowSmallMap();
void BuildLandLegend();
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 */