1

/* $Id$ */

     2

     3

/** @file viewport_type.h Types related to viewports. */

     4

     5

#ifndef VIEWPORT_TYPE_H

     6

#define VIEWPORT_TYPE_H

     7

     8

#include "core/geometry_type.hpp"

     9

#include "zoom_type.h"

    10

#include "window_type.h"

    11

#include "tile_type.h"

    12

#include "newgrf_fsmports.h"

    13

    14

/**

    15

 * Data structure for viewport, display of a part of the world

    16

 */

    17

struct ViewPort {

    18

	int left;    ///< Screen coordinate left egde of the viewport

    19

	int top;     ///< Screen coordinate top edge of the viewport

    20

	int width;   ///< Screen width of the viewport

    21

	int height;  ///< Screen height of the viewport

    22

    23

	int virtual_left;    ///< Virtual left coordinate

    24

	int virtual_top;     ///< Virtual top coordinate

    25

	int virtual_width;   ///< width << zoom

    26

	int virtual_height;  ///< height << zoom

    27

    28

	ZoomLevel zoom;

    29

};

    30

    31

enum {

    32

	ZOOM_IN   = 0,

    33

	ZOOM_OUT  = 1,

    34

	ZOOM_NONE = 2, // hack, used to update the button status

    35

};

    36

    37

/**

    38

 * Some values for constructing bounding boxes (BB). The Z positions under bridges are:

    39

 * z=0..5  Everything that can be built under low bridges.

    40

 * z=6     reserved, currently unused.

    41

 * z=7     Z separator between bridge/tunnel and the things under/above it.

    42

 */

    43

enum {

    44

	BB_HEIGHT_UNDER_BRIDGE = 6, ///< Everything that can be built under low bridges, must not exceed this Z height.

    45

	BB_Z_SEPARATOR  = 7,        ///< Separates the bridge/tunnel from the things under/above it.

    46

};

    47

    48

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

    49

enum ViewportPlaceMethod {

    50

	VPM_X_OR_Y          = 0, ///< drag in X or Y direction

    51

	VPM_FIX_X           = 1, ///< drag only in X axis

    52

	VPM_FIX_Y           = 2, ///< drag only in Y axis

    53

	VPM_RAILDIRS        = 3, ///< all rail directions

    54

	VPM_X_AND_Y         = 4, ///< area of land in X and Y directions

    55

	VPM_X_AND_Y_LIMITED = 5, ///< area of land of limited size

    56

	VPM_SIGNALDIRS      = 6, ///< similiar to VMP_RAILDIRS, but with different cursor

    57

};

    58

    59

/** Viewport highlight mode (for highlighting tiles below cursor) */

    60

enum ViewportHighlightMode {

    61

	VHM_NONE    = 0, ///< default

    62

	VHM_RECT    = 1, ///< rectangle (stations, depots, ...)

    63

	VHM_POINT   = 2, ///< point (lower land, raise land, level land, ...)

    64

	VHM_SPECIAL = 3, ///< special mode used for highlighting while dragging (and for tunnels/docks)

    65

	VHM_DRAG    = 4, ///< dragging items in the depot windows

    66

	VHM_RAIL    = 5, ///< rail pieces

    67

};

    68

    69

/** Highlighting draw styles */

    70

enum HighLightStyle {

    71

	HT_NONE   = 0x00,

    72

	HT_RECT   = 0x80,

    73

	HT_POINT  = 0x40,

    74

	HT_LINE   = 0x20,    ///< used for autorail highlighting (longer streches)

    75

	                     ///< (uses lower bits to indicate direction)

    76

	HT_RAIL   = 0x10,    ///< autorail (one piece)

    77

	                     ///< (uses lower bits to indicate direction)

    78

	HT_DRAG_MASK = 0xF0, ///< masks the drag-type

    79

    80

	/* lower bits (used with HT_LINE and HT_RAIL):

    81

	 * (see ASCII art in autorail.h for a visual interpretation) */

    82

	HT_DIR_X  = 0,    ///< X direction

    83

	HT_DIR_Y  = 1,    ///< Y direction

    84

	HT_DIR_HU = 2,    ///< horizontal upper

    85

	HT_DIR_HL = 3,    ///< horizontal lower

    86

	HT_DIR_VL = 4,    ///< vertical left

    87

	HT_DIR_VR = 5,    ///< vertical right

    88

	HT_DIR_MASK = 0x7 ///< masks the drag-direction

    89

};

    90

DECLARE_ENUM_AS_BIT_SET(HighLightStyle);

    91

    92

    93

struct TileHighlightData {

    94

	Point size;

    95

	Point outersize;

    96

	Point pos;

    97

	Point offs;

    98

    99

	Point new_pos;

   100

	Point new_size;

   101

	Point new_outersize;

   102

   103

	Point selend, selstart;

   104

   105

	byte dirty;

   106

	byte sizelimit;

   107

   108

	byte drawstyle;      // lower bits 0-3 are reserved for detailed highlight information information

   109

	byte new_drawstyle;  // only used in UpdateTileSelection() to as a buffer to compare if there was a change between old and new

   110

	byte next_drawstyle; // queued, but not yet drawn style

   111

   112

	ViewportHighlightMode place_mode;

   113

	bool make_square_red;

   114

	WindowClass window_class;

   115

	WindowNumber window_number;

   116

   117

	ViewportPlaceMethod select_method;

   118

	byte select_proc;

   119

   120

	TileIndex redsq;

   121

   122

	FSMportsLayout *FSMportLayout;

   123

	FSMportsLayout *FSMportMask;

   124

};

   125

   126

#endif /* VIEWPORT_TYPE_H */