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

/* XXX - maximum viewports is maximum windows - 2 (main toolbar + status bar) */

    36

static ViewPort _viewports[25 - 2];

    37

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

    38

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

    39

    40

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

    41

 *                                               *

    42

 *                    ^ Z                        *

    43

 *                    |                          *

    44

 *                    |                          *

    45

 *                    |                          *

    46

 *                    |                          *

    47

 *                 /     \                       *

    48

 *              /           \                    *

    49

 *           /                 \                 *

    50

 *        /                       \              *

    51

 *   X <                             > Y         *

    52

 */

    53

    54

struct StringSpriteToDraw {

    55

	uint16 string;

    56

	uint16 color;

    57

	StringSpriteToDraw *next;

    58

	int32 x;

    59

	int32 y;

    60

	uint64 params[2];

    61

	uint16 width;

    62

};

    63

    64

struct TileSpriteToDraw {

    65

	SpriteID image;

    66

	SpriteID pal;

    67

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

    68

	TileSpriteToDraw *next;

    69

	int32 x;

    70

	int32 y;

    71

	byte z;

    72

};

    73

    74

struct ChildScreenSpriteToDraw {

    75

	SpriteID image;

    76

	SpriteID pal;

    77

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

    78

	int32 x;

    79

	int32 y;

    80

	ChildScreenSpriteToDraw *next;

    81

};

    82

    83

struct ParentSpriteToDraw {

    84

	SpriteID image;                 ///< sprite to draw

    85

	SpriteID pal;                   ///< palette to use

    86

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

    87

    88

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

    89

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

    90

    91

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

    92

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

    93

    94

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

    95

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

    96

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

    97

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

    98

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

    99

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

   100

   101

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

   102

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

   103

};

   104

   105

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

   106

 * to prevent a buffer overflow. */

   107

#define LARGEST_SPRITELIST_STRUCT ParentSpriteToDraw

   108

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

   109

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

   110

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

   111

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

   112

   113

/* Enumeration of multi-part foundations */

   114

enum FoundationPart {

   115

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

   116

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

   117

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

   118

	FOUNDATION_PART_END

   119

};

   120

   121

struct ViewportDrawer {

   122

	DrawPixelInfo dpi;

   123

   124

	byte *spritelist_mem;

   125

	const byte *eof_spritelist_mem;

   126

   127

	StringSpriteToDraw **last_string, *first_string;

   128

	TileSpriteToDraw **last_tile, *first_tile;

   129

   130

	ChildScreenSpriteToDraw **last_child;

   131

   132

	ParentSpriteToDraw **parent_list;

   133

	ParentSpriteToDraw * const *eof_parent_list;

   134

   135

	byte combine_sprites;

   136

   137

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

   138

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

   139

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

   140

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

   141

};

   142

   143

static ViewportDrawer *_cur_vd;

   144

   145

TileHighlightData _thd;

   146

static TileInfo *_cur_ti;

   147

   148

extern void SmallMapCenterOnCurrentPos(Window *w);

   149

   150

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

   151

{

   152

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

   153

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

   154

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

   155

	return p;

   156

}

   157

   158

void InitViewports()

   159

{

   160

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

   161

	_active_viewports = 0;

   162

}

   163

   164

void DeleteWindowViewport(Window *w)

   165

{

   166

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

   167

	w->viewport->width = 0;

   168

	w->viewport = NULL;

   169

}

   170

   171

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

   172

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

   173

{

   174

	ViewPort *vp;

   175

	Point pt;

   176

	uint32 bit;

   177

   178

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

   179

		assert(vp != endof(_viewports));

   180

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

   181

	}

   182

	SetBit(_active_viewports, bit);

   183

   184

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

   185

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

   186

	vp->width = width;

   187

	vp->height = height;

   188

   189

	vp->zoom = zoom;

   190

   191

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

   192

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

   193

   194

	if (follow_flags & 0x80000000) {

   195

		const Vehicle *veh;

   196

   197

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

   198

		veh = GetVehicle(WP(w, vp_d).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

		WP(w, vp_d).follow_vehicle = INVALID_VEHICLE;

   205

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

   206

	}

   207

   208

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

   209

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

   210

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

   211

	WP(w, vp_d).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

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

   343

{

   344

	ViewPort *vp = w->viewport;

   345

   346

	if (vp != NULL &&

   347

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

   348

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

   349

		return vp;

   350

   351

	return NULL;

   352

}

   353

   354

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

   355

{

   356

	Point pt;

   357

	int a,b;

   358

	uint z;

   359

   360

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

   361

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

   362

				Point pt = {-1, -1};

   363

				return pt;

   364

	}

   365

   366

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

   367

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

   368

   369

	a = y-x;

   370

	b = y+x;

   371

   372

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

   373

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

   374

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

   375

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

   376

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

   377

   378

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

   379

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

   380

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

   381

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

   382

	 * (FOUNDATION_HALFTILE_LOWER on SLOPE_STEEP_S hides north halftile completely)

   383

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

   384

	 */

   385

	z = 0;

   386

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

   387

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

   388

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

   389

   390

	pt.x = a + z;

   391

	pt.y = b + z;

   392

   393

	return pt;

   394

}

   395

   396

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

   397

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

   398

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

   399

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

   400

{

   401

	Window *w;

   402

	ViewPort *vp;

   403

	Point pt;

   404

   405

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

   406

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

   407

				return TranslateXYToTileCoord(vp, zoom_x, zoom_y);

   408

   409

	pt.y = pt.x = -1;

   410

	return pt;

   411

}

   412

   413

Point GetTileBelowCursor()

   414

{

   415

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

   416

}

   417

   418

   419

Point GetTileZoomCenterWindow(bool in, Window * w)

   420

{

   421

	int x, y;

   422

	ViewPort * vp;

   423

   424

	vp = w->viewport;

   425

   426

	if (in) {

   427

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

   428

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

   429

	} else {

   430

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

   431

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

   432

	}

   433

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

   434

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

   435

}

   436

   437

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

   438

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

   439

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

   440

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

   441

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

   442

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

   443

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

   444

{

   445

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

   446

	InvalidateWidget(w, widget_zoom_in);

   447

   448

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

   449

	InvalidateWidget(w, widget_zoom_out);

   450

}

   451

   452

/**

   453

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

   454

 *

   455

 * @param image the image to draw.

   456

 * @param pal the provided palette.

   457

 * @param x position x of the sprite.

   458

 * @param y position y of the sprite.

   459

 * @param z position z of the sprite.

   460

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

   461

 *

   462

 */

   463

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

   464

{

   465

	ViewportDrawer *vd = _cur_vd;

   466

	TileSpriteToDraw *ts;

   467

   468

	assert((image & SPRITE_MASK) < MAX_SPRITES);

   469

   470

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

   471

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

   472

		return;

   473

	}

   474

	ts = (TileSpriteToDraw*)vd->spritelist_mem;

   475

   476

	vd->spritelist_mem += sizeof(TileSpriteToDraw);

   477

   478

	ts->image = image;

   479

	ts->pal = pal;

   480

	ts->sub = sub;

   481

	ts->next = NULL;

   482

	ts->x = x;

   483

	ts->y = y;

   484

	ts->z = z;

   485

	*vd->last_tile = ts;

   486

	vd->last_tile = &ts->next;

   487

}

   488

   489

/**

   490

 * Adds a child sprite to the active foundation.

   491

 *

   492

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

   493

 *

   494

 * @param image the image to draw.

   495

 * @param pal the provided palette.

   496

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

   497

 * @param foundation_part Foundation part.