OpenTTD Source: CYapfDestinationTileT< Types > Class Template Reference

OpenTTD Source 14.1

Public Types | Public Member Functions | Protected Member Functions | Protected Attributes
CYapfDestinationTileT< Types > Class Template Reference

YAPF destination provider base class - used when destination is single tile / multiple trackdirs. More...

`#include <yapf_common.hpp>`

## Public Types
typedef Types::Tpf | Tpf
| the pathfinder class (derived from THIS class)
typedef Types::NodeList::Titem | Node
| this will be our node type
typedef Node::Key | Key
| key to hash tables

## Public Member Functions
void | SetDestination (TileIndex tile, TrackdirBits trackdirs)
| set the destination tile / more trackdirs
bool | PfDetectDestination (Node &n)
| Called by YAPF to detect if node ends in the desired destination.
bool | PfCalcEstimate (Node &n)
| Called by YAPF to calculate cost estimate. More...

## Protected Member Functions
Tpf & | Yapf ()
| to access inherited path finder

## Protected Attributes
TileIndex | m_destTile
| destination tile
TrackdirBits | m_destTrackdirs
| destination trackdir mask

## Detailed Description

### template<class Types>
class CYapfDestinationTileT< Types >

YAPF destination provider base class - used when destination is single tile / multiple trackdirs.

Definition at line 113 of file yapf_common.hpp.

## Member Function Documentation

## ◆ PfCalcEstimate()

template<class Types >

bool CYapfDestinationTileT< Types >::PfCalcEstimate | ( | Node & | n | ) |
| inline

Called by YAPF to calculate cost estimate.

Calculates distance to the destination adds it to the actual cost from origin and stores the sum to the Node::m_estimate

Definition at line 150 of file yapf_common.hpp.

References abs(), CYapfDestinationTileT< Types >::m_destTile, CYapfDestinationTileT< Types >::PfDetectDestination(), TileX(), TileY(), TrackdirToExitdir(), YAPF_TILE_CORNER_LENGTH, and YAPF_TILE_LENGTH.

The documentation for this class was generated from the following file:

- src/pathfinder/yapf/yapf_common.hpp