1

/* $Id$ */

     2

     3

#include "stdafx.h"

     4

#include "openttd.h"

     5

#include "debug.h"

     6

#include "functions.h"

     7

#include "gui.h"

     8

#include "spritecache.h"

     9

#include "strings.h"

    10

#include "table/sprites.h"

    11

#include "table/strings.h"

    12

#include "map.h"

    13

#include "viewport.h"

    14

#include "window.h"

    15

#include "vehicle.h"

    16

#include "station.h"

    17

#include "gfx.h"

    18

#include "town.h"

    19

#include "signs.h"

    20

#include "waypoint.h"

    21

#include "variables.h"

    22

#include "train.h"

    23

    24

#define VIEWPORT_DRAW_MEM (65536 * 2)

    25

    26

/* viewport.c */

    27

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

    28

static ViewPort _viewports[25 - 2];

    29

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

    30

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

    31

    32

static bool _added_tile_sprite;

    33

static bool _offset_ground_sprites;

    34

    35

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

    36

 *                                               *

    37

 *                    ^ Z                        *

    38

 *                    |                          *

    39

 *                    |                          *

    40

 *                    |                          *

    41

 *                    |                          *

    42

 *                 /     \                       *

    43

 *              /           \                    *

    44

 *           /                 \                 *

    45

 *        /                       \              *

    46

 *   X <                             > Y         *

    47

 */

    48

    49

typedef struct StringSpriteToDraw {

    50

	uint16 string;

    51

	uint16 color;

    52

	struct StringSpriteToDraw *next;

    53

	int32 x;

    54

	int32 y;

    55

	uint32 params[2];

    56

	uint16 width;

    57

} StringSpriteToDraw;

    58

    59

typedef struct TileSpriteToDraw {

    60

	uint32 image;

    61

	struct TileSpriteToDraw *next;

    62

	int32 x;

    63

	int32 y;

    64

	byte z;

    65

} TileSpriteToDraw;

    66

    67

typedef struct ChildScreenSpriteToDraw {

    68

	uint32 image;

    69

	int32 x;

    70

	int32 y;

    71

	struct ChildScreenSpriteToDraw *next;

    72

} ChildScreenSpriteToDraw;

    73

    74

typedef struct ParentSpriteToDraw {

    75

	uint32 image;

    76

	int32 left;

    77

	int32 top;

    78

	int32 right;

    79

	int32 bottom;

    80

	int32 xmin;

    81

	int32 ymin;

    82

	int32 xmax;

    83

	int32 ymax;

    84

	ChildScreenSpriteToDraw *child;

    85

	byte unk16;

    86

	byte zmin;

    87

	byte zmax;

    88

} ParentSpriteToDraw;

    89

    90

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

    91

// to prevent a buffer overflow.

    92

#define LARGEST_SPRITELIST_STRUCT ParentSpriteToDraw

    93

    94

typedef struct ViewportDrawer {

    95

	DrawPixelInfo dpi;

    96

    97

	byte *spritelist_mem;

    98

	const byte *eof_spritelist_mem;

    99

   100

	StringSpriteToDraw **last_string, *first_string;

   101

	TileSpriteToDraw **last_tile, *first_tile;

   102

   103

	ChildScreenSpriteToDraw **last_child;

   104

   105

	ParentSpriteToDraw **parent_list;

   106

	ParentSpriteToDraw * const *eof_parent_list;

   107

   108

	byte combine_sprites;

   109

   110

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

   111

} ViewportDrawer;

   112

   113

static ViewportDrawer *_cur_vd;

   114

   115

TileHighlightData _thd;

   116

static TileInfo *_cur_ti;

   117

   118

extern void SmallMapCenterOnCurrentPos(Window *w);

   119

   120

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

   121

{

   122

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

   123

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

   124

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

   125

	return p;

   126

}

   127

   128

void InitViewports(void) {

   129

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

   130

	_active_viewports = 0;

   131

}

   132

   133

void DeleteWindowViewport(Window *w)

   134

{

   135

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

   136

	w->viewport->width = 0;

   137

	w->viewport = NULL;

   138

}

   139

   140

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

   141

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

   142

{

   143

	ViewPort *vp;

   144

	Point pt;

   145

	uint32 bit;

   146

   147

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

   148

		assert(vp != endof(_viewports));

   149

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

   150

	}

   151

	SETBIT(_active_viewports, bit);

   152

   153

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

   154

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

   155

	vp->width = width;

   156

	vp->height = height;

   157

   158

	vp->zoom = zoom;

   159

   160

	vp->virtual_width = width << zoom;

   161

	vp->virtual_height = height << zoom;

   162

   163

	if (follow_flags & 0x80000000) {

   164

		const Vehicle *veh;

   165

   166

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

   167

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

   168

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

   169

	} else {

   170

		uint x = TileX(follow_flags) * TILE_SIZE;

   171

		uint y = TileY(follow_flags) * TILE_SIZE;

   172

   173

		WP(w, vp_d).follow_vehicle = INVALID_VEHICLE;

   174

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

   175

	}

   176

   177

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

   178

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

   179

	w->viewport = vp;

   180

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

   181

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

   182

}

   183

   184

static Point _vp_move_offs;

   185

   186

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

   187

{

   188

   189

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

   190

		const Window *w = *wz;

   191

   192

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

   193

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

   194

				top + height > w->top &&

   195

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

   196

   197

			if (left < w->left) {

   198

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

   199

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

   200

				return;

   201

			}

   202

   203

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

   204

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

   205

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

   206

				return;

   207

			}

   208

   209

			if (top < w->top) {

   210

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

   211

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

   212

				return;

   213

			}

   214

   215

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

   216

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

   217

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

   218

				return;

   219

			}

   220

   221

			return;

   222

		}

   223

	}

   224

   225

	{

   226

		int xo = _vp_move_offs.x;

   227

		int yo = _vp_move_offs.y;

   228

   229

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

   230

			/* fully_outside */

   231

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

   232

			return;

   233

		}

   234

   235

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

   236

   237

		if (xo > 0) {

   238

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

   239

			left += xo;

   240

			width -= xo;

   241

		} else if (xo < 0) {

   242

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

   243

			width += xo;

   244

		}

   245

   246

		if (yo > 0) {

   247

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

   248

		} else if (yo < 0) {

   249

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

   250

		}

   251

	}

   252

}

   253

   254

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

   255

{

   256

	ViewPort *vp = w->viewport;

   257

	int old_left = vp->virtual_left;

   258

	int old_top = vp->virtual_top;

   259

	int i;

   260

	int left, top, width, height;

   261

   262

	vp->virtual_left = x;

   263

	vp->virtual_top = y;

   264

   265

	old_left >>= vp->zoom;

   266

	old_top >>= vp->zoom;

   267

	x >>= vp->zoom;

   268

	y >>= vp->zoom;

   269

   270

	old_left -= x;

   271

	old_top -= y;

   272

   273

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

   274

   275

	_vp_move_offs.x = old_left;

   276

	_vp_move_offs.y = old_top;

   277

   278

	left = vp->left;

   279

	top = vp->top;

   280

	width = vp->width;

   281

	height = vp->height;

   282

   283

	if (left < 0) {

   284

		width += left;

   285

		left = 0;

   286

	}

   287

   288

	i = left + width - _screen.width;

   289

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

   290

   291

	if (width > 0) {

   292

		if (top < 0) {

   293

			height += top;

   294

			top = 0;

   295

		}

   296

   297

		i = top + height - _screen.height;

   298

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

   299

   300

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

   301

	}

   302

}

   303

   304

   305

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

   306

{

   307

	ViewPort *vp = w->viewport;

   308

   309

	if (vp != NULL &&

   310

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

   311

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

   312

		return vp;

   313

   314

	return NULL;

   315

}

   316

   317

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

   318

{

   319

	Point pt;

   320

	int a,b;

   321

	uint z;

   322

   323

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

   324

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

   325

				Point pt = {-1, -1};

   326

				return pt;

   327

	}

   328

   329

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

   330

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

   331

   332

	a = y-x;

   333

	b = y+x;

   334

   335

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

   336

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

   337

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

   338

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

   339

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

   340

   341

	z = GetSlopeZ(a,     b    ) / 2;

   342

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

   343

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

   344

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

   345

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

   346

   347

	pt.x = a + z;

   348

	pt.y = b + z;

   349

   350

	return pt;

   351

}

   352

   353

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

   354

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

   355

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

   356

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

   357

{

   358

	Window *w;

   359

	ViewPort *vp;

   360

	Point pt;

   361

   362

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

   363

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

   364

				return TranslateXYToTileCoord(vp, zoom_x, zoom_y);

   365

   366

	pt.y = pt.x = -1;

   367

	return pt;

   368

}

   369

   370

Point GetTileBelowCursor(void)

   371

{

   372

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

   373

}

   374

   375

   376

Point GetTileZoomCenterWindow(bool in, Window * w)

   377

{

   378

	int x, y;

   379

	ViewPort * vp;

   380

   381

	vp = w->viewport;

   382

   383

	if (in) {

   384

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

   385

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

   386

	} else {

   387

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

   388

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

   389

	}

   390

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

   391

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

   392

}

   393

   394

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

   395

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

   396

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

   397

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

   398

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

   399

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

   400

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

   401

{

   402

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

   403

	InvalidateWidget(w, widget_zoom_in);

   404

   405

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

   406

	InvalidateWidget(w, widget_zoom_out);

   407

}

   408

   409

void DrawGroundSpriteAt(uint32 image, int32 x, int32 y, byte z)

   410

{

   411

	ViewportDrawer *vd = _cur_vd;

   412

	TileSpriteToDraw *ts;

   413

   414

	assert((image & SPRITE_MASK) < MAX_SPRITES);

   415

   416

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

   417

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

   418

		return;

   419

	}

   420

	ts = (TileSpriteToDraw*)vd->spritelist_mem;

   421

   422

	vd->spritelist_mem += sizeof(TileSpriteToDraw);

   423

   424

	ts->image = image;

   425

	ts->next = NULL;

   426

	ts->x = x;

   427

	ts->y = y;

   428

	ts->z = z;

   429

	*vd->last_tile = ts;

   430

	vd->last_tile = &ts->next;

   431

}

   432

   433

void DrawGroundSprite(uint32 image)

   434

{

   435

	if (_offset_ground_sprites) {

   436

		// offset ground sprite because of foundation?

   437

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

   438

	} else {

   439

		_added_tile_sprite = true;

   440

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

   441

	}

   442

}

   443

   444

   445

void OffsetGroundSprite(int x, int y)

   446

{

   447

	_cur_vd->offs_x = x;

   448

	_cur_vd->offs_y = y;

   449

	_offset_ground_sprites = true;

   450

}

   451

   452

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

   453

{

   454

	const ViewportDrawer *vd = _cur_vd;

   455

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

   456

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

   457

   458

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

   459

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

   460

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

   461

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

   462

		return;

   463

   464

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

   465

}

   466

   467

   468

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

   469

{

   470

	ViewportDrawer *vd = _cur_vd;

   471

	ParentSpriteToDraw *ps;

   472

	const Sprite *spr;

   473

	Point pt;

   474

   475

	assert((image & SPRITE_MASK) < MAX_SPRITES);

   476

   477

	if (vd->combine_sprites == 2) {

   478

		AddCombinedSprite(image, x, y, z);

   479

		return;

   480

	}

   481

   482

	vd->last_child = NULL;

   483

   484

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

   485

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

   486

		return;

   487

	}

   488

	ps = (ParentSpriteToDraw*)vd->spritelist_mem;

   489

   490

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

   491

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

   492

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

   493

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

   494

		//  parent_list somewhere below to a higher number.

   495

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

   496

		//  spots on the screen ;)

   497

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

   498

		return;

   499

	}

   500

   501

	pt = RemapCoords(x, y, z);

   502

	spr = GetSprite(image & SPRITE_MASK);

   503

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

   504

			(ps->right  = (pt.x +  spr->width )) <= vd->dpi.left ||