1

/* $Id$ */

     2

     3

/** @file viewport.cpp */

     4

     5

#include "stdafx.h"

     6

#include "openttd.h"

     7

#include "debug.h"

     8

#include "tile_cmd.h"

     9

#include "gui.h"

    10

#include "spritecache.h"

    11

#include "landscape.h"

    12

#include "viewport_func.h"

    13

#include "station.h"

    14

#include "town.h"

    15

#include "signs.h"

    16

#include "waypoint.h"

    17

#include "variables.h"

    18

#include "train.h"

    19

#include "roadveh.h"

    20

#include "vehicle_gui.h"

    21

#include "blitter/factory.hpp"

    22

#include "newgrf_fsmports.h"

    23

#include "transparency.h"

    24

#include "strings_func.h"

    25

#include "zoom_func.h"

    26

#include "vehicle_func.h"

    27

#include "player_func.h"

    28

#include "settings_type.h"

    29

    30

#include "table/sprites.h"

    31

#include "table/strings.h"

    32

    33

#define VIEWPORT_DRAW_MEM (65536 * 2)

    34

    35

PlaceProc *_place_proc;

    36

Point _tile_fract_coords;

    37

ZoomLevel _saved_scrollpos_zoom;

    38

    39

/**

    40

 * The maximum number of viewports depends on the maximum number

    41

 * of windows. Technically is could be the maximum number of

    42

 * windows, but there is always at least one window that does

    43

 * not need a viewport. Not having 'support' for that viewport

    44

 * saves some time and memory.

    45

 * For the introduction GUI and create game GUIs there is no

    46

 * need for more than one viewport, however in the normal game

    47

 * and scenario editor one can make a lot of viewports. For the

    48

 * normal game one always has a main toolbar and a status bar,

    49

 * however the statusbar does not exist on the scenario editor.

    50

 *

    51

 * This means that we can only safely assume that there is one

    52

 * window without viewport.

    53

 */

    54

static ViewPort _viewports[MAX_NUMBER_OF_WINDOWS - 1];

    55

static uint32 _active_viewports;    ///< bitmasked variable where each bit signifies if a viewport is in use or not

    56

assert_compile(lengthof(_viewports) < sizeof(_active_viewports) * 8);

    57

    58

/* The in-game coordiante system looks like this *

    59

 *                                               *

    60

 *                    ^ Z                        *

    61

 *                    |                          *

    62

 *                    |                          *

    63

 *                    |                          *

    64

 *                    |                          *

    65

 *                 /     \                       *

    66

 *              /           \                    *

    67

 *           /                 \                 *

    68

 *        /                       \              *

    69

 *   X <                             > Y         *

    70

 */

    71

    72

struct StringSpriteToDraw {

    73

	uint16 string;

    74

	uint16 color;

    75

	StringSpriteToDraw *next;

    76

	int32 x;

    77

	int32 y;

    78

	uint64 params[2];

    79

	uint16 width;

    80

};

    81

    82

struct TileSpriteToDraw {

    83

	SpriteID image;

    84

	SpriteID pal;

    85

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

    86

	TileSpriteToDraw *next;

    87

	int32 x;

    88

	int32 y;

    89

	byte z;

    90

};

    91

    92

struct ChildScreenSpriteToDraw {

    93

	SpriteID image;

    94

	SpriteID pal;

    95

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

    96

	int32 x;

    97

	int32 y;

    98

	ChildScreenSpriteToDraw *next;

    99

};

   100

   101

struct ParentSpriteToDraw {

   102

	SpriteID image;                 ///< sprite to draw

   103

	SpriteID pal;                   ///< palette to use

   104

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

   105

   106

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

   107

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

   108

   109

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

   110

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

   111

   112

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

   113

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

   114

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

   115

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

   116

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

   117

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

   118

   119

	ChildScreenSpriteToDraw *child; ///< head of child list;

   120

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

   121

};

   122

   123

/* Quick hack to know how much memory to reserve when allocating from the spritelist

   124

 * to prevent a buffer overflow. */

   125

#define LARGEST_SPRITELIST_STRUCT ParentSpriteToDraw

   126

assert_compile(sizeof(LARGEST_SPRITELIST_STRUCT) >= sizeof(StringSpriteToDraw));

   127

assert_compile(sizeof(LARGEST_SPRITELIST_STRUCT) >= sizeof(TileSpriteToDraw));

   128

assert_compile(sizeof(LARGEST_SPRITELIST_STRUCT) >= sizeof(ChildScreenSpriteToDraw));

   129

assert_compile(sizeof(LARGEST_SPRITELIST_STRUCT) >= sizeof(ParentSpriteToDraw));

   130

   131

/* Enumeration of multi-part foundations */

   132

enum FoundationPart {

   133

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

   134

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

   135

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

   136

	FOUNDATION_PART_END

   137

};

   138

   139

struct ViewportDrawer {

   140

	DrawPixelInfo dpi;

   141

   142

	byte *spritelist_mem;

   143

	const byte *eof_spritelist_mem;

   144

   145

	StringSpriteToDraw **last_string, *first_string;

   146

	TileSpriteToDraw **last_tile, *first_tile;

   147

   148

	ChildScreenSpriteToDraw **last_child;

   149

   150

	ParentSpriteToDraw **parent_list;

   151

	ParentSpriteToDraw * const *eof_parent_list;

   152

   153

	byte combine_sprites;

   154

   155

	ParentSpriteToDraw *foundation[FOUNDATION_PART_END];                   ///< Foundation sprites.

   156

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

   157

	ChildScreenSpriteToDraw **last_foundation_child[FOUNDATION_PART_END];  ///< Tail of ChildSprite list of the foundations.

   158

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

   159

};

   160

   161

static ViewportDrawer *_cur_vd;

   162

   163

TileHighlightData _thd;

   164

static TileInfo *_cur_ti;

   165

   166

extern void SmallMapCenterOnCurrentPos(Window *w);

   167

   168

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

   169

{

   170

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

   171

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

   172

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

   173

	return p;

   174

}

   175

   176

void InitViewports()

   177

{

   178

	memset(_viewports, 0, sizeof(_viewports));

   179

	_active_viewports = 0;

   180

}

   181

   182

void DeleteWindowViewport(Window *w)

   183

{

   184

	ClrBit(_active_viewports, w->viewport - _viewports);

   185

	w->viewport->width = 0;

   186

	w->viewport = NULL;

   187

}

   188

   189

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

   190

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

   191

{

   192

	ViewPort *vp;

   193

	Point pt;

   194

	uint32 bit;

   195

   196

	for (vp = _viewports, bit = 0; ; vp++, bit++) {

   197

		assert(vp != endof(_viewports));

   198

		if (vp->width == 0) break;

   199

	}

   200

	SetBit(_active_viewports, bit);

   201

   202

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

   203

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

   204

	vp->width = width;

   205

	vp->height = height;

   206

   207

	vp->zoom = zoom;

   208

   209

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

   210

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

   211

   212

	if (follow_flags & 0x80000000) {

   213

		const Vehicle *veh;

   214

   215

		WP(w, vp_d).follow_vehicle = (VehicleID)(follow_flags & 0xFFFF);

   216

		veh = GetVehicle(WP(w, vp_d).follow_vehicle);

   217

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

   218

	} else {

   219

		uint x = TileX(follow_flags) * TILE_SIZE;

   220

		uint y = TileY(follow_flags) * TILE_SIZE;

   221

   222

		WP(w, vp_d).follow_vehicle = INVALID_VEHICLE;

   223

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

   224

	}

   225

   226

	WP(w, vp_d).scrollpos_x = pt.x;

   227

	WP(w, vp_d).scrollpos_y = pt.y;

   228

	WP(w, vp_d).dest_scrollpos_x = pt.x;

   229

	WP(w, vp_d).dest_scrollpos_y = pt.y;

   230

   231

	w->viewport = vp;

   232

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

   233

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

   234

}

   235

   236

static Point _vp_move_offs;

   237

   238

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

   239

{

   240

   241

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

   242

		const Window *w = *wz;

   243

   244

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

   245

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

   246

				top + height > w->top &&

   247

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

   248

   249

			if (left < w->left) {

   250

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

   251

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

   252

				return;

   253

			}

   254

   255

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

   256

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

   257

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

   258

				return;

   259

			}

   260

   261

			if (top < w->top) {

   262

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

   263

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

   264

				return;

   265

			}

   266

   267

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

   268

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

   269

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

   270

				return;

   271

			}

   272

   273

			return;

   274

		}

   275

	}

   276

   277

	{

   278

		int xo = _vp_move_offs.x;

   279

		int yo = _vp_move_offs.y;

   280

   281

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

   282

			/* fully_outside */

   283

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

   284

			return;

   285

		}

   286

   287

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

   288

   289

		if (xo > 0) {

   290

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

   291

			left += xo;

   292

			width -= xo;

   293

		} else if (xo < 0) {

   294

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

   295

			width += xo;

   296

		}

   297

   298

		if (yo > 0) {

   299

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

   300

		} else if (yo < 0) {

   301

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

   302

		}

   303

	}

   304

}

   305

   306

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

   307

{

   308

	ViewPort *vp = w->viewport;

   309

	int old_left = vp->virtual_left;

   310

	int old_top = vp->virtual_top;

   311

	int i;

   312

	int left, top, width, height;

   313

   314

	vp->virtual_left = x;

   315

	vp->virtual_top = y;

   316

   317

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

   318

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

   319

	 */

   320

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

   321

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

   322

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

   323

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

   324

   325

	old_left -= x;

   326

	old_top -= y;

   327

   328

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

   329

   330

	_vp_move_offs.x = old_left;

   331

	_vp_move_offs.y = old_top;

   332

   333

	left = vp->left;

   334

	top = vp->top;

   335

	width = vp->width;

   336

	height = vp->height;

   337

   338

	if (left < 0) {

   339

		width += left;

   340

		left = 0;

   341

	}

   342

   343

	i = left + width - _screen.width;

   344

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

   345

   346

	if (width > 0) {

   347

		if (top < 0) {

   348

			height += top;

   349

			top = 0;

   350

		}

   351

   352

		i = top + height - _screen.height;

   353

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

   354

   355

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

   356

	}

   357

}

   358

   359

   360

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

   361

{

   362

	ViewPort *vp = w->viewport;

   363

   364

	if (vp != NULL &&

   366

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

   367

		return vp;

   368

   369

	return NULL;

   370

}

   371

   372

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

   373

{

   374

	Point pt;

   375

	int a,b;

   376

	uint z;

   377

   378

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

   379

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

   380

				Point pt = {-1, -1};

   381

				return pt;

   382

	}

   383

   384

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

   385

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

   386

   387

	a = y-x;

   388

	b = y+x;

   389

   390

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

   391

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

   392

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

   393

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

   394

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

   395

   396

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

   397

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

   398

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

   399

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

   400

	 * (FOUNDATION_HALFTILE_LOWER on SLOPE_STEEP_S hides north halftile completely)

   401

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

   402

	 */

   403

	z = 0;

   404

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

   405

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

   406

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

   407

   408

	pt.x = a + z;

   409

	pt.y = b + z;

   410

   411

	return pt;

   412

}

   413

   414

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

   415

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

   416

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

   417

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

   418

{

   419

	Window *w;

   420

	ViewPort *vp;

   421

	Point pt;

   422

   423

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

   424

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

   425

				return TranslateXYToTileCoord(vp, zoom_x, zoom_y);

   426

   427

	pt.y = pt.x = -1;

   428

	return pt;

   429

}

   430

   431

Point GetTileBelowCursor()

   432

{

   433

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

   434

}

   435

   436

   437

Point GetTileZoomCenterWindow(bool in, Window * w)

   438

{

   439

	int x, y;

   440

	ViewPort * vp;

   441

   442

	vp = w->viewport;

   443

   444

	if (in) {

   445

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

   446

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

   447

	} else {

   448

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

   449

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

   450

	}

   451

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

   452

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

   453

}

   454

   455

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

   456

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

   457

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

   458

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

   459

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

   460

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

   461

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

   462

{

   463

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

   464

	w->InvalidateWidget(widget_zoom_in);

   465

   466

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

   467

	w->InvalidateWidget(widget_zoom_out);

   468

}

   469

   470

/**

   471

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

   472

 *

   473

 * @param image the image to draw.

   474

 * @param pal the provided palette.

   475

 * @param x position x of the sprite.

   476

 * @param y position y of the sprite.

   477

 * @param z position z of the sprite.

   478

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

   479

 *

   480

 */

   481

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

   482

{

   483

	ViewportDrawer *vd = _cur_vd;

   484

	TileSpriteToDraw *ts;

   485

   486

	assert((image & SPRITE_MASK) < MAX_SPRITES);

   487

   488

	if (vd->spritelist_mem >= vd->eof_spritelist_mem) {

   489

		DEBUG(sprite, 0, "Out of sprite memory");

   490

		return;

   491

	}

   492

	ts = (TileSpriteToDraw*)vd->spritelist_mem;

   493

   494

	vd->spritelist_mem += sizeof(TileSpriteToDraw);

   495

   496

	ts->image = image;

   497

	ts->pal = pal;