1

/* $Id$ */

     2

     3

#ifndef VIEWPORT_H

     4

#define VIEWPORT_H

     5

     6

struct ViewPort {

     7

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

     8

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

     9

    10

	int virtual_left, virtual_top;      // virtual coordinates

    11

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

    12

    13

	byte zoom;

    14

};

    15

    16

void SetSelectionRed(bool);

    17

    18

/* viewport.c */

    19

void InitViewports(void);

    20

void DeleteWindowViewport(Window *w);

    21

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

    22

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

    23

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

    24

Point GetTileBelowCursor(void);

    25

void UpdateViewportPosition(Window *w);

    26

    27

enum {

    28

	ZOOM_IN   = 0,

    29

	ZOOM_OUT  = 1,

    30

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

    31

};

    32

    33

bool DoZoomInOutWindow(int how, Window *w);

    34

void ZoomInOrOutToCursorWindow(bool in, Window * w);

    35

Point GetTileZoomCenterWindow(bool in, Window * w);

    36

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

    37

    38

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

    39

{

    40

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

    41

}

    42

    43

void OffsetGroundSprite(int x, int y);

    44

    45

void DrawGroundSprite(uint32 image);

    46

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

    47

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

    48

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

    49

void AddChildSpriteScreen(uint32 image, int x, int y);

    50

    51

    52

void StartSpriteCombine(void);

    53

void EndSpriteCombine(void);

    54

    55

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

    56

void PlaceObject(void);

    57

void SetRedErrorSquare(TileIndex tile);

    58

void SetTileSelectSize(int w, int h);

    59

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

    60

    61

void VpStartPlaceSizing(TileIndex tile, int user);

    62

void VpSetPresizeRange(uint from, uint to);

    63

void VpSetPlaceSizingLimit(int limit);

    64

    65

Vehicle *CheckMouseOverVehicle(void);

    66

    67

enum {

    68

	VPM_X_OR_Y          = 0,

    69

	VPM_FIX_X           = 1,

    70

	VPM_FIX_Y           = 2,

    71

	VPM_RAILDIRS        = 3,

    72

	VPM_X_AND_Y         = 4,

    73

	VPM_X_AND_Y_LIMITED = 5,

    74

	VPM_SIGNALDIRS      = 6

    75

};

    76

    77

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

    78

enum {

    79

	VHM_NONE    = 0, // default

    80

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

    81

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

    82

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

    83

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

    84

	VHM_RAIL    = 5, // rail pieces

    85

};

    86

    87

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

    88

    89

// highlighting draw styles

    90

typedef byte HighLightStyle;

    91

enum HighLightStyles {

    92

	HT_NONE   = 0x00,

    93

	HT_RECT   = 0x80,

    94

	HT_POINT  = 0x40,

    95

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

    96

	                   * (uses lower bits to indicate direction) */

    97

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

    98

	                  * (uses lower bits to indicate direction) */

    99

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

   100

   101

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

   102

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

   103

	HT_DIR_X  = 0,    ///< X direction

   104

	HT_DIR_Y  = 1,    ///< Y direction

   105

	HT_DIR_HU = 2,    ///< horizontal upper

   106

	HT_DIR_HL = 3,    ///< horizontal lower

   107

	HT_DIR_VL = 4,    ///< vertical left

   108

	HT_DIR_VR = 5,    ///< vertical right

   109

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

   110

};

   111

   112

typedef struct TileHighlightData {

   113

	Point size;

   114

	Point outersize;

   115

	Point pos;

   116

	Point offs;

   117

   118

	Point new_pos;

   119

	Point new_size;

   120

	Point new_outersize;

   121

   122

	Point selend, selstart;

   123

   124

	byte dirty;

   125

	byte sizelimit;

   126

   127

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

   128

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

   129

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

   130

   131

	byte place_mode;

   132

	bool make_square_red;

   133

	WindowClass window_class;

   134

	WindowNumber window_number;

   135

   136

	int userdata;

   137

	TileIndex redsq;

   138

} TileHighlightData;

   139

   140

   141

// common button handler

   142

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

   143

   144

VARDEF Point _tile_fract_coords;

   145

   146

extern TileHighlightData _thd;

   147

   148

   149

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

   150

   151

#endif /* VIEWPORT_H */