1

/* $Id$ */

     2

     3

/** @file viewport.h */

     4

     5

#ifndef VIEWPORT_H

     6

#define VIEWPORT_H

     7

     8

#include "zoom.hpp"

    10

    11

struct ViewPort {

    12

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

    13

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

    14

    15

	int virtual_left, virtual_top;      // virtual coordinates

    16

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

    17

    18

	ZoomLevel zoom;

    19

};

    20

    21

void SetSelectionRed(bool);

    22

    23

/* viewport.cpp */

    24

void InitViewports();

    25

void DeleteWindowViewport(Window *w);

    26

void AssignWindowViewport(Window *w, int x, int y,

    27

	int width, int height, uint32 follow_flags, ZoomLevel zoom);

    28

ViewPort *IsPtInWindowViewport(const Window *w, int x, int y);

    29

Point GetTileBelowCursor();

    30

void UpdateViewportPosition(Window *w);

    31

    32

enum {

    33

	ZOOM_IN   = 0,

    34

	ZOOM_OUT  = 1,

    35

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

    36

};

    37

    38

bool DoZoomInOutWindow(int how, Window *w);

    39

void ZoomInOrOutToCursorWindow(bool in, Window * w);

    40

Point GetTileZoomCenterWindow(bool in, Window * w);

    41

void HandleZoomMessage(Window *w, const ViewPort *vp, byte widget_zoom_in, byte widget_zoom_out);

    42

    43

static inline void MaxZoomInOut(int how, Window *w)

    44

{

    45

	while (DoZoomInOutWindow(how, w)) {};

    46

}

    47

    48

/**

    49

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

    50

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

    51

 * z=6     reserved, currently unused.

    52

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

    53

 */

    54

enum {

    55

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

    56

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

    57

};

    58

    59

void OffsetGroundSprite(int x, int y);

    60

    61

void DrawGroundSprite(SpriteID image, SpriteID pal, const SubSprite *sub = NULL);

    62

void DrawGroundSpriteAt(SpriteID image, SpriteID pal, int32 x, int32 y, byte z, const SubSprite *sub = NULL);

    63

void AddSortableSpriteToDraw(SpriteID image, SpriteID pal, int x, int y, int w, int h, int dz, int z, bool transparent = false, int bb_offset_x = 0, int bb_offset_y = 0, int bb_offset_z = 0, const SubSprite *sub = NULL);

    64

void *AddStringToDraw(int x, int y, StringID string, uint64 params_1, uint64 params_2);

    65

void AddChildSpriteScreen(SpriteID image, SpriteID pal, int x, int y, bool transparent = false, const SubSprite *sub = NULL);

    66

    67

    68

void StartSpriteCombine();

    69

void EndSpriteCombine();

    70

    71

void HandleViewportClicked(const ViewPort *vp, int x, int y);

    72

void PlaceObject();

    73

void SetRedErrorSquare(TileIndex tile);

    74

void SetTileSelectSize(int w, int h);

    75

void SetTileSelectBigSize(int ox, int oy, int sx, int sy);

    76

    77

Vehicle *CheckMouseOverVehicle();

    78

    79

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

    80

enum ViewportPlaceMethod {

    81

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

    82

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

    83

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

    84

	VPM_RAILDIRS        = 3, ///< all rail directions

    85

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

    86

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

    87

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

    88

};

    89

    90

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

    91

enum ViewportHighlightMode {

    92

	VHM_NONE    = 0, ///< default

    93

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

    94

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

    95

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

    96

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

    97

	VHM_RAIL    = 5, ///< rail pieces

    98

};

    99

   100

void VpSelectTilesWithMethod(int x, int y, ViewportPlaceMethod method);

   101

void VpStartPlaceSizing(TileIndex tile, ViewportPlaceMethod method, byte process);

   102

void VpSetPresizeRange(uint from, uint to);

   103

void VpSetPlaceSizingLimit(int limit);

   104

   105

/* highlighting draw styles */

   106

typedef byte HighLightStyle;

   107

enum HighLightStyles {

   108

	HT_NONE   = 0x00,

   109

	HT_RECT   = 0x80,

   110

	HT_POINT  = 0x40,

   111

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

   112

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

   113

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

   114

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

   115

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

   116

   117

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

   118

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

   119

	HT_DIR_X  = 0,    ///< X direction

   120

	HT_DIR_Y  = 1,    ///< Y direction

   121

	HT_DIR_HU = 2,    ///< horizontal upper

   122

	HT_DIR_HL = 3,    ///< horizontal lower

   123

	HT_DIR_VL = 4,    ///< vertical left

   124

	HT_DIR_VR = 5,    ///< vertical right

   125

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

   126

};

   127

   128

struct TileHighlightData {

   129

	Point size;

   130

	Point outersize;

   131

	Point pos;

   132

	Point offs;

   133

   134

	Point new_pos;

   135

	Point new_size;

   136

	Point new_outersize;

   137

   138

	Point selend, selstart;

   139

   140

	byte dirty;

   141

	byte sizelimit;

   142

   143

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

   144

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

   145

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

   146

   147

	ViewportHighlightMode place_mode;

   148

	bool make_square_red;

   149

	WindowClass window_class;

   150

	WindowNumber window_number;

   151

   152

	ViewportPlaceMethod select_method;

   153

	byte select_proc;

   154

   155

	TileIndex redsq;

   156

};

   157

   158

   159

/* common button handler */

   160

bool HandlePlacePushButton(Window *w, int widget, CursorID cursor, ViewportHighlightMode mode, PlaceProc *placeproc);

   161

   162

VARDEF Point _tile_fract_coords;

   163

   164

extern TileHighlightData _thd;

   165

   166

   167

void ViewportDoDraw(const ViewPort *vp, int left, int top, int right, int bottom);

   168

   169

#endif /* VIEWPORT_H */