1/**************************************************************************/
2/* navigation_utilities.h */
3/**************************************************************************/
4/* This file is part of: */
5/* GODOT ENGINE */
6/* https://godotengine.org */
7/**************************************************************************/
8/* Copyright (c) 2014-present Godot Engine contributors (see AUTHORS.md). */
9/* Copyright (c) 2007-2014 Juan Linietsky, Ariel Manzur. */
10/* */
11/* Permission is hereby granted, free of charge, to any person obtaining */
12/* a copy of this software and associated documentation files (the */
13/* "Software"), to deal in the Software without restriction, including */
14/* without limitation the rights to use, copy, modify, merge, publish, */
15/* distribute, sublicense, and/or sell copies of the Software, and to */
16/* permit persons to whom the Software is furnished to do so, subject to */
17/* the following conditions: */
18/* */
19/* The above copyright notice and this permission notice shall be */
20/* included in all copies or substantial portions of the Software. */
21/* */
22/* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, */
23/* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF */
24/* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. */
25/* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY */
26/* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, */
27/* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE */
28/* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */
29/**************************************************************************/
30
31#ifndef NAVIGATION_UTILITIES_H
32#define NAVIGATION_UTILITIES_H
33
34#include "core/math/vector3.h"
35#include "core/variant/typed_array.h"
36
37namespace NavigationUtilities {
38
39enum PathfindingAlgorithm {
40 PATHFINDING_ALGORITHM_ASTAR = 0,
41};
42
43enum PathPostProcessing {
44 PATH_POSTPROCESSING_CORRIDORFUNNEL = 0,
45 PATH_POSTPROCESSING_EDGECENTERED,
46};
47
48enum PathSegmentType {
49 PATH_SEGMENT_TYPE_REGION = 0,
50 PATH_SEGMENT_TYPE_LINK
51};
52
53enum PathMetadataFlags {
54 PATH_INCLUDE_NONE = 0,
55 PATH_INCLUDE_TYPES = 1,
56 PATH_INCLUDE_RIDS = 2,
57 PATH_INCLUDE_OWNERS = 4,
58 PATH_INCLUDE_ALL = PATH_INCLUDE_TYPES | PATH_INCLUDE_RIDS | PATH_INCLUDE_OWNERS
59};
60
61struct PathQueryParameters {
62 PathfindingAlgorithm pathfinding_algorithm = PATHFINDING_ALGORITHM_ASTAR;
63 PathPostProcessing path_postprocessing = PATH_POSTPROCESSING_CORRIDORFUNNEL;
64 RID map;
65 Vector3 start_position;
66 Vector3 target_position;
67 uint32_t navigation_layers = 1;
68 BitField<PathMetadataFlags> metadata_flags = PATH_INCLUDE_ALL;
69};
70
71struct PathQueryResult {
72 PackedVector3Array path;
73 PackedInt32Array path_types;
74 TypedArray<RID> path_rids;
75 PackedInt64Array path_owner_ids;
76};
77
78} //namespace NavigationUtilities
79
80#endif // NAVIGATION_UTILITIES_H
81