1

/* $Id$ */

     2

     3

/** @file viewport.cpp */

     4

     5

#include "stdafx.h"

     6

#include "openttd.h"

     7

#include "debug.h"

     8

#include "functions.h"

     9

#include "gui.h"

    10

#include "spritecache.h"

    11

#include "strings.h"

    12

#include "table/sprites.h"

    13

#include "table/strings.h"

    14

#include "landscape.h"

    15

#include "map.h"

    16

#include "viewport.h"

    17

#include "window.h"

    18

#include "vehicle.h"

    19

#include "station.h"

    20

#include "gfx.h"

    21

#include "town.h"

    22

#include "signs.h"

    23

#include "waypoint.h"

    24

#include "variables.h"

    25

#include "train.h"

    26

#include "roadveh.h"

    27

#include "vehicle_gui.h"

    28

#include "blitter/factory.hpp"

    29

#include "transparency.h"

    30

    31

#define VIEWPORT_DRAW_MEM (65536 * 2)

    32

    33

ZoomLevel _saved_scrollpos_zoom;

    34

    35

/**

    36

 * The maximum number of viewports depends on the maximum number

    37

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

    38

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

    39

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

    40

 * saves some time and memory.

    41

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

    42

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

    43

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

    44

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

    45

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

    46

 *

    47

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

    48

 * window without viewport.

    49

 */

    50

static ViewPort _viewports[MAX_NUMBER_OF_WINDOWS - 1];

    51

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

    52

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

    53

    54

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

    55

 *                                               *

    56

 *                    ^ Z                        *

    57

 *                    |                          *

    58

 *                    |                          *

    59

 *                    |                          *

    60

 *                    |                          *

    61

 *                 /     \                       *

    62

 *              /           \                    *

    63

 *           /                 \                 *

    64

 *        /                       \              *

    65

 *   X <                             > Y         *

    66

 */

    67

    68

struct StringSpriteToDraw {

    69

	uint16 string;

    70

	uint16 color;

    71

	StringSpriteToDraw *next;

    72

	int32 x;

    73

	int32 y;

    74

	uint64 params[2];

    75

	uint16 width;

    76

};

    77

    78

struct TileSpriteToDraw {

    79

	SpriteID image;

    80

	SpriteID pal;

    81

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

    82

	TileSpriteToDraw *next;

    83

	int32 x;

    84

	int32 y;

    85

	byte z;

    86

};

    87

    88

struct ChildScreenSpriteToDraw {

    89

	SpriteID image;

    90

	SpriteID pal;

    91

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

    92

	int32 x;

    93

	int32 y;

    94

	ChildScreenSpriteToDraw *next;

    95

};

    96

    97

struct ParentSpriteToDraw {

    98

	SpriteID image;                 ///< sprite to draw

    99

	SpriteID pal;                   ///< palette to use

   100

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

   101

   102

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

   103

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

   104

   105

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

   106

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

   107

   108

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

   109

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

   110

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

   111

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

   112

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

   113

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

   114

   115

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

   116

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

   117

};

   118

   119

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

   120

 * to prevent a buffer overflow. */

   121

#define LARGEST_SPRITELIST_STRUCT ParentSpriteToDraw

   122

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

   123

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

   124

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

   125

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

   126

   127

/* Enumeration of multi-part foundations */

   128

enum FoundationPart {

   129

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

   130

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

   131

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

   132

	FOUNDATION_PART_END

   133

};

   134

   135

struct ViewportDrawer {

   136

	DrawPixelInfo dpi;

   137

   138

	byte *spritelist_mem;

   139

	const byte *eof_spritelist_mem;

   140

   141

	StringSpriteToDraw **last_string, *first_string;

   142

	TileSpriteToDraw **last_tile, *first_tile;

   143

   144

	ChildScreenSpriteToDraw **last_child;

   145

   146

	ParentSpriteToDraw **parent_list;

   147

	ParentSpriteToDraw * const *eof_parent_list;

   148

   149

	byte combine_sprites;

   150

   151

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

   152

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

   153

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

   154

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

   155

};

   156

   157

static ViewportDrawer *_cur_vd;

   158

   159

TileHighlightData _thd;

   160

static TileInfo *_cur_ti;

   161

   162

extern void SmallMapCenterOnCurrentPos(Window *w);

   163

   164

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

   165

{

   166

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

   167

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

   168

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

   169

	return p;

   170

}

   171

   172

void InitViewports()

   173

{

   174

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

   175

	_active_viewports = 0;

   176

}

   177

   178

void DeleteWindowViewport(Window *w)

   179

{

   180

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

   181

	w->viewport->width = 0;

   182

	w->viewport = NULL;

   183

}

   184

   185

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

   186

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

   187

{

   188

	ViewPort *vp;

   189

	Point pt;

   190

	uint32 bit;

   191

   192

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

   193

		assert(vp != endof(_viewports));

   194

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

   195

	}

   196

	SetBit(_active_viewports, bit);

   197

   198

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

   199

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

   200

	vp->width = width;

   201

	vp->height = height;

   202

   203

	vp->zoom = zoom;

   204

   205

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

   206

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

   207

   208

	if (follow_flags & 0x80000000) {

   209

		const Vehicle *veh;

   210

   211

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

   212

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

   213

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

   214

	} else {

   215

		uint x = TileX(follow_flags) * TILE_SIZE;

   216

		uint y = TileY(follow_flags) * TILE_SIZE;

   217

   218

		WP(w, vp_d).follow_vehicle = INVALID_VEHICLE;

   219

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

   220

	}

   221

   222

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

   223

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

   224

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

   225

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

   226

   227

	w->viewport = vp;

   228

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

   229

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

   230

}

   231

   232

static Point _vp_move_offs;

   233

   234

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

   235

{

   236

   237

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

   238

		const Window *w = *wz;

   239

   240

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

   241

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

   242

				top + height > w->top &&

   243

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

   244

   245

			if (left < w->left) {

   246

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

   247

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

   248

				return;

   249

			}

   250

   251

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

   252

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

   253

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

   254

				return;

   255

			}

   256

   257

			if (top < w->top) {

   258

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

   259

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

   260

				return;

   261

			}

   262

   263

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

   264

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

   265

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

   266

				return;

   267

			}

   268

   269

			return;

   270

		}

   271

	}

   272

   273

	{

   274

		int xo = _vp_move_offs.x;

   275

		int yo = _vp_move_offs.y;

   276

   277

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

   278

			/* fully_outside */

   279

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

   280

			return;

   281

		}

   282

   283

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

   284

   285

		if (xo > 0) {

   286

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

   287

			left += xo;

   288

			width -= xo;

   289

		} else if (xo < 0) {

   290

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

   291

			width += xo;

   292

		}

   293

   294

		if (yo > 0) {

   295

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

   296

		} else if (yo < 0) {

   297

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

   298

		}

   299

	}

   300

}

   301

   302

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

   303

{

   304

	ViewPort *vp = w->viewport;

   305

	int old_left = vp->virtual_left;

   306

	int old_top = vp->virtual_top;

   307

	int i;

   308

	int left, top, width, height;

   309

   310

	vp->virtual_left = x;

   311

	vp->virtual_top = y;

   312

   313

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

   314

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

   315

	 */

   316

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

   317

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

   318

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

   319

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

   320

   321

	old_left -= x;

   322

	old_top -= y;

   323

   324

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

   325

   326

	_vp_move_offs.x = old_left;

   327

	_vp_move_offs.y = old_top;

   328

   329

	left = vp->left;

   330

	top = vp->top;

   331

	width = vp->width;

   332

	height = vp->height;

   333

   334

	if (left < 0) {

   335

		width += left;

   336

		left = 0;

   337

	}

   338

   339

	i = left + width - _screen.width;

   340

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

   341

   342

	if (width > 0) {

   343

		if (top < 0) {

   344

			height += top;

   345

			top = 0;

   346

		}

   347

   348

		i = top + height - _screen.height;

   349

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

   350

   351

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

   352

	}

   353

}

   354

   355

   356

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

   357

{

   358

	ViewPort *vp = w->viewport;

   359

   360

	if (vp != NULL &&

   361

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

   362

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

   363

		return vp;

   364

   365

	return NULL;

   366

}

   367

   368

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

   369

{

   370

	Point pt;

   371

	int a,b;

   372

	uint z;

   373

   374

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

   375

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

   376

				Point pt = {-1, -1};

   377

				return pt;

   378

	}

   379

   380

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

   381

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

   382

   383

	a = y-x;

   384

	b = y+x;

   385

   386

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

   387

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

   388

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

   389

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

   390

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

   391

   392

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

   393

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

   394

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

   395

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

   396

	 * (FOUNDATION_HALFTILE_LOWER on SLOPE_STEEP_S hides north halftile completely)

   397

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

   398

	 */

   399

	z = 0;

   400

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

   401

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

   402

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

   403

   404

	pt.x = a + z;

   405

	pt.y = b + z;

   406

   407

	return pt;

   408

}

   409

   410

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

   411

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

   412

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

   413

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

   414

{

   415

	Window *w;

   416

	ViewPort *vp;

   417

	Point pt;

   418

   419

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

   420

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

   421

				return TranslateXYToTileCoord(vp, zoom_x, zoom_y);

   422

   423

	pt.y = pt.x = -1;

   424

	return pt;

   425

}

   426

   427

Point GetTileBelowCursor()

   428

{

   429

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

   430

}

   431

   432

   433

Point GetTileZoomCenterWindow(bool in, Window * w)

   434

{

   435

	int x, y;

   436

	ViewPort * vp;

   437

   438

	vp = w->viewport;

   439

   440

	if (in) {

   441

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

   442

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

   443

	} else {

   444

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

   445

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

   446

	}

   447

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

   448

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

   449

}

   450

   451

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

   452

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

   453

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

   454

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

   455

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

   456

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

   457

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

   458

{

   459

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

   460

	w->InvalidateWidget(widget_zoom_in);

   461

   462

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

   463

	w->InvalidateWidget(widget_zoom_out);

   464

}

   465

   466

/**

   467

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

   468

 *

   469

 * @param image the image to draw.

   470

 * @param pal the provided palette.

   471

 * @param x position x of the sprite.

   472

 * @param y position y of the sprite.

   473

 * @param z position z of the sprite.

   474

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

   475

 *

   476

 */

   477

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

   478

{

   479

	ViewportDrawer *vd = _cur_vd;

   480

	TileSpriteToDraw *ts;

   481

   482

	assert((image & SPRITE_MASK) < MAX_SPRITES);

   483

   484

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

   485

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

   486

		return;

   487

	}

   488

	ts = (TileSpriteToDraw*)vd->spritelist_mem;

   489

   490

	vd->spritelist_mem += sizeof(TileSpriteToDraw);

   491

   492

	ts->image = image;

   493

	ts->pal = pal;

   494

	ts->sub = sub;

   495

	ts->next = NULL;

   496

	ts->x = x;

   497

	ts->y = y;