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(BaseWindow *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(BaseWindow *w)

   139

{

   140

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

   141

	w->viewport->width = 0;

   142

	w->viewport = NULL;

   143

}

   144

   145

void AssignWindowViewport(BaseWindow *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(WindowList::Iterator vit, int left, int top, int width, int height)

   192

{

   193

	//BaseWindow *w = (*wit).w;

   194

   195

	for (WindowList::Iterator wit = vit; wit != BaseWindow::s_list.m_list.end(); wit++) {

   196

		const BaseWindow *w = (*wit).w;

   197

   198

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

   199

				w->Left() + w->Width() > left &&

   200

				top + height > w->Top() &&

   201

				w->Top() + w->Height() > top) {

   202

   203

			if (left < w->Left()) {

   204

				DoSetViewportPosition(wit, left, top, w->Left() - left, height);

   205

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

   206

				return;

   207

			}

   208

   209

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

   210

				DoSetViewportPosition(wit, left, top, (w->Left() + w->Width() - left), height);

   211

				DoSetViewportPosition(wit, left + (w->Left() + w->Width() - left), top, width - (w->Left() + w->Width() - left) , height);

   212

				return;

   213

			}

   214

   215

			if (top < w->Top()) {

   216

				DoSetViewportPosition(wit, left, top, width, (w->Top() - top));

   217

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

   218

				return;

   219

			}

   220

   221

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

   222

				DoSetViewportPosition(wit, left, top, width, (w->Top() + w->Height() - top));

   223

				DoSetViewportPosition(wit, left, top + (w->Top() + w->Height() - top), width , height - (w->Top() + w->Height() - top));

   224

				return;

   225

			}

   226

   227

			return;

   228

		}

   229

	}

   230

   231

	{

   232

		int xo = _vp_move_offs.x;

   233

		int yo = _vp_move_offs.y;

   234

   235

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

   236

			/* fully_outside */

   237

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

   238

			return;

   239

		}

   240

   241

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

   242

   243

		if (xo > 0) {

   244

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

   245

			left += xo;

   246

			width -= xo;

   247

		} else if (xo < 0) {

   248

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

   249

			width += xo;

   250

		}

   251

   252

		if (yo > 0) {

   253

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

   254

		} else if (yo < 0) {

   255

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

   256

		}

   257

	}

   258

}

   259

   260

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

   261

{

   262

	ViewPort *vp = w->viewport;

   263

	int old_left = vp->virtual_left;

   264

	int old_top = vp->virtual_top;

   265

	int i;

   266

	int left, top, width, height;

   267

   268

	vp->virtual_left = x;

   269

	vp->virtual_top = y;

   270

   271

	old_left >>= vp->zoom;

   272

	old_top >>= vp->zoom;

   273

	x >>= vp->zoom;

   274

	y >>= vp->zoom;

   275

   276

	old_left -= x;

   277

	old_top -= y;

   278

   279

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

   280

   281

	_vp_move_offs.x = old_left;

   282

	_vp_move_offs.y = old_top;

   283

   284

	left = vp->left;

   285

	top = vp->top;

   286

	width = vp->width;

   287

	height = vp->height;

   288

   289

	if (left < 0) {

   290

		width += left;

   291

		left = 0;

   292

	}

   293

   294

	i = left + width - _screen.width;

   295

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

   296

   297

	if (width > 0) {

   298

		if (top < 0) {

   299

			height += top;

   300

			top = 0;

   301

		}

   302

   303

		i = top + height - _screen.height;

   304

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

   305

   306

		WindowList::Iterator it = BaseWindow::s_list.Find(w);

   307

		if (height > 0) DoSetViewportPosition(++it, left, top, width, height);

   308

	}

   309

}

   310

   311

   312

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

   313

{

   314

	ViewPort *vp = w->viewport;

   315

   316

	if (vp != NULL &&

   317

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

   318

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

   319

		return vp;

   320

   321

	return NULL;

   322

}

   323

   324

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

   325

{

   326

	Point pt;

   327

	int a,b;

   328

	uint z;

   329

   330

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

   331

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

   332

				Point pt(-1, -1);

   333

				return pt;

   334

	}

   335

   336

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

   337

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

   338

   339

	a = y-x;

   340

	b = y+x;

   341

   342

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

   343

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

   344

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

   345

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

   346

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

   347

   348

	z = GetSlopeZ(a,     b    ) / 2;

   349

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

   350

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

   351

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

   352

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

   353

   354

	pt.x = a + z;

   355

	pt.y = b + z;

   356

   357

	return pt;

   358

}

   359

   360

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

   361

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

   362

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

   363

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

   364

{

   365

	BaseWindow *w;

   366

	ViewPort *vp;

   367

	Point pt;

   368

   369

	if ( (w = BaseWindow::FindFromPt(x, y)) != NULL &&

   370

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

   371

				return TranslateXYToTileCoord(vp, zoom_x, zoom_y);

   372

   373

	pt.y = pt.x = -1;

   374

	return pt;

   375

}

   376

   377

Point GetTileBelowCursor()

   378

{

   379

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

   380

}

   381

   382

   383

Point GetTileZoomCenterWindow(bool in, BaseWindow * w)

   384

{

   385

	int x, y;

   386

	ViewPort * vp;

   387

   388

	vp = w->viewport;

   389

   390

	if (in) {

   391

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

   392

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

   393

	} else {

   394

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

   395

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

   396

	}

   397

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

   398

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

   399

}

   400

   401

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

   402

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

   403

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

   404

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

   405

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

   406

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

   407

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

   408

{

   409

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

   410

	w->InvalidateWidget(widget_zoom_in);

   411

   412

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

   413

	w->InvalidateWidget(widget_zoom_out);

   414

}

   415

   416

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

   417

{

   418

	ViewportDrawer *vd = _cur_vd;

   419

	TileSpriteToDraw *ts;

   420

   421

	assert((image & SPRITE_MASK) < MAX_SPRITES);

   422

   423

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

   424

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

   425

		return;

   426

	}

   427

	ts = (TileSpriteToDraw*)vd->spritelist_mem;

   428

   429

	vd->spritelist_mem += sizeof(TileSpriteToDraw);

   430

   431

	ts->image = image;

   432

	ts->pal = pal;

   433

	ts->next = NULL;

   434

	ts->x = x;

   435

	ts->y = y;

   436

	ts->z = z;

   437

	*vd->last_tile = ts;

   438

	vd->last_tile = &ts->next;

   439

}

   440

   441

void DrawGroundSprite(SpriteID image, SpriteID pal)

   442

{

   443

	if (_offset_ground_sprites) {

   444

		/* offset ground sprite because of foundation? */

   445

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

   446

	} else {

   447

		_added_tile_sprite = true;

   448

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

   449

	}

   450

}

   451

   452

   453

void OffsetGroundSprite(int x, int y)

   454

{

   455

	_cur_vd->offs_x = x;

   456

	_cur_vd->offs_y = y;

   457

	_offset_ground_sprites = true;

   458

}

   459

   460

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

   461

{

   462

	const ViewportDrawer *vd = _cur_vd;

   463

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

   464

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

   465

   466

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

   467

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

   468

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

   469

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

   470

		return;

   471

   472

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

   473

}

   474

   475

   476

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

   477

{

   478

	ViewportDrawer *vd = _cur_vd;

   479

	ParentSpriteToDraw *ps;

   480

	const Sprite *spr;

   481

	Point pt;

   482

   483

	assert((image & SPRITE_MASK) < MAX_SPRITES);

   484

   485

	if (vd->combine_sprites == 2) {

   486

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

   487

		return;

   488

	}

   489

   490

	vd->last_child = NULL;

   491

   492

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

   493

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

   494

		return;

   495

	}

   496

	ps = (ParentSpriteToDraw*)vd->spritelist_mem;

   497

   498

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

   499

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