OpenTTD: src/viewport_type.h File Reference

OpenTTD

- Main Page
- Related Pages
- Modules
- Namespaces
- Data Structures
- Files

- File List
- Globals

Data Structures | Enumerations | Variables
viewport_type.h File Reference

Types related to viewports. More...

`#include "zoom_type.h"`
`#include "strings_type.h"`
`#include "table/strings.h"`

Go to the source code of this file.

## Data Structures
struct | ViewPort
| Data structure for viewport, display of a part of the world. More...
struct | ViewportSign
| Location information about a sign as seen on the viewport. More...

## Enumerations
enum | ViewportSignMargin { VPSM_LEFT = 1, VPSM_RIGHT = 1, VPSM_TOP = 1, VPSM_BOTTOM = 1 }
| Margins for the viewport sign. More...
enum | ZoomStateChange { ZOOM_IN = 0, ZOOM_OUT = 1, ZOOM_NONE = 2 }
| Directions of zooming. More...
enum | ViewportPlaceMethod { 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 }
| Viewport place method (type of highlighted area and placed objects) More...
enum | ViewportDragDropSelectionProcess { 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_PLACE_RAIL, DDSP_BUILD_SIGNALS, DDSP_BUILD_STATION, DDSP_REMOVE_STATION, DDSP_CONVERT_RAIL, DDSP_PLACE_ROAD_X_DIR, DDSP_PLACE_ROAD_Y_DIR, DDSP_PLACE_AUTOROAD, DDSP_BUILD_BUSSTOP, DDSP_BUILD_TRUCKSTOP, DDSP_REMOVE_BUSSTOP, DDSP_REMOVE_TRUCKSTOP }
| Drag and drop selection process, or, what to do with an area of land when you've selected it. More...

## Variables
static const uint | BB_HEIGHT_UNDER_BRIDGE = 6
| Some values for constructing bounding boxes (BB).
static const uint | BB_Z_SEPARATOR = 7
| Separates the bridge/tunnel from the things under/above it.

## Detailed Description

Types related to viewports.

Definition in file viewport_type.h.

## Enumeration Type Documentation

enum ViewportDragDropSelectionProcess

Drag and drop selection process, or, what to do with an area of land when you've selected it.

Enumerator:

  DDSP_DEMOLISH_AREA | Clear area.
  DDSP_RAISE_AND_LEVEL_AREA | Raise / level area.
  DDSP_LOWER_AND_LEVEL_AREA | Lower / level area.
  DDSP_LEVEL_AREA | Level area.
  DDSP_CREATE_DESERT | Fill area with desert.
  DDSP_CREATE_ROCKS | Fill area with rocks.
  DDSP_CREATE_WATER | Create a canal.
  DDSP_CREATE_RIVER | Create rivers.
  DDSP_PLANT_TREES | Plant trees.
  DDSP_BUILD_BRIDGE | Bridge placement.
  DDSP_PLACE_RAIL | Rail placement.
  DDSP_BUILD_SIGNALS | Signal placement.
  DDSP_BUILD_STATION | Station placement.
  DDSP_REMOVE_STATION | Station removal.
  DDSP_CONVERT_RAIL | Rail conversion.
  DDSP_PLACE_ROAD_X_DIR | Road placement (X axis)
  DDSP_PLACE_ROAD_Y_DIR | Road placement (Y axis)
  DDSP_PLACE_AUTOROAD | Road placement (auto)
  DDSP_BUILD_BUSSTOP | Road stop placement (buses)
  DDSP_BUILD_TRUCKSTOP | Road stop placement (trucks)
  DDSP_REMOVE_BUSSTOP | Road stop removal (buses)
  DDSP_REMOVE_TRUCKSTOP | Road stop removal (trucks)

Definition at line 97 of file viewport_type.h.

enum ViewportPlaceMethod

Viewport place method (type of highlighted area and placed objects)

Enumerator:

  VPM_X_OR_Y | drag in X or Y direction
  VPM_FIX_X | drag only in X axis
  VPM_FIX_Y | drag only in Y axis
  VPM_X_AND_Y | area of land in X and Y directions
  VPM_X_AND_Y_LIMITED | area of land of limited size
  VPM_FIX_HORIZONTAL | drag only in horizontal direction
  VPM_FIX_VERTICAL | drag only in vertical direction
  VPM_X_LIMITED | Drag only in X axis with limited size.
  VPM_Y_LIMITED | Drag only in Y axis with limited size.
  VPM_RAILDIRS | all rail directions
  VPM_SIGNALDIRS | similar to VMP_RAILDIRS, but with different cursor

Definition at line 78 of file viewport_type.h.

enum ViewportSignMargin

Margins for the viewport sign.

Enumerator:

  VPSM_LEFT | Left margin.
  VPSM_RIGHT | Right margin.
  VPSM_TOP | Top margin.
  VPSM_BOTTOM | Bottom margin.

Definition at line 40 of file viewport_type.h.

enum ZoomStateChange

Directions of zooming.

See Also
  DoZoomInOutWindow

Enumerator:

  ZOOM_IN | Zoom in (get more detailed view).
  ZOOM_OUT | Zoom out (get helicopter view).
  ZOOM_NONE | Hack, used to update the button status.

Definition at line 62 of file viewport_type.h.

## Variable Documentation

const uint BB_HEIGHT_UNDER_BRIDGE = 6
| static

Some values for constructing bounding boxes (BB).

The Z positions under bridges are: z=0..5 Everything that can be built under low bridges. z=6 reserved, currently unused. z=7 Z separator between bridge/tunnel and the things under/above it.Everything that can be built under low bridges, must not exceed this Z height.

Definition at line 74 of file viewport_type.h.

Referenced by DrawPillar(), DrawRailCatenaryOnBridge(), DrawRailCatenaryRailway(), and DrawRoadCatenary().