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

	SpriteID image;

    61

	SpriteID pal;

    62

	struct TileSpriteToDraw *next;

    63

	int32 x;

    64

	int32 y;

    65

	byte z;

    66

} TileSpriteToDraw;

    67

    68

typedef struct ChildScreenSpriteToDraw {

    69

	SpriteID image;

    70

	SpriteID pal;

    71

	int32 x;

    72

	int32 y;

    73

	struct ChildScreenSpriteToDraw *next;

    74

} ChildScreenSpriteToDraw;

    75

    76

typedef struct ParentSpriteToDraw {

    77

	SpriteID image;

    78

	SpriteID pal;

    79

	int32 left;

    80

	int32 top;

    81

	int32 right;

    82

	int32 bottom;

    83

	int32 xmin;

    84

	int32 ymin;

    85

	int32 xmax;

    86

	int32 ymax;

    87

	ChildScreenSpriteToDraw *child;

    88

	byte unk16;

    89

	byte zmin;

    90

	byte zmax;

    91

} ParentSpriteToDraw;

    92

    93

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

    94

// to prevent a buffer overflow.

    95

#define LARGEST_SPRITELIST_STRUCT ParentSpriteToDraw

    96

    97

typedef struct ViewportDrawer {

    98

	DrawPixelInfo dpi;

    99

   100

	byte *spritelist_mem;

   101

	const byte *eof_spritelist_mem;

   102

   103

	StringSpriteToDraw **last_string, *first_string;

   104

	TileSpriteToDraw **last_tile, *first_tile;

   105

   106

	ChildScreenSpriteToDraw **last_child;

   107

   108

	ParentSpriteToDraw **parent_list;

   109

	ParentSpriteToDraw * const *eof_parent_list;

   110

   111

	byte combine_sprites;

   112

   113

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

   114

} ViewportDrawer;

   115

   116

static ViewportDrawer *_cur_vd;

   117

   118

TileHighlightData _thd;

   119

static TileInfo *_cur_ti;

   120

   121

extern void SmallMapCenterOnCurrentPos(Window *w);

   122

   123

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

   124

{

   125

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

   126

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

   127

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

   128

	return p;

   129

}

   130

   131

void InitViewports(void) {

   132

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

   133

	_active_viewports = 0;

   134

}

   135

   136

void DeleteWindowViewport(Window *w)

   137

{

   138

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

   139

	w->viewport->width = 0;

   140

	w->viewport = NULL;

   141

}

   142

   143

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

   144

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

   145

{

   146

	ViewPort *vp;

   147

	Point pt;

   148

	uint32 bit;

   149

   150

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

   151

		assert(vp != endof(_viewports));

   152

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

   153

	}

   154

	SETBIT(_active_viewports, bit);

   155

   156

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

   157

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

   158

	vp->width = width;

   159

	vp->height = height;

   160

   161

	vp->zoom = zoom;

   162

   163

	vp->virtual_width = width << zoom;

   164

	vp->virtual_height = height << zoom;

   165

   166

	if (follow_flags & 0x80000000) {

   167

		const Vehicle *veh;

   168

   169

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

   170

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

   171

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

   172

	} else {

   173

		uint x = TileX(follow_flags) * TILE_SIZE;

   174

		uint y = TileY(follow_flags) * TILE_SIZE;

   175

   176

		WP(w, vp_d).follow_vehicle = INVALID_VEHICLE;

   177

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

   178

	}

   179

   180

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

   181

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

   182

	w->viewport = vp;

   183

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

   184

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

   185

}

   186

   187

static Point _vp_move_offs;

   188

   189

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

   190

{

   191

   192

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

   193

		const Window *w = *wz;

   194

   195

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

   196

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

   197

				top + height > w->top &&

   198

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

   199

   200

			if (left < w->left) {

   201

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

   202

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

   203

				return;

   204

			}

   205

   206

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

   207

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

   208

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

   209

				return;

   210

			}

   211

   212

			if (top < w->top) {

   213

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

   214

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

   215

				return;

   216

			}

   217

   218

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

   219

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

   220

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

   221

				return;

   222

			}

   223

   224

			return;

   225

		}

   226

	}

   227

   228

	{

   229

		int xo = _vp_move_offs.x;

   230

		int yo = _vp_move_offs.y;

   231

   232

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

   233

			/* fully_outside */

   234

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

   235

			return;

   236

		}

   237

   238

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

   239

   240

		if (xo > 0) {

   241

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

   242

			left += xo;

   243

			width -= xo;

   244

		} else if (xo < 0) {

   245

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

   246

			width += xo;

   247

		}

   248

   249

		if (yo > 0) {

   250

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

   251

		} else if (yo < 0) {

   252

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

   253

		}

   254

	}

   255

}

   256

   257

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

   258

{

   259

	ViewPort *vp = w->viewport;

   260

	int old_left = vp->virtual_left;

   261

	int old_top = vp->virtual_top;

   262

	int i;

   263

	int left, top, width, height;

   264

   265

	vp->virtual_left = x;

   266

	vp->virtual_top = y;

   267

   268

	old_left >>= vp->zoom;

   269

	old_top >>= vp->zoom;

   270

	x >>= vp->zoom;

   271

	y >>= vp->zoom;

   272

   273

	old_left -= x;

   274

	old_top -= y;

   275

   276

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

   277

   278

	_vp_move_offs.x = old_left;

   279

	_vp_move_offs.y = old_top;

   280

   281

	left = vp->left;

   282

	top = vp->top;

   283

	width = vp->width;

   284

	height = vp->height;

   285

   286

	if (left < 0) {

   287

		width += left;

   288

		left = 0;

   289

	}

   290

   291

	i = left + width - _screen.width;

   292

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

   293

   294

	if (width > 0) {

   295

		if (top < 0) {

   296

			height += top;

   297

			top = 0;

   298

		}

   299

   300

		i = top + height - _screen.height;

   301

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

   302

   303

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

   304

	}

   305

}

   306

   307

   308

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

   309

{

   310

	ViewPort *vp = w->viewport;

   311

   312

	if (vp != NULL &&

   313

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

   314

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

   315

		return vp;

   316

   317

	return NULL;

   318

}

   319

   320

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

   321

{

   322

	Point pt;

   323

	int a,b;

   324

	uint z;

   325

   326

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

   327

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

   328

				Point pt = {-1, -1};

   329

				return pt;

   330

	}

   331

   332

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

   333

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

   334

   335

	a = y-x;

   336

	b = y+x;

   337

   338

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

   339

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

   340

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

   341

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

   342

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

   343

   344

	z = GetSlopeZ(a,     b    ) / 2;

   345

	z = GetSlopeZ(a + z, b + z) / 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

   350

	pt.x = a + z;

   351

	pt.y = b + z;

   352

   353

	return pt;

   354

}

   355

   356

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

   357

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

   358

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

   359

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

   360

{

   361

	Window *w;

   362

	ViewPort *vp;

   363

	Point pt;

   364

   365

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

   366

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

   367

				return TranslateXYToTileCoord(vp, zoom_x, zoom_y);

   368

   369

	pt.y = pt.x = -1;

   370

	return pt;

   371

}

   372

   373

Point GetTileBelowCursor(void)

   374

{

   375

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

   376

}

   377

   378

   379

Point GetTileZoomCenterWindow(bool in, Window * w)

   380

{

   381

	int x, y;

   382

	ViewPort * vp;

   383

   384

	vp = w->viewport;

   385

   386

	if (in) {

   387

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

   388

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

   389

	} else {

   390

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

   391

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

   392

	}

   393

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

   394

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

   395

}

   396

   397

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

   398

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

   399

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

   400

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

   401

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

   402

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

   403

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

   404

{

   405

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

   406

	InvalidateWidget(w, widget_zoom_in);

   407

   408

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

   409

	InvalidateWidget(w, widget_zoom_out);

   410

}

   411

   412

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

   413

{

   414

	ViewportDrawer *vd = _cur_vd;

   415

	TileSpriteToDraw *ts;

   416

   417

	assert((image & SPRITE_MASK) < MAX_SPRITES);

   418

   419

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

   420

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

   421

		return;

   422

	}

   423

	ts = (TileSpriteToDraw*)vd->spritelist_mem;

   424

   425

	vd->spritelist_mem += sizeof(TileSpriteToDraw);

   426

   427

	ts->image = image;

   428

	ts->pal = pal;

   429

	ts->next = NULL;

   430

	ts->x = x;

   431

	ts->y = y;

   432

	ts->z = z;

   433

	*vd->last_tile = ts;

   434

	vd->last_tile = &ts->next;

   435

}

   436

   437

void DrawGroundSprite(SpriteID image, SpriteID pal)

   438

{

   439

	if (_offset_ground_sprites) {

   440

		// offset ground sprite because of foundation?

   441

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

   442

	} else {

   443

		_added_tile_sprite = true;

   444

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

   445

	}

   446

}

   447

   448

   449

void OffsetGroundSprite(int x, int y)

   450

{

   451

	_cur_vd->offs_x = x;

   452

	_cur_vd->offs_y = y;

   453

	_offset_ground_sprites = true;

   454

}

   455

   456

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

   457

{

   458

	const ViewportDrawer *vd = _cur_vd;

   459

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

   460

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

   461

   462

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

   463

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

   464

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

   465

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

   466

		return;

   467

   468

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

   469

}

   470

   471

   472

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

   473

{

   474

	ViewportDrawer *vd = _cur_vd;

   475

	ParentSpriteToDraw *ps;

   476

	const Sprite *spr;

   477

	Point pt;

   478

   479

	assert((image & SPRITE_MASK) < MAX_SPRITES);

   480

   481

	if (vd->combine_sprites == 2) {

   482

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

   483

		return;

   484

	}

   485

   486

	vd->last_child = NULL;

   487

   488

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

   489

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

   490

		return;

   491

	}

   492

	ps = (ParentSpriteToDraw*)vd->spritelist_mem;

   493

   494

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

   495

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

   496

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

   497

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

   498

		//  parent_list somewhere below to a higher number.

   499

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

   500

		//  spots on the screen ;)

   501

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

   502

		return;