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

    23

#include "strings_func.h"

    24

#include "zoom_func.h"

    25

#include "vehicle_func.h"

    26

#include "player_func.h"

    27

#include "settings_type.h"

    28

    29

#include "table/sprites.h"

    30

#include "table/strings.h"

    31

    32

#define VIEWPORT_DRAW_MEM (65536 * 2)

    33

    34

PlaceProc *_place_proc;

    35

Point _tile_fract_coords;

    36

ZoomLevel _saved_scrollpos_zoom;

    37

    38

/**

    39

 * The maximum number of viewports depends on the maximum number

    40

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

    41

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

    42

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

    43

 * saves some time and memory.

    44

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

    45

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

    46

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

    47

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

    48

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

    49

 *

    50

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

    51

 * window without viewport.

    52

 */

    53

static ViewPort _viewports[MAX_NUMBER_OF_WINDOWS - 1];

    54

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

    55

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

    56

    57

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

    58

 *                                               *

    59

 *                    ^ Z                        *

    60

 *                    |                          *

    61

 *                    |                          *

    62

 *                    |                          *

    63

 *                    |                          *

    64

 *                 /     \                       *

    65

 *              /           \                    *

    66

 *           /                 \                 *

    67

 *        /                       \              *

    68

 *   X <                             > Y         *

    69

 */

    70

    71

struct StringSpriteToDraw {

    72

	uint16 string;

    73

	uint16 color;

    74

	StringSpriteToDraw *next;

    75

	int32 x;

    76

	int32 y;

    77

	uint64 params[2];

    78

	uint16 width;

    79

};

    80

    81

struct TileSpriteToDraw {

    82

	SpriteID image;

    83

	SpriteID pal;

    84

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

    85

	TileSpriteToDraw *next;

    86

	int32 x;

    87

	int32 y;

    88

	byte z;

    89

};

    90

    91

struct ChildScreenSpriteToDraw {

    92

	SpriteID image;

    93

	SpriteID pal;

    94

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

    95

	int32 x;

    96

	int32 y;

    97

	ChildScreenSpriteToDraw *next;

    98

};

    99

   100

struct ParentSpriteToDraw {

   101

	SpriteID image;                 ///< sprite to draw

   102

	SpriteID pal;                   ///< palette to use

   103

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

   104

   105

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

   106

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

   107

   108

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

   109

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

   110

   111

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

   112

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

   113

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

   114

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

   115

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

   116

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

   117

   118

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

   119

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

   120

};

   121

   122

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

   123

 * to prevent a buffer overflow. */

   124

#define LARGEST_SPRITELIST_STRUCT ParentSpriteToDraw

   125

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

   126

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

   127

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

   128

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

   129

   130

/* Enumeration of multi-part foundations */

   131

enum FoundationPart {

   132

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

   133

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

   134

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

   135

	FOUNDATION_PART_END

   136

};

   137

   138

struct ViewportDrawer {

   139

	DrawPixelInfo dpi;

   140

   141

	byte *spritelist_mem;

   142

	const byte *eof_spritelist_mem;

   143

   144

	StringSpriteToDraw **last_string, *first_string;

   145

	TileSpriteToDraw **last_tile, *first_tile;

   146

   147

	ChildScreenSpriteToDraw **last_child;

   148

   149

	ParentSpriteToDraw **parent_list;

   150

	ParentSpriteToDraw * const *eof_parent_list;

   151

   152

	byte combine_sprites;

   153

   154

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

   155

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

   156

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

   157

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

   158

};

   159

   160

static ViewportDrawer *_cur_vd;

   161

   162

TileHighlightData _thd;

   163

static TileInfo *_cur_ti;

   164

   165

extern void SmallMapCenterOnCurrentPos(Window *w);

   166

   167

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

   168

{

   169

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

   170

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

   171

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

   172

	return p;

   173

}

   174

   175

void InitViewports()

   176

{

   177

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

   178

	_active_viewports = 0;

   179

}

   180

   181

void DeleteWindowViewport(Window *w)

   182

{

   183

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

   184

	w->viewport->width = 0;

   185

	w->viewport = NULL;

   186

}

   187

   188

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

   189

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

   190

{

   191

	ViewPort *vp;

   192

	Point pt;

   193

	uint32 bit;

   194

   195

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

   196

		assert(vp != endof(_viewports));

   197

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

   198

	}

   199

	SetBit(_active_viewports, bit);

   200

   201

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

   202

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

   203

	vp->width = width;

   204

	vp->height = height;

   205

   206

	vp->zoom = zoom;

   207

   208

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

   209

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

   210

   211

	if (follow_flags & 0x80000000) {

   212

		const Vehicle *veh;

   213

   214

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

   215

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

   216

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

   217

	} else {

   218

		uint x = TileX(follow_flags) * TILE_SIZE;

   219

		uint y = TileY(follow_flags) * TILE_SIZE;

   220

   221

		WP(w, vp_d).follow_vehicle = INVALID_VEHICLE;

   222

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

   223

	}

   224

   225

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

   226

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

   227

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

   228

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

   229

   230

	w->viewport = vp;

   231

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

   232

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

   233

}

   234

   235

static Point _vp_move_offs;

   236

   237

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

   238

{

   239

   240

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

   241

		const Window *w = *wz;

   242

   243

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

   244

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

   245

				top + height > w->top &&

   246

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

   247

   248

			if (left < w->left) {

   249

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

   250

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

   251

				return;

   252

			}

   253

   254

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

   255

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

   256

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

   257

				return;

   258

			}

   259

   260

			if (top < w->top) {

   261

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

   262

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

   263

				return;

   264

			}

   265

   266

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

   267

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

   268

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

   269

				return;

   270

			}

   271

   272

			return;

   273

		}

   274

	}

   275

   276

	{

   277

		int xo = _vp_move_offs.x;

   278

		int yo = _vp_move_offs.y;

   279

   280

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

   281

			/* fully_outside */

   282

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

   283

			return;

   284

		}

   285

   286

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

   287

   288

		if (xo > 0) {

   289

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

   290

			left += xo;

   291

			width -= xo;

   292

		} else if (xo < 0) {

   293

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

   294

			width += xo;

   295

		}

   296

   297

		if (yo > 0) {

   298

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

   299

		} else if (yo < 0) {

   300

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

   301

		}

   302

	}

   303

}

   304

   305

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

   306

{

   307

	ViewPort *vp = w->viewport;

   308

	int old_left = vp->virtual_left;

   309

	int old_top = vp->virtual_top;

   310

	int i;

   311

	int left, top, width, height;

   312

   313

	vp->virtual_left = x;

   314

	vp->virtual_top = y;

   315

   316

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

   317

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

   318

	 */

   319

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

   320

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

   321

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

   322

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

   323

   324

	old_left -= x;

   325

	old_top -= y;

   326

   327

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

   328

   329

	_vp_move_offs.x = old_left;

   330

	_vp_move_offs.y = old_top;

   331

   332

	left = vp->left;

   333

	top = vp->top;

   334

	width = vp->width;

   335

	height = vp->height;

   336

   337

	if (left < 0) {

   338

		width += left;

   339

		left = 0;

   340

	}

   341

   342

	i = left + width - _screen.width;

   343

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

   344

   345

	if (width > 0) {

   346

		if (top < 0) {

   347

			height += top;

   348

			top = 0;

   349

		}

   350

   351

		i = top + height - _screen.height;

   352

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

   353

   354

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

   355

	}

   356

}

   357

   358

   359

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

   360

{

   361

	ViewPort *vp = w->viewport;

   362

   363

	if (vp != NULL &&

   364

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

   365

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

   366

		return vp;

   367

   368

	return NULL;

   369

}

   370

   371

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

   372

{

   373

	Point pt;

   374

	int a,b;

   375

	uint z;

   376

   377

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

   378

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

   379

				Point pt = {-1, -1};

   380

				return pt;

   381

	}

   382

   383

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

   384

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

   385

   386

	a = y-x;

   387

	b = y+x;

   388

   389

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

   390

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

   391

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

   392

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

   393

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

   394

   395

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

   396

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

   397

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

   398

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

   399

	 * (FOUNDATION_HALFTILE_LOWER on SLOPE_STEEP_S hides north halftile completely)

   400

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

   401

	 */

   402

	z = 0;

   403

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

   404

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

   405

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

   406

   407

	pt.x = a + z;

   408

	pt.y = b + z;

   409

   410

	return pt;

   411

}

   412

   413

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

   414

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

   415

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

   416

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

   417

{

   418

	Window *w;

   419

	ViewPort *vp;

   420

	Point pt;

   421

   422

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

   423

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

   424

				return TranslateXYToTileCoord(vp, zoom_x, zoom_y);

   425

   426

	pt.y = pt.x = -1;

   427

	return pt;

   428

}

   429

   430

Point GetTileBelowCursor()

   431

{

   432

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

   433

}

   434

   435

   436

Point GetTileZoomCenterWindow(bool in, Window * w)

   437

{

   438

	int x, y;

   439

	ViewPort * vp;

   440

   441

	vp = w->viewport;

   442

   443

	if (in) {

   444

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

   445

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

   446

	} else {

   447

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

   448

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

   449

	}

   450

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

   451

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

   452

}

   453

   454

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

   455

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

   456

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

   457

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

   458

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

   459

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

   460

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

   461

{

   462

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

   463

	w->InvalidateWidget(widget_zoom_in);

   464

   465

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

   466

	w->InvalidateWidget(widget_zoom_out);

   467

}

   468

   469

/**

   470

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

   471

 *

   472

 * @param image the image to draw.

   473

 * @param pal the provided palette.

   474

 * @param x position x of the sprite.

   475

 * @param y position y of the sprite.

   476

 * @param z position z of the sprite.

   477

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

   478

 *

   479

 */

   480

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

   481

{

   482

	ViewportDrawer *vd = _cur_vd;

   483

	TileSpriteToDraw *ts;

   484

   485

	assert((image & SPRITE_MASK) < MAX_SPRITES);

   486

   487

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

   488

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

   489

		return;

   490

	}

   491

	ts = (TileSpriteToDraw*)vd->spritelist_mem;

   492

   493

	vd->spritelist_mem += sizeof(TileSpriteToDraw);

   494

   495

	ts->image = image;

   496

	ts->pal = pal;

   497

	ts->sub = sub;