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

    27

#define VIEWPORT_DRAW_MEM (65536 * 2)

    28

    29

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

    30

static ViewPort _viewports[25 - 2];

    31

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

    32

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

    33

    34

static bool _added_tile_sprite;

    35

static bool _offset_ground_sprites;

    36

    37

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

    38

 *                                               *

    39

 *                    ^ Z                        *

    40

 *                    |                          *

    41

 *                    |                          *

    42

 *                    |                          *

    43

 *                    |                          *

    44

 *                 /     \                       *

    45

 *              /           \                    *

    46

 *           /                 \                 *

    47

 *        /                       \              *

    48

 *   X <                             > Y         *

    49

 */

    50

    51

struct StringSpriteToDraw {

    52

	uint16 string;

    53

	uint16 color;

    54

	StringSpriteToDraw *next;

    55

	int32 x;

    56

	int32 y;

    57

	uint32 params[2];

    58

	uint16 width;

    59

};

    60

    61

struct TileSpriteToDraw {

    62

	SpriteID image;

    63

	SpriteID pal;

    64

	TileSpriteToDraw *next;

    65

	int32 x;

    66

	int32 y;

    67

	byte z;

    68

};

    69

    70

struct ChildScreenSpriteToDraw {

    71

	SpriteID image;

    72

	SpriteID pal;

    73

	int32 x;

    74

	int32 y;

    75

	ChildScreenSpriteToDraw *next;

    76

};

    77

    78

struct ParentSpriteToDraw {

    79

	SpriteID image;

    80

	SpriteID pal;

    81

	int32 left;

    82

	int32 top;

    83

	int32 right;

    84

	int32 bottom;

    85

	int32 xmin;

    86

	int32 ymin;

    87

	int32 xmax;

    88

	int32 ymax;

    89

	ChildScreenSpriteToDraw *child;

    90

	byte unk16;

    91

	byte zmin;

    92

	byte zmax;

    93

};

    94

    95

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

    96

 * to prevent a buffer overflow. */

    97

#define LARGEST_SPRITELIST_STRUCT ParentSpriteToDraw

    98

    99

struct ViewportDrawer {

   100

	DrawPixelInfo dpi;

   101

   102

	byte *spritelist_mem;

   103

	const byte *eof_spritelist_mem;

   104

   105

	StringSpriteToDraw **last_string, *first_string;

   106

	TileSpriteToDraw **last_tile, *first_tile;

   107

   108

	ChildScreenSpriteToDraw **last_child;

   109

   110

	ParentSpriteToDraw **parent_list;

   111

	ParentSpriteToDraw * const *eof_parent_list;

   112

   113

	byte combine_sprites;

   114

   115

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

   116

};

   117

   118

static ViewportDrawer *_cur_vd;

   119

   120

TileHighlightData _thd;

   121

static TileInfo *_cur_ti;

   122

   123

extern void SmallMapCenterOnCurrentPos(Window *w);

   124

   125

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

   126

{

   127

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

   128

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

   129

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

   130

	return p;

   131

}

   132

   133

void InitViewports() {

   134

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

   135

	_active_viewports = 0;

   136

}

   137

   138

void DeleteWindowViewport(Window *w)

   139

{

   140

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

   141

	w->viewport->width = 0;

   142

	w->viewport = NULL;

   143

}

   144

   145

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

   146

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

   147

{

   148

	ViewPort *vp;

   149

	Point pt;

   150

	uint32 bit;

   151

   152

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

   153

		assert(vp != endof(_viewports));

   154

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

   155

	}

   156

	SETBIT(_active_viewports, bit);

   157

   158

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

   159

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

   160

	vp->width = width;

   161

	vp->height = height;

   162

   163

	vp->zoom = zoom;

   164

   165

	vp->virtual_width = width << zoom;

   166

	vp->virtual_height = height << zoom;

   167

   168

	if (follow_flags & 0x80000000) {

   169

		const Vehicle *veh;

   170

   171

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

   172

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

   173

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

   174

	} else {

   175

		uint x = TileX(follow_flags) * TILE_SIZE;

   176

		uint y = TileY(follow_flags) * TILE_SIZE;

   177

   178

		WP(w, vp_d).follow_vehicle = INVALID_VEHICLE;

   179

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

   180

	}

   181

   182

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

   183

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

   184

	w->viewport = vp;

   185

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

   186

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

   187

}

   188

   189

static Point _vp_move_offs;

   190

   191

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

   192

{

   193

   194

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

   195

		const Window *w = *wz;

   196

   197

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

   198

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

   199

				top + height > w->top &&

   200

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

   201

   202

			if (left < w->left) {

   203

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

   204

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

   205

				return;

   206

			}

   207

   208

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

   209

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

   210

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

   211

				return;

   212

			}

   213

   214

			if (top < w->top) {

   215

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

   216

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

   217

				return;

   218

			}

   219

   220

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

   221

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

   222

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

   223

				return;

   224

			}

   225

   226

			return;

   227

		}

   228

	}

   229

   230

	{

   231

		int xo = _vp_move_offs.x;

   232

		int yo = _vp_move_offs.y;

   233

   234

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

   235

			/* fully_outside */

   236

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

   237

			return;

   238

		}

   239

   240

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

   241

   242

		if (xo > 0) {

   243

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

   244

			left += xo;

   245

			width -= xo;

   246

		} else if (xo < 0) {

   247

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

   248

			width += xo;

   249

		}

   250

   251

		if (yo > 0) {

   252

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

   253

		} else if (yo < 0) {

   254

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

   255

		}

   256

	}

   257

}

   258

   259

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

   260

{

   261

	ViewPort *vp = w->viewport;

   262

	int old_left = vp->virtual_left;

   263

	int old_top = vp->virtual_top;

   264

	int i;

   265

	int left, top, width, height;

   266

   267

	vp->virtual_left = x;

   268

	vp->virtual_top = y;

   269

   270

	old_left >>= vp->zoom;

   271

	old_top >>= vp->zoom;

   272

	x >>= vp->zoom;

   273

	y >>= vp->zoom;

   274

   275

	old_left -= x;

   276

	old_top -= y;

   277

   278

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

   279

   280

	_vp_move_offs.x = old_left;

   281

	_vp_move_offs.y = old_top;

   282

   283

	left = vp->left;

   284

	top = vp->top;

   285

	width = vp->width;

   286

	height = vp->height;

   287

   288

	if (left < 0) {

   289

		width += left;

   290

		left = 0;

   291

	}

   292

   293

	i = left + width - _screen.width;

   294

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

   295

   296

	if (width > 0) {

   297

		if (top < 0) {

   298

			height += top;

   299

			top = 0;

   300

		}

   301

   302

		i = top + height - _screen.height;

   303

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

   304

   305

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

   306

	}

   307

}

   308

   309

   310

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

   311

{

   312

	ViewPort *vp = w->viewport;

   313

   314

	if (vp != NULL &&

   315

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

   316

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

   317

		return vp;

   318

   319

	return NULL;

   320

}

   321

   322

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

   323

{

   324

	Point pt;

   325

	int a,b;

   326

	uint z;

   327

   328

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

   329

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

   330

				Point pt = {-1, -1};

   331

				return pt;

   332

	}

   333

   334

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

   335

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

   336

   337

	a = y-x;

   338

	b = y+x;

   339

   340

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

   341

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

   342

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

   343

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

   344

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

   345

   346

	z = GetSlopeZ(a,     b    ) / 2;

   347

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

   348

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

   349

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

   350

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

   351

   352

	pt.x = a + z;

   353

	pt.y = b + z;

   354

   355

	return pt;

   356

}

   357

   358

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

   359

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

   360

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

   361

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

   362

{

   363

	Window *w;

   364

	ViewPort *vp;

   365

	Point pt;

   366

   367

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

   368

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

   369

				return TranslateXYToTileCoord(vp, zoom_x, zoom_y);

   370

   371

	pt.y = pt.x = -1;

   372

	return pt;

   373

}

   374

   375

Point GetTileBelowCursor()

   376

{

   377

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

   378

}

   379

   380

   381

Point GetTileZoomCenterWindow(bool in, Window * w)

   382

{

   383

	int x, y;

   384

	ViewPort * vp;

   385

   386

	vp = w->viewport;

   387

   388

	if (in) {

   389

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

   390

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

   391

	} else {

   392

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

   393

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

   394

	}

   395

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

   396

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

   397

}

   398

   399

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

   400

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

   401

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

   402

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

   403

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

   404

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

   405

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

   406

{

   407

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

   408

	InvalidateWidget(w, widget_zoom_in);

   409

   410

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

   411

	InvalidateWidget(w, widget_zoom_out);

   412

}

   413

   414

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

   415

{

   416

	ViewportDrawer *vd = _cur_vd;

   417

	TileSpriteToDraw *ts;

   418

   419

	assert((image & SPRITE_MASK) < MAX_SPRITES);

   420

   421

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

   422

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

   423

		return;

   424

	}

   425

	ts = (TileSpriteToDraw*)vd->spritelist_mem;

   426

   427

	vd->spritelist_mem += sizeof(TileSpriteToDraw);

   428

   429

	ts->image = image;

   430

	ts->pal = pal;

   431

	ts->next = NULL;

   432

	ts->x = x;

   433

	ts->y = y;

   434

	ts->z = z;

   435

	*vd->last_tile = ts;

   436

	vd->last_tile = &ts->next;

   437

}

   438

   439

void DrawGroundSprite(SpriteID image, SpriteID pal)

   440

{

   441

	if (_offset_ground_sprites) {

   442

		/* offset ground sprite because of foundation? */

   443

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

   444

	} else {

   445

		_added_tile_sprite = true;

   446

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

   447

	}

   448

}

   449

   450

   451

void OffsetGroundSprite(int x, int y)

   452

{

   453

	_cur_vd->offs_x = x;

   454

	_cur_vd->offs_y = y;

   455

	_offset_ground_sprites = true;

   456

}

   457

   458

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

   459

{

   460

	const ViewportDrawer *vd = _cur_vd;

   461

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

   462

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

   463

   464

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

   465

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

   466

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

   467

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

   468

		return;

   469

   470

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

   471

}

   472

   473

   474

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

   475

{

   476

	ViewportDrawer *vd = _cur_vd;

   477

	ParentSpriteToDraw *ps;

   478

	const Sprite *spr;

   479

	Point pt;

   480

   481

	assert((image & SPRITE_MASK) < MAX_SPRITES);

   482

   483

	if (vd->combine_sprites == 2) {

   484

		AddCombinedSprite(image, pal, x, y, z);

   485

		return;

   486

	}

   487

   488

	vd->last_child = NULL;

   489

   490

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

   491

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

   492

		return;

   493

	}

   494

	ps = (ParentSpriteToDraw*)vd->spritelist_mem;

   495

   496

	if (vd->parent_list >= vd->eof_parent_list) {

   497

		/* This can happen rarely, mostly when you zoom out completely

   498

		 *  and have a lot of stuff that moves (and is added to the

   499

		 *  sort-list, this function). To solve it, increase

   500

		 *  parent_list somewhere below to a higher number.