viewport_type.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 VIEWPORT_TYPE_H
#define VIEWPORT_TYPE_H
 
#include "core/enum_type.hpp"
#include "zoom_type.h"
#include "strings_type.h"
#include "table/strings.h"
 
class LinkGraphOverlay;
 
enum class ViewportStringFlag : uint8_t {
  Small, 
  Shadow, 
  ColourRect, 
  TransparentRect, 
  TextColour, 
};
using ViewportStringFlags = EnumBitSet<ViewportStringFlag, uint8_t>;
 
struct Viewport {
  int left;    
  int top;     
  int width;   
  int height;  
 
  int virtual_left;    
  int virtual_top;     
  int virtual_width;   
  int virtual_height;  
 
  ZoomLevel zoom; 
  std::shared_ptr<LinkGraphOverlay> overlay;
};
 
struct ViewportSign {
  int32_t center;        
  int32_t top;           
  uint16_t width_normal; 
  uint16_t width_small;  
 
  auto operator<=>(const ViewportSign &) const = default;
 
  void UpdatePosition(int center, int top, StringID str, StringID str_small = STR_NULL);
  void MarkDirty(ZoomLevel maxzoom = ZOOM_LVL_MAX) const;
};
 
struct TrackedViewportSign : ViewportSign {
  bool kdtree_valid; 
 
  auto operator<=>(const TrackedViewportSign &) const = default;
 
  void UpdatePosition(int center, int top, StringID str, StringID str_small = STR_NULL)
  {
    this->kdtree_valid = true;
    this->ViewportSign::UpdatePosition(center, top, str, str_small);
  }
 
 
  TrackedViewportSign() : kdtree_valid{ false }
  {
  }
};
 
enum ZoomStateChange : uint8_t {
  ZOOM_IN   = 0, 
  ZOOM_OUT  = 1, 
  ZOOM_NONE = 2, 
};
 
static const uint BB_HEIGHT_UNDER_BRIDGE = 6; 
static const uint BB_Z_SEPARATOR         = 7; 
 
enum ViewportPlaceMethod : uint8_t {
  VPM_X_OR_Y          =    0, 
  VPM_FIX_X           =    1, 
  VPM_FIX_Y           =    2, 
  VPM_X_AND_Y         =    3, 
  VPM_X_AND_Y_LIMITED =    4, 
  VPM_FIX_HORIZONTAL  =    5, 
  VPM_FIX_VERTICAL    =    6, 
  VPM_X_LIMITED       =    7, 
  VPM_Y_LIMITED       =    8, 
  VPM_RAILDIRS        = 0x40, 
  VPM_SIGNALDIRS      = 0x80, 
};
DECLARE_ENUM_AS_BIT_SET(ViewportPlaceMethod)
 
 
enum ViewportDragDropSelectionProcess : uint8_t {
  DDSP_DEMOLISH_AREA,        
  DDSP_RAISE_AND_LEVEL_AREA, 
  DDSP_LOWER_AND_LEVEL_AREA, 
  DDSP_LEVEL_AREA,           
  DDSP_CREATE_DESERT,        
  DDSP_CREATE_ROCKS,         
  DDSP_CREATE_WATER,         
  DDSP_CREATE_RIVER,         
  DDSP_PLANT_TREES,          
  DDSP_BUILD_BRIDGE,         
  DDSP_BUILD_OBJECT,         
 
  /* Rail specific actions */
  DDSP_PLACE_RAIL,           
  DDSP_BUILD_SIGNALS,        
  DDSP_BUILD_STATION,        
  DDSP_REMOVE_STATION,       
  DDSP_CONVERT_RAIL,         
 
  /* Road specific actions */
  DDSP_PLACE_ROAD_X_DIR,     
  DDSP_PLACE_ROAD_Y_DIR,     
  DDSP_PLACE_AUTOROAD,       
  DDSP_BUILD_ROAD_WAYPOINT,  
  DDSP_BUILD_BUSSTOP,        
  DDSP_BUILD_TRUCKSTOP,      
  DDSP_REMOVE_ROAD_WAYPOINT, 
  DDSP_REMOVE_BUSSTOP,       
  DDSP_REMOVE_TRUCKSTOP,     
  DDSP_CONVERT_ROAD,         
};
 
 
enum ViewportScrollTarget : uint8_t {
  VST_EVERYONE, 
  VST_COMPANY,  
  VST_CLIENT,   
};
 
#endif /* VIEWPORT_TYPE_H */