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

/* 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

	uint64 params[2];

    60

	uint16 width;

    61

};

    62

    63

struct TileSpriteToDraw {

    64

	SpriteID image;

    65

	SpriteID pal;

    66

	const SubSprite *sub;           ///< only draw a rectangular part of the sprite

    67

	TileSpriteToDraw *next;

    68

	int32 x;

    69

	int32 y;

    70

	byte z;

    71

};

    72

    73

struct ChildScreenSpriteToDraw {

    74

	SpriteID image;

    75

	SpriteID pal;

    76

	const SubSprite *sub;           ///< only draw a rectangular part of the sprite

    77

	int32 x;

    78

	int32 y;

    79

	ChildScreenSpriteToDraw *next;

    80

};

    81

    82

struct ParentSpriteToDraw {

    83

	SpriteID image;                 ///< sprite to draw

    84

	SpriteID pal;                   ///< palette to use

    85

	const SubSprite *sub;           ///< only draw a rectangular part of the sprite

    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

	ParentSpriteToDraw *foundation;                      ///< Foundation sprite.

   129

	ChildScreenSpriteToDraw **last_foundation_child;     ///< Tail of ChildSprite list of active foundation.

   130

	Point foundation_offset;                             ///< Pixeloffset of ground sprites on the foundation.

   131

};

   132

   133

static ViewportDrawer *_cur_vd;

   134

   135

TileHighlightData _thd;

   136

static TileInfo *_cur_ti;

   137

   138

extern void SmallMapCenterOnCurrentPos(Window *w);

   139

   140

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

   141

{

   142

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

   143

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

   144

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

   145

	return p;

   146

}

   147

   148

void InitViewports()

   149

{

   150

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

   151

	_active_viewports = 0;

   152

}

   153

   154

void DeleteWindowViewport(Window *w)

   155

{

   156

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

   157

	w->viewport->width = 0;

   158

	w->viewport = NULL;

   159

}

   160

   161

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

   162

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

   163

{

   164

	ViewPort *vp;

   165

	Point pt;

   166

	uint32 bit;

   167

   168

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

   169

		assert(vp != endof(_viewports));

   170

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

   171

	}

   172

	SETBIT(_active_viewports, bit);

   173

   174

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

   175

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

   176

	vp->width = width;

   177

	vp->height = height;

   178

   179

	vp->zoom = zoom;

   180

   181

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

   182

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

   183

   184

	if (follow_flags & 0x80000000) {

   185

		const Vehicle *veh;

   186

   187

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

   188

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

   189

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

   190

	} else {

   191

		uint x = TileX(follow_flags) * TILE_SIZE;

   192

		uint y = TileY(follow_flags) * TILE_SIZE;

   193

   194

		WP(w, vp_d).follow_vehicle = INVALID_VEHICLE;

   195

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

   196

	}

   197

   198

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

   199

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

   200

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

   201

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

   202

   203

	w->viewport = vp;

   204

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

   205

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

   206

}

   207

   208

static Point _vp_move_offs;

   209

   210

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

   211

{

   212

   213

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

   214

		const Window *w = *wz;

   215

   216

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

   217

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

   218

				top + height > w->top &&

   219

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

   220

   221

			if (left < w->left) {

   222

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

   223

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

   224

				return;

   225

			}

   226

   227

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

   228

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

   229

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

   230

				return;

   231

			}

   232

   233

			if (top < w->top) {

   234

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

   235

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

   236

				return;

   237

			}

   238

   239

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

   240

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

   241

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

   242

				return;

   243

			}

   244

   245

			return;

   246

		}

   247

	}

   248

   249

	{

   250

		int xo = _vp_move_offs.x;

   251

		int yo = _vp_move_offs.y;

   252

   253

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

   254

			/* fully_outside */

   255

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

   256

			return;

   257

		}

   258

   259

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

   260

   261

		if (xo > 0) {

   262

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

   263

			left += xo;

   264

			width -= xo;

   265

		} else if (xo < 0) {

   266

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

   267

			width += xo;

   268

		}

   269

   270

		if (yo > 0) {

   271

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

   272

		} else if (yo < 0) {

   273

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

   274

		}

   275

	}

   276

}

   277

   278

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

   279

{

   280

	ViewPort *vp = w->viewport;

   281

	int old_left = vp->virtual_left;

   282

	int old_top = vp->virtual_top;

   283

	int i;

   284

	int left, top, width, height;

   285

   286

	vp->virtual_left = x;

   287

	vp->virtual_top = y;

   288

   289

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

   290

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

   291

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

   292

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

   293

   294

	old_left -= x;

   295

	old_top -= y;

   296

   297

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

   298

   299

	_vp_move_offs.x = old_left;

   300

	_vp_move_offs.y = old_top;

   301

   302

	left = vp->left;

   303

	top = vp->top;

   304

	width = vp->width;

   305

	height = vp->height;

   306

   307

	if (left < 0) {

   308

		width += left;

   309

		left = 0;

   310

	}

   311

   312

	i = left + width - _screen.width;

   313

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

   314

   315

	if (width > 0) {

   316

		if (top < 0) {

   317

			height += top;

   318

			top = 0;

   319

		}

   320

   321

		i = top + height - _screen.height;

   322

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

   323

   324

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

   325

	}

   326

}

   327

   328

   329

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

   330

{

   331

	ViewPort *vp = w->viewport;

   332

   333

	if (vp != NULL &&

   334

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

   335

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

   336

		return vp;

   337

   338

	return NULL;

   339

}

   340

   341

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

   342

{

   343

	Point pt;

   344

	int a,b;

   345

	uint z;

   346

   347

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

   348

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

   349

				Point pt = {-1, -1};

   350

				return pt;

   351

	}

   352

   353

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

   354

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

   355

   356

	a = y-x;

   357

	b = y+x;

   358

   359

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

   360

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

   361

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

   362

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

   363

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

   364

   365

	z = GetSlopeZ(a,     b    ) / 2;

   366

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

   367

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

   368

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

   369

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

   370

   371

	pt.x = a + z;

   372

	pt.y = b + z;

   373

   374

	return pt;

   375

}

   376

   377

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

   378

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

   379

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

   380

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

   381

{

   382

	Window *w;

   383

	ViewPort *vp;

   384

	Point pt;

   385

   386

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

   387

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

   388

				return TranslateXYToTileCoord(vp, zoom_x, zoom_y);

   389

   390

	pt.y = pt.x = -1;

   391

	return pt;

   392

}

   393

   394

Point GetTileBelowCursor()

   395

{

   396

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

   397

}

   398

   399

   400

Point GetTileZoomCenterWindow(bool in, Window * w)

   401

{

   402

	int x, y;

   403

	ViewPort * vp;

   404

   405

	vp = w->viewport;

   406

   407

	if (in) {

   408

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

   409

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

   410

	} else {

   411

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

   412

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

   413

	}

   414

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

   415

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

   416

}

   417

   418

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

   419

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

   420

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

   421

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

   422

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

   423

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

   424

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

   425

{

   426

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

   427

	InvalidateWidget(w, widget_zoom_in);

   428

   429

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

   430

	InvalidateWidget(w, widget_zoom_out);

   431

}

   432

   433

/**

   434

 * Draws a ground sprite at a specific world-coordinate.

   435

 *

   436

 * @param image the image to draw.

   437

 * @param pal the provided palette.

   438

 * @param x position x of the sprite.

   439

 * @param y position y of the sprite.

   440

 * @param z position z of the sprite.

   441

 * @param sub Only draw a part of the sprite.

   442

 *

   443

 */

   444

void DrawGroundSpriteAt(SpriteID image, SpriteID pal, int32 x, int32 y, byte z, const SubSprite *sub)

   445

{

   446

	ViewportDrawer *vd = _cur_vd;

   447

	TileSpriteToDraw *ts;

   448

   449

	assert((image & SPRITE_MASK) < MAX_SPRITES);

   450

   451

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

   452

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

   453

		return;

   454

	}

   455

	ts = (TileSpriteToDraw*)vd->spritelist_mem;

   456

   457

	vd->spritelist_mem += sizeof(TileSpriteToDraw);

   458

   459

	ts->image = image;

   460

	ts->pal = pal;

   461

	ts->sub = sub;

   462

	ts->next = NULL;

   463

	ts->x = x;

   464

	ts->y = y;

   465

	ts->z = z;

   466

	*vd->last_tile = ts;

   467

	vd->last_tile = &ts->next;

   468

}

   469

   470

/**

   471

 * Adds a child sprite to the active foundation.

   472

 *

   473

 * The pixel offset of the sprite relative to the ParentSprite is the sum of the offset passed to OffsetGroundSprite() and extra_offs_?.

   474

 *

   475

 * @param image the image to draw.

   476

 * @param pal the provided palette.

   477

 * @param sub Only draw a part of the sprite.

   478

 * @param extra_offs_x Pixel X offset for the sprite position.

   479

 * @param extra_offs_y Pixel Y offset for the sprite position.

   480

 */

   481

static void AddChildSpriteToFoundation(SpriteID image, SpriteID pal, const SubSprite *sub, int extra_offs_x, int extra_offs_y)

   482

{

   483

	ViewportDrawer *vd = _cur_vd;

   484

	assert(vd->foundation != NULL);

   485

	Point offs = vd->foundation_offset;

   486

   487

	/* Change the active ChildSprite list to the one of the foundation */

   488

	ChildScreenSpriteToDraw **old_child = vd->last_child;

   489

	vd->last_child = vd->last_foundation_child;

   490

   491

	AddChildSpriteScreen(image, pal, offs.x + extra_offs_x, offs.y + extra_offs_y, false, sub);

   492

   493

	/* Switch back to last ChildSprite list */

   494

	vd->last_child = old_child;

   495

}

   496

   497

/**