1

/* $Id$ */

     2

     3

/** @file landscape.cpp Functions related to the landscape (slopes etc.). */

     4

     5

#include "stdafx.h"

     6

#include "openttd.h"

     7

#include "bridge_map.h"

     8

#include "heightmap.h"

     9

#include "clear_map.h"

    10

#include "spritecache.h"

    11

#include <stdarg.h>

    12

#include "viewport_func.h"

    13

#include "command_func.h"

    14

#include "landscape.h"

    15

#include "variables.h"

    16

#include "void_map.h"

    17

#include "water_map.h"

    18

#include "tgp.h"

    19

#include "genworld.h"

    20

#include "tile_cmd.h"

    21

#include "core/alloc_func.hpp"

    22

#include "fios.h"

    23

#include "window_func.h"

    24

#include "functions.h"

    25

#include "date_func.h"

    26

#include "vehicle_func.h"

    27

#include "settings_type.h"

    28

#include "water.h"

    29

#include "effectvehicle_func.h"

    30

#include "landscape_type.h"

    31

    32

#include "table/sprites.h"

    33

    34

extern const TileTypeProcs

    35

	_tile_type_clear_procs,

    36

	_tile_type_rail_procs,

    37

	_tile_type_road_procs,

    38

	_tile_type_town_procs,

    39

	_tile_type_trees_procs,

    40

	_tile_type_station_procs,

    41

	_tile_type_water_procs,

    42

	_tile_type_dummy_procs,

    43

	_tile_type_industry_procs,

    44

	_tile_type_tunnelbridge_procs,

    45

	_tile_type_unmovable_procs;

    46

    47

const TileTypeProcs * const _tile_type_procs[16] = {

    48

	&_tile_type_clear_procs,

    49

	&_tile_type_rail_procs,

    50

	&_tile_type_road_procs,

    51

	&_tile_type_town_procs,

    52

	&_tile_type_trees_procs,

    53

	&_tile_type_station_procs,

    54

	&_tile_type_water_procs,

    55

	&_tile_type_dummy_procs,

    56

	&_tile_type_industry_procs,

    57

	&_tile_type_tunnelbridge_procs,

    58

	&_tile_type_unmovable_procs,

    59

};

    60

    61

/* landscape slope => sprite */

    62

const byte _tileh_to_sprite[32] = {

    63

	0, 1, 2, 3, 4, 5, 6,  7, 8, 9, 10, 11, 12, 13, 14, 0,

    64

	0, 0, 0, 0, 0, 0, 0, 16, 0, 0,  0, 17,  0, 15, 18, 0,

    65

};

    66

    67

SnowLine *_snow_line = NULL;

    68

    69

/**

    70

 * Applys a foundation to a slope.

    71

 *

    72

 * @pre      Foundation and slope must be valid combined.

    73

 * @param f  The #Foundation.

    74

 * @param s  The #Slope to modify.

    75

 * @return   Increment to the tile Z coordinate.

    76

 */

    77

uint ApplyFoundationToSlope(Foundation f, Slope *s)

    78

{

    79

	if (!IsFoundation(f)) return 0;

    80

    81

	if (IsLeveledFoundation(f)) {

    82

		*s = SLOPE_FLAT;

    83

		return TILE_HEIGHT;

    84

	}

    85

    86

	if (f != FOUNDATION_STEEP_BOTH && IsNonContinuousFoundation(f)) {

    87

		*s = HalftileSlope(*s, GetHalftileFoundationCorner(f));

    88

		return 0;

    89

	}

    90

    91

	if (IsSpecialRailFoundation(f)) {

    92

		*s = SlopeWithThreeCornersRaised(OppositeCorner(GetRailFoundationCorner(f)));

    93

		return 0;

    94

	}

    95

    96

	uint dz = IsSteepSlope(*s) ? TILE_HEIGHT : 0;

    97

	Corner highest_corner = GetHighestSlopeCorner(*s);

    98

    99

	switch (f) {

   100

		case FOUNDATION_INCLINED_X:

   101

			*s = (((highest_corner == CORNER_W) || (highest_corner == CORNER_S)) ? SLOPE_SW : SLOPE_NE);

   102

			break;

   103

   104

		case FOUNDATION_INCLINED_Y:

   105

			*s = (((highest_corner == CORNER_S) || (highest_corner == CORNER_E)) ? SLOPE_SE : SLOPE_NW);

   106

			break;

   107

   108

		case FOUNDATION_STEEP_LOWER:

   109

			*s = SlopeWithOneCornerRaised(highest_corner);

   110

			break;

   111

   112

		case FOUNDATION_STEEP_BOTH:

   113

			*s = HalftileSlope(SlopeWithOneCornerRaised(highest_corner), highest_corner);

   114

			break;

   115

   116

		default: NOT_REACHED();

   117

	}

   118

	return dz;

   119

}

   120

   121

   122

/**

   123

 * Determines height at given coordinate of a slope

   124

 * @param x x coordinate

   125

 * @param y y coordinate

   126

 * @param corners slope to examine

   127

 * @return height of given point of given slope

   128

 */

   129

uint GetPartialZ(int x, int y, Slope corners)

   130

{

   131

	if (IsHalftileSlope(corners)) {

   132

		switch (GetHalftileSlopeCorner(corners)) {

   133

			case CORNER_W:

   134

				if (x - y >= 0) return GetSlopeMaxZ(corners);

   135

				break;

   136

   137

			case CORNER_S:

   138

				if (x - (y ^ 0xF) >= 0) return GetSlopeMaxZ(corners);

   139

				break;

   140

   141

			case CORNER_E:

   142

				if (y - x >= 0) return GetSlopeMaxZ(corners);

   143

				break;

   144

   145

			case CORNER_N:

   146

				if ((y ^ 0xF) - x >= 0) return GetSlopeMaxZ(corners);

   147

				break;

   148

   149

			default: NOT_REACHED();

   150

		}

   151

	}

   152

   153

	int z = 0;

   154

   155

	switch (RemoveHalftileSlope(corners)) {

   156

		case SLOPE_W:

   157

			if (x - y >= 0) {

   158

				z = (x - y) >> 1;

   159

			}

   160

			break;

   161

   162

		case SLOPE_S:

   163

			y ^= 0xF;

   164

			if ((x - y) >= 0) {

   165

				z = (x - y) >> 1;

   166

			}

   167

			break;

   168

   169

		case SLOPE_SW:

   170

			z = (x >> 1) + 1;

   171

			break;

   172

   173

		case SLOPE_E:

   174

			if (y - x >= 0) {

   175

				z = (y - x) >> 1;

   176

			}

   177

			break;

   178

   179

		case SLOPE_EW:

   180

		case SLOPE_NS:

   181

		case SLOPE_ELEVATED:

   182

			z = 4;

   183

			break;

   184

   185

		case SLOPE_SE:

   186

			z = (y >> 1) + 1;

   187

			break;

   188

   189

		case SLOPE_WSE:

   190

			z = 8;

   191

			y ^= 0xF;

   192

			if (x - y < 0) {

   193

				z += (x - y) >> 1;

   194

			}

   195

			break;

   196

   197

		case SLOPE_N:

   198

			y ^= 0xF;

   199

			if (y - x >= 0) {

   200

				z = (y - x) >> 1;

   201

			}

   202

			break;

   203

   204

		case SLOPE_NW:

   205

			z = (y ^ 0xF) >> 1;

   206

			break;

   207

   208

		case SLOPE_NWS:

   209

			z = 8;

   210

			if (x - y < 0) {

   211

				z += (x - y) >> 1;

   212

			}

   213

			break;

   214

   215

		case SLOPE_NE:

   216

			z = (x ^ 0xF) >> 1;

   217

			break;

   218

   219

		case SLOPE_ENW:

   220

			z = 8;

   221

			y ^= 0xF;

   222

			if (y - x < 0) {

   223

				z += (y - x) >> 1;

   224

			}

   225

			break;

   226

   227

		case SLOPE_SEN:

   228

			z = 8;

   229

			if (y - x < 0) {

   230

				z += (y - x) >> 1;

   231

			}

   232

			break;

   233

   234

		case SLOPE_STEEP_S:

   235

			z = 1 + ((x + y) >> 1);

   236

			break;

   237

   238

		case SLOPE_STEEP_W:

   239

			z = 1 + ((x + (y ^ 0xF)) >> 1);

   240

			break;

   241

   242

		case SLOPE_STEEP_N:

   243

			z = 1 + (((x ^ 0xF) + (y ^ 0xF)) >> 1);

   244

			break;

   245

   246

		case SLOPE_STEEP_E:

   247

			z = 1 + (((x ^ 0xF) + y) >> 1);

   248

			break;

   249

   250

		default: break;

   251

	}

   252

   253

	return z;

   254

}

   255

   256

uint GetSlopeZ(int x, int y)

   257

{

   258

	TileIndex tile = TileVirtXY(x, y);

   259

   260

	return _tile_type_procs[GetTileType(tile)]->get_slope_z_proc(tile, x, y);

   261

}

   262

   263

/**

   264

 * Determine the Z height of a corner relative to TileZ.

   265

 *

   266

 * @pre The slope must not be a halftile slope.

   267

 *

   268

 * @param tileh The slope.

   269

 * @param corner The corner.

   270

 * @return Z position of corner relative to TileZ.

   271

 */

   272

int GetSlopeZInCorner(Slope tileh, Corner corner)

   273

{

   274

	assert(!IsHalftileSlope(tileh));

   275

	return ((tileh & SlopeWithOneCornerRaised(corner)) != 0 ? TILE_HEIGHT : 0) + (tileh == SteepSlope(corner) ? TILE_HEIGHT : 0);

   276

}

   277

   278

/**

   279

 * Determine the Z height of the corners of a specific tile edge

   280

 *

   281

 * @note If a tile has a non-continuous halftile foundation, a corner can have different heights wrt. it's edges.

   282

 *

   283

 * @pre z1 and z2 must be initialized (typ. with TileZ). The corner heights just get added.

   284

 *

   285

 * @param tileh The slope of the tile.

   286

 * @param edge The edge of interest.

   287

 * @param z1 Gets incremented by the height of the first corner of the edge. (near corner wrt. the camera)

   288

 * @param z2 Gets incremented by the height of the second corner of the edge. (far corner wrt. the camera)

   289

 */

   290

void GetSlopeZOnEdge(Slope tileh, DiagDirection edge, int *z1, int *z2)

   291

{

   292

	static const Slope corners[4][4] = {

   293

		/*    corner     |          steep slope

   294

		 *  z1      z2   |       z1             z2        */

   295

		{SLOPE_E, SLOPE_N, SLOPE_STEEP_E, SLOPE_STEEP_N}, // DIAGDIR_NE, z1 = E, z2 = N

   296

		{SLOPE_S, SLOPE_E, SLOPE_STEEP_S, SLOPE_STEEP_E}, // DIAGDIR_SE, z1 = S, z2 = E

   297

		{SLOPE_S, SLOPE_W, SLOPE_STEEP_S, SLOPE_STEEP_W}, // DIAGDIR_SW, z1 = S, z2 = W

   298

		{SLOPE_W, SLOPE_N, SLOPE_STEEP_W, SLOPE_STEEP_N}, // DIAGDIR_NW, z1 = W, z2 = N

   299

	};

   300

   301

	int halftile_test = (IsHalftileSlope(tileh) ? SlopeWithOneCornerRaised(GetHalftileSlopeCorner(tileh)) : 0);

   302

	if (halftile_test == corners[edge][0]) *z2 += TILE_HEIGHT; // The slope is non-continuous in z2. z2 is on the upper side.

   303

	if (halftile_test == corners[edge][1]) *z1 += TILE_HEIGHT; // The slope is non-continuous in z1. z1 is on the upper side.

   304

   305

	if ((tileh & corners[edge][0]) != 0) *z1 += TILE_HEIGHT; // z1 is raised

   306

	if ((tileh & corners[edge][1]) != 0) *z2 += TILE_HEIGHT; // z2 is raised

   307

	if (RemoveHalftileSlope(tileh) == corners[edge][2]) *z1 += TILE_HEIGHT; // z1 is highest corner of a steep slope

   308

	if (RemoveHalftileSlope(tileh) == corners[edge][3]) *z2 += TILE_HEIGHT; // z2 is highest corner of a steep slope

   309

}

   310

   311

/**

   312

 * Get slope of a tile on top of a (possible) foundation

   313

 * If a tile does not have a foundation, the function returns the same as GetTileSlope.

   314

 *

   315

 * @param tile The tile of interest.

   316

 * @param z returns the z of the foundation slope. (Can be NULL, if not needed)

   317

 * @return The slope on top of the foundation.

   318

 */

   319

Slope GetFoundationSlope(TileIndex tile, uint* z)

   320

{

   321

	Slope tileh = GetTileSlope(tile, z);

   322

	Foundation f = _tile_type_procs[GetTileType(tile)]->get_foundation_proc(tile, tileh);

   323

	uint z_inc = ApplyFoundationToSlope(f, &tileh);

   324

	if (z != NULL) *z += z_inc;

   325

	return tileh;

   326

}

   327

   328

   329

static bool HasFoundationNW(TileIndex tile, Slope slope_here, uint z_here)

   330

{

   331

	uint z;

   332

   333

	int z_W_here = z_here;

   334

	int z_N_here = z_here;

   335

	GetSlopeZOnEdge(slope_here, DIAGDIR_NW, &z_W_here, &z_N_here);

   336

   337

	Slope slope = GetFoundationSlope(TILE_ADDXY(tile, 0, -1), &z);

   338

	int z_W = z;

   339

	int z_N = z;

   340

	GetSlopeZOnEdge(slope, DIAGDIR_SE, &z_W, &z_N);

   341

   342

	return (z_N_here > z_N) || (z_W_here > z_W);

   343

}

   344

   345

   346

static bool HasFoundationNE(TileIndex tile, Slope slope_here, uint z_here)

   347

{

   348

	uint z;

   349

   350

	int z_E_here = z_here;

   351

	int z_N_here = z_here;

   352

	GetSlopeZOnEdge(slope_here, DIAGDIR_NE, &z_E_here, &z_N_here);

   353

   354

	Slope slope = GetFoundationSlope(TILE_ADDXY(tile, -1, 0), &z);

   355

	int z_E = z;

   356

	int z_N = z;

   357

	GetSlopeZOnEdge(slope, DIAGDIR_SW, &z_E, &z_N);

   358

   359

	return (z_N_here > z_N) || (z_E_here > z_E);

   360

}

   361

   362

   363

void DrawFoundation(TileInfo *ti, Foundation f)

   364

{

   365

	if (!IsFoundation(f)) return;

   366

   367

	/* Two part foundations must be drawn separately */

   368

	assert(f != FOUNDATION_STEEP_BOTH);

   369

   370

	uint sprite_block = 0;

   371

	uint z;

   372

	Slope slope = GetFoundationSlope(ti->tile, &z);

   373

   374

	/* Select the needed block of foundations sprites

   375

	 * Block 0: Walls at NW and NE edge

   376

	 * Block 1: Wall  at        NE edge

   377

	 * Block 2: Wall  at NW        edge

   378

	 * Block 3: No walls at NW or NE edge

   379

	 */

   380

	if (!HasFoundationNW(ti->tile, slope, z)) sprite_block += 1;

   381

	if (!HasFoundationNE(ti->tile, slope, z)) sprite_block += 2;

   382

   383

	/* Use the original slope sprites if NW and NE borders should be visible */

   384

	SpriteID leveled_base = (sprite_block == 0 ? (int)SPR_FOUNDATION_BASE : (SPR_SLOPES_VIRTUAL_BASE + sprite_block * SPR_TRKFOUND_BLOCK_SIZE));

   385

	SpriteID inclined_base = SPR_SLOPES_VIRTUAL_BASE + SPR_SLOPES_INCLINED_OFFSET + sprite_block * SPR_TRKFOUND_BLOCK_SIZE;

   386

	SpriteID halftile_base = SPR_HALFTILE_FOUNDATION_BASE + sprite_block * SPR_HALFTILE_BLOCK_SIZE;

   387

   388

	if (IsSteepSlope(ti->tileh)) {

   389

		if (!IsNonContinuousFoundation(f)) {

   390

			/* Lower part of foundation */

   391

			AddSortableSpriteToDraw(

   392

				leveled_base + (ti->tileh & ~SLOPE_STEEP), PAL_NONE, ti->x, ti->y, 16, 16, 7, ti->z

   393

			);

   394

		}

   395

   396

		Corner highest_corner = GetHighestSlopeCorner(ti->tileh);

   397

		ti->z += ApplyFoundationToSlope(f, &ti->tileh);

   398

   399

		if (IsInclinedFoundation(f)) {

   400

			/* inclined foundation */

   401

			byte inclined = highest_corner * 2 + (f == FOUNDATION_INCLINED_Y ? 1 : 0);

   402

   403

			AddSortableSpriteToDraw(inclined_base + inclined, PAL_NONE, ti->x, ti->y, 16, 16, 1, ti->z);

   404

			OffsetGroundSprite(31, 9);

   405

		} else if (f == FOUNDATION_STEEP_LOWER) {

   406

			/* one corner raised */

   407

			OffsetGroundSprite(31, 1);

   408

		} else {

   409

			/* halftile foundation */

   410

			int x_bb = (((highest_corner == CORNER_W) || (highest_corner == CORNER_S)) ? 8 : 0);

   411

			int y_bb = (((highest_corner == CORNER_S) || (highest_corner == CORNER_E)) ? 8 : 0);

   412

   413

			AddSortableSpriteToDraw(halftile_base + highest_corner, PAL_NONE, ti->x + x_bb, ti->y + y_bb, 8, 8, 7, ti->z + TILE_HEIGHT);

   414

			OffsetGroundSprite(31, 9);

   415

		}

   416

	} else {

   417

		if (IsLeveledFoundation(f)) {

   418

			/* leveled foundation */

   419

			AddSortableSpriteToDraw(leveled_base + ti->tileh, PAL_NONE, ti->x, ti->y, 16, 16, 7, ti->z);

   420

			OffsetGroundSprite(31, 1);

   421

		} else if (IsNonContinuousFoundation(f)) {

   422

			/* halftile foundation */

   423

			Corner halftile_corner = GetHalftileFoundationCorner(f);

   424

			int x_bb = (((halftile_corner == CORNER_W) || (halftile_corner == CORNER_S)) ? 8 : 0);

   425

			int y_bb = (((halftile_corner == CORNER_S) || (halftile_corner == CORNER_E)) ? 8 : 0);

   426

   427

			AddSortableSpriteToDraw(halftile_base + halftile_corner, PAL_NONE, ti->x + x_bb, ti->y + y_bb, 8, 8, 7, ti->z);

   428

			OffsetGroundSprite(31, 9);

   429

		} else if (IsSpecialRailFoundation(f)) {

   430

			/* anti-zig-zag foundation */

   431

			SpriteID spr;

   432

			if (ti->tileh == SLOPE_NS || ti->tileh == SLOPE_EW) {

   433

				/* half of leveled foundation under track corner */

   434

				spr = leveled_base + SlopeWithThreeCornersRaised(GetRailFoundationCorner(f));

   435

			} else {

   436

				/* tile-slope = sloped along X/Y, foundation-slope = three corners raised */

   437

				spr = inclined_base + 2 * GetRailFoundationCorner(f) + ((ti->tileh == SLOPE_SW || ti->tileh == SLOPE_NE) ? 1 : 0);

   438

			}

   439

			AddSortableSpriteToDraw(spr, PAL_NONE, ti->x, ti->y, 16, 16, 7, ti->z);

   440

			OffsetGroundSprite(31, 9);

   441

		} else {

   442

			/* inclined foundation */

   443

			byte inclined = GetHighestSlopeCorner(ti->tileh) * 2 + (f == FOUNDATION_INCLINED_Y ? 1 : 0);

   444

   445

			AddSortableSpriteToDraw(inclined_base + inclined, PAL_NONE, ti->x, ti->y, 16, 16, 1, ti->z);

   446

			OffsetGroundSprite(31, 9);

   447

		}

   448

		ti->z += ApplyFoundationToSlope(f, &ti->tileh);

   449

	}

   450

}

   451

   452

void DoClearSquare(TileIndex tile)

   453

{

   454

	MakeClear(tile, CLEAR_GRASS, _generating_world ? 3 : 0);

   455

	MarkTileDirtyByTile(tile);

   456

}

   457

   458

/** Returns information about trackdirs and signal states.

   459

 * If there is any trackbit at 'side', return all trackdirbits.

   460

 * For TRANSPORT_ROAD, return no trackbits if there is no roadbit (of given subtype) at given side.

   461

 * @param tile tile to get info about

   462

 * @param mode transport type

   463

 * @param sub_mode for TRANSPORT_ROAD, roadtypes to check

   464

 * @param side side we are entering from, INVALID_DIAGDIR to return all trackbits

   465

 * @return trackdirbits and other info depending on 'mode'

   466

 */

   467

TrackStatus GetTileTrackStatus(TileIndex tile, TransportType mode, uint sub_mode, DiagDirection side)

   468

{

   469

	return _tile_type_procs[GetTileType(tile)]->get_tile_track_status_proc(tile, mode, sub_mode, side);

   470

}

   471

   472

void ChangeTileOwner(TileIndex tile, PlayerID old_player, PlayerID new_player)

   473

{

   474

	_tile_type_procs[GetTileType(tile)]->change_tile_owner_proc(tile, old_player, new_player);

   475

}

   476

   477

void GetAcceptedCargo(TileIndex tile, AcceptedCargo ac)

   478

{

   479

	memset(ac, 0, sizeof(AcceptedCargo));

   480

	_tile_type_procs[GetTileType(tile)]->get_accepted_cargo_proc(tile, ac);

   481

}

   482

   483

void AnimateTile(TileIndex tile)

   484

{

   485

	_tile_type_procs[GetTileType(tile)]->animate_tile_proc(tile);

   486

}

   487

   488

void ClickTile(TileIndex tile)

   489

{

   490

	_tile_type_procs[GetTileType(tile)]->click_tile_proc(tile);

   491