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 "transparency.h"

    40

#include "strings_func.h"

    41

#include "zoom_func.h"

    42

#include "vehicle_func.h"

    43

#include "player_func.h"

    44

#include "settings_type.h"

    45

#include "station_func.h"

    46

#include "core/alloc_type.hpp"

    47

#include "misc/smallvec.h"

    48

#include "window_func.h"

    49

#include "tilehighlight_func.h"

    50

#include "window_gui.h"

    51

    52

#include "table/sprites.h"

    53

#include "table/strings.h"

    54

    55

PlaceProc *_place_proc;

    56

Point _tile_fract_coords;

    57

ZoomLevel _saved_scrollpos_zoom;

    58

    59

struct StringSpriteToDraw {

    60

	uint16 string;

    61

	uint16 color;

    62

	int32 x;

    63

	int32 y;

    64

	uint64 params[2];

    65

	uint16 width;

    66

};

    67

    68

struct TileSpriteToDraw {

    69

	SpriteID image;

    70

	SpriteID pal;

    71

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

    72

	int32 x;

    73

	int32 y;

    74

	byte z;

    75

};

    76

    77

struct ChildScreenSpriteToDraw {

    78

	SpriteID image;

    79

	SpriteID pal;

    80

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

    81

	int32 x;

    82

	int32 y;

    84

};

    85

    86

struct ParentSpriteToDraw {

    87

	SpriteID image;                 ///< sprite to draw

    88

	SpriteID pal;                   ///< palette to use

    89

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

    90

    91

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

    92

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

    93

    94

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

    95

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

    96

    97

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

    98

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

    99

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

   100

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

   101

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

   102

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

   103

   104

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

   105

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

   106

};

   107

   108

/* Enumeration of multi-part foundations */

   109

enum FoundationPart {

   110

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

   111

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

   112

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

   113

	FOUNDATION_PART_END

   114

};

   115

   116

typedef SmallVector<TileSpriteToDraw, 64> TileSpriteToDrawVector;

   117

typedef SmallVector<StringSpriteToDraw, 4> StringSpriteToDrawVector;

   118

typedef SmallVector<ParentSpriteToDraw, 64> ParentSpriteToDrawVector;

   119

typedef SmallVector<ParentSpriteToDraw*, 64> ParentSpriteToSortVector;

   120

typedef SmallVector<ChildScreenSpriteToDraw, 16> ChildScreenSpriteToDrawVector;

   121

   122

struct ViewportDrawer {

   123

	DrawPixelInfo dpi;

   124

   125

	StringSpriteToDrawVector string_sprites_to_draw;

   126

	TileSpriteToDrawVector tile_sprites_to_draw;

   127

	ParentSpriteToDrawVector parent_sprites_to_draw;

   128

	ParentSpriteToSortVector parent_sprites_to_sort;

   129

	ChildScreenSpriteToDrawVector child_screen_sprites_to_draw;

   130

   131

	int *last_child;

   132

   133

	byte combine_sprites;

   134

   135

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

   136

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

   137

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

   138

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

   139

};

   140

   141

static ViewportDrawer _vd;

   142

   143

TileHighlightData _thd;

   144

static TileInfo *_cur_ti;

   145

bool _draw_bounding_boxes = false;

   146

   147

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

   148

{

   149

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

   150

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

   151

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

   152

	return p;

   153

}

   154

   155

void DeleteWindowViewport(Window *w)

   156

{

   157

	free(w->viewport);

   158

	w->viewport = NULL;

   159

}

   160

   161

/**

   162

 * Initialize viewport of the window for use.

   163

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

   164

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

   165

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

   166

 * @param width Width of the viewport

   167

 * @param height Height of the viewport

   168

 * @param follow_flags Flags controlling the viewport.

   169

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

   170

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

   171

 * @param zoom Zoomlevel to display

   172

 */

   173

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

   174

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

   175

{

   176

	assert(w->viewport == NULL);

   177

   178

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

   179

   180

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

   181

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

   182

	vp->width = width;

   183

	vp->height = height;

   184

   185

	vp->zoom = zoom;

   186

   187

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

   188

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

   189

   190

	Point pt;

   191

   192

	if (follow_flags & 0x80000000) {

   193

		const Vehicle *veh;

   194

   195

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

   196

		veh = GetVehicle(vp->follow_vehicle);

   197

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

   198

	} else {

   199

		uint x = TileX(follow_flags) * TILE_SIZE;

   200

		uint y = TileY(follow_flags) * TILE_SIZE;

   201

   202

		vp->follow_vehicle = INVALID_VEHICLE;

   203

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

   204

	}

   205

   206

	vp->scrollpos_x = pt.x;

   207

	vp->scrollpos_y = pt.y;

   208

	vp->dest_scrollpos_x = pt.x;

   209

	vp->dest_scrollpos_y = pt.y;

   210

   211

	w->viewport = vp;

   212

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

   213

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

   214

}

   215

   216

static Point _vp_move_offs;

   217

   218

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

   219

{

   220

   221

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

   222

		const Window *w = *wz;

   223

   224

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

   225

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

   226

				top + height > w->top &&

   227

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

   228

   229

			if (left < w->left) {

   230

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

   231

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

   232

				return;

   233

			}

   234

   235

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

   236

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

   237

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

   238

				return;

   239

			}

   240

   241

			if (top < w->top) {

   242

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

   243

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

   244

				return;

   245

			}

   246

   247

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

   248

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

   249

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

   250

				return;

   251

			}

   252

   253

			return;

   254

		}

   255

	}

   256

   257

	{

   258

		int xo = _vp_move_offs.x;

   259

		int yo = _vp_move_offs.y;

   260

   261

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

   262

			/* fully_outside */

   263

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

   264

			return;

   265

		}

   266

   267

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

   268

   269

		if (xo > 0) {

   270

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

   271

			left += xo;

   272

			width -= xo;

   273

		} else if (xo < 0) {

   274

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

   275

			width += xo;

   276

		}

   277

   278

		if (yo > 0) {

   279

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

   280

		} else if (yo < 0) {

   281

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

   282

		}

   283

	}

   284

}

   285

   286

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

   287

{

   288

	ViewPort *vp = w->viewport;

   289

	int old_left = vp->virtual_left;

   290

	int old_top = vp->virtual_top;

   291

	int i;

   292

	int left, top, width, height;

   293

   294

	vp->virtual_left = x;

   295

	vp->virtual_top = y;

   296

   297

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

   298

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

   299

	 */

   300

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

   301

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

   302

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

   303

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

   304

   305

	old_left -= x;

   306

	old_top -= y;

   307

   308

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

   309

   310

	_vp_move_offs.x = old_left;

   311

	_vp_move_offs.y = old_top;

   312

   313

	left = vp->left;

   314

	top = vp->top;

   315

	width = vp->width;

   316

	height = vp->height;

   317

   318

	if (left < 0) {

   319

		width += left;

   320

		left = 0;

   321

	}

   322

   323

	i = left + width - _screen.width;

   324

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

   325

   326

	if (width > 0) {

   327

		if (top < 0) {

   328

			height += top;

   329

			top = 0;

   330

		}

   331

   332

		i = top + height - _screen.height;

   333

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

   334

   335

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

   336

	}

   337

}

   338

   339

/**

   340

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

   341

 * @param w Window to examine its viewport

   342

 * @param x X coordinate of the xy position

   343

 * @param y Y coordinate of the xy position

   344

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

   345

 *         otherwise \c NULL is returned.

   346

 */

   347

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

   348

{

   349

	ViewPort *vp = w->viewport;

   350

   351

	if (vp != NULL &&

   352

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

   353

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

   354

		return vp;

   355

   356

	return NULL;

   357

}

   358

   359

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

   360

{

   361

	Point pt;

   362

	int a,b;

   363

	uint z;

   364

   365

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

   366

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

   367

				Point pt = {-1, -1};

   368

				return pt;

   369

	}

   370

   371

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

   372

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

   373

   374

	a = y-x;

   375

	b = y+x;

   376

   377

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

   378

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

   379

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

   380

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

   381

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

   382

   383

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

   384

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

   385

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

   386

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

   387

	 * (FOUNDATION_HALFTILE_LOWER on SLOPE_STEEP_S hides north halftile completely)

   388

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

   389

	 */

   390

	z = 0;

   391

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

   392

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

   393

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

   394

   395

	pt.x = a + z;

   396

	pt.y = b + z;

   397

   398

	return pt;

   399

}

   400

   401

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

   402

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

   403

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

   404

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

   405

{

   406

	Window *w;

   407

	ViewPort *vp;

   408

	Point pt;

   409

   410

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

   411

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

   412

				return TranslateXYToTileCoord(vp, zoom_x, zoom_y);

   413

   414

	pt.y = pt.x = -1;

   415

	return pt;

   416

}

   417

   418

Point GetTileBelowCursor()

   419

{

   420

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

   421

}

   422

   423

   424

Point GetTileZoomCenterWindow(bool in, Window * w)

   425

{

   426

	int x, y;

   427

	ViewPort *vp = w->viewport;

   428

   429

	if (in) {

   430

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

   431

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

   432

	} else {

   433

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

   434

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

   435

	}

   436

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

   437

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

   438

}

   439

   440

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

   441

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

   442

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

   443

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

   444

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

   445

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

   446

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

   447

{

   448

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

   449

	w->InvalidateWidget(widget_zoom_in);

   450

   451

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

   452

	w->InvalidateWidget(widget_zoom_out);

   453

}

   454

   455

/**

   456

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

   457

 *

   458

 * @param image the image to draw.

   459

 * @param pal the provided palette.

   460

 * @param x position x of the sprite.

   461

 * @param y position y of the sprite.

   462

 * @param z position z of the sprite.

   463

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

   464

 *

   465

 */

   466

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

   467

{

   468

	assert((image & SPRITE_MASK) < MAX_SPRITES);

   469

   470

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

   471

	ts->image = image;

   472

	ts->pal = pal;

   473

	ts->sub = sub;

   474

	ts->x = x;

   475

	ts->y = y;

   476

	ts->z = z;

   477

}

   478

   479

/**

   480

 * Adds a child sprite to the active foundation.

   481

 *

   482

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

   483

 *

   484

 * @param image the image to draw.

   485

 * @param pal the provided palette.

   486

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

   487

 * @param foundation_part Foundation part.

   488

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

   489

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

   490

 */

   491

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

   492

{

   493

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

   494

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