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

static bool _added_tile_sprite;

    27

static bool _offset_ground_sprites;

    28

    29

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

    30

 *                                               *

    31

 *                    ^ Z                        *

    32

 *                    |                          *

    33

 *                    |                          *

    34

 *                    |                          *

    35

 *                    |                          *

    36

 *                 /     \                       *

    37

 *              /           \                    *

    38

 *           /                 \                 *

    39

 *        /                       \              *

    40

 *   X <                             > Y         *

    41

 */

    42

    43

typedef struct StringSpriteToDraw {

    44

	uint16 string;

    45

	uint16 color;

    46

	struct StringSpriteToDraw *next;

    47

	int32 x;

    48

	int32 y;

    49

	uint32 params[3];

    50

	uint16 width;

    51

} StringSpriteToDraw;

    52

    53

typedef struct TileSpriteToDraw {

    54

	uint32 image;

    55

	struct TileSpriteToDraw *next;

    56

	int32 x;

    57

	int32 y;

    58

	byte z;

    59

} TileSpriteToDraw;

    60

    61

typedef struct ChildScreenSpriteToDraw {

    62

	uint32 image;

    63

	int32 x;

    64

	int32 y;

    65

	struct ChildScreenSpriteToDraw *next;

    66

} ChildScreenSpriteToDraw;

    67

    68

typedef struct ParentSpriteToDraw {

    69

	uint32 image;

    70

	int32 left;

    71

	int32 top;

    72

	int32 right;

    73

	int32 bottom;

    74

	int32 xmin;

    75

	int32 ymin;

    76

	int32 xmax;

    77

	int32 ymax;

    78

	ChildScreenSpriteToDraw *child;

    79

	byte unk16;

    80

	byte zmin;

    81

	byte zmax;

    82

} ParentSpriteToDraw;

    83

    84

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

    85

// to prevent a buffer overflow.

    86

#define LARGEST_SPRITELIST_STRUCT ParentSpriteToDraw

    87

    88

typedef struct ViewportDrawer {

    89

	DrawPixelInfo dpi;

    90

    91

	byte *spritelist_mem;

    92

	const byte *eof_spritelist_mem;

    93

    94

	StringSpriteToDraw **last_string, *first_string;

    95

	TileSpriteToDraw **last_tile, *first_tile;

    96

    97

	ChildScreenSpriteToDraw **last_child;

    98

    99

	ParentSpriteToDraw **parent_list;

   100

	ParentSpriteToDraw * const *eof_parent_list;

   101

   102

	byte combine_sprites;

   103

   104

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

   105

} ViewportDrawer;

   106

   107

static ViewportDrawer *_cur_vd;

   108

   109

TileHighlightData _thd;

   110

static TileInfo *_cur_ti;

   111

   112

extern void SmallMapCenterOnCurrentPos(Window *w);

   113

   114

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

   115

{

   116

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

   117

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

   118

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

   119

	return p;

   120

}

   121

   122

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

   123

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

   124

{

   125

	ViewPort *vp;

   126

	Point pt;

   127

	uint32 bit;

   128

   129

	for (vp = _viewports, bit = 1; ; vp++, bit <<= 1) {

   130

		assert(vp != endof(_viewports));

   131

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

   132

	}

   133

	_active_viewports |= bit;

   134

   135

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

   136

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

   137

	vp->width = width;

   138

	vp->height = height;

   139

   140

	vp->zoom = zoom;

   141

   142

	vp->virtual_width = width << zoom;

   143

	vp->virtual_height = height << zoom;

   144

   145

	if (follow_flags & 0x80000000) {

   146

		const Vehicle *veh;

   147

   148

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

   149

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

   150

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

   151

	} else {

   152

		uint x = TileX(follow_flags) * TILE_SIZE;

   153

		uint y = TileY(follow_flags) * TILE_SIZE;

   154

   155

		WP(w, vp_d).follow_vehicle = INVALID_VEHICLE;

   156

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

   157

	}

   158

   159

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

   160

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

   161

	w->viewport = vp;

   162

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

   163

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

   164

}

   165

   166

static Point _vp_move_offs;

   167

   168

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

   169

{

   170

	for (; w < _last_window; w++) {

   171

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

   172

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

   173

				top + height > w->top &&

   174

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

   175

   176

			if (left < w->left) {

   177

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

   178

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

   179

				return;

   180

			}

   181

   182

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

   183

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

   184

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

   185

				return;

   186

			}

   187

   188

			if (top < w->top) {

   189

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

   190

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

   191

				return;

   192

			}

   193

   194

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

   195

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

   196

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

   197

				return;

   198

			}

   199

   200

			return;

   201

		}

   202

	}

   203

   204

	{

   205

		int xo = _vp_move_offs.x;

   206

		int yo = _vp_move_offs.y;

   207

   208

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

   209

			/* fully_outside */

   210

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

   211

			return;

   212

		}

   213

   214

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

   215

   216

		if (xo > 0) {

   217

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

   218

			left += xo;

   219

			width -= xo;

   220

		} else if (xo < 0) {

   221

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

   222

			width += xo;

   223

		}

   224

   225

		if (yo > 0) {

   226

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

   227

		} else if (yo < 0) {

   228

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

   229

		}

   230

	}

   231

}

   232

   233

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

   234

{

   235

	ViewPort *vp = w->viewport;

   236

	int old_left = vp->virtual_left;

   237

	int old_top = vp->virtual_top;

   238

	int i;

   239

	int left, top, width, height;

   240

   241

	vp->virtual_left = x;

   242

	vp->virtual_top = y;

   243

   244

	old_left >>= vp->zoom;

   245

	old_top >>= vp->zoom;

   246

	x >>= vp->zoom;

   247

	y >>= vp->zoom;

   248

   249

	old_left -= x;

   250

	old_top -= y;

   251

   252

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

   253

   254

	_vp_move_offs.x = old_left;

   255

	_vp_move_offs.y = old_top;

   256

   257

	left = vp->left;

   258

	top = vp->top;

   259

	width = vp->width;

   260

	height = vp->height;

   261

   262

	if (left < 0) {

   263

		width += left;

   264

		left = 0;

   265

	}

   266

   267

	i = left + width - _screen.width;

   268

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

   269

   270

	if (width > 0) {

   271

		if (top < 0) {

   272

			height += top;

   273

			top = 0;

   274

		}

   275

   276

		i = top + height - _screen.height;

   277

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

   278

   279

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

   280

	}

   281

}

   282

   283

   284

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

   285

{

   286

	ViewPort *vp = w->viewport;

   287

   288

	if (vp != NULL &&

   289

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

   290

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

   291

		return vp;

   292

   293

	return NULL;

   294

}

   295

   296

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

   297

{

   298

	Point pt;

   299

	int a,b;

   300

	uint z;

   301

   302

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

   303

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

   304

				Point pt = {-1, -1};

   305

				return pt;

   306

	}

   307

   308

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

   309

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

   310

   311

#if !defined(NEW_ROTATION)

   312

	a = y-x;

   313

	b = y+x;

   314

#else

   315

	a = x+y;

   316

	b = x-y;

   317

#endif

   318

   319

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

   320

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

   321

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

   322

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

   323

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

   324

   325

	z = GetSlopeZ(a,     b    ) / 2;

   326

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

   327

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

   328

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

   329

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

   330

   331

	pt.x = a + z;

   332

	pt.y = b + z;

   333

   334

	return pt;

   335

}

   336

   337

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

   338

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

   339

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

   340

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

   341

{

   342

	Window *w;

   343

	ViewPort *vp;

   344

	Point pt;

   345

   346

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

   347

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

   348

				return TranslateXYToTileCoord(vp, zoom_x, zoom_y);

   349

   350

	pt.y = pt.x = -1;

   351

	return pt;

   352

}

   353

   354

Point GetTileBelowCursor(void)

   355

{

   356

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

   357

}

   358

   359

   360

Point GetTileZoomCenterWindow(bool in, Window * w)

   361

{

   362

	int x, y;

   363

	ViewPort * vp;

   364

   365

	vp = w->viewport;

   366

   367

	if (in) {

   368

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

   369

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

   370

	} else {

   371

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

   372

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

   373

	}

   374

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

   375

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

   376

}

   377

   378

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

   379

{

   380

	ViewportDrawer *vd = _cur_vd;

   381

	TileSpriteToDraw *ts;

   382

   383

	assert((image & SPRITE_MASK) < MAX_SPRITES);

   384

   385

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

   386

		DEBUG(misc, 0) ("Out of sprite mem");

   387

		return;

   388

	}

   389

	ts = (TileSpriteToDraw*)vd->spritelist_mem;

   390

   391

	vd->spritelist_mem += sizeof(TileSpriteToDraw);

   392

   393

	ts->image = image;

   394

	ts->next = NULL;

   395

	ts->x = x;

   396

	ts->y = y;

   397

	ts->z = z;

   398

	*vd->last_tile = ts;

   399

	vd->last_tile = &ts->next;

   400

}

   401

   402

void DrawGroundSprite(uint32 image)

   403

{

   404

	if (_offset_ground_sprites) {

   405

		// offset ground sprite because of foundation?

   406

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

   407

	} else {

   408

		_added_tile_sprite = true;

   409

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

   410

	}

   411

}

   412

   413

   414

void OffsetGroundSprite(int x, int y)

   415

{

   416

	_cur_vd->offs_x = x;

   417

	_cur_vd->offs_y = y;

   418

	_offset_ground_sprites = true;

   419

}

   420

   421

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

   422

{

   423

	const ViewportDrawer *vd = _cur_vd;

   424

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

   425

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

   426

   427

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

   428

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

   429

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

   430

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

   431

		return;

   432

   433

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

   434

}

   435

   436

   437

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

   438

{

   439

	ViewportDrawer *vd = _cur_vd;

   440

	ParentSpriteToDraw *ps;

   441

	const Sprite *spr;

   442

	Point pt;

   443

   444

	assert((image & SPRITE_MASK) < MAX_SPRITES);

   445

   446

	if (vd->combine_sprites == 2) {

   447

		AddCombinedSprite(image, x, y, z);

   448

		return;

   449

	}

   450

   451

	vd->last_child = NULL;

   452

   453

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

   454

		DEBUG(misc, 0) ("Out of sprite mem");

   455

		return;

   456

	}

   457

	ps = (ParentSpriteToDraw*)vd->spritelist_mem;

   458

   459

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

   460

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

   461

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

   462

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

   463

		//  parent_list somewhere below to a higher number.

   464

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

   465

		//  spots on the screen ;)

   466

		DEBUG(misc, 0) ("Out of sprite mem (parent_list)");

   467

		return;

   468

	}

   469

   470

	pt = RemapCoords(x, y, z);

   471

	spr = GetSprite(image & SPRITE_MASK);

   472

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

   473

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

   474

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

   475

			(ps->bottom = (pt.y +  spr->height)) <= vd->dpi.top) {

   476

		return;

   477

	}

   478

   479

	vd->spritelist_mem += sizeof(ParentSpriteToDraw);

   480

   481

	ps->image = image;

   482

	ps->xmin = x;

   483

	ps->xmax = x + w - 1;

   484

   485

	ps->ymin = y;

   486

	ps->ymax = y + h - 1;

   487

   488

	ps->zmin = z;

   489

	ps->zmax = z + dz - 1;

   490

   491

	ps->unk16 = 0;

   492

	ps->child = NULL;

   493

	vd->last_child = &ps->child;

   494

   495

	*vd->parent_list++ = ps;

   496

   497

	if (vd->combine_sprites == 1) vd->combine_sprites = 2;

   498

}

   499

   500

void StartSpriteCombine(void)

   501

{

   502

	_cur_vd->combine_sprites = 1;

   503

}

   504

   505

void EndSpriteCombine(void)

   506

{