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