1

/* $Id$ */

     2

     3

/** @file viewport.h */

     4

     5

#ifndef VIEWPORT_H

     6

#define VIEWPORT_H

     7

     8

#include "window.h"

     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

	byte zoom;

    18

};

    19

    20

void SetSelectionRed(bool);

    21

    22

/* viewport.cpp */

    23

void InitViewports();

    24

void DeleteWindowViewport(BaseWindow *w);

    25

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

    26

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

    27

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

    28

Point GetTileBelowCursor();

    29

void UpdateViewportPosition(BaseWindow *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, BaseWindow *w);

    38

void ZoomInOrOutToCursorWindow(bool in, BaseWindow * w);

    39

Point GetTileZoomCenterWindow(bool in, BaseWindow * w);

    40

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

    41

    42

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

    43

{

    44

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

    45

}

    46

    47

void OffsetGroundSprite(int x, int y);

    48

    49

void DrawGroundSprite(SpriteID image, SpriteID pal);

    50

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

    51

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

    52

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

    53

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

    54

    55

    56

void StartSpriteCombine();

    57

void EndSpriteCombine();

    58

    59

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

    60

void PlaceObject();

    61

void SetRedErrorSquare(TileIndex tile);

    62

void SetTileSelectSize(int w, int h);

    63

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

    64

    65

void VpStartPlaceSizing(TileIndex tile, int user);

    66

void VpSetPresizeRange(uint from, uint to);

    67

void VpSetPlaceSizingLimit(int limit);

    68

    69

Vehicle *CheckMouseOverVehicle();

    70

    71

enum {

    72

	VPM_X_OR_Y          = 0,

    73

	VPM_FIX_X           = 1,

    74

	VPM_FIX_Y           = 2,

    75

	VPM_RAILDIRS        = 3,

    76

	VPM_X_AND_Y         = 4,

    77

	VPM_X_AND_Y_LIMITED = 5,

    78

	VPM_SIGNALDIRS      = 6

    79

};

    80

    81

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

    82

enum {

    83

	VHM_NONE    = 0, ///< default

    84

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

    85

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

    86

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

    87

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

    88

	VHM_RAIL    = 5, ///< rail pieces

    89

};

    90

    91

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

    92

    93

/* highlighting draw styles */

    94

typedef byte HighLightStyle;

    95

enum HighLightStyles {

    96

	HT_NONE   = 0x00,

    97

	HT_RECT   = 0x80,

    98

	HT_POINT  = 0x40,

    99

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

   100

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

   101

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

   102

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

   103

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

   104

   105

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

   106

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

   107

	HT_DIR_X  = 0,    ///< X direction

   108

	HT_DIR_Y  = 1,    ///< Y direction

   109

	HT_DIR_HU = 2,    ///< horizontal upper

   110

	HT_DIR_HL = 3,    ///< horizontal lower

   111

	HT_DIR_VL = 4,    ///< vertical left

   112

	HT_DIR_VR = 5,    ///< vertical right

   113

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

   114

};

   115

   116

struct TileHighlightData {

   117

	Point size;

   118

	Point outersize;

   119

	Point pos;

   120

	Point offs;

   121

   122

	Point new_pos;

   123

	Point new_size;

   124

	Point new_outersize;

   125

   126

	Point selend, selstart;

   127

   128

	byte dirty;

   129

	byte sizelimit;

   130

   131

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

   132

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

   133

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

   134

   135

	byte place_mode;

   136

	bool make_square_red;

   137

	WindowClass window_class;

   138

	WindowNumber window_number;

   139

   140

	int userdata;

   141

	TileIndex redsq;

   142

};

   143

   144

   145

/* common button handler */

   146

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

   147

   148

VARDEF Point _tile_fract_coords;

   149

   150

extern TileHighlightData _thd;

   151

   152

   153

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

   154

   155

#endif /* VIEWPORT_H */