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

ZoomLevel _saved_scrollpos_zoom;

    30

    31

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

    32

static ViewPort _viewports[25 - 2];

    33

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

    34

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

    35

    36

static bool _added_tile_sprite;

    37

static bool _offset_ground_sprites;

    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

	uint32 params[2];

    60

	uint16 width;

    61

};

    62

    63

struct TileSpriteToDraw {

    64

	SpriteID image;

    65

	SpriteID pal;

    66

	TileSpriteToDraw *next;

    67

	int32 x;

    68

	int32 y;

    69

	byte z;

    70

};

    71

    72

struct ChildScreenSpriteToDraw {

    73

	SpriteID image;

    74

	SpriteID pal;

    75

	int32 x;

    76

	int32 y;

    77

	ChildScreenSpriteToDraw *next;

    78

};

    79

    80

struct ParentSpriteToDraw {

    81

	SpriteID image;

    82

	SpriteID pal;

    83

	int32 left;

    84

	int32 top;

    85

	int32 right;

    86

	int32 bottom;

    87

	int32 xmin;

    88

	int32 ymin;

    89

	int32 xmax;

    90

	int32 ymax;

    91

	ChildScreenSpriteToDraw *child;

    92

	byte unk16;

    93

	byte zmin;

    94

	byte zmax;

    95

};

    96

    97

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

    98

 * to prevent a buffer overflow. */

    99

#define LARGEST_SPRITELIST_STRUCT ParentSpriteToDraw

   100

   101

struct ViewportDrawer {

   102

	DrawPixelInfo dpi;

   103

   104

	byte *spritelist_mem;

   105

	const byte *eof_spritelist_mem;

   106

   107

	StringSpriteToDraw **last_string, *first_string;

   108

	TileSpriteToDraw **last_tile, *first_tile;

   109

   110

	ChildScreenSpriteToDraw **last_child;

   111

   112

	ParentSpriteToDraw **parent_list;

   113

	ParentSpriteToDraw * const *eof_parent_list;

   114

   115

	byte combine_sprites;

   116

   117

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

   118

};

   119

   120

static ViewportDrawer *_cur_vd;

   121

   122

TileHighlightData _thd;

   123

static TileInfo *_cur_ti;

   124

   125

extern void SmallMapCenterOnCurrentPos(Window *w);

   126

   127

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

   128

{

   129

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

   130

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

   131

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

   132

	return p;

   133

}

   134

   135

void InitViewports() {

   136

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

   137

	_active_viewports = 0;

   138

}

   139

   140

void DeleteWindowViewport(Window *w)

   141

{

   142

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

   143

	w->viewport->width = 0;

   144

	w->viewport = NULL;

   145

}

   146

   147

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

   148

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

   149

{

   150

	ViewPort *vp;

   151

	Point pt;

   152

	uint32 bit;

   153

   154

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

   155

		assert(vp != endof(_viewports));

   156

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

   157

	}

   158

	SETBIT(_active_viewports, bit);

   159

   160

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

   161

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

   162

	vp->width = width;

   163

	vp->height = height;

   164

   165

	vp->zoom = zoom;

   166

   167

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

   168

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

   169

   170

	if (follow_flags & 0x80000000) {

   171

		const Vehicle *veh;

   172

   173

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

   174

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

   175

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

   176

	} else {

   177

		uint x = TileX(follow_flags) * TILE_SIZE;

   178

		uint y = TileY(follow_flags) * TILE_SIZE;

   179

   180

		WP(w, vp_d).follow_vehicle = INVALID_VEHICLE;

   181

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

   182

	}

   183

   184

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

   185

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

   186

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

   187

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

   188

   189

	w->viewport = vp;

   190

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

   191

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

   192

}

   193

   194

static Point _vp_move_offs;

   195

   196

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

   197

{

   198

   199

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

   200

		const Window *w = *wz;

   201

   202

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

   203

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

   204

				top + height > w->top &&

   205

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

   206

   207

			if (left < w->left) {

   208

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

   209

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

   210

				return;

   211

			}

   212

   213

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

   214

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

   215

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

   216

				return;

   217

			}

   218

   219

			if (top < w->top) {

   220

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

   221

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

   222

				return;

   223

			}

   224

   225

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

   226

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

   227

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

   228

				return;

   229

			}

   230

   231

			return;

   232

		}

   233

	}

   234

   235

	{

   236

		int xo = _vp_move_offs.x;

   237

		int yo = _vp_move_offs.y;

   238

   239

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

   240

			/* fully_outside */

   241

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

   242

			return;

   243

		}

   244

   245

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

   246

   247

		if (xo > 0) {

   248

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

   249

			left += xo;

   250

			width -= xo;

   251

		} else if (xo < 0) {

   252

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

   253

			width += xo;

   254

		}

   255

   256

		if (yo > 0) {

   257

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

   258

		} else if (yo < 0) {

   259

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

   260

		}

   261

	}

   262

}

   263

   264

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

   265

{

   266

	ViewPort *vp = w->viewport;

   267

	int old_left = vp->virtual_left;

   268

	int old_top = vp->virtual_top;

   269

	int i;

   270

	int left, top, width, height;

   271

   272

	vp->virtual_left = x;

   273

	vp->virtual_top = y;

   274

   275

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

   276

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

   277

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

   278

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

   279

   280

	old_left -= x;

   281

	old_top -= y;

   282

   283

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

   284

   285

	_vp_move_offs.x = old_left;

   286

	_vp_move_offs.y = old_top;

   287

   288

	left = vp->left;

   289

	top = vp->top;

   290

	width = vp->width;

   291

	height = vp->height;

   292

   293

	if (left < 0) {

   294

		width += left;

   295

		left = 0;

   296

	}

   297

   298

	i = left + width - _screen.width;

   299

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

   300

   301

	if (width > 0) {

   302

		if (top < 0) {

   303

			height += top;

   304

			top = 0;

   305

		}

   306

   307

		i = top + height - _screen.height;

   308

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

   309

   310

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

   311

	}

   312

}

   313

   314

   315

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

   316

{

   317

	ViewPort *vp = w->viewport;

   318

   319

	if (vp != NULL &&

   320

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

   321

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

   322

		return vp;

   323

   324

	return NULL;

   325

}

   326

   327

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

   328

{

   329

	Point pt;

   330

	int a,b;

   331

	uint z;

   332

   333

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

   334

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

   335

				Point pt = {-1, -1};

   336

				return pt;

   337

	}

   338

   339

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

   340

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

   341

   342

	a = y-x;

   343

	b = y+x;

   344

   345

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

   346

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

   347

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

   348

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

   349

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

   350

   351

	z = GetSlopeZ(a,     b    ) / 2;

   352

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

   353

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

   354

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

   355

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

   356

   357

	pt.x = a + z;

   358

	pt.y = b + z;

   359

   360

	return pt;

   361

}

   362

   363

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

   364

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

   365

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

   366

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

   367

{

   368

	Window *w;

   369

	ViewPort *vp;

   370

	Point pt;

   371

   372

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

   373

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

   374

				return TranslateXYToTileCoord(vp, zoom_x, zoom_y);

   375

   376

	pt.y = pt.x = -1;

   377

	return pt;

   378

}

   379

   380

Point GetTileBelowCursor()

   381

{

   382

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

   383

}

   384

   385

   386

Point GetTileZoomCenterWindow(bool in, Window * w)

   387

{

   388

	int x, y;

   389

	ViewPort * vp;

   390

   391

	vp = w->viewport;

   392

   393

	if (in) {

   394

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

   395

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

   396

	} else {

   397

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

   398

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

   399

	}

   400

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

   401

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

   402

}

   403

   404

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

   405

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

   406

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

   407

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

   408

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

   409

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

   410

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

   411

{

   412

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

   413

	InvalidateWidget(w, widget_zoom_in);

   414

   415

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

   416

	InvalidateWidget(w, widget_zoom_out);

   417

}

   418

   419

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

   420

{

   421

	ViewportDrawer *vd = _cur_vd;

   422

	TileSpriteToDraw *ts;

   423

   424

	assert((image & SPRITE_MASK) < MAX_SPRITES);

   425

   426

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

   427

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

   428

		return;

   429

	}

   430

	ts = (TileSpriteToDraw*)vd->spritelist_mem;

   431

   432

	vd->spritelist_mem += sizeof(TileSpriteToDraw);

   433

   434

	ts->image = image;

   435

	ts->pal = pal;

   436

	ts->next = NULL;

   437

	ts->x = x;

   438

	ts->y = y;

   439

	ts->z = z;

   440

	*vd->last_tile = ts;

   441

	vd->last_tile = &ts->next;

   442

}

   443

   444

void DrawGroundSprite(SpriteID image, SpriteID pal)

   445

{

   446

	if (_offset_ground_sprites) {

   447

		/* offset ground sprite because of foundation? */

   448

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

   449

	} else {

   450

		_added_tile_sprite = true;

   451

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

   452

	}

   453

}

   454

   455

   456

void OffsetGroundSprite(int x, int y)

   457

{

   458

	_cur_vd->offs_x = x;

   459

	_cur_vd->offs_y = y;

   460

	_offset_ground_sprites = true;

   461

}

   462

   463

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

   464

{

   465

	const ViewportDrawer *vd = _cur_vd;

   466

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

   467

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

   468

   469

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

   470

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

   471

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

   472

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

   473

		return;

   474

   475

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

   476

}

   477

   478

   479

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

   480

{

   481

	ViewportDrawer *vd = _cur_vd;

   482

	ParentSpriteToDraw *ps;

   483

	const Sprite *spr;

   484

	Point pt;

   485

   486

	assert((image & SPRITE_MASK) < MAX_SPRITES);

   487

   488

	if (vd->combine_sprites == 2) {

   489

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

   490

		return;

   491

	}

   492

   493

	vd->last_child = NULL;

   494

   495

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

   496

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

   497

		return;

   498

	}

   499

	ps = (ParentSpriteToDraw*)vd->spritelist_mem;