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"

    27

    28

#define VIEWPORT_DRAW_MEM (65536 * 2)

    29

    30

ZoomLevel _saved_scrollpos_zoom;

    31

    32

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

    33

static ViewPort _viewports[25 - 2];

    34

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

    35

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

    36

    37

static bool _added_tile_sprite;

    38

static bool _offset_ground_sprites;

    39

    40

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

    41

 *                                               *

    42

 *                    ^ Z                        *

    43

 *                    |                          *

    44

 *                    |                          *

    45

 *                    |                          *

    46

 *                    |                          *

    47

 *                 /     \                       *

    48

 *              /           \                    *

    49

 *           /                 \                 *

    50

 *        /                       \              *

    51

 *   X <                             > Y         *

    52

 */

    53

    54

struct StringSpriteToDraw {

    55

	uint16 string;

    56

	uint16 color;

    57

	StringSpriteToDraw *next;

    58

	int32 x;

    59

	int32 y;

    60

	uint32 params[2];

    61

	uint16 width;

    62

};

    63

    64

struct TileSpriteToDraw {

    65

	SpriteID image;

    66

	SpriteID pal;

    67

	TileSpriteToDraw *next;

    68

	int32 x;

    69

	int32 y;

    70

	byte z;

    71

};

    72

    73

struct ChildScreenSpriteToDraw {

    74

	SpriteID image;

    75

	SpriteID pal;

    76

	int32 x;

    77

	int32 y;

    78

	ChildScreenSpriteToDraw *next;

    79

};

    80

    81

struct ParentSpriteToDraw {

    82

	SpriteID image;

    83

	SpriteID pal;

    84

	int32 left;

    85

	int32 top;

    86

	int32 right;

    87

	int32 bottom;

    88

	int32 xmin;

    89

	int32 ymin;

    90

	int32 xmax;

    91

	int32 ymax;

    92

	ChildScreenSpriteToDraw *child;

    93

	byte unk16;

    94

	byte zmin;

    95

	byte zmax;

    96

};

    97

    98

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

    99

 * to prevent a buffer overflow. */

   100

#define LARGEST_SPRITELIST_STRUCT ParentSpriteToDraw

   101

   102

struct ViewportDrawer {

   103

	DrawPixelInfo dpi;

   104

   105

	byte *spritelist_mem;

   106

	const byte *eof_spritelist_mem;

   107

   108

	StringSpriteToDraw **last_string, *first_string;

   109

	TileSpriteToDraw **last_tile, *first_tile;

   110

   111

	ChildScreenSpriteToDraw **last_child;

   112

   113

	ParentSpriteToDraw **parent_list;

   114

	ParentSpriteToDraw * const *eof_parent_list;

   115

   116

	byte combine_sprites;

   117

   118

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

   119

};

   120

   121

static ViewportDrawer *_cur_vd;

   122

   123

TileHighlightData _thd;

   124

static TileInfo *_cur_ti;

   125

   126

extern void SmallMapCenterOnCurrentPos(Window *w);

   127

   128

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

   129

{

   130

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

   131

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

   132

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

   133

	return p;

   134

}

   135

   136

void InitViewports() {

   137

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

   138

	_active_viewports = 0;

   139

}

   140

   141

void DeleteWindowViewport(Window *w)

   142

{

   143

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

   144

	w->viewport->width = 0;

   145

	w->viewport = NULL;

   146

}

   147

   148

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

   149

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

   150

{

   151

	ViewPort *vp;

   152

	Point pt;

   153

	uint32 bit;

   154

   155

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

   156

		assert(vp != endof(_viewports));

   157

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

   158

	}

   159

	SETBIT(_active_viewports, bit);

   160

   161

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

   162

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

   163

	vp->width = width;

   164

	vp->height = height;

   165

   166

	vp->zoom = zoom;

   167

   168

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

   169

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

   170

   171

	if (follow_flags & 0x80000000) {

   172

		const Vehicle *veh;

   173

   174

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

   175

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

   176

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

   177

	} else {

   178

		uint x = TileX(follow_flags) * TILE_SIZE;

   179

		uint y = TileY(follow_flags) * TILE_SIZE;

   180

   181

		WP(w, vp_d).follow_vehicle = INVALID_VEHICLE;

   182

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

   183

	}

   184

   185

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

   186

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

   187

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

   188

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

   189

   190

	w->viewport = vp;

   191

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

   192

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

   193

}

   194

   195

static Point _vp_move_offs;

   196

   197

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

   198

{

   199

   200

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

   201

		const Window *w = *wz;

   202

   203

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

   204

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

   205

				top + height > w->top &&

   206

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

   207

   208

			if (left < w->left) {

   209

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

   210

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

   211

				return;

   212

			}

   213

   214

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

   215

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

   216

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

   217

				return;

   218

			}

   219

   220

			if (top < w->top) {

   221

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

   222

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

   223

				return;

   224

			}

   225

   226

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

   227

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

   228

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

   229

				return;

   230

			}

   231

   232

			return;

   233

		}

   234

	}

   235

   236

	{

   237

		int xo = _vp_move_offs.x;

   238

		int yo = _vp_move_offs.y;

   239

   240

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

   241

			/* fully_outside */

   242

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

   243

			return;

   244

		}

   245

   246

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

   247

   248

		if (xo > 0) {

   249

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

   250

			left += xo;

   251

			width -= xo;

   252

		} else if (xo < 0) {

   253

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

   254

			width += xo;

   255

		}

   256

   257

		if (yo > 0) {

   258

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

   259

		} else if (yo < 0) {

   260

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

   261

		}

   262

	}

   263

}

   264

   265

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

   266

{

   267

	ViewPort *vp = w->viewport;

   268

	int old_left = vp->virtual_left;

   269

	int old_top = vp->virtual_top;

   270

	int i;

   271

	int left, top, width, height;

   272

   273

	vp->virtual_left = x;

   274

	vp->virtual_top = y;

   275

   276

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

   277

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

   278

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

   279

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

   280

   281

	old_left -= x;

   282

	old_top -= y;

   283

   284

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

   285

   286

	_vp_move_offs.x = old_left;

   287

	_vp_move_offs.y = old_top;

   288

   289

	left = vp->left;

   290

	top = vp->top;

   291

	width = vp->width;

   292

	height = vp->height;

   293

   294

	if (left < 0) {

   295

		width += left;

   296

		left = 0;

   297

	}

   298

   299

	i = left + width - _screen.width;

   300

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

   301

   302

	if (width > 0) {

   303

		if (top < 0) {

   304

			height += top;

   305

			top = 0;

   306

		}

   307

   308

		i = top + height - _screen.height;

   309

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

   310

   311

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

   312

	}

   313

}

   314

   315

   316

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

   317

{

   318

	ViewPort *vp = w->viewport;

   319

   320

	if (vp != NULL &&

   321

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

   322

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

   323

		return vp;

   324

   325

	return NULL;

   326

}

   327

   328

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

   329

{

   330

	Point pt;

   331

	int a,b;

   332

	uint z;

   333

   334

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

   335

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

   336

				Point pt = {-1, -1};

   337

				return pt;

   338

	}

   339

   340

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

   341

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

   342

   343

	a = y-x;

   344

	b = y+x;

   345

   346

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

   347

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

   348

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

   349

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

   350

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

   351

   352

	z = GetSlopeZ(a,     b    ) / 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

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

   357

   358

	pt.x = a + z;

   359

	pt.y = b + z;

   360

   361

	return pt;

   362

}

   363

   364

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

   365

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

   366

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

   367

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

   368

{

   369

	Window *w;

   370

	ViewPort *vp;

   371

	Point pt;

   372

   373

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

   374

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

   375

				return TranslateXYToTileCoord(vp, zoom_x, zoom_y);

   376

   377

	pt.y = pt.x = -1;

   378

	return pt;

   379

}

   380

   381

Point GetTileBelowCursor()

   382

{

   383

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

   384

}

   385

   386

   387

Point GetTileZoomCenterWindow(bool in, Window * w)

   388

{

   389

	int x, y;

   390

	ViewPort * vp;

   391

   392

	vp = w->viewport;

   393

   394

	if (in) {

   395

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

   396

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

   397

	} else {

   398

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

   399

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

   400

	}

   401

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

   402

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

   403

}

   404

   405

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

   406

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

   407

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

   408

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

   409

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

   410

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

   411

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

   412

{

   413

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

   414

	InvalidateWidget(w, widget_zoom_in);

   415

   416

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

   417

	InvalidateWidget(w, widget_zoom_out);

   418

}

   419

   420

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

   421

{

   422

	ViewportDrawer *vd = _cur_vd;

   423

	TileSpriteToDraw *ts;

   424

   425

	assert((image & SPRITE_MASK) < MAX_SPRITES);

   426

   427

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

   428

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

   429

		return;

   430

	}

   431

	ts = (TileSpriteToDraw*)vd->spritelist_mem;

   432

   433

	vd->spritelist_mem += sizeof(TileSpriteToDraw);

   434

   435

	ts->image = image;

   436

	ts->pal = pal;

   437

	ts->next = NULL;

   438

	ts->x = x;

   439

	ts->y = y;

   440

	ts->z = z;

   441

	*vd->last_tile = ts;

   442

	vd->last_tile = &ts->next;

   443

}

   444

   445

void DrawGroundSprite(SpriteID image, SpriteID pal)

   446

{

   447

	if (_offset_ground_sprites) {

   448

		/* offset ground sprite because of foundation? */

   449

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

   450

	} else {

   451

		_added_tile_sprite = true;

   452

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

   453

	}

   454

}

   455

   456

   457

void OffsetGroundSprite(int x, int y)

   458

{

   459

	_cur_vd->offs_x = x;

   460

	_cur_vd->offs_y = y;

   461

	_offset_ground_sprites = true;

   462

}

   463

   464

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

   465

{

   466

	const ViewportDrawer *vd = _cur_vd;

   467

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

   468

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

   469

   470

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

   471

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

   472

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

   473

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

   474

		return;

   475

   476

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

   477

}

   478

   479

   480

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

   481

{

   482

	ViewportDrawer *vd = _cur_vd;

   483

	ParentSpriteToDraw *ps;

   484

	const Sprite *spr;

   485

	Point pt;

   486

   487

	assert((image & SPRITE_MASK) < MAX_SPRITES);

   488

   489

	if (vd->combine_sprites == 2) {

   490

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

   491

		return;

   492

	}

   493

   494

	vd->last_child = NULL;

   495

   496

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

   497

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

   498

		return;

   499

	}