(svn r28004) -Update from Eints:
[openttd.git] / src / elrail.cpp
blob9fdfb57a3df771ae5a284ab53c1861d345663c2b
1 /* $Id$ */
3 /*
4 * This file is part of OpenTTD.
5 * OpenTTD is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, version 2.
6 * OpenTTD is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
7 * See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with OpenTTD. If not, see <http://www.gnu.org/licenses/>.
8 */
10 /**
11 * @file elrail.cpp
12 * This file deals with displaying wires and pylons for electric railways.
13 * <h2>Basics</h2>
15 * <h3>Tile Types</h3>
17 * We have two different types of tiles in the drawing code:
18 * Normal Railway Tiles (NRTs) which can have more than one track on it, and
19 * Special Railways tiles (SRTs) which have only one track (like crossings, depots
20 * stations, etc).
22 * <h3>Location Categories</h3>
24 * All tiles are categorized into three location groups (TLG):
25 * Group 0: Tiles with both an even X coordinate and an even Y coordinate
26 * Group 1: Tiles with an even X and an odd Y coordinate
27 * Group 2: Tiles with an odd X and an even Y coordinate
28 * Group 3: Tiles with both an odd X and Y coordinate.
30 * <h3>Pylon Points</h3>
31 * <h4>Control Points</h4>
32 * A Pylon Control Point (PCP) is a position where a wire (or rather two)
33 * is mounted onto a pylon.
34 * Each NRT does contain 4 PCPs which are bitmapped to a byte
35 * variable and are represented by the DiagDirection enum
37 * Each track ends on two PCPs and thus requires one pylon on each end. However,
38 * there is one exception: Straight-and-level tracks only have one pylon every
39 * other tile.
41 * Now on each edge there are two PCPs: One from each adjacent tile. Both PCPs
42 * are merged using an OR operation (i. e. if one tile needs a PCP at the position
43 * in question, both tiles get it).
45 * <h4>Position Points</h4>
46 * A Pylon Position Point (PPP) is a position where a pylon is located on the
47 * ground. Each PCP owns 8 in (45 degree steps) PPPs that are located around
48 * it. PPPs are represented using the Direction enum. Each track bit has PPPs
49 * that are impossible (because the pylon would be situated on the track) and
50 * some that are preferred (because the pylon would be rectangular to the track).
52 * @image html elrail_tile.png
53 * @image html elrail_track.png
57 #include "stdafx.h"
58 #include "station_map.h"
59 #include "viewport_func.h"
60 #include "train.h"
61 #include "rail_gui.h"
62 #include "tunnelbridge_map.h"
63 #include "tunnelbridge.h"
64 #include "elrail_func.h"
65 #include "company_base.h"
66 #include "newgrf_railtype.h"
68 #include "table/elrail_data.h"
70 #include "safeguards.h"
72 /**
73 * Get the tile location group of a tile.
74 * @param t The tile to get the tile location group of.
75 * @return The tile location group.
77 static inline TLG GetTLG(TileIndex t)
79 return (TLG)((HasBit(TileX(t), 0) << 1) + HasBit(TileY(t), 0));
82 /**
83 * Finds which Electrified Rail Bits are present on a given tile.
84 * @param t tile to check
85 * @param override pointer to PCP override, can be NULL
86 * @return trackbits of tile if it is electrified
88 static TrackBits GetRailTrackBitsUniversal(TileIndex t, byte *override)
90 switch (GetTileType(t)) {
91 case MP_RAILWAY:
92 if (!HasRailCatenary(GetRailType(t))) return TRACK_BIT_NONE;
93 switch (GetRailTileType(t)) {
94 case RAIL_TILE_NORMAL: case RAIL_TILE_SIGNALS:
95 return GetTrackBits(t);
96 default:
97 return TRACK_BIT_NONE;
99 break;
101 case MP_TUNNELBRIDGE:
102 if (GetTunnelBridgeTransportType(t) != TRANSPORT_RAIL) return TRACK_BIT_NONE;
103 if (!HasRailCatenary(GetRailType(t))) return TRACK_BIT_NONE;
104 if (override != NULL && (IsTunnel(t) || GetTunnelBridgeLength(t, GetOtherBridgeEnd(t)) > 0)) {
105 *override = 1 << GetTunnelBridgeDirection(t);
107 return DiagDirToDiagTrackBits(GetTunnelBridgeDirection(t));
109 case MP_ROAD:
110 if (!IsLevelCrossing(t)) return TRACK_BIT_NONE;
111 if (!HasRailCatenary(GetRailType(t))) return TRACK_BIT_NONE;
112 return GetCrossingRailBits(t);
114 case MP_STATION:
115 if (!HasStationRail(t)) return TRACK_BIT_NONE;
116 if (!HasRailCatenary(GetRailType(t))) return TRACK_BIT_NONE;
117 return TrackToTrackBits(GetRailStationTrack(t));
119 default:
120 return TRACK_BIT_NONE;
125 * Masks out track bits when neighbouring tiles are unelectrified.
127 static TrackBits MaskWireBits(TileIndex t, TrackBits tracks)
129 if (!IsPlainRailTile(t)) return tracks;
131 TrackdirBits neighbour_tdb = TRACKDIR_BIT_NONE;
132 for (DiagDirection d = DIAGDIR_BEGIN; d < DIAGDIR_END; d++) {
133 /* If the neighbour tile is either not electrified or has no tracks that can be reached
134 * from this tile, mark all trackdirs that can be reached from the neighbour tile
135 * as needing no catenary. We make an exception for blocked station tiles with a matching
136 * axis that still display wires to preserve visual continuity. */
137 TileIndex next_tile = TileAddByDiagDir(t, d);
138 RailType rt = GetTileRailType(next_tile);
139 if (rt == INVALID_RAILTYPE || !HasRailCatenary(rt) ||
140 ((TrackStatusToTrackBits(GetTileTrackStatus(next_tile, TRANSPORT_RAIL, 0)) & DiagdirReachesTracks(d)) == TRACK_BIT_NONE &&
141 (!HasStationTileRail(next_tile) || GetRailStationAxis(next_tile) != DiagDirToAxis(d) || !CanStationTileHaveWires(next_tile)))) {
142 neighbour_tdb |= DiagdirReachesTrackdirs(ReverseDiagDir(d));
146 /* If the tracks from either a diagonal crossing or don't overlap, both
147 * trackdirs have to be marked to mask the corresponding track bit. Else
148 * one marked trackdir is enough the mask the track bit. */
149 TrackBits mask;
150 if (tracks == TRACK_BIT_CROSS || !TracksOverlap(tracks)) {
151 /* If the tracks form either a diagonal crossing or don't overlap, both
152 * trackdirs have to be marked to mask the corresponding track bit. */
153 mask = ~(TrackBits)((neighbour_tdb & (neighbour_tdb >> 8)) & TRACK_BIT_MASK);
154 /* If that results in no masked tracks and it is not a diagonal crossing,
155 * require only one marked trackdir to mask. */
156 if (tracks != TRACK_BIT_CROSS && (mask & TRACK_BIT_MASK) == TRACK_BIT_MASK) mask = ~TrackdirBitsToTrackBits(neighbour_tdb);
157 } else {
158 /* Require only one marked trackdir to mask the track. */
159 mask = ~TrackdirBitsToTrackBits(neighbour_tdb);
160 /* If that results in an empty set, require both trackdirs for diagonal track. */
161 if ((tracks & mask) == TRACK_BIT_NONE) {
162 if ((neighbour_tdb & TRACKDIR_BIT_X_NE) == 0 || (neighbour_tdb & TRACKDIR_BIT_X_SW) == 0) mask |= TRACK_BIT_X;
163 if ((neighbour_tdb & TRACKDIR_BIT_Y_NW) == 0 || (neighbour_tdb & TRACKDIR_BIT_Y_SE) == 0) mask |= TRACK_BIT_Y;
164 /* If that still is not enough, require both trackdirs for any track. */
165 if ((tracks & mask) == TRACK_BIT_NONE) mask = ~(TrackBits)((neighbour_tdb & (neighbour_tdb >> 8)) & TRACK_BIT_MASK);
169 /* Mask the tracks only if at least one track bit would remain. */
170 return (tracks & mask) != TRACK_BIT_NONE ? tracks & mask : tracks;
174 * Get the base wire sprite to use.
176 static inline SpriteID GetWireBase(TileIndex tile, TileContext context = TCX_NORMAL)
178 const RailtypeInfo *rti = GetRailTypeInfo(GetRailType(tile));
179 SpriteID wires = GetCustomRailSprite(rti, tile, RTSG_WIRES, context);
180 return wires == 0 ? SPR_WIRE_BASE : wires;
184 * Get the base pylon sprite to use.
186 static inline SpriteID GetPylonBase(TileIndex tile, TileContext context = TCX_NORMAL)
188 const RailtypeInfo *rti = GetRailTypeInfo(GetRailType(tile));
189 SpriteID pylons = GetCustomRailSprite(rti, tile, RTSG_PYLONS, context);
190 return pylons == 0 ? SPR_PYLON_BASE : pylons;
194 * Corrects the tileh for certain tile types. Returns an effective tileh for the track on the tile.
195 * @param tile The tile to analyse
196 * @param *tileh the tileh
198 static void AdjustTileh(TileIndex tile, Slope *tileh)
200 if (IsTileType(tile, MP_TUNNELBRIDGE)) {
201 if (IsTunnel(tile)) {
202 *tileh = SLOPE_STEEP; // XXX - Hack to make tunnel entrances to always have a pylon
203 } else if (*tileh != SLOPE_FLAT) {
204 *tileh = SLOPE_FLAT;
205 } else {
206 *tileh = InclinedSlope(GetTunnelBridgeDirection(tile));
212 * Returns the Z position of a Pylon Control Point.
214 * @param tile The tile the pylon should stand on.
215 * @param PCPpos The PCP of the tile.
216 * @return The Z position of the PCP.
218 static int GetPCPElevation(TileIndex tile, DiagDirection PCPpos)
220 /* The elevation of the "pylon"-sprite should be the elevation at the PCP.
221 * PCPs are always on a tile edge.
223 * This position can be outside of the tile, i.e. ?_pcp_offset == TILE_SIZE > TILE_SIZE - 1.
224 * So we have to move it inside the tile, because if the neighboured tile has a foundation,
225 * that does not smoothly connect to the current tile, we will get a wrong elevation from GetSlopePixelZ().
227 * When we move the position inside the tile, we will get a wrong elevation if we have a slope.
228 * To catch all cases we round the Z position to the next (TILE_HEIGHT / 2).
229 * This will return the correct elevation for slopes and will also detect non-continuous elevation on edges.
231 * Also note that the result of GetSlopePixelZ() is very special on bridge-ramps.
234 int z = GetSlopePixelZ(TileX(tile) * TILE_SIZE + min(x_pcp_offsets[PCPpos], TILE_SIZE - 1), TileY(tile) * TILE_SIZE + min(y_pcp_offsets[PCPpos], TILE_SIZE - 1));
235 return (z + 2) & ~3; // this means z = (z + TILE_HEIGHT / 4) / (TILE_HEIGHT / 2) * (TILE_HEIGHT / 2);
239 * Draws wires on a tunnel tile
241 * DrawTile_TunnelBridge() calls this function to draw the wires as SpriteCombine with the tunnel roof.
243 * @param ti The Tileinfo to draw the tile for
245 void DrawRailCatenaryOnTunnel(const TileInfo *ti)
247 /* xmin, ymin, xmax + 1, ymax + 1 of BB */
248 static const int _tunnel_wire_BB[4][4] = {
249 { 0, 1, 16, 15 }, // NE
250 { 1, 0, 15, 16 }, // SE
251 { 0, 1, 16, 15 }, // SW
252 { 1, 0, 15, 16 }, // NW
255 DiagDirection dir = GetTunnelBridgeDirection(ti->tile);
257 SpriteID wire_base = GetWireBase(ti->tile);
259 const SortableSpriteStruct *sss = &RailCatenarySpriteData_Tunnel[dir];
260 const int *BB_data = _tunnel_wire_BB[dir];
261 AddSortableSpriteToDraw(
262 wire_base + sss->image_offset, PAL_NONE, ti->x + sss->x_offset, ti->y + sss->y_offset,
263 BB_data[2] - sss->x_offset, BB_data[3] - sss->y_offset, BB_Z_SEPARATOR - sss->z_offset + 1,
264 GetTilePixelZ(ti->tile) + sss->z_offset,
265 IsTransparencySet(TO_CATENARY),
266 BB_data[0] - sss->x_offset, BB_data[1] - sss->y_offset, BB_Z_SEPARATOR - sss->z_offset
271 * Draws wires and, if required, pylons on a given tile
272 * @param ti The Tileinfo to draw the tile for
274 static void DrawRailCatenaryRailway(const TileInfo *ti)
276 /* Pylons are placed on a tile edge, so we need to take into account
277 * the track configuration of 2 adjacent tiles. trackconfig[0] stores the
278 * current tile (home tile) while [1] holds the neighbour */
279 TrackBits trackconfig[TS_END];
280 TrackBits wireconfig[TS_END];
281 bool isflat[TS_END];
282 /* Note that ti->tileh has already been adjusted for Foundations */
283 Slope tileh[TS_END] = { ti->tileh, SLOPE_FLAT };
285 /* Half tile slopes coincide only with horizontal/vertical track.
286 * Faking a flat slope results in the correct sprites on positions. */
287 Corner halftile_corner = CORNER_INVALID;
288 if (IsHalftileSlope(tileh[TS_HOME])) {
289 halftile_corner = GetHalftileSlopeCorner(tileh[TS_HOME]);
290 tileh[TS_HOME] = SLOPE_FLAT;
293 TLG tlg = GetTLG(ti->tile);
294 byte PCPstatus = 0;
295 byte OverridePCP = 0;
296 byte PPPpreferred[DIAGDIR_END];
297 byte PPPallowed[DIAGDIR_END];
299 /* Find which rail bits are present, and select the override points.
300 * We don't draw a pylon:
301 * 1) INSIDE a tunnel (we wouldn't see it anyway)
302 * 2) on the "far" end of a bridge head (the one that connects to bridge middle),
303 * because that one is drawn on the bridge. Exception is for length 0 bridges
304 * which have no middle tiles */
305 trackconfig[TS_HOME] = GetRailTrackBitsUniversal(ti->tile, &OverridePCP);
306 wireconfig[TS_HOME] = MaskWireBits(ti->tile, trackconfig[TS_HOME]);
307 /* If a track bit is present that is not in the main direction, the track is level */
308 isflat[TS_HOME] = ((trackconfig[TS_HOME] & (TRACK_BIT_HORZ | TRACK_BIT_VERT)) != 0);
310 AdjustTileh(ti->tile, &tileh[TS_HOME]);
312 SpriteID pylon_normal = GetPylonBase(ti->tile);
313 SpriteID pylon_halftile = (halftile_corner != CORNER_INVALID) ? GetPylonBase(ti->tile, TCX_UPPER_HALFTILE) : pylon_normal;
315 for (DiagDirection i = DIAGDIR_BEGIN; i < DIAGDIR_END; i++) {
316 static const uint edge_corners[] = {
317 1 << CORNER_N | 1 << CORNER_E, // DIAGDIR_NE
318 1 << CORNER_S | 1 << CORNER_E, // DIAGDIR_SE
319 1 << CORNER_S | 1 << CORNER_W, // DIAGDIR_SW
320 1 << CORNER_N | 1 << CORNER_W, // DIAGDIR_NW
322 SpriteID pylon_base = (halftile_corner != CORNER_INVALID && HasBit(edge_corners[i], halftile_corner)) ? pylon_halftile : pylon_normal;
323 TileIndex neighbour = ti->tile + TileOffsByDiagDir(i);
324 int elevation = GetPCPElevation(ti->tile, i);
326 /* Here's one of the main headaches. GetTileSlope does not correct for possibly
327 * existing foundataions, so we do have to do that manually later on.*/
328 tileh[TS_NEIGHBOUR] = GetTileSlope(neighbour);
329 trackconfig[TS_NEIGHBOUR] = GetRailTrackBitsUniversal(neighbour, NULL);
330 wireconfig[TS_NEIGHBOUR] = MaskWireBits(neighbour, trackconfig[TS_NEIGHBOUR]);
331 if (IsTunnelTile(neighbour) && i != GetTunnelBridgeDirection(neighbour)) wireconfig[TS_NEIGHBOUR] = trackconfig[TS_NEIGHBOUR] = TRACK_BIT_NONE;
333 /* Ignore station tiles that allow neither wires nor pylons. */
334 if (IsRailStationTile(neighbour) && !CanStationTileHavePylons(neighbour) && !CanStationTileHaveWires(neighbour)) wireconfig[TS_NEIGHBOUR] = trackconfig[TS_NEIGHBOUR] = TRACK_BIT_NONE;
336 /* If the neighboured tile does not smoothly connect to the current tile (because of a foundation),
337 * we have to draw all pillars on the current tile. */
338 if (elevation != GetPCPElevation(neighbour, ReverseDiagDir(i))) wireconfig[TS_NEIGHBOUR] = trackconfig[TS_NEIGHBOUR] = TRACK_BIT_NONE;
340 isflat[TS_NEIGHBOUR] = ((trackconfig[TS_NEIGHBOUR] & (TRACK_BIT_HORZ | TRACK_BIT_VERT)) != 0);
342 PPPpreferred[i] = 0xFF; // We start with preferring everything (end-of-line in any direction)
343 PPPallowed[i] = AllowedPPPonPCP[i];
345 /* We cycle through all the existing tracks at a PCP and see what
346 * PPPs we want to have, or may not have at all */
347 for (uint k = 0; k < NUM_TRACKS_AT_PCP; k++) {
348 /* Next to us, we have a bridge head, don't worry about that one, if it shows away from us */
349 if (TrackSourceTile[i][k] == TS_NEIGHBOUR &&
350 IsBridgeTile(neighbour) &&
351 GetTunnelBridgeDirection(neighbour) == ReverseDiagDir(i)) {
352 continue;
355 /* We check whether the track in question (k) is present in the tile
356 * (TrackSourceTile) */
357 DiagDirection PCPpos = i;
358 if (HasBit(wireconfig[TrackSourceTile[i][k]], TracksAtPCP[i][k])) {
359 /* track found, if track is in the neighbour tile, adjust the number
360 * of the PCP for preferred/allowed determination*/
361 PCPpos = (TrackSourceTile[i][k] == TS_HOME) ? i : ReverseDiagDir(i);
362 SetBit(PCPstatus, i); // This PCP is in use
363 PPPpreferred[i] &= PreferredPPPofTrackAtPCP[TracksAtPCP[i][k]][PCPpos];
366 if (HasBit(trackconfig[TrackSourceTile[i][k]], TracksAtPCP[i][k])) {
367 PPPallowed[i] &= ~DisallowedPPPofTrackAtPCP[TracksAtPCP[i][k]][PCPpos];
371 /* Deactivate all PPPs if PCP is not used */
372 if (!HasBit(PCPstatus, i)) {
373 PPPpreferred[i] = 0;
374 PPPallowed[i] = 0;
377 Foundation foundation = FOUNDATION_NONE;
379 /* Station and road crossings are always "flat", so adjust the tileh accordingly */
380 if (IsTileType(neighbour, MP_STATION) || IsTileType(neighbour, MP_ROAD)) tileh[TS_NEIGHBOUR] = SLOPE_FLAT;
382 /* Read the foundations if they are present, and adjust the tileh */
383 if (trackconfig[TS_NEIGHBOUR] != TRACK_BIT_NONE && IsTileType(neighbour, MP_RAILWAY) && HasRailCatenary(GetRailType(neighbour))) foundation = GetRailFoundation(tileh[TS_NEIGHBOUR], trackconfig[TS_NEIGHBOUR]);
384 if (IsBridgeTile(neighbour)) {
385 foundation = GetBridgeFoundation(tileh[TS_NEIGHBOUR], DiagDirToAxis(GetTunnelBridgeDirection(neighbour)));
388 ApplyFoundationToSlope(foundation, &tileh[TS_NEIGHBOUR]);
390 /* Half tile slopes coincide only with horizontal/vertical track.
391 * Faking a flat slope results in the correct sprites on positions. */
392 if (IsHalftileSlope(tileh[TS_NEIGHBOUR])) tileh[TS_NEIGHBOUR] = SLOPE_FLAT;
394 AdjustTileh(neighbour, &tileh[TS_NEIGHBOUR]);
396 /* If we have a straight (and level) track, we want a pylon only every 2 tiles
397 * Delete the PCP if this is the case.
398 * Level means that the slope is the same, or the track is flat */
399 if (tileh[TS_HOME] == tileh[TS_NEIGHBOUR] || (isflat[TS_HOME] && isflat[TS_NEIGHBOUR])) {
400 for (uint k = 0; k < NUM_IGNORE_GROUPS; k++) {
401 if (PPPpreferred[i] == IgnoredPCP[k][tlg][i]) ClrBit(PCPstatus, i);
405 /* Now decide where we draw our pylons. First try the preferred PPPs, but they may not exist.
406 * In that case, we try the any of the allowed ones. if they don't exist either, don't draw
407 * anything. Note that the preferred PPPs still contain the end-of-line markers.
408 * Remove those (simply by ANDing with allowed, since these markers are never allowed) */
409 if ((PPPallowed[i] & PPPpreferred[i]) != 0) PPPallowed[i] &= PPPpreferred[i];
411 if (IsBridgeAbove(ti->tile)) {
412 Track bridgetrack = GetBridgeAxis(ti->tile) == AXIS_X ? TRACK_X : TRACK_Y;
413 int height = GetBridgeHeight(GetNorthernBridgeEnd(ti->tile));
415 if ((height <= GetTileMaxZ(ti->tile) + 1) &&
416 (i == PCPpositions[bridgetrack][0] || i == PCPpositions[bridgetrack][1])) {
417 SetBit(OverridePCP, i);
421 if (PPPallowed[i] != 0 && HasBit(PCPstatus, i) && !HasBit(OverridePCP, i) &&
422 (!IsRailStationTile(ti->tile) || CanStationTileHavePylons(ti->tile))) {
423 for (Direction k = DIR_BEGIN; k < DIR_END; k++) {
424 byte temp = PPPorder[i][GetTLG(ti->tile)][k];
426 if (HasBit(PPPallowed[i], temp)) {
427 uint x = ti->x + x_pcp_offsets[i] + x_ppp_offsets[temp];
428 uint y = ti->y + y_pcp_offsets[i] + y_ppp_offsets[temp];
430 /* Don't build the pylon if it would be outside the tile */
431 if (!HasBit(OwnedPPPonPCP[i], temp)) {
432 /* We have a neighbour that will draw it, bail out */
433 if (trackconfig[TS_NEIGHBOUR] != TRACK_BIT_NONE) break;
434 continue; // No neighbour, go looking for a better position
437 AddSortableSpriteToDraw(pylon_base + pylon_sprites[temp], PAL_NONE, x, y, 1, 1, BB_HEIGHT_UNDER_BRIDGE,
438 elevation, IsTransparencySet(TO_CATENARY), -1, -1);
440 break; // We already have drawn a pylon, bail out
446 /* The wire above the tunnel is drawn together with the tunnel-roof (see DrawRailCatenaryOnTunnel()) */
447 if (IsTunnelTile(ti->tile)) return;
449 /* Don't draw a wire under a low bridge */
450 if (IsBridgeAbove(ti->tile) && !IsTransparencySet(TO_BRIDGES)) {
451 int height = GetBridgeHeight(GetNorthernBridgeEnd(ti->tile));
453 if (height <= GetTileMaxZ(ti->tile) + 1) return;
456 /* Don't draw a wire if the station tile does not want any */
457 if (IsRailStationTile(ti->tile) && !CanStationTileHaveWires(ti->tile)) return;
459 SpriteID wire_normal = GetWireBase(ti->tile);
460 SpriteID wire_halftile = (halftile_corner != CORNER_INVALID) ? GetWireBase(ti->tile, TCX_UPPER_HALFTILE) : wire_normal;
461 Track halftile_track;
462 switch (halftile_corner) {
463 case CORNER_W: halftile_track = TRACK_LEFT; break;
464 case CORNER_S: halftile_track = TRACK_LOWER; break;
465 case CORNER_E: halftile_track = TRACK_RIGHT; break;
466 case CORNER_N: halftile_track = TRACK_UPPER; break;
467 default: halftile_track = INVALID_TRACK; break;
470 /* Drawing of pylons is finished, now draw the wires */
471 Track t;
472 FOR_EACH_SET_TRACK(t, wireconfig[TS_HOME]) {
473 SpriteID wire_base = (t == halftile_track) ? wire_halftile : wire_normal;
474 byte PCPconfig = HasBit(PCPstatus, PCPpositions[t][0]) +
475 (HasBit(PCPstatus, PCPpositions[t][1]) << 1);
477 const SortableSpriteStruct *sss;
478 int tileh_selector = !(tileh[TS_HOME] % 3) * tileh[TS_HOME] / 3; // tileh for the slopes, 0 otherwise
480 assert(PCPconfig != 0); // We have a pylon on neither end of the wire, that doesn't work (since we have no sprites for that)
481 assert(!IsSteepSlope(tileh[TS_HOME]));
482 sss = &RailCatenarySpriteData[Wires[tileh_selector][t][PCPconfig]];
485 * The "wire"-sprite position is inside the tile, i.e. 0 <= sss->?_offset < TILE_SIZE.
486 * Therefore it is safe to use GetSlopePixelZ() for the elevation.
487 * Also note that the result of GetSlopePixelZ() is very special for bridge-ramps.
489 AddSortableSpriteToDraw(wire_base + sss->image_offset, PAL_NONE, ti->x + sss->x_offset, ti->y + sss->y_offset,
490 sss->x_size, sss->y_size, sss->z_size, GetSlopePixelZ(ti->x + sss->x_offset, ti->y + sss->y_offset) + sss->z_offset,
491 IsTransparencySet(TO_CATENARY));
496 * Draws wires on a tunnel tile
498 * DrawTile_TunnelBridge() calls this function to draw the wires on the bridge.
500 * @param ti The Tileinfo to draw the tile for
502 void DrawRailCatenaryOnBridge(const TileInfo *ti)
504 TileIndex end = GetSouthernBridgeEnd(ti->tile);
505 TileIndex start = GetOtherBridgeEnd(end);
507 uint length = GetTunnelBridgeLength(start, end);
508 uint num = GetTunnelBridgeLength(ti->tile, start) + 1;
509 uint height;
511 const SortableSpriteStruct *sss;
512 Axis axis = GetBridgeAxis(ti->tile);
513 TLG tlg = GetTLG(ti->tile);
515 RailCatenarySprite offset = (RailCatenarySprite)(axis == AXIS_X ? 0 : WIRE_Y_FLAT_BOTH - WIRE_X_FLAT_BOTH);
517 if ((length % 2) && num == length) {
518 /* Draw the "short" wire on the southern end of the bridge
519 * only needed if the length of the bridge is odd */
520 sss = &RailCatenarySpriteData[WIRE_X_FLAT_BOTH + offset];
521 } else {
522 /* Draw "long" wires on all other tiles of the bridge (one pylon every two tiles) */
523 sss = &RailCatenarySpriteData[WIRE_X_FLAT_SW + (num % 2) + offset];
526 height = GetBridgePixelHeight(end);
528 SpriteID wire_base = GetWireBase(end, TCX_ON_BRIDGE);
530 AddSortableSpriteToDraw(wire_base + sss->image_offset, PAL_NONE, ti->x + sss->x_offset, ti->y + sss->y_offset,
531 sss->x_size, sss->y_size, sss->z_size, height + sss->z_offset,
532 IsTransparencySet(TO_CATENARY)
535 SpriteID pylon_base = GetPylonBase(end, TCX_ON_BRIDGE);
537 /* Finished with wires, draw pylons
538 * every other tile needs a pylon on the northern end */
539 if (num % 2) {
540 DiagDirection PCPpos = (axis == AXIS_X ? DIAGDIR_NE : DIAGDIR_NW);
541 Direction PPPpos = (axis == AXIS_X ? DIR_NW : DIR_NE);
542 if (HasBit(tlg, (axis == AXIS_X ? 0 : 1))) PPPpos = ReverseDir(PPPpos);
543 uint x = ti->x + x_pcp_offsets[PCPpos] + x_ppp_offsets[PPPpos];
544 uint y = ti->y + y_pcp_offsets[PCPpos] + y_ppp_offsets[PPPpos];
545 AddSortableSpriteToDraw(pylon_base + pylon_sprites[PPPpos], PAL_NONE, x, y, 1, 1, BB_HEIGHT_UNDER_BRIDGE, height, IsTransparencySet(TO_CATENARY), -1, -1);
548 /* need a pylon on the southern end of the bridge */
549 if (GetTunnelBridgeLength(ti->tile, start) + 1 == length) {
550 DiagDirection PCPpos = (axis == AXIS_X ? DIAGDIR_SW : DIAGDIR_SE);
551 Direction PPPpos = (axis == AXIS_X ? DIR_NW : DIR_NE);
552 if (HasBit(tlg, (axis == AXIS_X ? 0 : 1))) PPPpos = ReverseDir(PPPpos);
553 uint x = ti->x + x_pcp_offsets[PCPpos] + x_ppp_offsets[PPPpos];
554 uint y = ti->y + y_pcp_offsets[PCPpos] + y_ppp_offsets[PPPpos];
555 AddSortableSpriteToDraw(pylon_base + pylon_sprites[PPPpos], PAL_NONE, x, y, 1, 1, BB_HEIGHT_UNDER_BRIDGE, height, IsTransparencySet(TO_CATENARY), -1, -1);
560 * Draws overhead wires and pylons for electric railways.
561 * @param ti The TileInfo struct of the tile being drawn
562 * @see DrawRailCatenaryRailway
564 void DrawRailCatenary(const TileInfo *ti)
566 switch (GetTileType(ti->tile)) {
567 case MP_RAILWAY:
568 if (IsRailDepot(ti->tile)) {
569 const SortableSpriteStruct *sss = &RailCatenarySpriteData_Depot[GetRailDepotDirection(ti->tile)];
571 SpriteID wire_base = GetWireBase(ti->tile);
573 /* This wire is not visible with the default depot sprites */
574 AddSortableSpriteToDraw(
575 wire_base + sss->image_offset, PAL_NONE, ti->x + sss->x_offset, ti->y + sss->y_offset,
576 sss->x_size, sss->y_size, sss->z_size,
577 GetTileMaxPixelZ(ti->tile) + sss->z_offset,
578 IsTransparencySet(TO_CATENARY)
580 return;
582 break;
584 case MP_TUNNELBRIDGE:
585 case MP_ROAD:
586 case MP_STATION:
587 break;
589 default: return;
591 DrawRailCatenaryRailway(ti);
594 bool SettingsDisableElrail(int32 p1)
596 Company *c;
597 Train *t;
598 bool disable = (p1 != 0);
600 /* we will now walk through all electric train engines and change their railtypes if it is the wrong one*/
601 const RailType old_railtype = disable ? RAILTYPE_ELECTRIC : RAILTYPE_RAIL;
602 const RailType new_railtype = disable ? RAILTYPE_RAIL : RAILTYPE_ELECTRIC;
604 /* walk through all train engines */
605 Engine *e;
606 FOR_ALL_ENGINES_OF_TYPE(e, VEH_TRAIN) {
607 RailVehicleInfo *rv_info = &e->u.rail;
608 /* if it is an electric rail engine and its railtype is the wrong one */
609 if (rv_info->engclass == 2 && rv_info->railtype == old_railtype) {
610 /* change it to the proper one */
611 rv_info->railtype = new_railtype;
615 /* when disabling elrails, make sure that all existing trains can run on
616 * normal rail too */
617 if (disable) {
618 FOR_ALL_TRAINS(t) {
619 if (t->railtype == RAILTYPE_ELECTRIC) {
620 /* this railroad vehicle is now compatible only with elrail,
621 * so add there also normal rail compatibility */
622 t->compatible_railtypes |= RAILTYPES_RAIL;
623 t->railtype = RAILTYPE_RAIL;
624 SetBit(t->flags, VRF_EL_ENGINE_ALLOWED_NORMAL_RAIL);
629 /* Fix the total power and acceleration for trains */
630 FOR_ALL_TRAINS(t) {
631 /* power and acceleration is cached only for front engines */
632 if (t->IsFrontEngine()) {
633 t->ConsistChanged(CCF_TRACK);
637 FOR_ALL_COMPANIES(c) c->avail_railtypes = GetCompanyRailtypes(c->index);
639 /* This resets the _last_built_railtype, which will be invalid for electric
640 * rails. It may have unintended consequences if that function is ever
641 * extended, though. */
642 ReinitGuiAfterToggleElrail(disable);
643 return true;