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"

    27

#include "vehicle_gui.h"

    28

#include "blitter/factory.hpp"

    29

#include "newgrf_fsmports.h"

    30

    31

#define VIEWPORT_DRAW_MEM (65536 * 2)

    32

    33

ZoomLevel _saved_scrollpos_zoom;

    34

    35

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

    36

static ViewPort _viewports[25 - 2];

    37

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

    38

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

    39

    40

static bool _added_tile_sprite;

    41

static bool _offset_ground_sprites;

    42

    43

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

    44

 *                                               *

    45

 *                    ^ Z                        *

    46

 *                    |                          *

    47

 *                    |                          *

    48

 *                    |                          *

    49

 *                    |                          *

    50

 *                 /     \                       *

    51

 *              /           \                    *

    52

 *           /                 \                 *

    53

 *        /                       \              *

    54

 *   X <                             > Y         *

    55

 */

    56

    57

struct StringSpriteToDraw {

    58

	uint16 string;

    59

	uint16 color;

    60

	StringSpriteToDraw *next;

    61

	int32 x;

    62

	int32 y;

    63

	uint64 params[2];

    64

	uint16 width;

    65

};

    66

    67

struct TileSpriteToDraw {

    68

	SpriteID image;

    69

	SpriteID pal;

    71

	TileSpriteToDraw *next;

    72

	int32 x;

    73

	int32 y;

    74

	byte z;

    75

};

    76

    77

struct ChildScreenSpriteToDraw {

    78

	SpriteID image;

    79

	SpriteID pal;

    81

	int32 x;

    82

	int32 y;

    83

	ChildScreenSpriteToDraw *next;

    84

};

    85

    86

struct ParentSpriteToDraw {

   106

};

   107

   108

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

   109

 * to prevent a buffer overflow. */

   110

#define LARGEST_SPRITELIST_STRUCT ParentSpriteToDraw

   115

   116

struct ViewportDrawer {

   117

	DrawPixelInfo dpi;

   118

   119

	byte *spritelist_mem;

   120

	const byte *eof_spritelist_mem;

   121

   122

	StringSpriteToDraw **last_string, *first_string;

   123

	TileSpriteToDraw **last_tile, *first_tile;

   124

   125

	ChildScreenSpriteToDraw **last_child;

   126

   127

	ParentSpriteToDraw **parent_list;

   128

	ParentSpriteToDraw * const *eof_parent_list;

   129

   130

	byte combine_sprites;

   131

   132

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

   133

};

   134

   135

static ViewportDrawer *_cur_vd;

   136

   137

TileHighlightData _thd;

   138

static TileInfo *_cur_ti;

   139

   140

extern void SmallMapCenterOnCurrentPos(Window *w);

   141

   142

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

   143

{

   144

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

   145

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

   146

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

   147

	return p;

   148

}

   149

   150

void InitViewports()

   151

{

   152

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

   153

	_active_viewports = 0;

   154

}

   155

   156

void DeleteWindowViewport(Window *w)

   157

{

   158

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

   159

	w->viewport->width = 0;

   160

	w->viewport = NULL;

   161

}

   162

   163

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

   164

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

   165

{

   166

	ViewPort *vp;

   167

	Point pt;

   168

	uint32 bit;

   169

   170

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

   171

		assert(vp != endof(_viewports));

   172

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

   173

	}

   174

	SETBIT(_active_viewports, bit);

   175

   176

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

   177

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

   178

	vp->width = width;

   179

	vp->height = height;

   180

   181

	vp->zoom = zoom;

   182

   183

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

   184

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

   185

   186

	if (follow_flags & 0x80000000) {

   187

		const Vehicle *veh;

   188

   189

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

   190

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

   191

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

   192

	} else {

   193

		uint x = TileX(follow_flags) * TILE_SIZE;

   194

		uint y = TileY(follow_flags) * TILE_SIZE;

   195

   196

		WP(w, vp_d).follow_vehicle = INVALID_VEHICLE;

   197

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

   198

	}

   199

   200

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

   201

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

   202

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

   203

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

   204

   205

	w->viewport = vp;

   206

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

   207

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

   208

}

   209

   210

static Point _vp_move_offs;

   211

   212

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

   213

{

   214

   215

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

   216

		const Window *w = *wz;

   217

   218

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

   219

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

   220

				top + height > w->top &&

   221

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

   222

   223

			if (left < w->left) {

   224

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

   225

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

   226

				return;

   227

			}

   228

   229

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

   230

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

   231

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

   232

				return;

   233

			}

   234

   235

			if (top < w->top) {

   236

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

   237

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

   238

				return;

   239

			}

   240

   241

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

   242

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

   243

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

   244

				return;

   245

			}

   246

   247

			return;

   248

		}

   249

	}

   250

   251

	{

   252

		int xo = _vp_move_offs.x;

   253

		int yo = _vp_move_offs.y;

   254

   255

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

   256

			/* fully_outside */

   257

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

   258

			return;

   259

		}

   260

   261

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

   262

   263

		if (xo > 0) {

   264

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

   265

			left += xo;

   266

			width -= xo;

   267

		} else if (xo < 0) {

   268

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

   269

			width += xo;

   270

		}

   271

   272

		if (yo > 0) {

   273

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

   274

		} else if (yo < 0) {

   275

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

   276

		}

   277

	}

   278

}

   279

   280

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

   281

{

   282

	ViewPort *vp = w->viewport;

   283

	int old_left = vp->virtual_left;

   284

	int old_top = vp->virtual_top;

   285

	int i;

   286

	int left, top, width, height;

   287

   288

	vp->virtual_left = x;

   289

	vp->virtual_top = y;

   290

   291

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

   292

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

   293

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

   294

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

   295

   296

	old_left -= x;

   297

	old_top -= y;

   298

   299

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

   300

   301

	_vp_move_offs.x = old_left;

   302

	_vp_move_offs.y = old_top;

   303

   304

	left = vp->left;

   305

	top = vp->top;

   306

	width = vp->width;

   307

	height = vp->height;

   308

   309

	if (left < 0) {

   310

		width += left;

   311

		left = 0;

   312

	}

   313

   314

	i = left + width - _screen.width;

   315

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

   316

   317

	if (width > 0) {

   318

		if (top < 0) {

   319

			height += top;

   320

			top = 0;

   321

		}

   322

   323

		i = top + height - _screen.height;

   324

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

   325

   326

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

   327

	}

   328

}

   329

   330

   331

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

   332

{

   333

	ViewPort *vp = w->viewport;

   334

   335

	if (vp != NULL &&

   336

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

   337

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

   338

		return vp;

   339

   340

	return NULL;

   341

}

   342

   343

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

   344

{

   345

	Point pt;

   346

	int a,b;

   347

	uint z;

   348

   349

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

   350

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

   351

				Point pt = {-1, -1};

   352

				return pt;

   353

	}

   354

   355

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

   356

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

   357

   358

	a = y-x;

   359

	b = y+x;

   360

   361

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

   362

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

   363

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

   364

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

   365

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

   366

   367

	z = GetSlopeZ(a,     b    ) / 2;

   368

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

   369

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

   370

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

   371

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

   372

   373

	pt.x = a + z;

   374

	pt.y = b + z;

   375

   376

	return pt;

   377

}

   378

   379

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

   380

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

   381

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

   382

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

   383

{

   384

	Window *w;

   385

	ViewPort *vp;

   386

	Point pt;

   387

   388

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

   389

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

   390

				return TranslateXYToTileCoord(vp, zoom_x, zoom_y);

   391

   392

	pt.y = pt.x = -1;

   393

	return pt;

   394

}

   395

   396

Point GetTileBelowCursor()

   397

{

   398

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

   399

}

   400

   401

   402

Point GetTileZoomCenterWindow(bool in, Window * w)

   403

{

   404

	int x, y;

   405

	ViewPort * vp;

   406

   407

	vp = w->viewport;

   408

   409

	if (in) {

   410

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

   411

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

   412

	} else {

   413

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

   414

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

   415

	}

   416

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

   417

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

   418

}

   419

   420

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

   421

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

   422

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

   423

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

   424

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

   425

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

   426

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

   427

{

   428

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

   429

	InvalidateWidget(w, widget_zoom_in);

   430

   431

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

   432

	InvalidateWidget(w, widget_zoom_out);

   433

}

   434

   447

{

   448

	ViewportDrawer *vd = _cur_vd;

   449

	TileSpriteToDraw *ts;

   450

   451

	assert((image & SPRITE_MASK) < MAX_SPRITES);

   452

   453

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

   454

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

   455

		return;

   456

	}

   457

	ts = (TileSpriteToDraw*)vd->spritelist_mem;

   458

   459

	vd->spritelist_mem += sizeof(TileSpriteToDraw);

   460

   461

	ts->image = image;

   462

	ts->pal = pal;

   464

	ts->next = NULL;

   465

	ts->x = x;

   466

	ts->y = y;

   467

	ts->z = z;

   468

	*vd->last_tile = ts;

   469

	vd->last_tile = &ts->next;

   470

}

   471

   481

{

   482

	if (_offset_ground_sprites) {

   483

		/* offset ground sprite because of foundation? */

   485

	} else {

   486

		_added_tile_sprite = true;

   488

	}

   489

}

   490

   491

   492

void OffsetGroundSprite(int x, int y)

   493

{

   494

	_cur_vd->offs_x = x;

   495

	_cur_vd->offs_y = y;

   496

	_offset_ground_sprites = true;

   497

}

   498