mirror of https://github.com/OpenTTD/OpenTTD
(svn r8866) -Doc: added more comments to template struct MakeEnumPropsT
parent
0cf592b17a
commit
f3d5fda36c
|
@ -80,12 +80,23 @@ template <typename T> static inline T delta(T a, T b) { return a < b ? b - a : a
|
||||||
|
|
||||||
/** Informative template class exposing basic enumeration properties used by several
|
/** Informative template class exposing basic enumeration properties used by several
|
||||||
* other templates below. Here we have only forward declaration. For each enum type
|
* other templates below. Here we have only forward declaration. For each enum type
|
||||||
* we will create specialization derived from MakeEnumPropsT<>. */
|
* we will create specialization derived from MakeEnumPropsT<>.
|
||||||
|
* i.e.:
|
||||||
|
* template <> struct EnumPropsT<Track> : MakeEnumPropsT<Track, byte, TRACK_BEGIN, TRACK_END, INVALID_TRACK> {};
|
||||||
|
* followed by:
|
||||||
|
* typedef TinyEnumT<Track> TrackByte;
|
||||||
|
*/
|
||||||
template <typename Tenum_t> struct EnumPropsT;
|
template <typename Tenum_t> struct EnumPropsT;
|
||||||
|
|
||||||
/** Helper template class that makes basic properties of given enumeration type visible
|
/** Helper template class that makes basic properties of given enumeration type visible
|
||||||
* from outsize. It is used as base class of several EnumPropsT specializations each
|
* from outsize. It is used as base class of several EnumPropsT specializations each
|
||||||
* dedicated to one of commonly used enumeration types. */
|
* dedicated to one of commonly used enumeration types.
|
||||||
|
* @param Tenum_t enumeration type that you want to describe
|
||||||
|
* @param Tstorage_t what storage type would be sufficient (i.e. byte)
|
||||||
|
* @param Tbegin first valid value from the contiguous range (i.e. TRACK_BEGIN)
|
||||||
|
* @param Tend one past the last valid value from the contiguous range (i.e. TRACK_END)
|
||||||
|
* @param Tinvalid value used as invalid value marker (i.e. INVALID_TRACK)
|
||||||
|
*/
|
||||||
template <typename Tenum_t, typename Tstorage_t, Tenum_t Tbegin, Tenum_t Tend, Tenum_t Tinvalid>
|
template <typename Tenum_t, typename Tstorage_t, Tenum_t Tbegin, Tenum_t Tend, Tenum_t Tinvalid>
|
||||||
struct MakeEnumPropsT {
|
struct MakeEnumPropsT {
|
||||||
typedef Tenum_t type; ///< enum type (i.e. Trackdir)
|
typedef Tenum_t type; ///< enum type (i.e. Trackdir)
|
||||||
|
|
|
@ -66,7 +66,7 @@ public:
|
||||||
}
|
}
|
||||||
|
|
||||||
/** return one tile cost. If tile is a tunnel entry, it is moved to the end of tunnel */
|
/** return one tile cost. If tile is a tunnel entry, it is moved to the end of tunnel */
|
||||||
FORCEINLINE int OneTileCost(TileIndex& tile, Trackdir trackdir)
|
FORCEINLINE int OneTileCost(TileIndex prev_tile, TileIndex& tile, Trackdir trackdir)
|
||||||
{
|
{
|
||||||
int cost = 0;
|
int cost = 0;
|
||||||
// set base cost
|
// set base cost
|
||||||
|
@ -81,7 +81,7 @@ public:
|
||||||
|
|
||||||
case MP_STATION:
|
case MP_STATION:
|
||||||
// penalty for passing station tiles
|
// penalty for passing station tiles
|
||||||
cost += Yapf().PfGetSettings().rail_station_penalty;
|
cost += Yapf().PfGetSettings().rail_station_penalty * DistanceManhattan(prev_tile, tile);
|
||||||
break;
|
break;
|
||||||
|
|
||||||
default:
|
default:
|
||||||
|
@ -202,7 +202,7 @@ public:
|
||||||
bool target_seen = Yapf().PfDetectDestination(tile, trackdir);
|
bool target_seen = Yapf().PfDetectDestination(tile, trackdir);
|
||||||
|
|
||||||
while (true) {
|
while (true) {
|
||||||
segment_cost += Yapf().OneTileCost(tile, trackdir);
|
segment_cost += Yapf().OneTileCost(prev_tile, tile, trackdir);
|
||||||
segment_cost += Yapf().CurveCost(prev_trackdir, trackdir);
|
segment_cost += Yapf().CurveCost(prev_trackdir, trackdir);
|
||||||
segment_cost += Yapf().SlopeCost(tile, trackdir);
|
segment_cost += Yapf().SlopeCost(tile, trackdir);
|
||||||
segment_cost += Yapf().SignalCost(n, tile, trackdir);
|
segment_cost += Yapf().SignalCost(n, tile, trackdir);
|
||||||
|
|
Loading…
Reference in New Issue