Merge branch 'blender2.7'
[blender.git] / source / blender / blenlib / BLI_astar.h
1 /*
2  * This program is free software; you can redistribute it and/or
3  * modify it under the terms of the GNU General Public License
4  * as published by the Free Software Foundation; either version 2
5  * of the License, or (at your option) any later version.
6  *
7  * This program is distributed in the hope that it will be useful,
8  * but WITHOUT ANY WARRANTY; without even the implied warranty of
9  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
10  * GNU General Public License for more details.
11  *
12  * You should have received a copy of the GNU General Public License
13  * along with this program; if not, write to the Free Software Foundation,
14  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
15  *
16  * The Original Code is Copyright (C) 2014 Blender Foundation.
17  * All rights reserved.
18  */
19
20 #ifndef __BLI_ASTAR_H__
21 #define __BLI_ASTAR_H__
22
23 /** \file \ingroup bli
24  *  \brief An implementation of the A* (AStar) algorithm to solve shortest path problem.
25  */
26
27 #include "BLI_utildefines.h"
28
29 #include "BLI_bitmap.h"
30
31 /* -------------------------------------------------------------------- */
32
33 typedef struct BLI_AStarGNLink {
34         int nodes[2];
35         float cost;
36
37         void *custom_data;
38 } BLI_AStarGNLink;
39
40 typedef struct BLI_AStarGNode {
41         struct ListBase neighbor_links;
42
43         void *custom_data;
44 } BLI_AStarGNode;
45
46 typedef struct BLI_AStarSolution {
47         /* Final 'most useful' data. */
48         /** Number of steps (i.e. walked links) in path
49          * (nodes num, including start and end, is steps + 1). */
50         int steps;
51         /** Store the path, in reversed order (from destination to source node), as indices. */
52         int *prev_nodes;
53         /** Indices are nodes' ones, as prev_nodes, but they map to relevant link. */
54         BLI_AStarGNLink **prev_links;
55
56         void *custom_data;
57
58         /* Mostly runtime data. */
59         BLI_bitmap *done_nodes;
60         float *g_costs;
61         int *g_steps;
62
63         struct MemArena *mem;  /* Memory arena. */
64 } BLI_AStarSolution;
65
66 typedef struct BLI_AStarGraph {
67         int node_num;
68         BLI_AStarGNode *nodes;
69
70         void *custom_data;
71
72         struct MemArena *mem;  /* Memory arena. */
73 } BLI_AStarGraph;
74
75 void BLI_astar_node_init(BLI_AStarGraph *as_graph, const int node_index, void *custom_data);
76 void BLI_astar_node_link_add(
77         BLI_AStarGraph *as_graph, const int node1_index, const int node2_index, const float cost, void *custom_data);
78 int BLI_astar_node_link_other_node(BLI_AStarGNLink *lnk, const int idx);
79
80 void BLI_astar_solution_init(BLI_AStarGraph *as_graph, BLI_AStarSolution *as_solution, void *custom_data);
81 void BLI_astar_solution_clear(BLI_AStarSolution *as_solution);
82 void BLI_astar_solution_free(BLI_AStarSolution *as_solution);
83
84 /**
85  * Callback computing the current cost (distance) to next node, and the estimated overall cost to destination node
86  * (A* expects this estimation to always be less or equal than actual shortest path from next node to destination one).
87  *
88  * \param link: the graph link between current node and next one.
89  * \param node_idx_curr: current node index.
90  * \param node_idx_next: next node index.
91  * \param node_idx_dst: destination node index.
92  */
93 typedef float (*astar_f_cost)(BLI_AStarGraph *as_graph, BLI_AStarSolution *as_solution, BLI_AStarGNLink *link,
94                               const int node_idx_curr, const int node_idx_next, const int node_idx_dst);
95
96 void BLI_astar_graph_init(BLI_AStarGraph *as_graph, const int node_num, void *custom_data);
97 void BLI_astar_graph_free(BLI_AStarGraph *as_graph);
98 bool BLI_astar_graph_solve(
99         BLI_AStarGraph *as_graph, const int node_index_src, const int node_index_dst, astar_f_cost f_cost_cb,
100         BLI_AStarSolution *r_solution, const int max_steps);
101
102 #endif  /* __BLI_ASTAR_H__ */