aystar.cpp

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/>.
 */
 
#include "../../stdafx.h"
#include "aystar.h"
 
#include "../../safeguards.h"
 
void AyStar::OpenListAdd(PathNode *parent, const AyStarNode *node, int f, int g)
{
  /* Add a new Node to the OpenList */
  PathNode &new_node = this->nodes.CreateNewNode();
  new_node.Set(parent, node->tile, node->td, true);
  new_node.estimate = f;
  new_node.cost = g;
  this->nodes.InsertOpenNode(new_node);
}
 
void AyStar::CheckTile(AyStarNode *current, PathNode *parent)
{
  /* Check the new node against the ClosedList */
  if (this->nodes.FindClosedNode(*current) != nullptr) return;
 
  /* Calculate the G-value for this node */
  int new_g = this->CalculateG(this, current, parent);
  /* If the value was INVALID_NODE, we don't do anything with this node */
  if (new_g == AYSTAR_INVALID_NODE) return;
 
  /* There should not be given any other error-code.. */
  assert(new_g >= 0);
  /* Add the parent g-value to the new g-value */
  new_g += parent->cost;
  if (this->max_path_cost != 0 && new_g > this->max_path_cost) return;
 
  /* Calculate the h-value */
  int new_h = this->CalculateH(this, current, parent);
  /* There should not be given any error-code.. */
  assert(new_h >= 0);
 
  /* The f-value if g + h */
  int new_f = new_g + new_h;
 
  /* Get the pointer to the parent in the ClosedList (the current one is to a copy of the one in the OpenList) */
  PathNode *closedlist_parent = this->nodes.FindClosedNode(parent->key);
 
  /* Check if this item is already in the OpenList */
  PathNode *check = this->nodes.FindOpenNode(*current);
  if (check != nullptr) {
    /* Yes, check if this g value is lower.. */
    if (new_g > check->cost) return;
    this->nodes.PopOpenNode(check->key);
    /* It is lower, so change it to this item */
    check->estimate = new_f;
    check->cost = new_g;
    check->parent = closedlist_parent;
    /* Re-add it in the openlist_queue. */
    this->nodes.InsertOpenNode(*check);
  } else {
    /* A new node, add it to the OpenList */
    this->OpenListAdd(closedlist_parent, current, new_f, new_g);
  }
}
 
AyStarStatus AyStar::Loop()
{
  /* Get the best node from OpenList */
  PathNode *current = this->nodes.PopBestOpenNode();
  /* If empty, drop an error */
  if (current == nullptr) return AyStarStatus::EmptyOpenList;
 
  /* Check for end node and if found, return that code */
  if (this->EndNodeCheck(this, current) == AyStarStatus::FoundEndNode && current->parent != nullptr) {
    if (this->FoundEndNode != nullptr) {
      this->FoundEndNode(this, current);
    }
    return AyStarStatus::FoundEndNode;
  }
 
  /* Add the node to the ClosedList */
  this->nodes.InsertClosedNode(*current);
 
  /* Load the neighbours */
  this->GetNeighbours(this, current);
 
  /* Go through all neighbours */
  for (auto &neighbour : this->neighbours) {
    /* Check and add them to the OpenList if needed */
    this->CheckTile(&neighbour, current);
  }
 
  if (this->max_search_nodes != 0 && this->nodes.ClosedCount() >= this->max_search_nodes) {
    /* We've expanded enough nodes */
    return AyStarStatus::LimitReached;
  } else {
    /* Return that we are still busy */
    return AyStarStatus::StillBusy;
  }
}
 
AyStarStatus AyStar::Main()
{
  AyStarStatus r = AyStarStatus::FoundEndNode;
  int i = 0;
  /* Loop through the OpenList
   *  Quit if result is no AyStarStatus::StillBusy or is more than loops_per_tick */
  while ((r = this->Loop()) == AyStarStatus::StillBusy && (this->loops_per_tick == 0 || ++i < this->loops_per_tick)) { }
#ifdef AYSTAR_DEBUG
  switch (r) {
    case AyStarStatus::FoundEndNode: Debug(misc, 0, "[AyStar] Found path!"); break;
    case AyStarStatus::EmptyOpenList: Debug(misc, 0, "[AyStar] OpenList run dry, no path found"); break;
    case AyStarStatus::LimitReached: Debug(misc, 0, "[AyStar] Exceeded search_nodes, no path found"); break;
    default: break;
  }
#endif
 
  switch (r) {
    case AyStarStatus::FoundEndNode: return AyStarStatus::FoundEndNode;
    case AyStarStatus::EmptyOpenList:
    case AyStarStatus::LimitReached: return AyStarStatus::NoPath;
    default: return AyStarStatus::StillBusy;
  }
}
 
void AyStar::AddStartNode(AyStarNode *start_node, int g)
{
#ifdef AYSTAR_DEBUG
  Debug(misc, 0, "[AyStar] Starting A* Algorithm from node ({}, {}, {})\n",
    TileX(start_node->tile), TileY(start_node->tile), start_node->direction);
#endif
  this->OpenListAdd(nullptr, start_node, 0, g);
}