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 "map.h"

    15

#include "viewport.h"

    16

#include "window.h"

    17

#include "vehicle.h"

    18

#include "station.h"

    19

#include "gfx.h"

    20

#include "town.h"

    21

#include "signs.h"

    22

#include "waypoint.h"

    23

#include "variables.h"

    24

#include "train.h"

    25

    26

#define VIEWPORT_DRAW_MEM (65536 * 2)

    27

    28

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

    29

static ViewPort _viewports[25 - 2];

    30

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

    31

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

    32

    33

static bool _added_tile_sprite;

    34

static bool _offset_ground_sprites;

    35

    36

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

    37

 *                                               *

    38

 *                    ^ Z                        *

    39

 *                    |                          *

    40

 *                    |                          *

    41

 *                    |                          *

    42

 *                    |                          *

    43

 *                 /     \                       *

    44

 *              /           \                    *

    45

 *           /                 \                 *

    46

 *        /                       \              *

    47

 *   X <                             > Y         *

    48

 */

    49

    50

typedef struct StringSpriteToDraw {

    51

	uint16 string;

    52

	uint16 color;

    53

	struct StringSpriteToDraw *next;

    54

	int32 x;

    55

	int32 y;

    56

	uint32 params[2];

    57

	uint16 width;

    58

} StringSpriteToDraw;

    59

    60

typedef struct TileSpriteToDraw {

    61

	SpriteID image;

    62

	SpriteID pal;

    63

	struct TileSpriteToDraw *next;

    64

	int32 x;

    65

	int32 y;

    66

	byte z;

    67

} TileSpriteToDraw;

    68

    69

typedef struct ChildScreenSpriteToDraw {

    70

	SpriteID image;

    71

	SpriteID pal;

    72

	int32 x;

    73

	int32 y;

    74

	struct ChildScreenSpriteToDraw *next;

    75

} ChildScreenSpriteToDraw;

    76

    77

typedef struct ParentSpriteToDraw {

    78

	SpriteID image;

    79

	SpriteID pal;

    80

	int32 left;

    81

	int32 top;

    82

	int32 right;

    83

	int32 bottom;

    84

	int32 xmin;

    85

	int32 ymin;

    86

	int32 xmax;

    87

	int32 ymax;

    88

	ChildScreenSpriteToDraw *child;

    89

	byte unk16;

    90

	byte zmin;

    91

	byte zmax;

    92

} ParentSpriteToDraw;

    93

    94

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

    95

// to prevent a buffer overflow.

    96

#define LARGEST_SPRITELIST_STRUCT ParentSpriteToDraw

    97

    98

typedef struct ViewportDrawer {

    99

	DrawPixelInfo dpi;

   100

   101

	byte *spritelist_mem;

   102

	const byte *eof_spritelist_mem;

   103

   104

	StringSpriteToDraw **last_string, *first_string;

   105

	TileSpriteToDraw **last_tile, *first_tile;

   106

   107

	ChildScreenSpriteToDraw **last_child;

   108

   109

	ParentSpriteToDraw **parent_list;

   110

	ParentSpriteToDraw * const *eof_parent_list;

   111

   112

	byte combine_sprites;

   113

   114

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

   115

} ViewportDrawer;

   116

   117

static ViewportDrawer *_cur_vd;

   118

   119

TileHighlightData _thd;

   120

static TileInfo *_cur_ti;

   121

   122

extern void SmallMapCenterOnCurrentPos(Window *w);

   123

   124

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

   125

{

   126

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

   127

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

   128

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

   129

	return p;

   130

}

   131

   132

void InitViewports(void) {

   133

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

   134

	_active_viewports = 0;

   135

}

   136

   137

void DeleteWindowViewport(Window *w)

   138

{

   139

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

   140

	w->viewport->width = 0;

   141

	w->viewport = NULL;

   142

}

   143

   144

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

   145

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

   146

{

   147

	ViewPort *vp;

   148

	Point pt;

   149

	uint32 bit;

   150

   151

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

   152

		assert(vp != endof(_viewports));

   153

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

   154

	}

   155

	SETBIT(_active_viewports, bit);

   156

   157

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

   158

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

   159

	vp->width = width;

   160

	vp->height = height;

   161

   162

	vp->zoom = zoom;

   163

   164

	vp->virtual_width = width << zoom;

   165

	vp->virtual_height = height << zoom;

   166

   167

	if (follow_flags & 0x80000000) {

   168

		const Vehicle *veh;

   169

   170

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

   171

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

   172

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

   173

	} else {

   174

		uint x = TileX(follow_flags) * TILE_SIZE;

   175

		uint y = TileY(follow_flags) * TILE_SIZE;

   176

   177

		WP(w, vp_d).follow_vehicle = INVALID_VEHICLE;

   178

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

   179

	}

   180

   181

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

   182

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

   183

	w->viewport = vp;

   184

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

   185

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

   186

}

   187

   188

static Point _vp_move_offs;

   189

   190

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

   191

{

   192

   193

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

   194

		const Window *w = *wz;

   195

   196

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

   197

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

   198

				top + height > w->top &&

   199

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

   200

   201

			if (left < w->left) {

   202

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

   203

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

   204

				return;

   205

			}

   206

   207

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

   208

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

   209

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

   210

				return;

   211

			}

   212

   213

			if (top < w->top) {

   214

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

   215

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

   216

				return;

   217

			}

   218

   219

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

   220

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

   221

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

   222

				return;

   223

			}

   224

   225

			return;

   226

		}

   227

	}

   228

   229

	{

   230

		int xo = _vp_move_offs.x;

   231

		int yo = _vp_move_offs.y;

   232

   233

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

   234

			/* fully_outside */

   235

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

   236

			return;

   237

		}

   238

   239

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

   240

   241

		if (xo > 0) {

   242

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

   243

			left += xo;

   244

			width -= xo;

   245

		} else if (xo < 0) {

   246

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

   247

			width += xo;

   248

		}

   249

   250

		if (yo > 0) {

   251

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

   252

		} else if (yo < 0) {

   253

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

   254

		}

   255

	}

   256

}

   257

   258

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

   259

{

   260

	ViewPort *vp = w->viewport;

   261

	int old_left = vp->virtual_left;

   262

	int old_top = vp->virtual_top;

   263

	int i;

   264

	int left, top, width, height;

   265

   266

	vp->virtual_left = x;

   267

	vp->virtual_top = y;

   268

   269

	old_left >>= vp->zoom;

   270

	old_top >>= vp->zoom;

   271

	x >>= vp->zoom;

   272

	y >>= vp->zoom;

   273

   274

	old_left -= x;

   275

	old_top -= y;

   276

   277

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

   278

   279

	_vp_move_offs.x = old_left;

   280

	_vp_move_offs.y = old_top;

   281

   282

	left = vp->left;

   283

	top = vp->top;

   284

	width = vp->width;

   285

	height = vp->height;

   286

   287

	if (left < 0) {

   288

		width += left;

   289

		left = 0;

   290

	}

   291

   292

	i = left + width - _screen.width;

   293

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

   294

   295

	if (width > 0) {

   296

		if (top < 0) {

   297

			height += top;

   298

			top = 0;

   299

		}

   300

   301

		i = top + height - _screen.height;

   302

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

   303

   304

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

   305

	}

   306

}

   307

   308

   309

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

   310

{

   311

	ViewPort *vp = w->viewport;

   312

   313

	if (vp != NULL &&

   314

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

   315

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

   316

		return vp;

   317

   318

	return NULL;

   319

}

   320

   321

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

   322

{

   323

	Point pt;

   324

	int a,b;

   325

	uint z;

   326

   327

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

   328

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

   329

				Point pt = {-1, -1};

   330

				return pt;

   331

	}

   332

   333

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

   334

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

   335

   336

	a = y-x;

   337

	b = y+x;

   338

   339

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

   340

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

   341

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

   342

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

   343

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

   344

   345

	z = GetSlopeZ(a,     b    ) / 2;

   346

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

   347

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

   348

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

   349

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

   350

   351

	pt.x = a + z;

   352

	pt.y = b + z;

   353

   354

	return pt;

   355

}

   356

   357

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

   358

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

   359

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

   360

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

   361

{

   362

	Window *w;

   363

	ViewPort *vp;

   364

	Point pt;

   365

   366

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

   367

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

   368

				return TranslateXYToTileCoord(vp, zoom_x, zoom_y);

   369

   370

	pt.y = pt.x = -1;

   371

	return pt;

   372

}

   373

   374

Point GetTileBelowCursor(void)

   375

{

   376

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

   377

}

   378

   379

   380

Point GetTileZoomCenterWindow(bool in, Window * w)

   381

{

   382

	int x, y;

   383

	ViewPort * vp;

   384

   385

	vp = w->viewport;

   386

   387

	if (in) {

   388

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

   389

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

   390

	} else {

   391

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

   392

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

   393

	}

   394

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

   395

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

   396

}

   397

   398

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

   399

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

   400

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

   401

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

   402

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

   403

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

   404

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

   405

{

   406

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

   407

	InvalidateWidget(w, widget_zoom_in);

   408

   409

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

   410

	InvalidateWidget(w, widget_zoom_out);

   411

}

   412

   413

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

   414

{

   415

	ViewportDrawer *vd = _cur_vd;

   416

	TileSpriteToDraw *ts;

   417

   418

	assert((image & SPRITE_MASK) < MAX_SPRITES);

   419

   420

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

   421

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

   422

		return;

   423

	}

   424

	ts = (TileSpriteToDraw*)vd->spritelist_mem;

   425

   426

	vd->spritelist_mem += sizeof(TileSpriteToDraw);

   427

   428

	ts->image = image;

   429

	ts->pal = pal;

   430

	ts->next = NULL;

   431

	ts->x = x;

   432

	ts->y = y;

   433

	ts->z = z;

   434

	*vd->last_tile = ts;

   435

	vd->last_tile = &ts->next;

   436

}

   437

   438

void DrawGroundSprite(SpriteID image, SpriteID pal)

   439

{

   440

	if (_offset_ground_sprites) {

   441

		// offset ground sprite because of foundation?

   442

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

   443

	} else {

   444

		_added_tile_sprite = true;

   445

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

   446

	}

   447

}

   448

   449

   450

void OffsetGroundSprite(int x, int y)

   451

{

   452

	_cur_vd->offs_x = x;

   453

	_cur_vd->offs_y = y;

   454

	_offset_ground_sprites = true;

   455

}

   456

   457

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

   458

{

   459

	const ViewportDrawer *vd = _cur_vd;

   460

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

   461

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

   462

   463

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

   464

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

   465

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

   466

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

   467

		return;

   468

   469

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

   470

}

   471

   472

   473

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

   474

{

   475

	ViewportDrawer *vd = _cur_vd;

   476

	ParentSpriteToDraw *ps;

   477

	const Sprite *spr;

   478

	Point pt;

   479

   480

	assert((image & SPRITE_MASK) < MAX_SPRITES);

   481

   482

	if (vd->combine_sprites == 2) {

   483

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

   484

		return;

   485

	}

   486

   487

	vd->last_child = NULL;

   488

   489

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

   490

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

   491

		return;

   492

	}

   493

	ps = (ParentSpriteToDraw*)vd->spritelist_mem;

   494

   495

	if (vd->parent_list >= vd->eof_parent_list) {

   496

		// This can happen rarely, mostly when you zoom out completely

   497

		//  and have a lot of stuff that moves (and is added to the

   498

		//  sort-list, this function). To solve it, increase

   499

		//  parent_list somewhere below to a higher number.

   500

		// This can not really hurt you, it just gives some black

   501

		//  spots on the screen ;)

   502

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