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"

    14

#include "town.h"

    17

#include "waypoint.h"

    18

#include "variables.h"

    19

#include "train.h"

    20

#include "roadveh.h"

    21

#include "vehicle_gui.h"

    22

#include "blitter/factory.hpp"

    23

#include "newgrf_fsmports.h"

    24

#include "transparency.h"

    25

#include "strings_func.h"

    26

#include "zoom_func.h"

    27

#include "vehicle_func.h"

    28

#include "player_func.h"

    29

#include "settings_type.h"

    32

    33

#include "table/sprites.h"

    34

#include "table/strings.h"

    35

    40

    41

PlaceProc *_place_proc;

    42

Point _tile_fract_coords;

    43

ZoomLevel _saved_scrollpos_zoom;

    44

    45

/**

    46

 * The maximum number of viewports depends on the maximum number

    47

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

    48

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

    49

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

    50

 * saves some time and memory.

    51

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

    52

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

    53

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

    54

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

    55

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

    56

 *

    57

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

    58

 * window without viewport.

    59

 */

    60

static ViewPort _viewports[MAX_NUMBER_OF_WINDOWS - 1];

    61

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

    62

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

    63

    64

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

    65

 *                                               *

    66

 *                    ^ Z                        *

    67

 *                    |                          *

    68

 *                    |                          *

    69

 *                    |                          *

    70

 *                    |                          *

    71

 *                 /     \                       *

    72

 *              /           \                    *

    73

 *           /                 \                 *

    74

 *        /                       \              *

    75

 *   X <                             > Y         *

    76

 */

    77

    78

struct StringSpriteToDraw {

    79

	uint16 string;

    80

	uint16 color;

    81

	StringSpriteToDraw *next;

    82

	int32 x;

    83

	int32 y;

    84

	uint64 params[2];

    85

	uint16 width;

    86

};

    87

    88

struct TileSpriteToDraw {

    89

	SpriteID image;

    90

	SpriteID pal;

    91

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

    92

	TileSpriteToDraw *next;

    93

	int32 x;

    94

	int32 y;

    95

	byte z;

    96

};

    97

    98

struct ChildScreenSpriteToDraw {

    99

	SpriteID image;

   100

	SpriteID pal;

   101

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

   102

	int32 x;

   103

	int32 y;

   104

	ChildScreenSpriteToDraw *next;

   105

};

   106

   107

struct ParentSpriteToDraw {

   108

	SpriteID image;                 ///< sprite to draw

   109

	SpriteID pal;                   ///< palette to use

   110

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

   111

   112

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

   113

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

   114

   115

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

   116

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

   117

   118

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

   119

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

   120

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

   121

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

   122

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

   123

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

   124

   125

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

   126

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

   127

};

   128

   129

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

   130

 * to prevent a buffer overflow. */

   131

#define LARGEST_SPRITELIST_STRUCT ParentSpriteToDraw

   132

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

   133

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

   134

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

   135

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

   136

   137

/* Enumeration of multi-part foundations */

   138

enum FoundationPart {

   139

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

   140

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

   141

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

   142

	FOUNDATION_PART_END

   143

};

   144

   145

struct ViewportDrawer {

   146

	DrawPixelInfo dpi;

   147

   148

	byte *spritelist_mem;

   149

	const byte *eof_spritelist_mem;

   150

   151

	StringSpriteToDraw **last_string, *first_string;

   152

	TileSpriteToDraw **last_tile, *first_tile;

   153

   154

	ChildScreenSpriteToDraw **last_child;

   155

   156

	ParentSpriteToDraw **parent_list;

   157

	ParentSpriteToDraw * const *eof_parent_list;

   158

   159

	byte combine_sprites;

   160

   161

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

   162

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

   163

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

   164

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

   165

};

   166

   167

static ViewportDrawer *_cur_vd;

   168

   169

TileHighlightData _thd;

   170

static TileInfo *_cur_ti;

   171

   172

extern void SmallMapCenterOnCurrentPos(Window *w);

   173

   174

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

   175

{

   176

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

   177

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

   178

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

   179

	return p;

   180

}

   181

   182

void InitViewports()

   183

{

   184

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

   185

	_active_viewports = 0;

   186

}

   187

   188

void DeleteWindowViewport(Window *w)

   189

{

   190

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

   191

	w->viewport->width = 0;

   192

	w->viewport = NULL;

   193

}

   194

   195

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

   196

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

   197

{

   198

	ViewPort *vp;

   199

	Point pt;

   200

	uint32 bit;

   201

   202

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

   203

		assert(vp != endof(_viewports));

   204

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

   205

	}

   206

	SetBit(_active_viewports, bit);

   207

   208

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

   209

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

   210

	vp->width = width;

   211

	vp->height = height;

   212

   213

	vp->zoom = zoom;

   214

   215

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

   216

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

   217

   218

	if (follow_flags & 0x80000000) {

   219

		const Vehicle *veh;

   220

   221

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

   222

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

   223

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

   224

	} else {

   225

		uint x = TileX(follow_flags) * TILE_SIZE;

   226

		uint y = TileY(follow_flags) * TILE_SIZE;

   227

   228

		WP(w, vp_d).follow_vehicle = INVALID_VEHICLE;

   229

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

   230

	}

   231

   232

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

   233

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

   234

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

   235

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

   236

   237

	w->viewport = vp;

   238

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

   239

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

   240

}

   241

   242

static Point _vp_move_offs;

   243

   244

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

   245

{

   246

   247

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

   248

		const Window *w = *wz;

   249

   250

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

   251

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

   252

				top + height > w->top &&

   253

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

   254

   255

			if (left < w->left) {

   256

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

   257

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

   258

				return;

   259

			}

   260

   261

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

   262

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

   263

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

   264

				return;

   265

			}

   266

   267

			if (top < w->top) {

   268

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

   269

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

   270

				return;

   271

			}

   272

   273

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

   274

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

   275

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

   276

				return;

   277

			}

   278

   279

			return;

   280

		}

   281

	}

   282

   283

	{

   284

		int xo = _vp_move_offs.x;

   285

		int yo = _vp_move_offs.y;

   286

   287

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

   288

			/* fully_outside */

   289

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

   290

			return;

   291

		}

   292

   293

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

   294

   295

		if (xo > 0) {

   296

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

   297

			left += xo;

   298

			width -= xo;

   299

		} else if (xo < 0) {

   300

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

   301

			width += xo;

   302

		}

   303

   304

		if (yo > 0) {

   305

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

   306

		} else if (yo < 0) {

   307

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

   308

		}

   309

	}

   310

}

   311

   312

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

   313

{

   314

	ViewPort *vp = w->viewport;

   315

	int old_left = vp->virtual_left;

   316

	int old_top = vp->virtual_top;

   317

	int i;

   318

	int left, top, width, height;

   319

   320

	vp->virtual_left = x;

   321

	vp->virtual_top = y;

   322

   323

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

   324

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

   325

	 */

   326

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

   327

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

   328

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

   329

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

   330

   331

	old_left -= x;

   332

	old_top -= y;

   333

   334

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

   335

   336

	_vp_move_offs.x = old_left;

   337

	_vp_move_offs.y = old_top;

   338

   339

	left = vp->left;

   340

	top = vp->top;

   341

	width = vp->width;

   342

	height = vp->height;

   343

   344

	if (left < 0) {

   345

		width += left;

   346

		left = 0;

   347

	}

   348

   349

	i = left + width - _screen.width;

   350

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

   351

   352

	if (width > 0) {

   353

		if (top < 0) {

   354

			height += top;

   355

			top = 0;

   356

		}

   357

   358

		i = top + height - _screen.height;

   359

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

   360

   361

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

   362

	}

   363

}

   364

   365

   366

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

   367

{

   368

	ViewPort *vp = w->viewport;

   369

   370

	if (vp != NULL &&

   371

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

   372

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

   373

		return vp;

   374

   375

	return NULL;

   376

}

   377

   378

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

   379

{

   380

	Point pt;

   381

	int a,b;

   382

	uint z;

   383

   384

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

   385

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

   386

				Point pt = {-1, -1};

   387

				return pt;

   388

	}

   389

   390

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

   391

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

   392

   393

	a = y-x;

   394

	b = y+x;

   395

   396

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

   397

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

   398

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

   399

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

   400

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

   401

   402

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

   403

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

   404

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

   405

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

   406

	 * (FOUNDATION_HALFTILE_LOWER on SLOPE_STEEP_S hides north halftile completely)

   407

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

   408

	 */

   409

	z = 0;

   410

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

   411

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

   412

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

   413

   414

	pt.x = a + z;

   415

	pt.y = b + z;

   416

   417

	return pt;

   418

}

   419

   420

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

   421

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

   422

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

   423

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

   424

{

   425

	Window *w;

   426

	ViewPort *vp;

   427

	Point pt;

   428

   429

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

   430

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

   431

				return TranslateXYToTileCoord(vp, zoom_x, zoom_y);

   432

   433

	pt.y = pt.x = -1;

   434

	return pt;

   435

}

   436

   437

Point GetTileBelowCursor()

   438

{

   439

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

   440

}

   441

   442

   443

Point GetTileZoomCenterWindow(bool in, Window * w)

   444

{

   445

	int x, y;

   446

	ViewPort * vp;

   447

   448

	vp = w->viewport;

   449

   450

	if (in) {

   451

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

   452

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

   453

	} else {

   454

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

   455

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

   456

	}

   457

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

   458

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

   459

}

   460

   461

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

   462

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

   463

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

   464

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

   465

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

   466

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

   467

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

   468

{

   469

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

   470

	w->InvalidateWidget(widget_zoom_in);

   471

   472

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

   473

	w->InvalidateWidget(widget_zoom_out);

   474

}

   475

   476

/**

   477

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

   478

 *

   479

 * @param image the image to draw.

   480

 * @param pal the provided palette.

   481

 * @param x position x of the sprite.

   482

 * @param y position y of the sprite.

   483

 * @param z position z of the sprite.

   484

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

   485

 *

   486

 */

   487

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

   488

{

   489

	ViewportDrawer *vd = _cur_vd;

   490

	TileSpriteToDraw *ts;

   491

   492

	assert((image & SPRITE_MASK) < MAX_SPRITES);

   493

   494

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

   495

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

   496

		return;

   497

	}