yapf_destrail.hpp

Go to the documentation of this file.

/*
 * This file is part of OpenTTD.
 * 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.
 * 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.
 * 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/>.
 */
 
#ifndef YAPF_DESTRAIL_HPP
#define YAPF_DESTRAIL_HPP
 
#include "../../train.h"
#include "../pathfinder_func.h"
#include "../pathfinder_type.h"
 
class CYapfDestinationRailBase {
protected:
  RailTypes compatible_railtypes;
 
public:
  void SetDestination(const Train *v, bool override_rail_type = false)
  {
    this->compatible_railtypes = v->compatible_railtypes;
    if (override_rail_type) this->compatible_railtypes |= GetRailTypeInfo(v->railtype)->compatible_railtypes;
  }
 
  bool IsCompatibleRailType(RailType rt)
  {
    return HasBit(this->compatible_railtypes, rt);
  }
 
  RailTypes GetCompatibleRailTypes() const
  {
    return this->compatible_railtypes;
  }
};
 
template <class Types>
class CYapfDestinationAnyDepotRailT : public CYapfDestinationRailBase {
public:
  typedef typename Types::Tpf Tpf;              
  typedef typename Types::NodeList::Titem Node; 
  typedef typename Node::Key Key;               
 
  Tpf &Yapf()
  {
    return *static_cast<Tpf *>(this);
  }
 
  inline bool PfDetectDestination(Node &n)
  {
    return this->PfDetectDestination(n.GetLastTile(), n.GetLastTrackdir());
  }
 
  inline bool PfDetectDestination(TileIndex tile, Trackdir)
  {
    return IsRailDepotTile(tile);
  }
 
  inline bool PfCalcEstimate(Node &n)
  {
    n.estimate = n.cost;
    return true;
  }
};
 
template <class Types>
class CYapfDestinationAnySafeTileRailT : public CYapfDestinationRailBase {
public:
  typedef typename Types::Tpf Tpf;              
  typedef typename Types::NodeList::Titem Node; 
  typedef typename Node::Key Key;               
  typedef typename Types::TrackFollower TrackFollower; 
 
  Tpf &Yapf()
  {
    return *static_cast<Tpf *>(this);
  }
 
  inline bool PfDetectDestination(Node &n)
  {
    return this->PfDetectDestination(n.GetLastTile(), n.GetLastTrackdir());
  }
 
  inline bool PfDetectDestination(TileIndex tile, Trackdir td)
  {
    return IsSafeWaitingPosition(Yapf().GetVehicle(), tile, td, true, !TrackFollower::Allow90degTurns()) &&
        IsWaitingPositionFree(Yapf().GetVehicle(), tile, td, !TrackFollower::Allow90degTurns());
  }
 
  inline bool PfCalcEstimate(Node &n)
  {
    n.estimate = n.cost;
    return true;
  }
};
 
template <class Types>
class CYapfDestinationTileOrStationRailT : public CYapfDestinationRailBase {
public:
  typedef typename Types::Tpf Tpf;              
  typedef typename Types::NodeList::Titem Node; 
  typedef typename Node::Key Key;               
 
protected:
  TileIndex dest_tile;
  TrackdirBits dest_trackdirs;
  StationID dest_station_id;
  bool any_depot;
 
  Tpf &Yapf()
  {
    return *static_cast<Tpf *>(this);
  }
 
public:
  void SetDestination(const Train *v)
  {
    this->any_depot = false;
    switch (v->current_order.GetType()) {
      case OT_GOTO_WAYPOINT:
        if (!Waypoint::Get(v->current_order.GetDestination())->IsSingleTile()) {
          /* In case of 'complex' waypoints we need to do a look
           * ahead. This look ahead messes a bit about, which
           * means that it 'corrupts' the cache. To prevent this
           * we disable caching when we're looking for a complex
           * waypoint. */
          Yapf().DisableCache(true);
        }
        [[fallthrough]];
 
      case OT_GOTO_STATION:
        this->dest_tile = CalcClosestStationTile(v->current_order.GetDestination(), v->tile, v->current_order.IsType(OT_GOTO_STATION) ? STATION_RAIL : STATION_WAYPOINT);
        this->dest_station_id = v->current_order.GetDestination();
        this->dest_trackdirs = INVALID_TRACKDIR_BIT;
        break;
 
      case OT_GOTO_DEPOT:
        if (v->current_order.GetDepotActionType() & ODATFB_NEAREST_DEPOT) {
          this->any_depot = true;
        }
        [[fallthrough]];
 
      default:
        this->dest_tile = v->dest_tile;
        this->dest_station_id = INVALID_STATION;
        this->dest_trackdirs = TrackStatusToTrackdirBits(GetTileTrackStatus(v->dest_tile, TRANSPORT_RAIL, 0));
        break;
    }
    this->CYapfDestinationRailBase::SetDestination(v);
  }
 
  inline bool PfDetectDestination(Node &n)
  {
    return this->PfDetectDestination(n.GetLastTile(), n.GetLastTrackdir());
  }
 
  inline bool PfDetectDestination(TileIndex tile, Trackdir td)
  {
    if (this->dest_station_id != INVALID_STATION) {
      return HasStationTileRail(tile)
        && (GetStationIndex(tile) == this->dest_station_id)
        && (GetRailStationTrack(tile) == TrackdirToTrack(td));
    }
 
    if (this->any_depot) {
      return IsRailDepotTile(tile);
    }
 
    return (tile == this->dest_tile) && HasTrackdir(this->dest_trackdirs, td);
  }
 
  inline bool PfCalcEstimate(Node &n)
  {
    static const int dg_dir_to_x_offs[] = {-1, 0, 1, 0};
    static const int dg_dir_to_y_offs[] = {0, 1, 0, -1};
    if (this->PfDetectDestination(n)) {
      n.estimate = n.cost;
      return true;
    }
 
    TileIndex tile = n.GetLastTile();
    DiagDirection exitdir = TrackdirToExitdir(n.GetLastTrackdir());
    int x1 = 2 * TileX(tile) + dg_dir_to_x_offs[(int)exitdir];
    int y1 = 2 * TileY(tile) + dg_dir_to_y_offs[(int)exitdir];
    int x2 = 2 * TileX(this->dest_tile);
    int y2 = 2 * TileY(this->dest_tile);
    int dx = abs(x1 - x2);
    int dy = abs(y1 - y2);
    int dmin = std::min(dx, dy);
    int dxy = abs(dx - dy);
    int d = dmin * YAPF_TILE_CORNER_LENGTH + (dxy - 1) * (YAPF_TILE_LENGTH / 2);
    n.estimate = n.cost + d;
    assert(n.estimate >= n.parent->estimate);
    return true;
  }
};
 
#endif /* YAPF_DESTRAIL_HPP */