1

/* $Id$ */

     2

     3

/** @file road_gui.cpp GUI for building roads. */

     4

     5

#include "stdafx.h"

     6

#include "openttd.h"

     7

#include "gui.h"

     8

#include "window_gui.h"

     9

#include "station_gui.h"

    10

#include "terraform_gui.h"

    11

#include "viewport_func.h"

    12

#include "gfx_func.h"

    13

#include "command_func.h"

    14

#include "variables.h"

    15

#include "road_type.h"

    16

#include "road_cmd.h"

    17

#include "road_map.h"

    18

#include "station_map.h"

    19

#include "functions.h"

    20

#include "window_func.h"

    21

#include "vehicle_func.h"

    22

#include "sound_func.h"

    23

#include "company_func.h"

    24

#include "settings_type.h"

    25

#include "tunnelbridge.h"

    26

#include "tilehighlight_func.h"

    27

#include "company_base.h"

    28

    29

#include "table/sprites.h"

    30

#include "table/strings.h"

    31

    32

static void ShowRVStationPicker(Window *parent, RoadStopType rs);

    33

static void ShowRoadDepotPicker(Window *parent);

    34

    35

static bool _remove_button_clicked;

    36

static bool _one_way_button_clicked;

    37

    38

/**

    39

 * Define the values of the RoadFlags

    40

 * @see CmdBuildLongRoad

    41

 */

    42

enum RoadFlags {

    43

	RF_NONE             = 0x00,

    44

	RF_START_HALFROAD_Y = 0x01,    // The start tile in Y-dir should have only a half road

    45

	RF_END_HALFROAD_Y   = 0x02,    // The end tile in Y-dir should have only a half road

    46

	RF_DIR_Y            = 0x04,    // The direction is Y-dir

    47

	RF_DIR_X            = RF_NONE, // Dummy; Dir X is set when RF_DIR_Y is not set

    48

	RF_START_HALFROAD_X = 0x08,    // The start tile in X-dir should have only a half road

    49

	RF_END_HALFROAD_X   = 0x10,    // The end tile in X-dir should have only a half road

    50

};

    51

DECLARE_ENUM_AS_BIT_SET(RoadFlags);

    52

    53

static RoadFlags _place_road_flag;

    54

    55

static RoadType _cur_roadtype;

    56

    57

static DiagDirection _road_depot_orientation;

    58

static DiagDirection _road_station_picker_orientation;

    59

    60

void CcPlaySound1D(bool success, TileIndex tile, uint32 p1, uint32 p2)

    61

{

    62

	if (success) SndPlayTileFx(SND_1F_SPLAT, tile);

    63

}

    64

    65

/**

    66

 * Set the initial flags for the road constuction.

    67

 * The flags are:

    68

 * @li The direction is the X-dir

    69

 * @li The first tile has a partitial RoadBit (true or false)

    70

 *

    71

 * @param tile The start tile

    72

 */

    73

static void PlaceRoad_X_Dir(TileIndex tile)

    74

{

    75

	_place_road_flag = RF_DIR_X;

    76

	if (_tile_fract_coords.x >= 8) _place_road_flag |= RF_START_HALFROAD_X;

    77

	VpStartPlaceSizing(tile, VPM_FIX_Y, DDSP_PLACE_ROAD_X_DIR);

    78

}

    79

    80

/**

    81

 * Set the initial flags for the road constuction.

    82

 * The flags are:

    83

 * @li The direction is the Y-dir

    84

 * @li The first tile has a partitial RoadBit (true or false)

    85

 *

    86

 * @param tile The start tile

    87

 */

    88

static void PlaceRoad_Y_Dir(TileIndex tile)

    89

{

    90

	_place_road_flag = RF_DIR_Y;

    91

	if (_tile_fract_coords.y >= 8) _place_road_flag |= RF_START_HALFROAD_Y;

    92

	VpStartPlaceSizing(tile, VPM_FIX_X, DDSP_PLACE_ROAD_Y_DIR);

    93

}

    94

    95

/**

    96

 * Set the initial flags for the road constuction.

    97

 * The flags are:

    98

 * @li The direction is not set.

    99

 * @li The first tile has a partitial RoadBit (true or false)

   100

 *

   101

 * @param tile The start tile

   102

 */

   103

static void PlaceRoad_AutoRoad(TileIndex tile)

   104

{

   105

	_place_road_flag = RF_NONE;

   106

	if (_tile_fract_coords.x >= 8) _place_road_flag |= RF_START_HALFROAD_X;

   107

	if (_tile_fract_coords.y >= 8) _place_road_flag |= RF_START_HALFROAD_Y;

   108

	VpStartPlaceSizing(tile, VPM_X_OR_Y, DDSP_PLACE_AUTOROAD);

   109

}

   110

   111

static void PlaceRoad_Bridge(TileIndex tile)

   112

{

   113

	VpStartPlaceSizing(tile, VPM_X_OR_Y, DDSP_BUILD_BRIDGE);

   114

}

   115

   116

   117

void CcBuildRoadTunnel(bool success, TileIndex tile, uint32 p1, uint32 p2)

   118

{

   119

	if (success) {

   120

		SndPlayTileFx(SND_20_SPLAT_2, tile);

   121

		ResetObjectToPlace();

   122

	} else {

   123

		SetRedErrorSquare(_build_tunnel_endtile);

   124

	}

   125

}

   126

   127

/** Structure holding information per roadtype for several functions */

   128

struct RoadTypeInfo {

   129

	StringID err_build_road;        ///< Building a normal piece of road

   130

	StringID err_remove_road;       ///< Removing a normal piece of road

   131

	StringID err_depot;             ///< Building a depot

   132

	StringID err_build_station[2];  ///< Building a bus or truck station

   133

	StringID err_remove_station[2]; ///< Removing of a bus or truck station

   134

   135

	StringID picker_title[2];       ///< Title for the station picker for bus or truck stations

   136

	StringID picker_tooltip[2];     ///< Tooltip for the station picker for bus or truck stations

   137

   138

	SpriteID cursor_nesw;           ///< Cursor for building NE and SW bits

   139

	SpriteID cursor_nwse;           ///< Cursor for building NW and SE bits

   140

	SpriteID cursor_autoroad;       ///< Cursor for building autoroad

   141

};

   142

   143

/** What errors/cursors must be shown for several types of roads */

   144

static const RoadTypeInfo _road_type_infos[] = {

   145

	{

   146

		STR_1804_CAN_T_BUILD_ROAD_HERE,

   147

		STR_1805_CAN_T_REMOVE_ROAD_FROM,

   148

		STR_1807_CAN_T_BUILD_ROAD_VEHICLE,

   149

		{ STR_1808_CAN_T_BUILD_BUS_STATION,        STR_1809_CAN_T_BUILD_TRUCK_STATION },

   150

		{ STR_CAN_T_REMOVE_BUS_STATION,            STR_CAN_T_REMOVE_TRUCK_STATION     },

   151

		{ STR_3042_BUS_STATION_ORIENTATION,        STR_3043_TRUCK_STATION_ORIENT      },

   152

		{ STR_3051_SELECT_BUS_STATION_ORIENTATION, STR_3052_SELECT_TRUCK_LOADING_BAY  },

   153

   154

		SPR_CURSOR_ROAD_NESW,

   155

		SPR_CURSOR_ROAD_NWSE,

   156

		SPR_CURSOR_AUTOROAD,

   157

	},

   158

	{

   159

		STR_CAN_T_BUILD_TRAMWAY_HERE,

   160

		STR_CAN_T_REMOVE_TRAMWAY_FROM,

   161

		STR_CAN_T_BUILD_TRAM_VEHICLE,

   162

		{ STR_CAN_T_BUILD_PASSENGER_TRAM_STATION,        STR_CAN_T_BUILD_CARGO_TRAM_STATION        },

   163

		{ STR_CAN_T_REMOVE_PASSENGER_TRAM_STATION,       STR_CAN_T_REMOVE_CARGO_TRAM_STATION       },

   164

		{ STR_PASSENGER_TRAM_STATION_ORIENTATION,        STR_CARGO_TRAM_STATION_ORIENT             },

   165

		{ STR_SELECT_PASSENGER_TRAM_STATION_ORIENTATION, STR_SELECT_CARGO_TRAM_STATION_ORIENTATION },

   166

   167

		SPR_CURSOR_TRAMWAY_NESW,

   168

		SPR_CURSOR_TRAMWAY_NWSE,

   169

		SPR_CURSOR_AUTOTRAM,

   170

	},

   171

};

   172

   173

static void PlaceRoad_Tunnel(TileIndex tile)

   174

{

   175

	DoCommandP(tile, 0x200 | RoadTypeToRoadTypes(_cur_roadtype), 0, CcBuildRoadTunnel, CMD_BUILD_TUNNEL | CMD_MSG(STR_5016_CAN_T_BUILD_TUNNEL_HERE));

   176

}

   177

   178

static void BuildRoadOutsideStation(TileIndex tile, DiagDirection direction)

   179

{

   180

	tile += TileOffsByDiagDir(direction);

   181

	/* if there is a roadpiece just outside of the station entrance, build a connecting route */

   182

	if (IsNormalRoadTile(tile)) {

   183

		if (GetRoadBits(tile, _cur_roadtype) != ROAD_NONE) {

   184

			DoCommandP(tile, _cur_roadtype << 4 | DiagDirToRoadBits(ReverseDiagDir(direction)), 0, NULL, CMD_BUILD_ROAD);

   185

		}

   186

	}

   187

}

   188

   189

void CcRoadDepot(bool success, TileIndex tile, uint32 p1, uint32 p2)

   190

{

   191

	if (success) {

   192

		DiagDirection dir = (DiagDirection)GB(p1, 0, 2);

   193

		SndPlayTileFx(SND_1F_SPLAT, tile);

   194

		ResetObjectToPlace();

   195

		BuildRoadOutsideStation(tile, dir);

   196

		/* For a drive-through road stop build connecting road for other entrance */

   197

		if (HasBit(p2, 1)) BuildRoadOutsideStation(tile, ReverseDiagDir(dir));

   198

	}

   199

}

   200

   201

static void PlaceRoad_Depot(TileIndex tile)

   202

{

   203

	DoCommandP(tile, _cur_roadtype << 2 | _road_depot_orientation, 0, CcRoadDepot, CMD_BUILD_ROAD_DEPOT | CMD_NO_WATER | CMD_MSG(_road_type_infos[_cur_roadtype].err_depot));

   204

}

   205

   206

static void PlaceRoadStop(TileIndex tile, uint32 p2, uint32 cmd)

   207

{

   208

	uint32 p1 = _road_station_picker_orientation;

   209

   210

	if (p1 >= DIAGDIR_END) {

   211

		SetBit(p2, 1); // It's a drive-through stop

   212

		p1 -= DIAGDIR_END; // Adjust picker result to actual direction

   213

	}

   214

	DoCommandP(tile, p1, p2, CcRoadDepot, cmd);

   215

}

   216

   217

static void PlaceRoad_BusStation(TileIndex tile)

   218

{

   219

	if (_remove_button_clicked) {

   220

		DoCommandP(tile, 0, ROADSTOP_BUS, CcPlaySound1D, CMD_REMOVE_ROAD_STOP | CMD_MSG(_road_type_infos[_cur_roadtype].err_remove_station[ROADSTOP_BUS]));

   221

	} else {

   222

		PlaceRoadStop(tile, (_ctrl_pressed << 5) | RoadTypeToRoadTypes(_cur_roadtype) << 2 | ROADSTOP_BUS, CMD_BUILD_ROAD_STOP | CMD_NO_WATER | CMD_MSG(_road_type_infos[_cur_roadtype].err_build_station[ROADSTOP_BUS]));

   223

	}

   224

}

   225

   226

static void PlaceRoad_TruckStation(TileIndex tile)

   227

{

   228

	if (_remove_button_clicked) {

   229

		DoCommandP(tile, 0, ROADSTOP_TRUCK, CcPlaySound1D, CMD_REMOVE_ROAD_STOP | CMD_MSG(_road_type_infos[_cur_roadtype].err_remove_station[ROADSTOP_TRUCK]));

   230

	} else {

   231

		PlaceRoadStop(tile, (_ctrl_pressed << 5) | RoadTypeToRoadTypes(_cur_roadtype) << 2 | ROADSTOP_TRUCK, CMD_BUILD_ROAD_STOP | CMD_NO_WATER | CMD_MSG(_road_type_infos[_cur_roadtype].err_build_station[ROADSTOP_TRUCK]));

   232

	}

   233

}

   234

   235

/** Enum referring to the widgets of the build road toolbar */

   236

enum RoadToolbarWidgets {

   237

	RTW_CLOSEBOX = 0,

   238

	RTW_CAPTION,

   239

	RTW_STICKY,

   240

	RTW_ROAD_X,

   241

	RTW_ROAD_Y,

   242

	RTW_AUTOROAD,

   243

	RTW_DEMOLISH,

   244

	RTW_DEPOT,

   245

	RTW_BUS_STATION,

   246

	RTW_TRUCK_STATION,

   247

	RTW_ONE_WAY,

   248

	RTW_BUILD_BRIDGE,

   249

	RTW_BUILD_TUNNEL,

   250

	RTW_REMOVE,

   251

};

   252

   253

typedef void OnButtonClick(Window *w);

   254

   255

   256

/** Toogles state of the Remove button of Build road toolbar

   257

 * @param w window the button belongs to

   258

 */

   259

static void ToggleRoadButton_Remove(Window *w)

   260

{

   261

	w->ToggleWidgetLoweredState(RTW_REMOVE);

   262

	w->InvalidateWidget(RTW_REMOVE);

   263

	_remove_button_clicked = w->IsWidgetLowered(RTW_REMOVE);

   264

	SetSelectionRed(_remove_button_clicked);

   265

}

   266

   267

/** Updates the Remove button because of Ctrl state change

   268

 * @param w window the button belongs to

   269

 * @return true iff the remove buton was changed

   270

 */

   271

static bool RoadToolbar_CtrlChanged(Window *w)

   272

{

   273

	if (w->IsWidgetDisabled(RTW_REMOVE)) return false;

   274

   275

	/* allow ctrl to switch remove mode only for these widgets */

   276

	for (uint i = RTW_ROAD_X; i <= RTW_AUTOROAD; i++) {

   277

		if (w->IsWidgetLowered(i)) {

   278

			ToggleRoadButton_Remove(w);

   279

			return true;

   280

		}

   281

	}

   282

   283

	return false;

   284

}

   285

   286

   287

/**

   288

 * Function that handles the click on the

   289

 *  X road placement button.

   290

 *

   291

 * @param w The current window

   292

 */

   293

static void BuildRoadClick_X_Dir(Window *w)

   294

{

   295

	HandlePlacePushButton(w, RTW_ROAD_X, _road_type_infos[_cur_roadtype].cursor_nwse, VHM_RECT, PlaceRoad_X_Dir);

   296

}

   297

   298

/**

   299

 * Function that handles the click on the

   300

 *  Y road placement button.

   301

 *

   302

 * @param w The current window

   303

 */

   304

static void BuildRoadClick_Y_Dir(Window *w)

   305

{

   306

	HandlePlacePushButton(w, RTW_ROAD_Y, _road_type_infos[_cur_roadtype].cursor_nesw, VHM_RECT, PlaceRoad_Y_Dir);

   307

}

   308

   309

/**

   310

 * Function that handles the click on the

   311

 *  autoroad placement button.

   312

 *

   313

 * @param w The current window

   314

 */

   315

static void BuildRoadClick_AutoRoad(Window *w)

   316

{

   317

	HandlePlacePushButton(w, RTW_AUTOROAD, _road_type_infos[_cur_roadtype].cursor_autoroad, VHM_RECT, PlaceRoad_AutoRoad);

   318

}

   319

   320

static void BuildRoadClick_Demolish(Window *w)

   321

{

   322

	HandlePlacePushButton(w, RTW_DEMOLISH, ANIMCURSOR_DEMOLISH, VHM_RECT, PlaceProc_DemolishArea);

   323

}

   324

   325

static void BuildRoadClick_Depot(Window *w)

   326

{

   327

	if (_game_mode == GM_EDITOR || !CanBuildVehicleInfrastructure(VEH_ROAD)) return;

   328

	if (HandlePlacePushButton(w, RTW_DEPOT, SPR_CURSOR_ROAD_DEPOT, VHM_RECT, PlaceRoad_Depot)) ShowRoadDepotPicker(w);

   329

}

   330

   331

static void BuildRoadClick_BusStation(Window *w)

   332

{

   333

	if (_game_mode == GM_EDITOR || !CanBuildVehicleInfrastructure(VEH_ROAD)) return;

   334

	if (HandlePlacePushButton(w, RTW_BUS_STATION, SPR_CURSOR_BUS_STATION, VHM_RECT, PlaceRoad_BusStation)) ShowRVStationPicker(w, ROADSTOP_BUS);

   335

}

   336

   337

static void BuildRoadClick_TruckStation(Window *w)

   338

{

   339

	if (_game_mode == GM_EDITOR || !CanBuildVehicleInfrastructure(VEH_ROAD)) return;

   340

	if (HandlePlacePushButton(w, RTW_TRUCK_STATION, SPR_CURSOR_TRUCK_STATION, VHM_RECT, PlaceRoad_TruckStation)) ShowRVStationPicker(w, ROADSTOP_TRUCK);

   341

}

   342

   343

/**

   344

 * Function that handles the click on the

   345

 *  one way road button.

   346

 *

   347

 * @param w The current window

   348

 */

   349

static void BuildRoadClick_OneWay(Window *w)

   350

{

   351

	if (w->IsWidgetDisabled(RTW_ONE_WAY)) return;

   352

	w->SetDirty();

   353

	w->ToggleWidgetLoweredState(RTW_ONE_WAY);

   354

	SetSelectionRed(false);

   355

}

   356

   357

static void BuildRoadClick_Bridge(Window *w)

   358

{

   359

	HandlePlacePushButton(w, RTW_BUILD_BRIDGE, SPR_CURSOR_BRIDGE, VHM_RECT, PlaceRoad_Bridge);

   360

}

   361

   362

static void BuildRoadClick_Tunnel(Window *w)

   363

{

   364

	HandlePlacePushButton(w, RTW_BUILD_TUNNEL, SPR_CURSOR_ROAD_TUNNEL, VHM_SPECIAL, PlaceRoad_Tunnel);

   365

}

   366

   367

static void BuildRoadClick_Remove(Window *w)

   368

{

   369

	if (w->IsWidgetDisabled(RTW_REMOVE)) return;

   370

	ToggleRoadButton_Remove(w);

   371

	SndPlayFx(SND_15_BEEP);

   372

}

   373

   374

/** Array with the handlers of the button-clicks for the road-toolbar */

   375

static OnButtonClick* const _build_road_button_proc[] = {

   376

	BuildRoadClick_X_Dir,

   377

	BuildRoadClick_Y_Dir,

   378

	BuildRoadClick_AutoRoad,

   379

	BuildRoadClick_Demolish,

   380

	BuildRoadClick_Depot,

   381

	BuildRoadClick_BusStation,

   382

	BuildRoadClick_TruckStation,

   383

	BuildRoadClick_OneWay,

   384

	BuildRoadClick_Bridge,

   385

	BuildRoadClick_Tunnel,

   386

	BuildRoadClick_Remove

   387

};

   388

   389

/** Array with the keycode of the button-clicks for the road-toolbar */

   390

static const uint16 _road_keycodes[] = {

   391

	'1',

   392

	'2',

   393

	'3',

   394

	'4',

   395

	'5',

   396

	'6',

   397

	'7',

   398

	'8',

   399

	'B',

   400

	'T',

   401

	'R',

   402

};

   403

   404

struct BuildRoadToolbarWindow : Window {

   405

	BuildRoadToolbarWindow(const WindowDesc *desc, WindowNumber window_number) : Window(desc, window_number)

   406

	{

   407

		this->SetWidgetsDisabledState(true,

   408

			RTW_REMOVE,

   409

			RTW_ONE_WAY,

   410

			WIDGET_LIST_END);

   411

   412

		this->FindWindowPlacementAndResize(desc);

   413

		if (_settings_client.gui.link_terraform_toolbar) ShowTerraformToolbar(this);

   414

	}

   415

   416

	~BuildRoadToolbarWindow()

   417

	{

   418

		if (_settings_client.gui.link_terraform_toolbar) DeleteWindowById(WC_SCEN_LAND_GEN, 0);

   419

	}

   420

   421

	/**

   422

	 * Update the remove button lowered state of the road toolbar

   423

	 *

   424

	 * @param clicked_widget The widget which the client clicked just now

   425

	 */

   426

	void UpdateOptionWidgetStatus(RoadToolbarWidgets clicked_widget)

   427

	{

   428

		/* The remove and the one way button state is driven

   429

		 * by the other buttons so they don't act on themselfs.

   430

		 * Both are only valid if they are able to apply as options. */

   431

		switch (clicked_widget) {

   432

			case RTW_REMOVE:

   433

				this->RaiseWidget(RTW_ONE_WAY);

   434

				this->InvalidateWidget(RTW_ONE_WAY);

   435

				break;

   436

   437

			case RTW_ONE_WAY:

   438

				this->RaiseWidget(RTW_REMOVE);

   439

				this->InvalidateWidget(RTW_REMOVE);

   440

				break;

   441

   442

			case RTW_BUS_STATION:

   443

			case RTW_TRUCK_STATION:

   444

				this->DisableWidget(RTW_ONE_WAY);

   445

				this->SetWidgetDisabledState(RTW_REMOVE, !this->IsWidgetLowered(clicked_widget));

   446

				break;

   447

   448

			case RTW_ROAD_X:

   449

			case RTW_ROAD_Y:

   450

			case RTW_AUTOROAD:

   451

				this->SetWidgetsDisabledState(!this->IsWidgetLowered(clicked_widget),

   452

					RTW_REMOVE,

   453

					RTW_ONE_WAY,

   454

					WIDGET_LIST_END);

   455

				break;

   456

   457

			default:

   458

				/* When any other buttons than road/station, raise and

   459

				 * disable the removal button */

   460

				this->SetWidgetsDisabledState(true,

   461

					RTW_REMOVE,

   462

					RTW_ONE_WAY,

   463

					WIDGET_LIST_END);

   464

				this->SetWidgetsLoweredState (false,

   465

					RTW_REMOVE,

   466

					RTW_ONE_WAY,

   467

					WIDGET_LIST_END);

   468

				break;

   469

		}

   470

	}

   471

   472

	virtual void OnPaint()

   473

	{

   474

		this->SetWidgetsDisabledState(!CanBuildVehicleInfrastructure(VEH_ROAD),

   475

			RTW_DEPOT,

   476

			RTW_BUS_STATION,

   477

			RTW_TRUCK_STATION,

   478

			WIDGET_LIST_END);

   479

		this->DrawWidgets();

   480

	}

   481

   482

	virtual void OnClick(Point pt, int widget)

   483

	{

   484

		if (widget >= RTW_ROAD_X) {

   485

			_remove_button_clicked = false;

   486

			_one_way_button_clicked = false;

   487

			_build_road_button_proc[widget - RTW_ROAD_X](this);

   488

		}

   489

		this->UpdateOptionWidgetStatus((RoadToolbarWidgets)widget);

   490

		if (_ctrl_pressed) RoadToolbar_CtrlChanged(this);