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"

    28

    29

#define VIEWPORT_DRAW_MEM (65536 * 2)

    30

    31

ZoomLevel _saved_scrollpos_zoom;

    32

    33

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

    34

static ViewPort _viewports[25 - 2];

    35

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

    36

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

    37

    38

static bool _added_tile_sprite;

    39

static bool _offset_ground_sprites;

    40

    41

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

    42

 *                                               *

    43

 *                    ^ Z                        *

    44

 *                    |                          *

    45

 *                    |                          *

    46

 *                    |                          *

    47

 *                    |                          *

    48

 *                 /     \                       *

    49

 *              /           \                    *

    50

 *           /                 \                 *

    51

 *        /                       \              *

    52

 *   X <                             > Y         *

    53

 */

    54

    55

struct StringSpriteToDraw {

    56

	uint16 string;

    57

	uint16 color;

    58

	StringSpriteToDraw *next;

    59

	int32 x;

    60

	int32 y;

    61

	uint32 params[2];

    62

	uint16 width;

    63

};

    64

    65

struct TileSpriteToDraw {

    66

	SpriteID image;

    67

	SpriteID pal;

    68

	TileSpriteToDraw *next;

    69

	int32 x;

    70

	int32 y;

    71

	byte z;

    72

};

    73

    74

struct ChildScreenSpriteToDraw {

    75

	SpriteID image;

    76

	SpriteID pal;

    77

	int32 x;

    78

	int32 y;

    79

	ChildScreenSpriteToDraw *next;

    80

};

    81

    82

struct ParentSpriteToDraw {

    83

	SpriteID image;

    84

	SpriteID pal;

    85

	int32 left;

    86

	int32 top;

    87

	int32 right;

    88

	int32 bottom;

    89

	int32 xmin;

    90

	int32 ymin;

    91

	int32 xmax;

    92

	int32 ymax;

    93

	ChildScreenSpriteToDraw *child;

    94

	byte unk16;

    95

	byte zmin;

    96

	byte zmax;

    97

};

    98

    99

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

   100

 * to prevent a buffer overflow. */

   101

#define LARGEST_SPRITELIST_STRUCT ParentSpriteToDraw

   102

   103

struct ViewportDrawer {

   104

	DrawPixelInfo dpi;

   105

   106

	byte *spritelist_mem;

   107

	const byte *eof_spritelist_mem;

   108

   109

	StringSpriteToDraw **last_string, *first_string;

   110

	TileSpriteToDraw **last_tile, *first_tile;

   111

   112

	ChildScreenSpriteToDraw **last_child;

   113

   114

	ParentSpriteToDraw **parent_list;

   115

	ParentSpriteToDraw * const *eof_parent_list;

   116

   117

	byte combine_sprites;

   118

   119

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

   120

};

   121

   122

static ViewportDrawer *_cur_vd;

   123

   124

TileHighlightData _thd;

   125

static TileInfo *_cur_ti;

   126

   127

extern void SmallMapCenterOnCurrentPos(Window *w);

   128

   129

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

   130

{

   131

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

   132

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

   133

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

   134

	return p;

   135

}

   136

   137

void InitViewports() {

   138

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

   139

	_active_viewports = 0;

   140

}

   141

   142

void DeleteWindowViewport(Window *w)

   143

{

   144

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

   145

	w->viewport->width = 0;

   146

	w->viewport = NULL;

   147

}

   148

   149

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

   150

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

   151

{

   152

	ViewPort *vp;

   153

	Point pt;

   154

	uint32 bit;

   155

   156

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

   157

		assert(vp != endof(_viewports));

   158

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

   159

	}

   160

	SETBIT(_active_viewports, bit);

   161

   162

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

   163

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

   164

	vp->width = width;

   165

	vp->height = height;

   166

   167

	vp->zoom = zoom;

   168

   169

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

   170

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

   171

   172

	if (follow_flags & 0x80000000) {

   173

		const Vehicle *veh;

   174

   175

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

   176

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

   177

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

   178

	} else {

   179

		uint x = TileX(follow_flags) * TILE_SIZE;

   180

		uint y = TileY(follow_flags) * TILE_SIZE;

   181

   182

		WP(w, vp_d).follow_vehicle = INVALID_VEHICLE;

   183

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

   184

	}

   185

   186

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

   187

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

   188

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

   189

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

   190

   191

	w->viewport = vp;

   192

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

   193

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

   194

}

   195

   196

static Point _vp_move_offs;

   197

   198

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

   199

{

   200

   201

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

   202

		const Window *w = *wz;

   203

   204

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

   205

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

   206

				top + height > w->top &&

   207

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

   208

   209

			if (left < w->left) {

   210

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

   211

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

   212

				return;

   213

			}

   214

   215

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

   216

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

   217

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

   218

				return;

   219

			}

   220

   221

			if (top < w->top) {

   222

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

   223

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

   224

				return;

   225

			}

   226

   227

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

   228

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

   229

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

   230

				return;

   231

			}

   232

   233

			return;

   234

		}

   235

	}

   236

   237

	{

   238

		int xo = _vp_move_offs.x;

   239

		int yo = _vp_move_offs.y;

   240

   241

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

   242

			/* fully_outside */

   243

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

   244

			return;

   245

		}

   246

   247

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

   248

   249

		if (xo > 0) {

   250

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

   251

			left += xo;

   252

			width -= xo;

   253

		} else if (xo < 0) {

   254

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

   255

			width += xo;

   256

		}

   257

   258

		if (yo > 0) {

   259

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

   260

		} else if (yo < 0) {

   261

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

   262

		}

   263

	}

   264

}

   265

   266

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

   267

{

   268

	ViewPort *vp = w->viewport;

   269

	int old_left = vp->virtual_left;

   270

	int old_top = vp->virtual_top;

   271

	int i;

   272

	int left, top, width, height;

   273

   274

	vp->virtual_left = x;

   275

	vp->virtual_top = y;

   276

   277

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

   278

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

   279

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

   280

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

   281

   282

	old_left -= x;

   283

	old_top -= y;

   284

   285

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

   286

   287

	_vp_move_offs.x = old_left;

   288

	_vp_move_offs.y = old_top;

   289

   290

	left = vp->left;

   291

	top = vp->top;

   292

	width = vp->width;

   293

	height = vp->height;

   294

   295

	if (left < 0) {

   296

		width += left;

   297

		left = 0;

   298

	}

   299

   300

	i = left + width - _screen.width;

   301

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

   302

   303

	if (width > 0) {

   304

		if (top < 0) {

   305

			height += top;

   306

			top = 0;

   307

		}

   308

   309

		i = top + height - _screen.height;

   310

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

   311

   312

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

   313

	}

   314

}

   315

   316

   317

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

   318

{

   319

	ViewPort *vp = w->viewport;

   320

   321

	if (vp != NULL &&

   322

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

   323

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

   324

		return vp;

   325

   326

	return NULL;

   327

}

   328

   329

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

   330

{

   331

	Point pt;

   332

	int a,b;

   333

	uint z;

   334

   335

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

   336

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

   337

				Point pt = {-1, -1};

   338

				return pt;

   339

	}

   340

   341

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

   342

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

   343

   344

	a = y-x;

   345

	b = y+x;

   346

   347

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

   348

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

   349

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

   350

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

   351

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

   352

   353

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

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

   358

   359

	pt.x = a + z;

   360

	pt.y = b + z;

   361

   362

	return pt;

   363

}

   364

   365

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

   366

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

   367

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

   368

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

   369

{

   370

	Window *w;

   371

	ViewPort *vp;

   372

	Point pt;

   373

   374

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

   375

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

   376

				return TranslateXYToTileCoord(vp, zoom_x, zoom_y);

   377

   378

	pt.y = pt.x = -1;

   379

	return pt;

   380

}

   381

   382

Point GetTileBelowCursor()

   383

{

   384

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

   385

}

   386

   387

   388

Point GetTileZoomCenterWindow(bool in, Window * w)

   389

{

   390

	int x, y;

   391

	ViewPort * vp;

   392

   393

	vp = w->viewport;

   394

   395

	if (in) {

   396

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

   397

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

   398

	} else {

   399

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

   400

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

   401

	}

   402

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

   403

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

   404

}

   405

   406

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

   407

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

   408

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

   409

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

   410

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

   411

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

   412

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

   413

{

   414

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

   415

	InvalidateWidget(w, widget_zoom_in);

   416

   417

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

   418

	InvalidateWidget(w, widget_zoom_out);

   419

}

   420

   421

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

   422

{

   423

	ViewportDrawer *vd = _cur_vd;

   424

	TileSpriteToDraw *ts;

   425

   426

	assert((image & SPRITE_MASK) < MAX_SPRITES);

   427

   428

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

   429

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

   430

		return;

   431

	}

   432

	ts = (TileSpriteToDraw*)vd->spritelist_mem;

   433

   434

	vd->spritelist_mem += sizeof(TileSpriteToDraw);

   435

   436

	ts->image = image;

   437

	ts->pal = pal;

   438

	ts->next = NULL;

   439

	ts->x = x;

   440

	ts->y = y;

   441

	ts->z = z;

   442

	*vd->last_tile = ts;

   443

	vd->last_tile = &ts->next;

   444

}

   445

   446

void DrawGroundSprite(SpriteID image, SpriteID pal)

   447

{

   448

	if (_offset_ground_sprites) {

   449

		/* offset ground sprite because of foundation? */

   450

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

   451

	} else {

   452

		_added_tile_sprite = true;

   453

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

   454

	}

   455

}

   456

   457

   458

void OffsetGroundSprite(int x, int y)

   459

{

   460

	_cur_vd->offs_x = x;

   461

	_cur_vd->offs_y = y;

   462

	_offset_ground_sprites = true;

   463

}

   464

   465

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

   466

{

   467

	const ViewportDrawer *vd = _cur_vd;

   468

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

   469

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

   470

   471

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

   472

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

   473

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

   474

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

   475

		return;

   476

   477

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

   478

}

   479

   480

   481

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

   482

{

   483

	ViewportDrawer *vd = _cur_vd;

   484

	ParentSpriteToDraw *ps;

   485

	const Sprite *spr;

   486

	Point pt;

   487

   488

	assert((image & SPRITE_MASK) < MAX_SPRITES);

   489

   490

	if (vd->combine_sprites == 2) {

   491

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

   492

		return;

   493

	}

   494

   495

	vd->last_child = NULL;

   496

   497

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

   498

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

   499

		return;