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

    13

struct ViewPort {

    14

	int left,top;                       // screen coordinates for the viewport

    15

	int width, height;                  // screen width/height for the viewport

    16

    17

	int virtual_left, virtual_top;      // virtual coordinates

    18

	int virtual_width, virtual_height;  // these are just width << zoom, height << zoom

    19

    20

	ZoomLevel zoom;

    21

};

    22

    23

enum {

    24

	ZOOM_IN   = 0,

    25

	ZOOM_OUT  = 1,

    26

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

    27

};

    28

    29

/**

    30

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

    31

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

    32

 * z=6     reserved, currently unused.

    33

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

    34

 */

    35

enum {

    36

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

    37

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

    38

};

    39

    40

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

    41

enum ViewportPlaceMethod {

    42

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

    43

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

    44

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

    45

	VPM_RAILDIRS        = 3, ///< all rail directions

    46

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

    47

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

    48

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

    49

};

    50

    51

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

    52

enum ViewportHighlightMode {

    53

	VHM_NONE    = 0, ///< default

    54

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

    55

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

    56

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

    57

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

    58

	VHM_RAIL    = 5, ///< rail pieces

    59

};

    60

    61

/* highlighting draw styles */

    62

enum HighLightStyle {

    63

	HT_NONE   = 0x00,

    64

	HT_RECT   = 0x80,

    65

	HT_POINT  = 0x40,

    66

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

    67

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

    68

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

    69

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

    70

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

    71

    72

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

    73

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

    74

	HT_DIR_X  = 0,    ///< X direction

    75

	HT_DIR_Y  = 1,    ///< Y direction

    76

	HT_DIR_HU = 2,    ///< horizontal upper

    77

	HT_DIR_HL = 3,    ///< horizontal lower

    78

	HT_DIR_VL = 4,    ///< vertical left

    79

	HT_DIR_VR = 5,    ///< vertical right

    80

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

    81

};

    82

DECLARE_ENUM_AS_BIT_SET(HighLightStyle);

    83

    84

    85

struct TileHighlightData {

    86

	Point size;

    87

	Point outersize;

    88

	Point pos;

    89

	Point offs;

    90

    91

	Point new_pos;

    92

	Point new_size;

    93

	Point new_outersize;

    94

    95

	Point selend, selstart;

    96

    97

	byte dirty;

    98

	byte sizelimit;

    99

   100

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

   101

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

   102

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

   103

   104

	ViewportHighlightMode place_mode;

   105

	bool make_square_red;

   106

	WindowClass window_class;

   107

	WindowNumber window_number;

   108

   109

	ViewportPlaceMethod select_method;

   110

	byte select_proc;

   111

   112

	TileIndex redsq;

   113

};

   114

   115

#endif /* VIEWPORT_TYPE_H */