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
24  * \ingroup bli
25  * \brief An implementation of the A* (AStar) algorithm to solve shortest path problem.
26  */
27
28 #include "BLI_utildefines.h"
29
30 #include "BLI_bitmap.h"
31
32 /* -------------------------------------------------------------------- */
33
34 typedef struct BLI_AStarGNLink {
35         int nodes[2];
36         float cost;
37
38         void *custom_data;
39 } BLI_AStarGNLink;
40
41 typedef struct BLI_AStarGNode {
42         struct ListBase neighbor_links;
43
44         void *custom_data;
45 } BLI_AStarGNode;
46
47 typedef struct BLI_AStarSolution {
48         /* Final 'most useful' data. */
49         /** Number of steps (i.e. walked links) in path
50          * (nodes num, including start and end, is steps + 1). */
51         int steps;
52         /** Store the path, in reversed order (from destination to source node), as indices. */
53         int *prev_nodes;
54         /** Indices are nodes' ones, as prev_nodes, but they map to relevant link. */
55         BLI_AStarGNLink **prev_links;
56
57         void *custom_data;
58
59         /* Mostly runtime data. */
60         BLI_bitmap *done_nodes;
61         float *g_costs;
62         int *g_steps;
63
64         struct MemArena *mem;  /* Memory arena. */
65 } BLI_AStarSolution;
66
67 typedef struct BLI_AStarGraph {
68         int node_num;
69         BLI_AStarGNode *nodes;
70
71         void *custom_data;
72
73         struct MemArena *mem;  /* Memory arena. */
74 } BLI_AStarGraph;
75
76 void BLI_astar_node_init(BLI_AStarGraph *as_graph, const int node_index, void *custom_data);
77 void BLI_astar_node_link_add(
78         BLI_AStarGraph *as_graph, const int node1_index, const int node2_index, const float cost, void *custom_data);
79 int BLI_astar_node_link_other_node(BLI_AStarGNLink *lnk, const int idx);
80
81 void BLI_astar_solution_init(BLI_AStarGraph *as_graph, BLI_AStarSolution *as_solution, void *custom_data);
82 void BLI_astar_solution_clear(BLI_AStarSolution *as_solution);
83 void BLI_astar_solution_free(BLI_AStarSolution *as_solution);
84
85 /**
86  * Callback computing the current cost (distance) to next node, and the estimated overall cost to destination node
87  * (A* expects this estimation to always be less or equal than actual shortest path from next node to destination one).
88  *
89  * \param link: the graph link between current node and next one.
90  * \param node_idx_curr: current node index.
91  * \param node_idx_next: next node index.
92  * \param node_idx_dst: destination node index.
93  */
94 typedef float (*astar_f_cost)(BLI_AStarGraph *as_graph, BLI_AStarSolution *as_solution, BLI_AStarGNLink *link,
95                               const int node_idx_curr, const int node_idx_next, const int node_idx_dst);
96
97 void BLI_astar_graph_init(BLI_AStarGraph *as_graph, const int node_num, void *custom_data);
98 void BLI_astar_graph_free(BLI_AStarGraph *as_graph);
99 bool BLI_astar_graph_solve(
100         BLI_AStarGraph *as_graph, const int node_index_src, const int node_index_dst, astar_f_cost f_cost_cb,
101         BLI_AStarSolution *r_solution, const int max_steps);
102
103 #endif  /* __BLI_ASTAR_H__ */