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

void OffsetGroundSprite(int x, int y);

    49

    50

void DrawGroundSprite(SpriteID image, SpriteID pal);

    51

void DrawGroundSpriteAt(SpriteID image, SpriteID pal, int32 x, int32 y, byte z);

    52

void AddSortableSpriteToDraw(SpriteID image, SpriteID pal, int x, int y, int w, int h, byte dz, byte z, bool transparent = false);

    53

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

    54

void AddChildSpriteScreen(SpriteID image, SpriteID pal, int x, int y);

    55

    56

    57

void StartSpriteCombine();

    58

void EndSpriteCombine();

    59

    60

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

    61

void PlaceObject();

    62

void SetRedErrorSquare(TileIndex tile);

    63

void SetTileSelectSize(int w, int h);

    64

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

    65

    66

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

    67

void VpSetPresizeRange(uint from, uint to);

    68

void VpSetPlaceSizingLimit(int limit);

    69

    70

Vehicle *CheckMouseOverVehicle();

    71

    72

enum {

    73

	VPM_X_OR_Y          = 0,

    74

	VPM_FIX_X           = 1,

    75

	VPM_FIX_Y           = 2,

    76

	VPM_RAILDIRS        = 3,

    77

	VPM_X_AND_Y         = 4,

    78

	VPM_X_AND_Y_LIMITED = 5,

    79

	VPM_SIGNALDIRS      = 6

    80

};

    81

    82

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

    83

enum {

    84

	VHM_NONE    = 0, ///< default

    85

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

    86

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

    87

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

    88

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

    89

	VHM_RAIL    = 5, ///< rail pieces

    90

};

    91

    92

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

    93

    94

/* highlighting draw styles */

    95

typedef byte HighLightStyle;

    96

enum HighLightStyles {

    97

	HT_NONE   = 0x00,

    98

	HT_RECT   = 0x80,

    99

	HT_POINT  = 0x40,

   100

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

   101

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

   102

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

   103

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

   104

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

   105

   106

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

   107

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

   108

	HT_DIR_X  = 0,    ///< X direction

   109

	HT_DIR_Y  = 1,    ///< Y direction

   110

	HT_DIR_HU = 2,    ///< horizontal upper

   111

	HT_DIR_HL = 3,    ///< horizontal lower

   112

	HT_DIR_VL = 4,    ///< vertical left

   113

	HT_DIR_VR = 5,    ///< vertical right

   114

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

   115

};

   116

   117

struct TileHighlightData {

   118

	Point size;

   119

	Point outersize;

   120

	Point pos;

   121

	Point offs;

   122

   123

	Point new_pos;

   124

	Point new_size;

   125

	Point new_outersize;

   126

   127

	Point selend, selstart;

   128

   129

	byte dirty;

   130

	byte sizelimit;

   131

   132

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

   133

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

   134

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

   135

   137

   138

	byte place_mode;

   139

	bool make_square_red;

   140

	WindowClass window_class;

   141

	WindowNumber window_number;

   142

   143

	byte select_method;

   144

	byte select_proc;

   145

   146

	TileIndex redsq;

   147

};

   148

   149

   150

/* common button handler */

   151

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

   152

   153

VARDEF Point _tile_fract_coords;

   154

   155

extern TileHighlightData _thd;

   156

   157

   158

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

   159

   160

#endif /* VIEWPORT_H */