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

static bool _added_tile_sprite;

    40

static bool _offset_ground_sprites;

    41

    42

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

    43

 *                                               *

    44

 *                    ^ Z                        *

    45

 *                    |                          *

    46

 *                    |                          *

    47

 *                    |                          *

    48

 *                    |                          *

    49

 *                 /     \                       *

    50

 *              /           \                    *

    51

 *           /                 \                 *

    52

 *        /                       \              *

    53

 *   X <                             > Y         *

    54

 */

    55

    56

struct StringSpriteToDraw {

    57

	uint16 string;

    58

	uint16 color;

    59

	StringSpriteToDraw *next;

    60

	int32 x;

    61

	int32 y;

    62

	uint64 params[2];

    63

	uint16 width;

    64

};

    65

    66

struct TileSpriteToDraw {

    67

	SpriteID image;

    68

	SpriteID pal;

    69

	TileSpriteToDraw *next;

    70

	int32 x;

    71

	int32 y;

    72

	byte z;

    73

};

    74

    75

struct ChildScreenSpriteToDraw {

    76

	SpriteID image;

    77

	SpriteID pal;

    78

	int32 x;

    79

	int32 y;

    80

	ChildScreenSpriteToDraw *next;

    81

};

    82

    83

struct ParentSpriteToDraw {

    84

	SpriteID image;

    85

	SpriteID pal;

    86

	int32 left;

    87

	int32 top;

    88

	int32 right;

    89

	int32 bottom;

    90

	int32 xmin;

    91

	int32 ymin;

    92

	int32 xmax;

    93

	int32 ymax;

    94

	ChildScreenSpriteToDraw *child;

    95

	byte unk16;

    96

	byte zmin;

    97

	byte zmax;

    98

};

    99

   100

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

   101

 * to prevent a buffer overflow. */

   102

#define LARGEST_SPRITELIST_STRUCT ParentSpriteToDraw

   103

   104

struct ViewportDrawer {

   105

	DrawPixelInfo dpi;

   106

   107

	byte *spritelist_mem;

   108

	const byte *eof_spritelist_mem;

   109

   110

	StringSpriteToDraw **last_string, *first_string;

   111

	TileSpriteToDraw **last_tile, *first_tile;

   112

   113

	ChildScreenSpriteToDraw **last_child;

   114

   115

	ParentSpriteToDraw **parent_list;

   116

	ParentSpriteToDraw * const *eof_parent_list;

   117

   118

	byte combine_sprites;

   119

   120

	int offs_x, offs_y; // used when drawing ground sprites relative

   121

};

   122

   123

static ViewportDrawer *_cur_vd;

   124

   125

TileHighlightData _thd;

   126

static TileInfo *_cur_ti;

   127

   128

extern void SmallMapCenterOnCurrentPos(Window *w);

   129

   130

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

   131

{

   132

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

   133

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

   134

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

   135

	return p;

   136

}

   137

   138

void InitViewports()

   139

{

   140

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

   141

	_active_viewports = 0;

   142

}

   143

   144

void DeleteWindowViewport(Window *w)

   145

{

   146

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

   147

	w->viewport->width = 0;

   148

	w->viewport = NULL;

   149

}

   150

   151

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

   152

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

   153

{

   154

	ViewPort *vp;

   155

	Point pt;

   156

	uint32 bit;

   157

   158

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

   159

		assert(vp != endof(_viewports));

   160

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

   161

	}

   162

	SETBIT(_active_viewports, bit);

   163

   164

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

   165

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

   166

	vp->width = width;

   167

	vp->height = height;

   168

   169

	vp->zoom = zoom;

   170

   171

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

   172

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

   173

   174

	if (follow_flags & 0x80000000) {

   175

		const Vehicle *veh;

   176

   177

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

   178

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

   179

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

   180

	} else {

   181

		uint x = TileX(follow_flags) * TILE_SIZE;

   182

		uint y = TileY(follow_flags) * TILE_SIZE;

   183

   184

		WP(w, vp_d).follow_vehicle = INVALID_VEHICLE;

   185

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

   186

	}

   187

   188

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

   189

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

   190

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

   191

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

   192

   193

	w->viewport = vp;

   194

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

   195

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

   196

}

   197

   198

static Point _vp_move_offs;

   199

   200

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

   201

{

   202

   203

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

   204

		const Window *w = *wz;

   205

   206

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

   207

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

   208

				top + height > w->top &&

   209

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

   210

   211

			if (left < w->left) {

   212

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

   213

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

   214

				return;

   215

			}

   216

   217

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

   218

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

   219

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

   220

				return;

   221

			}

   222

   223

			if (top < w->top) {

   224

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

   225

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

   226

				return;

   227

			}

   228

   229

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

   230

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

   231

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

   232

				return;

   233

			}

   234

   235

			return;

   236

		}

   237

	}

   238

   239

	{

   240

		int xo = _vp_move_offs.x;

   241

		int yo = _vp_move_offs.y;

   242

   243

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

   244

			/* fully_outside */

   245

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

   246

			return;

   247

		}

   248

   249

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

   250

   251

		if (xo > 0) {

   252

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

   253

			left += xo;

   254

			width -= xo;

   255

		} else if (xo < 0) {

   256

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

   257

			width += xo;

   258

		}

   259

   260

		if (yo > 0) {

   261

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

   262

		} else if (yo < 0) {

   263

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

   264

		}

   265

	}

   266

}

   267

   268

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

   269

{

   270

	ViewPort *vp = w->viewport;

   271

	int old_left = vp->virtual_left;

   272

	int old_top = vp->virtual_top;

   273

	int i;

   274

	int left, top, width, height;

   275

   276

	vp->virtual_left = x;

   277

	vp->virtual_top = y;

   278

   279

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

   280

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

   281

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

   282

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

   283

   284

	old_left -= x;

   285

	old_top -= y;

   286

   287

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

   288

   289

	_vp_move_offs.x = old_left;

   290

	_vp_move_offs.y = old_top;

   291

   292

	left = vp->left;

   293

	top = vp->top;

   294

	width = vp->width;

   295

	height = vp->height;

   296

   297

	if (left < 0) {

   298

		width += left;

   299

		left = 0;

   300

	}

   301

   302

	i = left + width - _screen.width;

   303

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

   304

   305

	if (width > 0) {

   306

		if (top < 0) {

   307

			height += top;

   308

			top = 0;

   309

		}

   310

   311

		i = top + height - _screen.height;

   312

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

   313

   314

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

   315

	}

   316

}

   317

   318

   319

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

   320

{

   321

	ViewPort *vp = w->viewport;

   322

   323

	if (vp != NULL &&

   324

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

   325

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

   326

		return vp;

   327

   328

	return NULL;

   329

}

   330

   331

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

   332

{

   333

	Point pt;

   334

	int a,b;

   335

	uint z;

   336

   337

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

   338

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

   339

				Point pt = {-1, -1};

   340

				return pt;

   341

	}

   342

   343

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

   344

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

   345

   346

	a = y-x;

   347

	b = y+x;

   348

   349

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

   350

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

   351

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

   352

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

   353

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

   354

   355

	z = GetSlopeZ(a,     b    ) / 2;

   356

	z = GetSlopeZ(a + z, b + z) / 2;

   357

	z = GetSlopeZ(a + z, b + z) / 2;

   358

	z = GetSlopeZ(a + z, b + z) / 2;

   359

	z = GetSlopeZ(a + z, b + z) / 2;

   360

   361

	pt.x = a + z;

   362

	pt.y = b + z;

   363

   364

	return pt;

   365

}

   366

   367

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

   368

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

   369

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

   370

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

   371

{

   372

	Window *w;

   373

	ViewPort *vp;

   374

	Point pt;

   375

   376

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

   377

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

   378

				return TranslateXYToTileCoord(vp, zoom_x, zoom_y);

   379

   380

	pt.y = pt.x = -1;

   381

	return pt;

   382

}

   383

   384

Point GetTileBelowCursor()

   385

{

   386

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

   387

}

   388

   389

   390

Point GetTileZoomCenterWindow(bool in, Window * w)

   391

{

   392

	int x, y;

   393

	ViewPort * vp;

   394

   395

	vp = w->viewport;

   396

   397

	if (in) {

   398

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

   399

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

   400

	} else {

   401

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

   402

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

   403

	}

   404

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

   405

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

   406

}

   407

   408

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

   409

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

   410

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

   411

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

   412

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

   413

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

   414

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

   415

{

   416

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

   417

	InvalidateWidget(w, widget_zoom_in);

   418

   419

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

   420

	InvalidateWidget(w, widget_zoom_out);

   421

}

   422

   423

void DrawGroundSpriteAt(SpriteID image, SpriteID pal, int32 x, int32 y, byte z)

   424

{

   425

	ViewportDrawer *vd = _cur_vd;

   426

	TileSpriteToDraw *ts;

   427

   428

	assert((image & SPRITE_MASK) < MAX_SPRITES);

   429

   430

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

   431

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

   432

		return;

   433

	}

   434

	ts = (TileSpriteToDraw*)vd->spritelist_mem;

   435

   436

	vd->spritelist_mem += sizeof(TileSpriteToDraw);

   437

   438

	ts->image = image;

   439

	ts->pal = pal;

   440

	ts->next = NULL;

   441

	ts->x = x;

   442

	ts->y = y;

   443

	ts->z = z;

   444

	*vd->last_tile = ts;

   445

	vd->last_tile = &ts->next;

   446

}

   447

   448

void DrawGroundSprite(SpriteID image, SpriteID pal)

   449

{

   450

	if (_offset_ground_sprites) {

   451

		/* offset ground sprite because of foundation? */

   452

		AddChildSpriteScreen(image, pal, _cur_vd->offs_x, _cur_vd->offs_y);

   453

	} else {

   454

		_added_tile_sprite = true;

   455

		DrawGroundSpriteAt(image, pal, _cur_ti->x, _cur_ti->y, _cur_ti->z);

   456

	}

   457

}

   458

   459

   460

void OffsetGroundSprite(int x, int y)

   461

{

   462

	_cur_vd->offs_x = x;

   463

	_cur_vd->offs_y = y;

   464

	_offset_ground_sprites = true;

   465

}

   466

   467

static void AddCombinedSprite(SpriteID image, SpriteID pal, int x, int y, byte z)

   468

{

   469

	const ViewportDrawer *vd = _cur_vd;

   470

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

   471

	const Sprite* spr = GetSprite(image & SPRITE_MASK);

   472

   473

	if (pt.x + spr->x_offs >= vd->dpi.left + vd->dpi.width ||

   474

			pt.x + spr->x_offs + spr->width <= vd->dpi.left ||

   475

			pt.y + spr->y_offs >= vd->dpi.top + vd->dpi.height ||

   476

			pt.y + spr->y_offs + spr->height <= vd->dpi.top)

   477

		return;

   478

   479

	AddChildSpriteScreen(image, pal, pt.x - vd->parent_list[-1]->left, pt.y - vd->parent_list[-1]->top);

   480

}

   481

   482

/** Draw a (transparent) sprite at given coordinates

   483

 * @param image the image to combine and draw,

   484

 * @param pal the provided palette,

   485

 * @param x position x of the sprite,

   486

 * @param y position y of the sprite,

   487

 * @param w width of the sprite,

   488

 * @param h height of the sprite,

   489

 * @param dz delta z, difference of elevation between sprite and parent sprite,

   490

 * @param z elevation of the sprite,

   491

 * @param transparent if true, switch the palette between the provided palette and the transparent palette

   492

 */

   493

void AddSortableSpriteToDraw(SpriteID image, SpriteID pal, int x, int y, int w, int h, byte dz, byte z, bool transparent)

   494

{

   495

	ViewportDrawer *vd = _cur_vd;

   496

	ParentSpriteToDraw *ps;

   497

	const Sprite *spr;

   498

	Point pt;

   499