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

    14

#include "town.h"

    15

#include "signs_base.h"

    16

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

    24

#include "strings_func.h"

    25

#include "zoom_func.h"

    26

#include "vehicle_func.h"

    27

#include "player_func.h"

    28

#include "settings_type.h"

    29

#include "station_func.h"

    30

#include "core/alloc_func.hpp"

    31

    32

#include "table/sprites.h"

    33

#include "table/strings.h"

    34

    35

enum {

    36

	VIEWPORT_DRAW_MEM = (65536 * 2),

    37

	PARENT_LIST_SIZE  = 6144,

    38

};

    39

    40

PlaceProc *_place_proc;

    41

Point _tile_fract_coords;

    42

ZoomLevel _saved_scrollpos_zoom;

    43

    44

/**

    45

 * The maximum number of viewports depends on the maximum number

    46

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

    47

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

    48

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

    49

 * saves some time and memory.

    50

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

    51

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

    52

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

    53

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

    54

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

    55

 *

    56

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

    57

 * window without viewport.

    58

 */

    59

static ViewPort _viewports[MAX_NUMBER_OF_WINDOWS - 1];

    60

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

    61

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

    62

    63

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

    64

 *                                               *

    65

 *                    ^ Z                        *

    66

 *                    |                          *

    67

 *                    |                          *

    68

 *                    |                          *

    69

 *                    |                          *

    70

 *                 /     \                       *

    71

 *              /           \                    *

    72

 *           /                 \                 *

    73

 *        /                       \              *

    74

 *   X <                             > Y         *

    75

 */

    76

    77

struct StringSpriteToDraw {

    78

	uint16 string;

    79

	uint16 color;

    80

	StringSpriteToDraw *next;

    81

	int32 x;

    82

	int32 y;

    83

	uint64 params[2];

    84

	uint16 width;

    85

};

    86

    87

struct TileSpriteToDraw {

    88

	SpriteID image;

    89

	SpriteID pal;

    90

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

    91

	TileSpriteToDraw *next;

    92

	int32 x;

    93

	int32 y;

    94

	byte z;

    95

};

    96

    97

struct ChildScreenSpriteToDraw {

    98

	SpriteID image;

    99

	SpriteID pal;

   100

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

   101

	int32 x;

   102

	int32 y;

   103

	ChildScreenSpriteToDraw *next;

   104

};

   105

   106

struct ParentSpriteToDraw {

   107

	SpriteID image;                 ///< sprite to draw

   108

	SpriteID pal;                   ///< palette to use

   109

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

   110

   111

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

   112

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

   113

   114

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

   115

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

   116

   117

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

   118

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

   119

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

   120

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

   121

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

   122

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

   123

   124

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

   125

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

   126

};

   127

   128

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

   129

 * to prevent a buffer overflow. */

   130

#define LARGEST_SPRITELIST_STRUCT ParentSpriteToDraw

   131

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

   132

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

   133

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

   134

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

   135

   136

/* Enumeration of multi-part foundations */

   137

enum FoundationPart {

   138

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

   139

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

   140

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

   141

	FOUNDATION_PART_END

   142

};

   143

   144

struct ViewportDrawer {

   145

	DrawPixelInfo dpi;

   146

   147

	byte *spritelist_mem;

   148

	const byte *eof_spritelist_mem;

   149

   150

	StringSpriteToDraw **last_string, *first_string;

   151

	TileSpriteToDraw **last_tile, *first_tile;

   152

   153

	ChildScreenSpriteToDraw **last_child;

   154

   155

	ParentSpriteToDraw **parent_list;

   156

	ParentSpriteToDraw * const *eof_parent_list;

   157

   158

	byte combine_sprites;

   159

   160

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

   161

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

   162

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

   163

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

   164

};

   165

   166

static ViewportDrawer *_cur_vd;

   167

   168

TileHighlightData _thd;

   169

static TileInfo *_cur_ti;

   170

   171

extern void SmallMapCenterOnCurrentPos(Window *w);

   172

   173

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

   174

{

   175

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

   176

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

   177

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

   178

	return p;

   179

}

   180

   181

void InitViewports()

   182

{

   183

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

   184

	_active_viewports = 0;

   185

}

   186

   187

void DeleteWindowViewport(Window *w)

   188

{

   189

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

   190

	w->viewport->width = 0;

   191

	w->viewport = NULL;

   192

}

   193

   194

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

   195

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

   196

{

   197

	ViewPort *vp;

   198

	Point pt;

   199

	uint32 bit;

   200

   201

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

   202

		assert(vp != endof(_viewports));

   203

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

   204

	}

   205

	SetBit(_active_viewports, bit);

   206

   207

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

   208

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

   209

	vp->width = width;

   210

	vp->height = height;

   211

   212

	vp->zoom = zoom;

   213

   214

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

   215

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

   216

   217

	if (follow_flags & 0x80000000) {

   218

		const Vehicle *veh;

   219

   220

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

   221

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

   222

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

   223

	} else {

   224

		uint x = TileX(follow_flags) * TILE_SIZE;

   225

		uint y = TileY(follow_flags) * TILE_SIZE;

   226

   227

		WP(w, vp_d).follow_vehicle = INVALID_VEHICLE;

   228

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

   229

	}

   230

   231

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

   232

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

   233

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

   234

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

   235

   236

	w->viewport = vp;

   237

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

   238

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

   239

}

   240

   241

static Point _vp_move_offs;

   242

   243

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

   244

{

   245

   246

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

   247

		const Window *w = *wz;

   248

   249

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

   250

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

   251

				top + height > w->top &&

   252

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

   253

   254

			if (left < w->left) {

   255

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

   256

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

   257

				return;

   258

			}

   259

   260

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

   261

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

   262

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

   263

				return;

   264

			}

   265

   266

			if (top < w->top) {

   267

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

   268

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

   269

				return;

   270

			}

   271

   272

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

   273

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

   274

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

   275

				return;

   276

			}

   277

   278

			return;

   279

		}

   280

	}

   281

   282

	{

   283

		int xo = _vp_move_offs.x;

   284

		int yo = _vp_move_offs.y;

   285

   286

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

   287

			/* fully_outside */

   288

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

   289

			return;

   290

		}

   291

   292

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

   293

   294

		if (xo > 0) {

   295

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

   296

			left += xo;

   297

			width -= xo;

   298

		} else if (xo < 0) {

   299

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

   300

			width += xo;

   301

		}

   302

   303

		if (yo > 0) {

   304

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

   305

		} else if (yo < 0) {

   306

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

   307

		}

   308

	}

   309

}

   310

   311

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

   312

{

   313

	ViewPort *vp = w->viewport;

   314

	int old_left = vp->virtual_left;

   315

	int old_top = vp->virtual_top;

   316

	int i;

   317

	int left, top, width, height;

   318

   319

	vp->virtual_left = x;

   320

	vp->virtual_top = y;

   321

   322

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

   323

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

   324

	 */

   325

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

   326

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

   327

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

   328

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

   329

   330

	old_left -= x;

   331

	old_top -= y;

   332

   333

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

   334

   335

	_vp_move_offs.x = old_left;

   336

	_vp_move_offs.y = old_top;

   337

   338

	left = vp->left;

   339

	top = vp->top;

   340

	width = vp->width;

   341

	height = vp->height;

   342

   343

	if (left < 0) {

   344

		width += left;

   345

		left = 0;

   346

	}

   347

   348

	i = left + width - _screen.width;

   349

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

   350

   351

	if (width > 0) {

   352

		if (top < 0) {

   353

			height += top;

   354

			top = 0;

   355

		}

   356

   357

		i = top + height - _screen.height;

   358

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

   359

   360

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

   361

	}

   362

}

   363

   364

   365

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

   366

{

   367

	ViewPort *vp = w->viewport;

   368

   369

	if (vp != NULL &&

   370

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

   371

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

   372

		return vp;

   373

   374

	return NULL;

   375

}

   376

   377

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

   378

{

   379

	Point pt;

   380

	int a,b;

   381

	uint z;

   382

   383

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

   384

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

   385

				Point pt = {-1, -1};

   386

				return pt;

   387

	}

   388

   389

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

   390

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

   391

   392

	a = y-x;

   393

	b = y+x;

   394

   395

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

   396

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

   397

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

   398

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

   399

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

   400

   401

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

   402

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

   403

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

   404

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

   405

	 * (FOUNDATION_HALFTILE_LOWER on SLOPE_STEEP_S hides north halftile completely)

   406

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

   407

	 */

   408

	z = 0;

   409

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

   410

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

   411

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

   412

   413

	pt.x = a + z;

   414

	pt.y = b + z;

   415

   416

	return pt;

   417

}

   418

   419

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

   420

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

   421

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

   422

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

   423

{

   424

	Window *w;

   425

	ViewPort *vp;

   426

	Point pt;

   427

   428

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

   429

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

   430

				return TranslateXYToTileCoord(vp, zoom_x, zoom_y);

   431

   432

	pt.y = pt.x = -1;

   433

	return pt;

   434

}

   435

   436

Point GetTileBelowCursor()

   437

{

   438

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

   439

}

   440

   441

   442

Point GetTileZoomCenterWindow(bool in, Window * w)

   443

{

   444

	int x, y;

   445

	ViewPort * vp;

   446

   447

	vp = w->viewport;

   448

   449

	if (in) {

   450

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

   451

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

   452

	} else {

   453

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

   454

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

   455

	}

   456

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

   457

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

   458

}

   459

   460

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

   461

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

   462

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

   463

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

   464

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

   465

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

   466

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

   467

{

   468

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

   469

	w->InvalidateWidget(widget_zoom_in);

   470

   471

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

   472

	w->InvalidateWidget(widget_zoom_out);

   473

}

   474

   475

/**

   476

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

   477

 *

   478

 * @param image the image to draw.

   479

 * @param pal the provided palette.

   480

 * @param x position x of the sprite.

   481

 * @param y position y of the sprite.

   482

 * @param z position z of the sprite.

   483

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

   484

 *

   485

 */

   486

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

   487

{

   488

	ViewportDrawer *vd = _cur_vd;

   489

	TileSpriteToDraw *ts;

   490

   491

	assert((image & SPRITE_MASK) < MAX_SPRITES);

   492

   493

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

   494

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

   495

		return;

   496

	}