1

/* $Id$ */

     2

     3

/** @file viewport.cpp Handling of all viewports.

     4

 *

     5

 * \verbatim

     6

 * The in-game coordinate system looks like this *

     7

 *                                               *

     8

 *                    ^ Z                        *

     9

 *                    |                          *

    10

 *                    |                          *

    11

 *                    |                          *

    12

 *                    |                          *

    13

 *                 /     \                       *

    14

 *              /           \                    *

    15

 *           /                 \                 *

    16

 *        /                       \              *

    17

 *   X <                             > Y         *

    18

 * \endverbatim

    19

 */

    20

    21

#include "stdafx.h"

    22

#include "openttd.h"

    23

#include "debug.h"

    24

#include "tile_cmd.h"

    25

#include "gui.h"

    26

#include "spritecache.h"

    27

#include "landscape.h"

    28

#include "viewport_func.h"

    29

#include "station_base.h"

    30

#include "town.h"

    31

#include "signs_base.h"

    32

#include "signs_func.h"

    33

#include "waypoint.h"

    34

#include "variables.h"

    35

#include "train.h"

    36

#include "roadveh.h"

    37

#include "vehicle_gui.h"

    38

#include "blitter/factory.hpp"

    39

#include "newgrf_fsmports.h"

    40

#include "transparency.h"

    41

#include "strings_func.h"

    42

#include "zoom_func.h"

    43

#include "vehicle_func.h"

    44

#include "player_func.h"

    45

#include "settings_type.h"

    46

#include "station_func.h"

    47

#include "core/alloc_type.hpp"

    48

#include "misc/smallvec.h"

    49

#include "window_func.h"

    50

#include "tilehighlight_func.h"

    51

#include "window_gui.h"

    52

    53

#include "table/sprites.h"

    54

#include "table/strings.h"

    55

    56

PlaceProc *_place_proc;

    57

Point _tile_fract_coords;

    58

ZoomLevel _saved_scrollpos_zoom;

    59

    60

struct StringSpriteToDraw {

    61

	uint16 string;

    62

	uint16 color;

    63

	int32 x;

    64

	int32 y;

    65

	uint64 params[2];

    66

	uint16 width;

    67

};

    68

    69

struct TileSpriteToDraw {

    70

	SpriteID image;

    71

	SpriteID pal;

    72

	const SubSprite *sub;           ///< only draw a rectangular part of the sprite

    73

	int32 x;

    74

	int32 y;

    75

	byte z;

    76

};

    77

    78

struct ChildScreenSpriteToDraw {

    79

	SpriteID image;

    80

	SpriteID pal;

    81

	const SubSprite *sub;           ///< only draw a rectangular part of the sprite

    82

	int32 x;

    83

	int32 y;

    85

};

    86

    87

struct ParentSpriteToDraw {

    88

	SpriteID image;                 ///< sprite to draw

    89

	SpriteID pal;                   ///< palette to use

    90

	const SubSprite *sub;           ///< only draw a rectangular part of the sprite

    91

    92

	int32 x;                        ///< screen X coordinate of sprite

    93

	int32 y;                        ///< screen Y coordinate of sprite

    94

    95

	int32 left;                     ///< minimal screen X coordinate of sprite (= x + sprite->x_offs), reference point for child sprites

    96

	int32 top;                      ///< minimal screen Y coordinate of sprite (= y + sprite->y_offs), reference point for child sprites

    97

    98

	int32 xmin;                     ///< minimal world X coordinate of bounding box

    99

	int32 xmax;                     ///< maximal world X coordinate of bounding box

   100

	int32 ymin;                     ///< minimal world Y coordinate of bounding box

   101

	int32 ymax;                     ///< maximal world Y coordinate of bounding box

   102

	int zmin;                       ///< minimal world Z coordinate of bounding box

   103

	int zmax;                       ///< maximal world Z coordinate of bounding box

   104

   105

	int first_child;                ///< the first child to draw.

   106

	bool comparison_done;           ///< Used during sprite sorting: true if sprite has been compared with all other sprites

   107

};

   108

   109

/* Enumeration of multi-part foundations */

   110

enum FoundationPart {

   111

	FOUNDATION_PART_NONE     = 0xFF,  ///< Neither foundation nor groundsprite drawn yet.

   112

	FOUNDATION_PART_NORMAL   = 0,     ///< First part (normal foundation or no foundation)

   113

	FOUNDATION_PART_HALFTILE = 1,     ///< Second part (halftile foundation)

   114

	FOUNDATION_PART_END

   115

};

   116

   117

typedef SmallVector<TileSpriteToDraw, 64> TileSpriteToDrawVector;

   118

typedef SmallVector<StringSpriteToDraw, 4> StringSpriteToDrawVector;

   119

typedef SmallVector<ParentSpriteToDraw, 64> ParentSpriteToDrawVector;

   120

typedef SmallVector<ParentSpriteToDraw*, 64> ParentSpriteToSortVector;

   121

typedef SmallVector<ChildScreenSpriteToDraw, 16> ChildScreenSpriteToDrawVector;

   122

   123

struct ViewportDrawer {

   124

	DrawPixelInfo dpi;

   125

   126

	StringSpriteToDrawVector string_sprites_to_draw;

   127

	TileSpriteToDrawVector tile_sprites_to_draw;

   128

	ParentSpriteToDrawVector parent_sprites_to_draw;

   129

	ParentSpriteToSortVector parent_sprites_to_sort;

   130

	ChildScreenSpriteToDrawVector child_screen_sprites_to_draw;

   131

   132

	int *last_child;

   133

   134

	byte combine_sprites;

   135

   136

	int foundation[FOUNDATION_PART_END];             ///< Foundation sprites (index into parent_sprites_to_draw).

   137

	FoundationPart foundation_part;                  ///< Currently active foundation for ground sprite drawing.

   138

	int *last_foundation_child[FOUNDATION_PART_END]; ///< Tail of ChildSprite list of the foundations. (index into child_screen_sprites_to_draw)

   139

	Point foundation_offset[FOUNDATION_PART_END];    ///< Pixeloffset for ground sprites on the foundations.

   140

};

   141

   142

static ViewportDrawer _vd;

   143

   144

TileHighlightData _thd;

   145

static TileInfo *_cur_ti;

   146

bool _draw_bounding_boxes = false;

   147

   148

static Point MapXYZToViewport(const ViewPort *vp, uint x, uint y, uint z)

   149

{

   150

	Point p = RemapCoords(x, y, z);

   151

	p.x -= vp->virtual_width / 2;

   152

	p.y -= vp->virtual_height / 2;

   153

	return p;

   154

}

   155

   156

void DeleteWindowViewport(Window *w)

   157

{

   158

	free(w->viewport);

   159

	w->viewport = NULL;

   160

}

   161

   162

/**

   163

 * Initialize viewport of the window for use.

   164

 * @param w Window to use/display the viewport in

   165

 * @param x Offset of left edge of viewport with respect to left edge window \a w

   166

 * @param y Offset of top edge of viewport with respect to top edge window \a w

   167

 * @param width Width of the viewport

   168

 * @param height Height of the viewport

   169

 * @param follow_flags Flags controlling the viewport.

   170

 *        - If bit 31 is set, the lower 16 bits are the vehicle that the viewport should follow.

   171

 *        - If bit 31 is clear, it is a tile position.

   172

 * @param zoom Zoomlevel to display

   173

 */

   174

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

   175

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

   176

{

   177

	assert(w->viewport == NULL);

   178

   179

	ViewportData *vp = CallocT<ViewportData>(1);

   180

   181

	vp->left = x + w->left;

   182

	vp->top = y + w->top;

   183

	vp->width = width;

   184

	vp->height = height;

   185

   186

	vp->zoom = zoom;

   187

   188

	vp->virtual_width = ScaleByZoom(width, zoom);

   189

	vp->virtual_height = ScaleByZoom(height, zoom);

   190

   191

	Point pt;

   192

   193

	if (follow_flags & 0x80000000) {

   194

		const Vehicle *veh;

   195

   196

		vp->follow_vehicle = (VehicleID)(follow_flags & 0xFFFF);

   197

		veh = GetVehicle(vp->follow_vehicle);

   198

		pt = MapXYZToViewport(vp, veh->x_pos, veh->y_pos, veh->z_pos);

   199

	} else {

   200

		uint x = TileX(follow_flags) * TILE_SIZE;

   201

		uint y = TileY(follow_flags) * TILE_SIZE;

   202

   203

		vp->follow_vehicle = INVALID_VEHICLE;

   204

		pt = MapXYZToViewport(vp, x, y, GetSlopeZ(x, y));

   205

	}

   206

   207

	vp->scrollpos_x = pt.x;

   208

	vp->scrollpos_y = pt.y;

   209

	vp->dest_scrollpos_x = pt.x;

   210

	vp->dest_scrollpos_y = pt.y;

   211

   212

	w->viewport = vp;

   213

	vp->virtual_left = 0;//pt.x;

   214

	vp->virtual_top = 0;//pt.y;

   215

}

   216

   217

static Point _vp_move_offs;

   218

   219

static void DoSetViewportPosition(Window* const *wz, int left, int top, int width, int height)

   220

{

   221

   222

	for (; wz != _last_z_window; wz++) {

   223

		const Window *w = *wz;

   224

   225

		if (left + width > w->left &&

   226

				w->left + w->width > left &&

   227

				top + height > w->top &&

   228

				w->top + w->height > top) {

   229

   230

			if (left < w->left) {

   231

				DoSetViewportPosition(wz, left, top, w->left - left, height);

   232

				DoSetViewportPosition(wz, left + (w->left - left), top, width - (w->left - left), height);

   233

				return;

   234

			}

   235

   236

			if (left + width > w->left + w->width) {

   237

				DoSetViewportPosition(wz, left, top, (w->left + w->width - left), height);

   238

				DoSetViewportPosition(wz, left + (w->left + w->width - left), top, width - (w->left + w->width - left) , height);

   239

				return;

   240

			}

   241

   242

			if (top < w->top) {

   243

				DoSetViewportPosition(wz, left, top, width, (w->top - top));

   244

				DoSetViewportPosition(wz, left, top + (w->top - top), width, height - (w->top - top));

   245

				return;

   246

			}

   247

   248

			if (top + height > w->top + w->height) {

   249

				DoSetViewportPosition(wz, left, top, width, (w->top + w->height - top));

   250

				DoSetViewportPosition(wz, left, top + (w->top + w->height - top), width , height - (w->top + w->height - top));

   251

				return;

   252

			}

   253

   254

			return;

   255

		}

   256

	}

   257

   258

	{

   259

		int xo = _vp_move_offs.x;

   260

		int yo = _vp_move_offs.y;

   261

   262

		if (abs(xo) >= width || abs(yo) >= height) {

   263

			/* fully_outside */

   264

			RedrawScreenRect(left, top, left + width, top + height);

   265

			return;

   266

		}

   267

   268

		GfxScroll(left, top, width, height, xo, yo);

   269

   270

		if (xo > 0) {

   271

			RedrawScreenRect(left, top, xo + left, top + height);

   272

			left += xo;

   273

			width -= xo;

   274

		} else if (xo < 0) {

   275

			RedrawScreenRect(left+width+xo, top, left+width, top + height);

   276

			width += xo;

   277

		}

   278

   279

		if (yo > 0) {

   280

			RedrawScreenRect(left, top, width+left, top + yo);

   281

		} else if (yo < 0) {

   282

			RedrawScreenRect(left, top + height + yo, width+left, top + height);

   283

		}

   284

	}

   285

}

   286

   287

static void SetViewportPosition(Window *w, int x, int y)

   288

{

   289

	ViewPort *vp = w->viewport;

   290

	int old_left = vp->virtual_left;

   291

	int old_top = vp->virtual_top;

   292

	int i;

   293

	int left, top, width, height;

   294

   295

	vp->virtual_left = x;

   296

	vp->virtual_top = y;

   297

   298

	/* viewport is bound to its left top corner, so it must be rounded down (UnScaleByZoomLower)

   299

	 * else glitch described in FS#1412 will happen (offset by 1 pixel with zoom level > NORMAL)

   300

	 */

   301

	old_left = UnScaleByZoomLower(old_left, vp->zoom);

   302

	old_top = UnScaleByZoomLower(old_top, vp->zoom);

   303

	x = UnScaleByZoomLower(x, vp->zoom);

   304

	y = UnScaleByZoomLower(y, vp->zoom);

   305

   306

	old_left -= x;

   307

	old_top -= y;

   308

   309

	if (old_top == 0 && old_left == 0) return;

   310

   311

	_vp_move_offs.x = old_left;

   312

	_vp_move_offs.y = old_top;

   313

   314

	left = vp->left;

   315

	top = vp->top;

   316

	width = vp->width;

   317

	height = vp->height;

   318

   319

	if (left < 0) {

   320

		width += left;

   321

		left = 0;

   322

	}

   323

   324

	i = left + width - _screen.width;

   325

	if (i >= 0) width -= i;

   326

   327

	if (width > 0) {

   328

		if (top < 0) {

   329

			height += top;

   330

			top = 0;

   331

		}

   332

   333

		i = top + height - _screen.height;

   334

		if (i >= 0) height -= i;

   335

   336

		if (height > 0) DoSetViewportPosition(FindWindowZPosition(w) + 1, left, top, width, height);

   337

	}

   338

}

   339

   340

/**

   341

 * Is a xy position inside the viewport of the window?

   342

 * @param w Window to examine its viewport

   343

 * @param x X coordinate of the xy position

   344

 * @param y Y coordinate of the xy position

   345

 * @return Pointer to the viewport if the xy position is in the viewport of the window,

   346

 *         otherwise \c NULL is returned.

   347

 */

   348

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

   349

{

   350

	ViewPort *vp = w->viewport;

   351

   352

	if (vp != NULL &&

   353

			IsInsideMM(x, vp->left, vp->left + vp->width) &&

   354

			IsInsideMM(y, vp->top, vp->top + vp->height))

   355

		return vp;

   356

   357

	return NULL;

   358

}

   359

   360

static Point TranslateXYToTileCoord(const ViewPort *vp, int x, int y)

   361

{

   362

	Point pt;

   363

	int a,b;

   364

	uint z;

   365

   366

	if ( (uint)(x -= vp->left) >= (uint)vp->width ||

   367

				(uint)(y -= vp->top) >= (uint)vp->height) {

   368

				Point pt = {-1, -1};

   369

				return pt;

   370

	}

   371

   372

	x = (ScaleByZoom(x, vp->zoom) + vp->virtual_left) >> 2;

   373

	y = (ScaleByZoom(y, vp->zoom) + vp->virtual_top) >> 1;

   374

   375

	a = y-x;

   376

	b = y+x;

   377

   378

	/* we need to move variables in to the valid range, as the

   379

	 * GetTileZoomCenterWindow() function can call here with invalid x and/or y,

   380

	 * when the user tries to zoom out along the sides of the map */

   381

	a = Clamp(a, 0, (int)(MapMaxX() * TILE_SIZE) - 1);

   382

	b = Clamp(b, 0, (int)(MapMaxY() * TILE_SIZE) - 1);

   383

   384

	/* (a, b) is the X/Y-world coordinate that belongs to (x,y) if the landscape would be completely flat on height 0.

   385

	 * Now find the Z-world coordinate by fix point iteration.

   386

	 * This is a bit tricky because the tile height is non-continuous at foundations.

   387

	 * The clicked point should be approached from the back, otherwise there are regions that are not clickable.

   388

	 * (FOUNDATION_HALFTILE_LOWER on SLOPE_STEEP_S hides north halftile completely)

   389

	 * So give it a z-malus of 4 in the first iterations.

   390

	 */

   391

	z = 0;

   392

	for (int i = 0; i < 5; i++) z = GetSlopeZ(a + max(z, 4u) - 4, b + max(z, 4u) - 4) / 2;

   393

	for (uint malus = 3; malus > 0; malus--) z = GetSlopeZ(a + max(z, malus) - malus, b + max(z, malus) - malus) / 2;

   394

	for (int i = 0; i < 5; i++) z = GetSlopeZ(a + z, b + z) / 2;

   395

   396

	pt.x = a + z;

   397

	pt.y = b + z;

   398

   399

	return pt;

   400

}

   401

   402

/* When used for zooming, check area below current coordinates (x,y)

   403

 * and return the tile of the zoomed out/in position (zoom_x, zoom_y)

   404

 * when you just want the tile, make x = zoom_x and y = zoom_y */

   405

static Point GetTileFromScreenXY(int x, int y, int zoom_x, int zoom_y)

   406

{

   407

	Window *w;

   408

	ViewPort *vp;

   409

	Point pt;

   410

   411

	if ( (w = FindWindowFromPt(x, y)) != NULL &&

   412

			 (vp = IsPtInWindowViewport(w, x, y)) != NULL)

   413

				return TranslateXYToTileCoord(vp, zoom_x, zoom_y);

   414

   415

	pt.y = pt.x = -1;

   416

	return pt;

   417

}

   418

   419

Point GetTileBelowCursor()

   420

{

   421

	return GetTileFromScreenXY(_cursor.pos.x, _cursor.pos.y, _cursor.pos.x, _cursor.pos.y);

   422

}

   423

   424

   425

Point GetTileZoomCenterWindow(bool in, Window * w)

   426

{

   427

	int x, y;

   428

	ViewPort *vp = w->viewport;

   429

   430

	if (in) {

   431

		x = ((_cursor.pos.x - vp->left) >> 1) + (vp->width >> 2);

   432

		y = ((_cursor.pos.y - vp->top) >> 1) + (vp->height >> 2);

   433

	} else {

   434

		x = vp->width - (_cursor.pos.x - vp->left);

   435

		y = vp->height - (_cursor.pos.y - vp->top);

   436

	}

   437

	/* Get the tile below the cursor and center on the zoomed-out center */

   438

	return GetTileFromScreenXY(_cursor.pos.x, _cursor.pos.y, x + vp->left, y + vp->top);

   439

}

   440

   441

/** Update the status of the zoom-buttons according to the zoom-level

   442

 * of the viewport. This will update their status and invalidate accordingly

   443

 * @param w Window pointer to the window that has the zoom buttons

   444

 * @param vp pointer to the viewport whose zoom-level the buttons represent

   445

 * @param widget_zoom_in widget index for window with zoom-in button

   446

 * @param widget_zoom_out widget index for window with zoom-out button */

   447

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

   448

{

   449

	w->SetWidgetDisabledState(widget_zoom_in, vp->zoom == ZOOM_LVL_MIN);

   450

	w->InvalidateWidget(widget_zoom_in);

   451

   452

	w->SetWidgetDisabledState(widget_zoom_out, vp->zoom == ZOOM_LVL_MAX);

   453

	w->InvalidateWidget(widget_zoom_out);

   454

}

   455

   456

/**

   457

 * Draws a ground sprite at a specific world-coordinate.

   458

 *

   459

 * @param image the image to draw.

   460

 * @param pal the provided palette.

   461

 * @param x position x of the sprite.

   462

 * @param y position y of the sprite.

   463

 * @param z position z of the sprite.

   464

 * @param sub Only draw a part of the sprite.

   465

 *

   466

 */

   467

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

   468

{

   469

	assert((image & SPRITE_MASK) < MAX_SPRITES);

   470

   471

	TileSpriteToDraw *ts = _vd.tile_sprites_to_draw.Append();

   472

	ts->image = image;

   473

	ts->pal = pal;

   474

	ts->sub = sub;

   475

	ts->x = x;

   476

	ts->y = y;

   477

	ts->z = z;

   478

}

   479

   480

/**

   481

 * Adds a child sprite to the active foundation.

   482

 *

   483

 * The pixel offset of the sprite relative to the ParentSprite is the sum of the offset passed to OffsetGroundSprite() and extra_offs_?.

   484

 *

   485

 * @param image the image to draw.

   486

 * @param pal the provided palette.

   487

 * @param sub Only draw a part of the sprite.

   488

 * @param foundation_part Foundation part.

   489

 * @param extra_offs_x Pixel X offset for the sprite position.

   490

 * @param extra_offs_y Pixel Y offset for the sprite position.

   491

 */

   492

static void AddChildSpriteToFoundation(SpriteID image, SpriteID pal, const SubSprite *sub, FoundationPart foundation_part, int extra_offs_x, int extra_offs_y)

   493

{

   494

	assert(IsInsideMM(foundation_part, 0, FOUNDATION_PART_END));

   495

	assert(_vd.foundation[foundation_part] != -1);

   496

	Point offs = _vd.foundation_offset[foundation_part];