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

    30

#define VIEWPORT_DRAW_MEM (65536 * 2)

    31

    32

ZoomLevel _saved_scrollpos_zoom;

    33

    34

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

    35

static ViewPort _viewports[25 - 2];

    36

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

    37

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

    38

    39

static bool _added_tile_sprite;

    40

static bool _offset_ground_sprites;

    41

    42

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

    43

 *                                               *

    44

 *                    ^ Z                        *

    45

 *                    |                          *

    46

 *                    |                          *

    47

 *                    |                          *

    48

 *                    |                          *

    49

 *                 /     \                       *

    50

 *              /           \                    *

    51

 *           /                 \                 *

    52

 *        /                       \              *

    53

 *   X <                             > Y         *

    54

 */

    55

    56

struct StringSpriteToDraw {

    57

	uint16 string;

    58

	uint16 color;

    59

	StringSpriteToDraw *next;

    60

	int32 x;

    61

	int32 y;

    62

	uint64 params[2];

    63

	uint16 width;

    64

};

    65

    66

struct TileSpriteToDraw {

    67

	SpriteID image;

    68

	SpriteID pal;

    69

	TileSpriteToDraw *next;

    70

	int32 x;

    71

	int32 y;

    72

	byte z;

    73

};

    74

    75

struct ChildScreenSpriteToDraw {

    76

	SpriteID image;

    77

	SpriteID pal;

    78

	int32 x;

    79

	int32 y;

    80

	ChildScreenSpriteToDraw *next;

    81

};

    82

    83

struct ParentSpriteToDraw {

    84

	SpriteID image;                 ///< sprite to draw

    85

	SpriteID pal;                   ///< palette to use

    86

    87

	int32 x;                        ///< screen X coordinate of sprite

    88

	int32 y;                        ///< screen Y coordinate of sprite

    89

    90

	int32 left;                     ///< minimal screen X coordinate of sprite (= x + sprite->x_offs), reference point for child sprites

    91

	int32 top;                      ///< minimal screen Y coordinate of sprite (= y + sprite->y_offs), reference point for child sprites

    92

    93

	int32 xmin;                     ///< minimal world X coordinate of bounding box

    94

	int32 xmax;                     ///< maximal world X coordinate of bounding box

    95

	int32 ymin;                     ///< minimal world Y coordinate of bounding box

    96

	int32 ymax;                     ///< maximal world Y coordinate of bounding box

    97

	int zmin;                       ///< minimal world Z coordinate of bounding box

    98

	int zmax;                       ///< maximal world Z coordinate of bounding box

    99

   100

	ChildScreenSpriteToDraw *child; ///< head of child list;

   101

	bool comparison_done;           ///< Used during sprite sorting: true if sprite has been compared with all other sprites

   102

};

   103

   104

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

   105

 * to prevent a buffer overflow. */

   106

#define LARGEST_SPRITELIST_STRUCT ParentSpriteToDraw

   107

assert_compile(sizeof(LARGEST_SPRITELIST_STRUCT) >= sizeof(StringSpriteToDraw));

   108

assert_compile(sizeof(LARGEST_SPRITELIST_STRUCT) >= sizeof(TileSpriteToDraw));

   109

assert_compile(sizeof(LARGEST_SPRITELIST_STRUCT) >= sizeof(ChildScreenSpriteToDraw));

   110

assert_compile(sizeof(LARGEST_SPRITELIST_STRUCT) >= sizeof(ParentSpriteToDraw));

   111

   112

struct ViewportDrawer {

   113

	DrawPixelInfo dpi;

   114

   115

	byte *spritelist_mem;

   116

	const byte *eof_spritelist_mem;

   117

   118

	StringSpriteToDraw **last_string, *first_string;

   119

	TileSpriteToDraw **last_tile, *first_tile;

   120

   121

	ChildScreenSpriteToDraw **last_child;

   122

   123

	ParentSpriteToDraw **parent_list;

   124

	ParentSpriteToDraw * const *eof_parent_list;

   125

   126

	byte combine_sprites;

   127

   128

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

   129

};

   130

   131

static ViewportDrawer *_cur_vd;

   132

   133

TileHighlightData _thd;

   134

static TileInfo *_cur_ti;

   135

   136

extern void SmallMapCenterOnCurrentPos(Window *w);

   137

   138

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

   139

{

   140

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

   141

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

   142

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

   143

	return p;

   144

}

   145

   146

void InitViewports()

   147

{

   148

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

   149

	_active_viewports = 0;

   150

}

   151

   152

void DeleteWindowViewport(Window *w)

   153

{

   154

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

   155

	w->viewport->width = 0;

   156

	w->viewport = NULL;

   157

}

   158

   159

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

   160

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

   161

{

   162

	ViewPort *vp;

   163

	Point pt;

   164

	uint32 bit;

   165

   166

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

   167

		assert(vp != endof(_viewports));

   168

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

   169

	}

   170

	SETBIT(_active_viewports, bit);

   171

   172

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

   173

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

   174

	vp->width = width;

   175

	vp->height = height;

   176

   177

	vp->zoom = zoom;

   178

   179

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

   180

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

   181

   182

	if (follow_flags & 0x80000000) {

   183

		const Vehicle *veh;

   184

   185

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

   186

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

   187

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

   188

	} else {

   189

		uint x = TileX(follow_flags) * TILE_SIZE;

   190

		uint y = TileY(follow_flags) * TILE_SIZE;

   191

   192

		WP(w, vp_d).follow_vehicle = INVALID_VEHICLE;

   193

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

   194

	}

   195

   196

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

   197

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

   198

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

   199

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

   200

   201

	w->viewport = vp;

   202

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

   203

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

   204

}

   205

   206

static Point _vp_move_offs;

   207

   208

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

   209

{

   210

   211

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

   212

		const Window *w = *wz;

   213

   214

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

   215

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

   216

				top + height > w->top &&

   217

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

   218

   219

			if (left < w->left) {

   220

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

   221

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

   222

				return;

   223

			}

   224

   225

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

   226

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

   227

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

   228

				return;

   229

			}

   230

   231

			if (top < w->top) {

   232

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

   233

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

   234

				return;

   235

			}

   236

   237

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

   238

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

   239

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

   240

				return;

   241

			}

   242

   243

			return;

   244

		}

   245

	}

   246

   247

	{

   248

		int xo = _vp_move_offs.x;

   249

		int yo = _vp_move_offs.y;

   250

   251

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

   252

			/* fully_outside */

   253

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

   254

			return;

   255

		}

   256

   257

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

   258

   259

		if (xo > 0) {

   260

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

   261

			left += xo;

   262

			width -= xo;

   263

		} else if (xo < 0) {

   264

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

   265

			width += xo;

   266

		}

   267

   268

		if (yo > 0) {

   269

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

   270

		} else if (yo < 0) {

   271

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

   272

		}

   273

	}

   274

}

   275

   276

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

   277

{

   278

	ViewPort *vp = w->viewport;

   279

	int old_left = vp->virtual_left;

   280

	int old_top = vp->virtual_top;

   281

	int i;

   282

	int left, top, width, height;

   283

   284

	vp->virtual_left = x;

   285

	vp->virtual_top = y;

   286

   287

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

   288

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

   289

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

   290

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

   291

   292

	old_left -= x;

   293

	old_top -= y;

   294

   295

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

   296

   297

	_vp_move_offs.x = old_left;

   298

	_vp_move_offs.y = old_top;

   299

   300

	left = vp->left;

   301

	top = vp->top;

   302

	width = vp->width;

   303

	height = vp->height;

   304

   305

	if (left < 0) {

   306

		width += left;

   307

		left = 0;

   308

	}

   309

   310

	i = left + width - _screen.width;

   311

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

   312

   313

	if (width > 0) {

   314

		if (top < 0) {

   315

			height += top;

   316

			top = 0;

   317

		}

   318

   319

		i = top + height - _screen.height;

   320

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

   321

   322

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

   323

	}

   324

}

   325

   326

   327

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

   328

{

   329

	ViewPort *vp = w->viewport;

   330

   331

	if (vp != NULL &&

   332

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

   333

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

   334

		return vp;

   335

   336

	return NULL;

   337

}

   338

   339

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

   340

{

   341

	Point pt;

   342

	int a,b;

   343

	uint z;

   344

   345

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

   346

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

   347

				Point pt = {-1, -1};

   348

				return pt;

   349

	}

   350

   351

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

   352

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

   353

   354

	a = y-x;

   355

	b = y+x;

   356

   357

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

   358

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

   359

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

   360

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

   361

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

   362

   363

	z = GetSlopeZ(a,     b    ) / 2;

   364

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

   365

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

   366

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

   367

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

   368

   369

	pt.x = a + z;

   370

	pt.y = b + z;

   371

   372

	return pt;

   373

}

   374

   375

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

   376

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

   377

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

   378

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

   379

{

   380

	Window *w;

   381

	ViewPort *vp;

   382

	Point pt;

   383

   384

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

   385

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

   386

				return TranslateXYToTileCoord(vp, zoom_x, zoom_y);

   387

   388

	pt.y = pt.x = -1;

   389

	return pt;

   390

}

   391

   392

Point GetTileBelowCursor()

   393

{

   394

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

   395

}

   396

   397

   398

Point GetTileZoomCenterWindow(bool in, Window * w)

   399

{

   400

	int x, y;

   401

	ViewPort * vp;

   402

   403

	vp = w->viewport;

   404

   405

	if (in) {

   406

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

   407

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

   408

	} else {

   409

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

   410

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

   411

	}

   412

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

   413

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

   414

}

   415

   416

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

   417

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

   418

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

   419

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

   420

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

   421

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

   422

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

   423

{

   424

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

   425

	InvalidateWidget(w, widget_zoom_in);

   426

   427

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

   428

	InvalidateWidget(w, widget_zoom_out);

   429

}

   430

   431

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

   432

{

   433

	ViewportDrawer *vd = _cur_vd;

   434

	TileSpriteToDraw *ts;

   435

   436

	assert((image & SPRITE_MASK) < MAX_SPRITES);

   437

   438

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

   439

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

   440

		return;

   441

	}

   442

	ts = (TileSpriteToDraw*)vd->spritelist_mem;

   443

   444

	vd->spritelist_mem += sizeof(TileSpriteToDraw);

   445

   446

	ts->image = image;

   447

	ts->pal = pal;

   448

	ts->next = NULL;

   449

	ts->x = x;

   450

	ts->y = y;

   451

	ts->z = z;

   452

	*vd->last_tile = ts;

   453

	vd->last_tile = &ts->next;

   454

}

   455

   456

void DrawGroundSprite(SpriteID image, SpriteID pal)

   457

{

   458

	if (_offset_ground_sprites) {

   459

		/* offset ground sprite because of foundation? */

   460

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

   461

	} else {

   462

		_added_tile_sprite = true;

   463

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

   464

	}

   465

}

   466

   467

   468

void OffsetGroundSprite(int x, int y)

   469

{

   470

	_cur_vd->offs_x = x;

   471

	_cur_vd->offs_y = y;

   472

	_offset_ground_sprites = true;

   473

}

   474

   475

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

   476

{

   477

	const ViewportDrawer *vd = _cur_vd;

   478

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

   479

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

   480

   481

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

   482

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

   483

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

   484

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

   485

		return;

   486

   487

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

   488

}

   489

   490

/** Draw a (transparent) sprite at given coordinates with a given bounding box.

   491

 * The bounding box extends from (x + bb_offset_x, y + bb_offset_y, z + bb_offset_z) to (x + w - 1, y + h - 1, z + dz - 1), both corners included.

   492

 * Bounding boxes with bb_offset_x == w or bb_offset_y == h or bb_offset_z == dz are allowed and produce thin slices.

   493

 *

   494

 * @note Bounding boxes are normally specified with bb_offset_x = bb_offset_y = bb_offset_z = 0. The extent of the bounding box in negative direction is

   495

 *       defined by the sprite offset in the grf file.

   496

 *       However if modifying the sprite offsets is not suitable (e.g. when using existing graphics), the bounding box can be tuned by bb_offset.

   497

 *

   498

 * @pre w >= bb_offset_x, h >= bb_offset_y, dz >= bb_offset_z. Else w, h or dz are ignored.