smallmap_gui.h

Go to the documentation of this file.

/*
 * This file is part of OpenTTD.
 * 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.
 * 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.
 * 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/>.
 */
 
#ifndef SMALLMAP_GUI_H
#define SMALLMAP_GUI_H
 
#include "industry_type.h"
#include "company_base.h"
#include "window_gui.h"
#include "strings_func.h"
#include "blitter/factory.hpp"
#include "linkgraph/linkgraph_gui.h"
#include "widgets/smallmap_widget.h"
#include "guitimer_func.h"
 
/* set up the cargos to be displayed in the smallmap's route legend */
void BuildLinkStatsLegend();
 
void BuildIndustriesLegend();
void ShowSmallMap();
void BuildLandLegend();
void BuildOwnerLegend();
 
enum class IncludeHeightmap {
  Never,      
  IfEnabled,  
  Always      
};
 
uint32 GetSmallMapOwnerPixels(TileIndex tile, TileType t, IncludeHeightmap include_heightmap);
 
struct LegendAndColour {
  uint8 colour;              
  StringID legend;           
  IndustryType type;         
  uint8 height;              
  CompanyID company;         
  bool show_on_map;          
  bool end;                  
  bool col_break;            
};
 
class SmallMapWindow : public Window {
protected:
  enum SmallMapType {
    SMT_CONTOUR,
    SMT_VEHICLES,
    SMT_INDUSTRY,
    SMT_LINKSTATS,
    SMT_ROUTES,
    SMT_VEGETATION,
    SMT_OWNER,
  };
 
  enum ZoomLevelChange {
    ZLC_INITIALIZE, 
    ZLC_ZOOM_OUT,   
    ZLC_ZOOM_IN,    
  };
 
  static SmallMapType map_type; 
  static bool show_towns;       
  static int map_height_limit;  
 
  static const uint INDUSTRY_MIN_NUMBER_OF_COLUMNS = 2; 
  static const uint FORCE_REFRESH_PERIOD = 930; 
  static const uint BLINK_PERIOD         = 450; 
 
  uint min_number_of_columns;    
  uint min_number_of_fixed_rows; 
  uint column_width;             
  uint legend_width;             
 
  int32 scroll_x;  
  int32 scroll_y;  
  int32 subscroll; 
  int zoom;        
 
  GUITimer refresh; 
  LinkGraphOverlay *overlay;
 
  static void BreakIndustryChainLink();
  Point SmallmapRemapCoords(int x, int y) const;
 
  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);
  }
 
  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);
  }
 
  inline uint GetMinLegendWidth() const
  {
    return WidgetDimensions::scaled.framerect.left + this->min_number_of_columns * this->column_width;
  }
 
  inline uint GetNumberColumnsLegend(uint width) const
  {
    return width / this->column_width;
  }
 
  inline uint GetLegendHeight(uint num_columns) const
  {
    return WidgetDimensions::scaled.framerect.Vertical() +
        this->GetNumberRowsLegend(num_columns) * FONT_HEIGHT_SMALL;
  }
 
  inline uint32 GetOverlayCompanyMask() const
  {
    return Company::IsValidID(_local_company) ? 1U << _local_company : 0xffffffff;
  }
 
  void RebuildColourIndexIfNecessary();
  uint GetNumberRowsLegend(uint columns) const;
  void SelectLegendItem(int click_pos, LegendAndColour *legend, int end_legend_item, int begin_legend_item = 0);
  void SwitchMapType(SmallMapType map_type);
  void SetNewScroll(int sx, int sy, int sub);
 
  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 SetOverlayCargoMask();
  void SetupWidgetData();
  uint32 GetTileColours(const TileArea &ta) const;
 
  int GetPositionOnLegend(Point pt);
 
public:
  friend class NWidgetSmallmapDisplay;
 
  SmallMapWindow(WindowDesc *desc, int window_number);
  virtual ~SmallMapWindow();
 
  void SmallMapCenterOnCurrentPos();
  Point GetStationMiddle(const Station *st) const;
 
  void Close() override;
  void SetStringParameters(int widget) const override;
  void OnInit() override;
  void OnPaint() override;
  void DrawWidget(const Rect &r, int widget) const override;
  void OnClick(Point pt, int widget, int click_count) override;
  void OnInvalidateData(int data = 0, bool gui_scope = true) override;
  bool OnRightClick(Point pt, int widget) override;
  void OnMouseWheel(int wheel) override;
  void OnRealtimeTick(uint delta_ms) override;
  void OnScroll(Point delta) override;
  void OnMouseOver(Point pt, int widget) override;
};
 
#endif /* SMALLMAP_GUI_H */