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

    44

#include "settings_type.h"

    45

#include "station_func.h"

    46

#include "core/alloc_type.hpp"

    47

#include "core/smallvec_type.hpp"

    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;

    83

	int next;                       ///< next child to draw (-1 at the end)

    84

};

    85

    86

/** Parent sprite that should be drawn */

    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

/** Data structure storing rendering information */

   124

struct ViewportDrawer {

   125

	DrawPixelInfo dpi;

   126

   127

	StringSpriteToDrawVector string_sprites_to_draw;

   128

	TileSpriteToDrawVector tile_sprites_to_draw;

   129

	ParentSpriteToDrawVector parent_sprites_to_draw;

   130

	ParentSpriteToSortVector parent_sprites_to_sort; ///< Parent sprite pointer array used for sorting

   131

	ChildScreenSpriteToDrawVector child_screen_sprites_to_draw;

   132

   133

	int *last_child;

   134

   135

	byte combine_sprites;

   136

   137

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

   138

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

   139

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

   140

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

   141

};

   142

   143

static ViewportDrawer _vd;

   144

   145

TileHighlightData _thd;

   146

static TileInfo *_cur_ti;

   147

bool _draw_bounding_boxes = false;

   148

   149

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

   150

{

   151

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

   152

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

   153

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

   154

	return p;

   155

}

   156

   157

void DeleteWindowViewport(Window *w)

   158

{

   159

	free(w->viewport);

   160

	w->viewport = NULL;

   161

}

   162

   163

/**

   164

 * Initialize viewport of the window for use.

   165

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

   166

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

   167

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

   168

 * @param width Width of the viewport

   169

 * @param height Height of the viewport

   170

 * @param follow_flags Flags controlling the viewport.

   171

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

   172

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

   173

 * @param zoom Zoomlevel to display

   174

 */

   175

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

   176

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

   177

{

   178

	assert(w->viewport == NULL);

   179

   180

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

   181

   182

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

   183

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

   184

	vp->width = width;

   185

	vp->height = height;

   186

   187

	vp->zoom = zoom;

   188

   189

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

   190

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

   191

   192

	Point pt;

   193

   194

	if (follow_flags & 0x80000000) {

   195

		const Vehicle *veh;

   196

   197

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

   198

		veh = GetVehicle(vp->follow_vehicle);

   199

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

   200

	} else {

   201

		uint x = TileX(follow_flags) * TILE_SIZE;

   202

		uint y = TileY(follow_flags) * TILE_SIZE;

   203

   204

		vp->follow_vehicle = INVALID_VEHICLE;

   205

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

   206

	}

   207

   208

	vp->scrollpos_x = pt.x;

   209

	vp->scrollpos_y = pt.y;

   210

	vp->dest_scrollpos_x = pt.x;

   211

	vp->dest_scrollpos_y = pt.y;

   212

   213

	w->viewport = vp;

   214

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

   215

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

   216

}

   217

   218

static Point _vp_move_offs;

   219

   220

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

   221

{

   222

   223

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

   224

		const Window *w = *wz;

   225

   226

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

   227

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

   228

				top + height > w->top &&

   229

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

   230

   231

			if (left < w->left) {

   232

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

   233

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

   234

				return;

   235

			}

   236

   237

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

   238

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

   239

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

   240

				return;

   241

			}

   242

   243

			if (top < w->top) {

   244

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

   245

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

   246

				return;

   247

			}

   248

   249

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

   250

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

   251

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

   252

				return;

   253

			}

   254

   255

			return;

   256

		}

   257

	}

   258

   259

	{

   260

		int xo = _vp_move_offs.x;

   261

		int yo = _vp_move_offs.y;

   262

   263

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

   264

			/* fully_outside */

   265

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

   266

			return;

   267

		}

   268

   269

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

   270

   271

		if (xo > 0) {

   272

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

   273

			left += xo;

   274

			width -= xo;

   275

		} else if (xo < 0) {

   276

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

   277

			width += xo;

   278

		}

   279

   280

		if (yo > 0) {

   281

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

   282

		} else if (yo < 0) {

   283

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

   284

		}

   285

	}

   286

}

   287

   288

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

   289

{

   290

	ViewPort *vp = w->viewport;

   291

	int old_left = vp->virtual_left;

   292

	int old_top = vp->virtual_top;

   293

	int i;

   294

	int left, top, width, height;

   295

   296

	vp->virtual_left = x;

   297

	vp->virtual_top = y;

   298

   299

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

   300

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

   301

	 */

   302

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

   303

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

   304

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

   305

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

   306

   307

	old_left -= x;

   308

	old_top -= y;

   309

   310

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

   311

   312

	_vp_move_offs.x = old_left;

   313

	_vp_move_offs.y = old_top;

   314

   315

	left = vp->left;

   316

	top = vp->top;

   317

	width = vp->width;

   318

	height = vp->height;

   319

   320

	if (left < 0) {

   321

		width += left;

   322

		left = 0;

   323

	}

   324

   325

	i = left + width - _screen.width;

   326

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

   327

   328

	if (width > 0) {

   329

		if (top < 0) {

   330

			height += top;

   331

			top = 0;

   332

		}

   333

   334

		i = top + height - _screen.height;

   335

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

   336

   337

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

   338

	}

   339

}

   340

   341

/**

   342

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

   343

 * @param w Window to examine its viewport

   344

 * @param x X coordinate of the xy position

   345

 * @param y Y coordinate of the xy position

   346

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

   347

 *         otherwise \c NULL is returned.

   348

 */

   349

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

   350

{

   351

	ViewPort *vp = w->viewport;

   352

   353

	if (vp != NULL &&

   354

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

   355

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

   356

		return vp;

   357

   358

	return NULL;

   359

}

   360

   361

/**

   362

 * Translate screen coordinate in a viewport to a tile coordinate

   363

 * @param vp  Viewport that contains the (\a x, \a y) screen coordinate

   364

 * @param x   Screen x coordinate

   365

 * @param y   Screen y coordinate

   366

 * @return Tile coordinate */

   367

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

   368

{

   369

	Point pt;

   370

	int a,b;

   371

	uint z;

   372

   373

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

   374

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

   375

				Point pt = {-1, -1};

   376

				return pt;

   377

	}

   378

   379

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

   380

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

   381

   382

	a = y-x;

   383

	b = y+x;

   384

   385

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

   386

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

   387

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

   388

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

   389

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

   390

   391

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

   392

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

   393

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

   394

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

   395

	 * (FOUNDATION_HALFTILE_LOWER on SLOPE_STEEP_S hides north halftile completely)

   396

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

   397

	 */

   398

	z = 0;

   399

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

   400

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

   401

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

   402

   403

	pt.x = a + z;

   404

	pt.y = b + z;

   405

   406

	return pt;

   407

}

   408

   409

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

   410

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

   411

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

   412

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

   413

{

   414

	Window *w;

   415

	ViewPort *vp;

   416

	Point pt;

   417

   418

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

   419

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

   420

				return TranslateXYToTileCoord(vp, zoom_x, zoom_y);

   421

   422

	pt.y = pt.x = -1;

   423

	return pt;

   424

}

   425

   426

Point GetTileBelowCursor()

   427

{

   428

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

   429

}

   430

   431

   432

Point GetTileZoomCenterWindow(bool in, Window * w)

   433

{

   434

	int x, y;

   435

	ViewPort *vp = w->viewport;

   436

   437

	if (in) {

   438

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

   439

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

   440

	} else {

   441

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

   442

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

   443

	}

   444

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

   445

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

   446

}

   447

   448

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

   449

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

   450

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

   451

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

   452

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

   453

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

   454

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

   455

{

   456

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

   457

	w->InvalidateWidget(widget_zoom_in);

   458

   459

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

   460

	w->InvalidateWidget(widget_zoom_out);

   461

}

   462

   463

/**

   464

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

   465

 *

   466

 * @param image the image to draw.

   467

 * @param pal the provided palette.

   468

 * @param x position x of the sprite.

   469

 * @param y position y of the sprite.

   470

 * @param z position z of the sprite.

   471

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

   472

 *

   473

 */

   474

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

   475

{

   476

	assert((image & SPRITE_MASK) < MAX_SPRITES);

   477

   478

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

   479

	ts->image = image;

   480

	ts->pal = pal;

   481

	ts->sub = sub;

   482

	ts->x = x;

   483

	ts->y = y;

   484

	ts->z = z;

   485

}

   486

   487

/**

   488

 * Adds a child sprite to the active foundation.

   489

 *

   490

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

   491

 *

   492

 * @param image the image to draw.

   493

 * @param pal the provided palette.

   494

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