src/pathfinder.h

   1 /*
   2 Minetest
   3 Copyright (C) 2013 sapier, sapier at gmx dot net
   4
   5 This program is free software; you can redistribute it and/or modify
   6 it under the terms of the GNU Lesser General Public License as published by
   7 the Free Software Foundation; either version 2.1 of the License, or
   8 (at your option) any later version.
   9
  10 This program is distributed in the hope that it will be useful,
  11 but WITHOUT ANY WARRANTY; without even the implied warranty of
  12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13 GNU Lesser General Public License for more details.
  14
  15 You should have received a copy of the GNU Lesser General Public License along
  16 with this program; if not, write to the Free Software Foundation, Inc.,
  17 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  18 */
  19
  20 #pragma once
  21
  22 /******************************************************************************/
  23 /* Includes                                                                   */
  24 /******************************************************************************/
  25 #include <vector>
  26 #include "irr_v3d.h"
  27
  28 /******************************************************************************/
  29 /* Forward declarations                                                       */
  30 /******************************************************************************/
  31
  32 class NodeDefManager;
  33 class Map;
  34
  35 /******************************************************************************/
  36 /* Typedefs and macros                                                        */
  37 /******************************************************************************/
  38
  39 typedef enum
  40 {
  41         DIR_XP,
  42         DIR_XM,
  43         DIR_ZP,
  44         DIR_ZM
  45 } PathDirections;
  46
  47 /** List of supported algorithms */
  48 typedef enum
  49 {
  50         PA_DIJKSTRA, /**< Dijkstra shortest path algorithm             */
  51         PA_PLAIN,    /**< A* algorithm using heuristics to find a path */
  52         PA_PLAIN_NP  /**< A* algorithm without prefetching of map data */
  53 } PathAlgorithm;
  54
  55 /******************************************************************************/
  56 /* declarations                                                               */
  57 /******************************************************************************/
  58
  59 /** c wrapper function to use from scriptapi */
  60 std::vector<v3s16> get_path(Map *map, const NodeDefManager *ndef, v3s16 source,
  61                 v3s16 destination, unsigned int searchdistance, unsigned int max_jump,
  62                 unsigned int max_drop, PathAlgorithm algo);