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

    30

#define VIEWPORT_DRAW_MEM (65536 * 2)

    31

    32

ZoomLevel _saved_scrollpos_zoom;

    33

    34

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

    35

static ViewPort _viewports[25 - 2];

    36

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

    37

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

    38

    39

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

    40

 *                                               *

    41

 *                    ^ Z                        *

    42

 *                    |                          *

    43

 *                    |                          *

    44

 *                    |                          *

    45

 *                    |                          *

    46

 *                 /     \                       *

    47

 *              /           \                    *

    48

 *           /                 \                 *

    49

 *        /                       \              *

    50

 *   X <                             > Y         *

    51

 */

    52

    53

struct StringSpriteToDraw {

    54

	uint16 string;

    55

	uint16 color;

    56

	StringSpriteToDraw *next;

    57

	int32 x;

    58

	int32 y;

    59

	uint64 params[2];

    60

	uint16 width;

    61

};

    62

    63

struct TileSpriteToDraw {

    64

	SpriteID image;

    65

	SpriteID pal;

    66

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

    67

	TileSpriteToDraw *next;

    68

	int32 x;

    69

	int32 y;

    70

	byte z;

    71

};

    72

    73

struct ChildScreenSpriteToDraw {

    74

	SpriteID image;

    75

	SpriteID pal;

    76

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

    77

	int32 x;

    78

	int32 y;

    79

	ChildScreenSpriteToDraw *next;

    80

};

    81

    82

struct ParentSpriteToDraw {

    83

	SpriteID image;                 ///< sprite to draw

    84

	SpriteID pal;                   ///< palette to use

    85

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

    86

    87

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

    88

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

    89

    90

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

    91

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

    92

    93

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

    94

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

    95

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

    96

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

    97

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

    98

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

    99

   100

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

   101

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

   102

};

   103

   104

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

   105

 * to prevent a buffer overflow. */

   106

#define LARGEST_SPRITELIST_STRUCT ParentSpriteToDraw

   107

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

   108

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

   109

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

   110

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

   111

   112

/* Enumeration of multi-part foundations */

   113

enum FoundationPart {

   114

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

   115

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

   116

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

   117

	FOUNDATION_PART_END

   118

};

   119

   120

struct ViewportDrawer {

   121

	DrawPixelInfo dpi;

   122

   123

	byte *spritelist_mem;

   124

	const byte *eof_spritelist_mem;

   125

   126

	StringSpriteToDraw **last_string, *first_string;

   127

	TileSpriteToDraw **last_tile, *first_tile;

   128

   129

	ChildScreenSpriteToDraw **last_child;

   130

   131

	ParentSpriteToDraw **parent_list;

   132

	ParentSpriteToDraw * const *eof_parent_list;

   133

   134

	byte combine_sprites;

   135

   136

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

   137

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

   138

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

   139

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

   140

};

   141

   142

static ViewportDrawer *_cur_vd;

   143

   144

TileHighlightData _thd;

   145

static TileInfo *_cur_ti;

   146

   147

extern void SmallMapCenterOnCurrentPos(Window *w);

   148

   149

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

   150

{

   151

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

   152

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

   153

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

   154

	return p;

   155

}

   156

   157

void InitViewports()

   158

{

   159

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

   160

	_active_viewports = 0;

   161

}

   162

   163

void DeleteWindowViewport(Window *w)

   164

{

   165

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

   166

	w->viewport->width = 0;

   167

	w->viewport = NULL;

   168

}

   169

   170

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

   171

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

   172

{

   173

	ViewPort *vp;

   174

	Point pt;

   175

	uint32 bit;

   176

   177

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

   178

		assert(vp != endof(_viewports));

   179

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

   180

	}

   181

	SETBIT(_active_viewports, bit);

   182

   183

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

   184

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

   185

	vp->width = width;

   186

	vp->height = height;

   187

   188

	vp->zoom = zoom;

   189

   190

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

   191

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

   192

   193

	if (follow_flags & 0x80000000) {

   194

		const Vehicle *veh;

   195

   196

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

   197

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

   198

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

   199

	} else {

   200

		uint x = TileX(follow_flags) * TILE_SIZE;

   201

		uint y = TileY(follow_flags) * TILE_SIZE;

   202

   203

		WP(w, vp_d).follow_vehicle = INVALID_VEHICLE;

   204

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

   205

	}

   206

   207

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

   208

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

   209

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

   210

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

   211

   212

	w->viewport = vp;

   213

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

   214

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

   215

}

   216

   217

static Point _vp_move_offs;

   218

   219

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

   220

{

   221

   222

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

   223

		const Window *w = *wz;

   224

   225

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

   226

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

   227

				top + height > w->top &&

   228

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

   229

   230

			if (left < w->left) {

   231

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

   232

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

   233

				return;

   234

			}

   235

   236

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

   237

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

   238

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

   239

				return;

   240

			}

   241

   242

			if (top < w->top) {

   243

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

   244

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

   245

				return;

   246

			}

   247

   248

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

   249

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

   250

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

   251

				return;

   252

			}

   253

   254

			return;

   255

		}

   256

	}

   257

   258

	{

   259

		int xo = _vp_move_offs.x;

   260

		int yo = _vp_move_offs.y;

   261

   262

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

   263

			/* fully_outside */

   264

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

   265

			return;

   266

		}

   267

   268

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

   269

   270

		if (xo > 0) {

   271

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

   272

			left += xo;

   273

			width -= xo;

   274

		} else if (xo < 0) {

   275

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

   276

			width += xo;

   277

		}

   278

   279

		if (yo > 0) {

   280

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

   281

		} else if (yo < 0) {

   282

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

   283

		}

   284

	}

   285

}

   286

   287

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

   288

{

   289

	ViewPort *vp = w->viewport;

   290

	int old_left = vp->virtual_left;

   291

	int old_top = vp->virtual_top;

   292

	int i;

   293

	int left, top, width, height;

   294

   295

	vp->virtual_left = x;

   296

	vp->virtual_top = y;

   297

   298

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

   299

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

   300

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

   301

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

   302

   303

	old_left -= x;

   304

	old_top -= y;

   305

   306

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

   307

   308

	_vp_move_offs.x = old_left;

   309

	_vp_move_offs.y = old_top;

   310

   311

	left = vp->left;

   312

	top = vp->top;

   313

	width = vp->width;

   314

	height = vp->height;

   315

   316

	if (left < 0) {

   317

		width += left;

   318

		left = 0;

   319

	}

   320

   321

	i = left + width - _screen.width;

   322

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

   323

   324

	if (width > 0) {

   325

		if (top < 0) {

   326

			height += top;

   327

			top = 0;

   328

		}

   329

   330

		i = top + height - _screen.height;

   331

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

   332

   333

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

   334

	}

   335

}

   336

   337

   338

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

   339

{

   340

	ViewPort *vp = w->viewport;

   341

   342

	if (vp != NULL &&

   343

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

   344

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

   345

		return vp;

   346

   347

	return NULL;

   348

}

   349

   350

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

   351

{

   352

	Point pt;

   353

	int a,b;

   354

	uint z;

   355

   356

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

   357

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

   358

				Point pt = {-1, -1};

   359

				return pt;

   360

	}

   361

   362

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

   363

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

   364

   365

	a = y-x;

   366

	b = y+x;

   367

   368

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

   369

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

   370

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

   371

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

   372

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

   373

   374

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

   375

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

   376

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

   377

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

   378

	 * (FOUNDATION_HALFTILE_LOWER on SLOPE_STEEP_S hides north halftile completely)

   379

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

   380

	 */

   381

	z = 0;

   382

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

   383

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

   384

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

   385

   386

	pt.x = a + z;

   387

	pt.y = b + z;

   388

   389

	return pt;

   390

}

   391

   392

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

   393

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

   394

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

   395

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

   396

{

   397

	Window *w;

   398

	ViewPort *vp;

   399

	Point pt;

   400

   401

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

   402

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

   403

				return TranslateXYToTileCoord(vp, zoom_x, zoom_y);

   404

   405

	pt.y = pt.x = -1;

   406

	return pt;

   407

}

   408

   409

Point GetTileBelowCursor()

   410

{

   411

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

   412

}

   413

   414

   415

Point GetTileZoomCenterWindow(bool in, Window * w)

   416

{

   417

	int x, y;

   418

	ViewPort * vp;

   419

   420

	vp = w->viewport;

   421

   422

	if (in) {

   423

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

   424

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

   425

	} else {

   426

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

   427

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

   428

	}

   429

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

   430

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

   431

}

   432

   433

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

   434

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

   435

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

   436

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

   437

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

   438

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

   439

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

   440

{

   441

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

   442

	InvalidateWidget(w, widget_zoom_in);

   443

   444

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

   445

	InvalidateWidget(w, widget_zoom_out);

   446

}

   447

   448

/**

   449

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

   450

 *

   451

 * @param image the image to draw.

   452

 * @param pal the provided palette.

   453

 * @param x position x of the sprite.

   454

 * @param y position y of the sprite.

   455

 * @param z position z of the sprite.

   456

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

   457

 *

   458

 */

   459

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

   460

{

   461

	ViewportDrawer *vd = _cur_vd;

   462

	TileSpriteToDraw *ts;

   463

   464

	assert((image & SPRITE_MASK) < MAX_SPRITES);

   465

   466

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

   467

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

   468

		return;

   469

	}

   470

	ts = (TileSpriteToDraw*)vd->spritelist_mem;

   471

   472

	vd->spritelist_mem += sizeof(TileSpriteToDraw);

   473

   474

	ts->image = image;

   475

	ts->pal = pal;

   476

	ts->sub = sub;

   477

	ts->next = NULL;

   478

	ts->x = x;

   479

	ts->y = y;

   480

	ts->z = z;

   481

	*vd->last_tile = ts;

   482

	vd->last_tile = &ts->next;

   483

}

   484

   485

/**

   486

 * Adds a child sprite to the active foundation.

   487

 *

   488

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

   489

 *

   490

 * @param image the image to draw.

   491

 * @param pal the provided palette.

   492

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

   493

 * @param foundation_part Foundation part.

   494

 * @param extra_offs_x Pixel X offset for the sprite position.

   495

 * @param extra_offs_y Pixel Y offset for the sprite position.

   496

 */

   497

static void AddChildSpriteToFoundation(SpriteID image, SpriteID pal, const SubSprite *sub, FoundationPart foundation_part, int extra_offs_x, int extra_offs_y)