# viewport_type.h File Reference

Types related to viewports. More...

`#include "core/geometry_type.hpp"`
`#include "zoom_type.h"`
`#include "window_type.h"`
`#include "tile_type.h"`

Go to the source code of this file.

## Data Structures
struct | ViewPort
struct | TileHighlightData
## Enumerations
enum | { ZOOM_IN = 0, ZOOM_OUT = 1, ZOOM_NONE = 2 }
enum | { BB_HEIGHT_UNDER_BRIDGE = 6, BB_Z_SEPARATOR = 7 }
| Some values for constructing bounding boxes (BB). More...
enum | ViewportPlaceMethod { VPM_X_OR_Y = 0, VPM_FIX_X = 1, VPM_FIX_Y = 2, VPM_RAILDIRS = 3, VPM_X_AND_Y = 4, VPM_X_AND_Y_LIMITED = 5, VPM_SIGNALDIRS = 6 }
| Viewport place method (type of highlighted area and placed objects). More...
enum | ViewportHighlightMode { VHM_NONE = 0, VHM_RECT = 1, VHM_POINT = 2, VHM_SPECIAL = 3, VHM_DRAG = 4, VHM_RAIL = 5 }
| Viewport highlight mode (for highlighting tiles below cursor). More...
enum | HighLightStyle { HT_NONE = 0x00, HT_RECT = 0x80, HT_POINT = 0x40, HT_LINE = 0x20, HT_RAIL = 0x10, HT_DRAG_MASK = 0xF0, HT_DIR_X = 0, HT_DIR_Y = 1, HT_DIR_HU = 2, HT_DIR_HL = 3, HT_DIR_VL = 4, HT_DIR_VR = 5, HT_DIR_MASK = 0x7 }
## Functions
| DECLARE_ENUM_AS_BIT_SET (HighLightStyle)

## Detailed Description

Types related to viewports.

Definition in file viewport_type.h.

## Enumeration Type Documentation

anonymous enum

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.

Enumerator:

  BB_HEIGHT_UNDER_BRIDGE | Everything that can be built under low bridges, must not exceed this Z height.
  BB_Z_SEPARATOR | Separates the bridge/tunnel from the things under/above it.

Definition at line 35 of file viewport_type.h.

enum HighLightStyle

Enumerator:

  HT_LINE | used for autorail highlighting (longer streches) (uses lower bits to indicate direction)
  HT_RAIL | autorail (one piece) (uses lower bits to indicate direction)
  HT_DRAG_MASK | masks the drag-type
  HT_DIR_X | X direction.
  HT_DIR_Y | Y direction.
  HT_DIR_HU | horizontal upper
  HT_DIR_HL | horizontal lower
  HT_DIR_VL | vertical left
  HT_DIR_VR | vertical right
  HT_DIR_MASK | masks the drag-direction

Definition at line 62 of file viewport_type.h.

enum ViewportHighlightMode

Viewport highlight mode (for highlighting tiles below cursor).

Enumerator:

  VHM_NONE | default
  VHM_RECT | rectangle (stations, depots, ...)
  VHM_POINT | point (lower land, raise land, level land, ...)
  VHM_SPECIAL | special mode used for highlighting while dragging (and for tunnels/docks)
  VHM_DRAG | dragging items in the depot windows
  VHM_RAIL | rail pieces

Definition at line 52 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_RAILDIRS | all rail directions
  VPM_X_AND_Y | area of land in X and Y directions
  VPM_X_AND_Y_LIMITED | area of land of limited size
  VPM_SIGNALDIRS | similiar to VMP_RAILDIRS, but with different cursor

Definition at line 41 of file viewport_type.h.