1

/* $Id$ */

     2

     3

/** @file viewport.h */

     4

     5

#ifndef VIEWPORT_H

     6

#define VIEWPORT_H

     7

     8

#include "zoom.hpp"

     9

    10

struct ViewPort {

    11

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

    12

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

    13

    14

	int virtual_left, virtual_top;      // virtual coordinates

    15

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

    16

    17

	ZoomLevel zoom;

    18

};

    19

    20

void SetSelectionRed(bool);

    21

    22

/* viewport.cpp */

    23

void InitViewports();

    24

void DeleteWindowViewport(Window *w);

    25

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

    26

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

    27

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

    28

Point GetTileBelowCursor();

    29

void UpdateViewportPosition(Window *w);

    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

bool DoZoomInOutWindow(int how, Window *w);

    38

void ZoomInOrOutToCursorWindow(bool in, Window * w);

    39

Point GetTileZoomCenterWindow(bool in, Window * w);

    40

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

    41

    42

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

    43

{

    44

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

    45

}

    46

    58

void OffsetGroundSprite(int x, int y);

    59

    60

void DrawGroundSprite(SpriteID image, SpriteID pal);

    61

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

    62

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);

    63

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

    64

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

    65

    66

    67

void StartSpriteCombine();

    68

void EndSpriteCombine();

    69

    70

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

    71

void PlaceObject();

    72

void SetRedErrorSquare(TileIndex tile);

    73

void SetTileSelectSize(int w, int h);

    74

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

    75

    76

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

    77

void VpSetPresizeRange(uint from, uint to);

    78

void VpSetPlaceSizingLimit(int limit);

    79

    80

Vehicle *CheckMouseOverVehicle();

    81

    82

enum {

    83

	VPM_X_OR_Y          = 0,

    84

	VPM_FIX_X           = 1,

    85

	VPM_FIX_Y           = 2,

    86

	VPM_RAILDIRS        = 3,

    87

	VPM_X_AND_Y         = 4,

    88

	VPM_X_AND_Y_LIMITED = 5,

    89

	VPM_SIGNALDIRS      = 6

    90

};

    91

    92

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

    93

enum {

    94

	VHM_NONE    = 0, ///< default

    95

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

    96

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

    97

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

    98

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

    99

	VHM_RAIL    = 5, ///< rail pieces

   100

};

   101

   102

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

   103

   104

/* highlighting draw styles */

   105

typedef byte HighLightStyle;

   106

enum HighLightStyles {

   107

	HT_NONE   = 0x00,

   108

	HT_RECT   = 0x80,

   109

	HT_POINT  = 0x40,

   110

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

   111

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

   112

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

   113

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

   114

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

   115

   116

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

   117

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

   118

	HT_DIR_X  = 0,    ///< X direction

   119

	HT_DIR_Y  = 1,    ///< Y direction

   120

	HT_DIR_HU = 2,    ///< horizontal upper

   121

	HT_DIR_HL = 3,    ///< horizontal lower

   122

	HT_DIR_VL = 4,    ///< vertical left

   123

	HT_DIR_VR = 5,    ///< vertical right

   124

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

   125

};

   126

   127

struct TileHighlightData {

   128

	Point size;

   129

	Point outersize;

   130

	Point pos;

   131

	Point offs;

   132

   133

	Point new_pos;

   134

	Point new_size;

   135

	Point new_outersize;

   136

   137

	Point selend, selstart;

   138

   139

	byte dirty;

   140

	byte sizelimit;

   141

   142

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

   143

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

   144

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

   145

   146

	byte place_mode;

   147

	bool make_square_red;

   148

	WindowClass window_class;

   149

	WindowNumber window_number;

   150

   151

	byte select_method;

   152

	byte select_proc;

   153

   154

	TileIndex redsq;

   155

};

   156

   157

   158

/* common button handler */

   159

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

   160

   161

VARDEF Point _tile_fract_coords;

   162

   163

extern TileHighlightData _thd;

   164

   165

   166

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

   167

   168

#endif /* VIEWPORT_H */