1

/* $Id$ */

     2

     3

/** @file viewport.h */

     4

     5

#ifndef VIEWPORT_H

     6

#define VIEWPORT_H

     7

     8

#include "zoom_type.h"

     9

#include "window_type.h"

    10

#include "vehicle_type.h"

    11

#include "gfx_func.h"

    12

    13

struct ViewPort {

    14

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

    15

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

    16

    17

	int virtual_left, virtual_top;      // virtual coordinates

    18

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

    19

    20

	ZoomLevel zoom;

    21

};

    22

    23

void SetSelectionRed(bool);

    24

    25

/* viewport.cpp */

    26

void InitViewports();

    27

void DeleteWindowViewport(Window *w);

    28

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

    29

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

    30

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

    31

Point GetTileBelowCursor();

    32

void UpdateViewportPosition(Window *w);

    33

    34

enum {

    35

	ZOOM_IN   = 0,

    36

	ZOOM_OUT  = 1,

    37

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

    38

};

    39

    40

bool DoZoomInOutWindow(int how, Window *w);

    41

void ZoomInOrOutToCursorWindow(bool in, Window * w);

    42

Point GetTileZoomCenterWindow(bool in, Window * w);

    43

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

    44

    45

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

    46

{

    47

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

    48

}

    49

    50

/**

    51

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

    52

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

    53

 * z=6     reserved, currently unused.

    54

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

    55

 */

    56

enum {

    57

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

    58

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

    59

};

    60

    61

void OffsetGroundSprite(int x, int y);

    62

    63

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

    64

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

    65

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

    66

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

    67

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

    68

    69

    70

void StartSpriteCombine();

    71

void EndSpriteCombine();

    72

    73

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

    74

void PlaceObject();

    75

void SetRedErrorSquare(TileIndex tile);

    76

void SetTileSelectSize(int w, int h);

    77

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

    78

    79

Vehicle *CheckMouseOverVehicle();

    80

    81

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

    82

enum ViewportPlaceMethod {

    83

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

    84

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

    85

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

    86

	VPM_RAILDIRS        = 3, ///< all rail directions

    87

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

    88

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

    89

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

    90

};

    91

    92

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

    93

enum ViewportHighlightMode {

    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, ViewportPlaceMethod method);

   103

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

   104

void VpSetPresizeRange(uint from, uint to);

   105

void VpSetPlaceSizingLimit(int limit);

   106

   107

/* highlighting draw styles */

   108

typedef byte HighLightStyle;

   109

enum HighLightStyles {

   110

	HT_NONE   = 0x00,

   111

	HT_RECT   = 0x80,

   112

	HT_POINT  = 0x40,

   113

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

   114

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

   115

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

   116

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

   117

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

   118

   119

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

   120

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

   121

	HT_DIR_X  = 0,    ///< X direction

   122

	HT_DIR_Y  = 1,    ///< Y direction

   123

	HT_DIR_HU = 2,    ///< horizontal upper

   124

	HT_DIR_HL = 3,    ///< horizontal lower

   125

	HT_DIR_VL = 4,    ///< vertical left

   126

	HT_DIR_VR = 5,    ///< vertical right

   127

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

   128

};

   129

   130

struct TileHighlightData {

   131

	Point size;

   132

	Point outersize;

   133

	Point pos;

   134

	Point offs;

   135

   136

	Point new_pos;

   137

	Point new_size;

   138

	Point new_outersize;

   139

   140

	Point selend, selstart;

   141

   142

	byte dirty;

   143

	byte sizelimit;

   144

   145

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

   146

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

   147

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

   148

   149

	ViewportHighlightMode place_mode;

   150

	bool make_square_red;

   151

	WindowClass window_class;

   152

	WindowNumber window_number;

   153

   154

	ViewportPlaceMethod select_method;

   155

	byte select_proc;

   156

   157

	TileIndex redsq;

   158

};

   159

   160

   161

/* common button handler */

   162

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

   163

   164

VARDEF Point _tile_fract_coords;

   165

   166

extern TileHighlightData _thd;

   167

   168

   169

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

   170

   171

void SetObjectToPlaceWnd(CursorID icon, SpriteID pal, ViewportHighlightMode mode, Window *w);

   172

void SetObjectToPlace(CursorID icon, SpriteID pal, ViewportHighlightMode mode, WindowClass window_class, WindowNumber window_num);

   173

   174

void ResetObjectToPlace();

   175

   176

bool ScrollWindowTo(int x, int y, Window *w, bool instant = false);

   177

   178

bool ScrollMainWindowToTile(TileIndex tile, bool instant = false);

   179

bool ScrollMainWindowTo(int x, int y, bool instant = false);

   180

   181

#endif /* VIEWPORT_H */