abstract_pathfinder Class Reference

#include <th_pathfind.h>

Inheritance diagram for abstract_pathfinder:

Public Member Functions
	abstract_pathfinder (pathfinder *pf)
virtual	~abstract_pathfinder ()=default
path_node *	init (const level_map *pMap, int iStartX, int iStarty)
	Initialize the path finder.
bool	search_neighbours (path_node *pNode, map_tile_flags flags, int iWidth)
	Expand the pNode to its neighbours.
void	record_neighbour_if_passable (path_node *pNode, map_tile_flags neighbour_flags, bool passable, path_node *pNeighbour)
virtual int	guess_distance (path_node *pNode)=0
	Guess distance to the destination for pNode.
virtual bool	try_node (path_node *pNode, map_tile_flags flags, path_node *pNeighbour, travel_direction direction)=0
	Try the pNeighbour node.

Protected Attributes
pathfinder *	parent
	Path finder parent object, containing shared data.
const level_map *	map
	Map being searched.

Detailed Description

Base class of the path finders.

Constructor & Destructor Documentation

abstract_pathfinder()

abstract_pathfinder::abstract_pathfinder

(

pathfinder *

pf

)

~abstract_pathfinder()

virtual abstract_pathfinder::~abstract_pathfinder ( )

virtualdefault

Member Function Documentation

guess_distance()

virtual int abstract_pathfinder::guess_distance ( path_node *  pNode )

pure virtual

Guess distance to the destination for pNode.

Parameters

pNode

Node to fill.

Implemented in basic_pathfinder, hospital_finder, idle_tile_finder, and object_visitor.

init()

path_node * abstract_pathfinder::init	(	const level_map *	pMap,
		int	iStartX,
		int	iStarty
	)

Initialize the path finder.

Parameters

pMap	Map to search on.
iStartX	X coordinate of the start position.
iStarty	Y coordinate of the start position.

Returns

The initial node to expand.

record_neighbour_if_passable()

void abstract_pathfinder::record_neighbour_if_passable	(	path_node *	pNode,
		map_tile_flags	neighbour_flags,
		bool	passable,
		path_node *	pNeighbour
	)

search_neighbours()

bool abstract_pathfinder::search_neighbours	(	path_node *	pNode,
		map_tile_flags	flags,
		int	iWidth
	)

Expand the pNode to its neighbours.

Parameters

pNode	Node to expand.
flags	Flags of the node.
iWidth	Width of the map.

Returns

Whether the search is done.

No need to check for the node being on the map edge, as the N/E/S/W flags are set as to prevent travelling off the map (as well as to prevent walking through walls).

try_node()

virtual bool abstract_pathfinder::try_node ( path_node *  pNode, map_tile_flags  flags, path_node *  pNeighbour, travel_direction  direction  )

pure virtual

Try the pNeighbour node.

Parameters

pNode	Source node.
flags	Flags of the node.
pNeighbour	Neighbour of pNode to try.
direction	Direction of travel.

Returns

Whether the search is done.

Implemented in basic_pathfinder, hospital_finder, idle_tile_finder, and object_visitor.

Member Data Documentation

map

const level_map* abstract_pathfinder::map

protected

Map being searched.

parent

pathfinder* abstract_pathfinder::parent

protected

Path finder parent object, containing shared data.

---

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

• /home/runner/work/CorsixTH/CorsixTH/CorsixTH/Src/th_pathfind.h
• /home/runner/work/CorsixTH/CorsixTH/CorsixTH/Src/th_pathfind.cpp