OpenTTD Source 20260621-master-g720d10536d
yapf_common.hpp
Go to the documentation of this file.
1/*
2 * This file is part of OpenTTD.
3 * 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.
4 * 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.
5 * 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 <https://www.gnu.org/licenses/old-licenses/gpl-2.0>.
6 */
7
9
10#ifndef YAPF_COMMON_HPP
11#define YAPF_COMMON_HPP
12
14#include "../../tile_type.h"
15#include "../../track_type.h"
16
18template <class Types>
20public:
21 typedef typename Types::Tpf Tpf;
22 typedef typename Types::NodeList::Item Node;
23 typedef typename Node::Key Key;
24
25protected:
27 inline Tpf &Yapf()
28 {
29 return *static_cast<Tpf *>(this);
30 }
31
32public:
38 void SetOrigin(TileIndex tile, TrackdirBits trackdirs)
39 {
40 bool is_choice = trackdirs.Count() > 1;
41 for (Trackdir td : trackdirs) {
42 Node &node = Yapf().CreateNewNode();
43 node.Set(nullptr, tile, td, is_choice);
44 Yapf().AddStartupNode(node);
45 }
46 }
47};
48
50template <class Types>
52public:
53 typedef typename Types::Tpf Tpf;
54 typedef typename Types::NodeList::Item Node;
55 typedef typename Node::Key Key;
56
57protected:
59 inline Tpf &Yapf()
60 {
61 return *static_cast<Tpf *>(this);
62 }
63
64public:
73 void SetOrigin(TileIndex forward_tile, Trackdir forward_td, TileIndex reverse_tile = INVALID_TILE,
74 Trackdir reverse_td = Trackdir::Invalid, int reverse_penalty = 0)
75 {
76 if (forward_tile != INVALID_TILE && forward_td != Trackdir::Invalid) {
77 Node &node = Yapf().CreateNewNode();
78 node.Set(nullptr, forward_tile, forward_td, false);
79 Yapf().AddStartupNode(node);
80 }
81 if (reverse_tile != INVALID_TILE && reverse_td != Trackdir::Invalid) {
82 Node &node = Yapf().CreateNewNode();
83 node.Set(nullptr, reverse_tile, reverse_td, false);
84 node.cost = reverse_penalty;
85 Yapf().AddStartupNode(node);
86 }
87 }
88};
89
96template <class Ttypes>
97class CYapfT
98 : public Ttypes::PfBase
99 , public Ttypes::PfCost
100 , public Ttypes::PfCache
101 , public Ttypes::PfOrigin
102 , public Ttypes::PfDestination
103 , public Ttypes::PfFollow
104{
105};
106
114inline int OctileDistanceCost(TileIndex start_tile, Trackdir start_td, TileIndex destination_tile)
115{
116 static constexpr int dg_dir_to_x_offs[] = {-1, 0, 1, 0};
117 static constexpr int dg_dir_to_y_offs[] = {0, 1, 0, -1};
118
119 const DiagDirection exitdir = TrackdirToExitdir(start_td);
120
121 const int x1 = 2 * TileX(start_tile) + dg_dir_to_x_offs[static_cast<int>(exitdir)];
122 const int y1 = 2 * TileY(start_tile) + dg_dir_to_y_offs[static_cast<int>(exitdir)];
123 const int x2 = 2 * TileX(destination_tile);
124 const int y2 = 2 * TileY(destination_tile);
125 const int dx = abs(x1 - x2);
126 const int dy = abs(y1 - y2);
127 const int dmin = std::min(dx, dy);
128 const int dxy = abs(dx - dy);
129
130 return dmin * YAPF_TILE_CORNER_LENGTH + (dxy - 1) * (YAPF_TILE_LENGTH / 2);
131}
132
133#endif /* YAPF_COMMON_HPP */
Functions related to bit mathematics.
uint Count() const
Count the number of set bits.
YAPF origin provider base class - used when origin is one tile / multiple trackdirs.
Node::Key Key
key to hash tables
Tpf & Yapf()
Access the inherited path finder.
Types::Tpf Tpf
the pathfinder class (derived from THIS class)
void SetOrigin(TileIndex tile, TrackdirBits trackdirs)
Set origin tile / trackdir mask.
Types::NodeList::Item Node
this will be our node type
YAPF origin provider base class - used when there are two tile/trackdir origins.
Tpf & Yapf()
Access the inherited path finder.
Node::Key Key
key to hash tables
Types::Tpf Tpf
the pathfinder class (derived from THIS class)
Types::NodeList::Item Node
this will be our node type
void SetOrigin(TileIndex forward_tile, Trackdir forward_td, TileIndex reverse_tile=INVALID_TILE, Trackdir reverse_td=Trackdir::Invalid, int reverse_penalty=0)
Set origin (tiles, trackdirs, etc.).
YAPF template that uses Ttypes template argument to determine all YAPF components (base classes) from...
DiagDirection
Enumeration for diagonal directions.
static uint TileY(TileIndex tile)
Get the Y component of a tile.
Definition map_func.h:429
static uint TileX(TileIndex tile)
Get the X component of a tile.
Definition map_func.h:419
constexpr T abs(const T a)
Returns the absolute value of (scalar) variable.
Definition math_func.hpp:23
static const int YAPF_TILE_CORNER_LENGTH
Length (penalty) of a corner with YAPF.
static const int YAPF_TILE_LENGTH
Length (penalty) of one tile with YAPF.
Types related to tiles.
StrongType::Typedef< uint32_t, struct TileIndexTag, StrongType::Compare, StrongType::Integer, StrongType::Compatible< int32_t >, StrongType::Compatible< int64_t > > TileIndex
The index/ID of a Tile.
Definition tile_type.h:92
constexpr TileIndex INVALID_TILE
The very nice invalid tile marker.
Definition tile_type.h:100
DiagDirection TrackdirToExitdir(Trackdir trackdir)
Maps a trackdir to the (4-way) direction the tile is exited when following that trackdir.
Definition track_func.h:343
All types related to tracks.
EnumBitSet< Trackdir, uint16_t > TrackdirBits
Bitset of Trackdir elements.
Definition track_type.h:93
Trackdir
Enumeration for tracks and directions.
Definition track_type.h:63
@ Invalid
Flag for an invalid trackdir.
Definition track_type.h:82
int OctileDistanceCost(TileIndex start_tile, Trackdir start_td, TileIndex destination_tile)
Calculates the octile distance cost between a starting tile / trackdir and a destination tile.