1/**************************************************************************/
2/* navigation_path_query_parameters_2d.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_PATH_QUERY_PARAMETERS_2D_H
32#define NAVIGATION_PATH_QUERY_PARAMETERS_2D_H
33
34#include "core/object/ref_counted.h"
35#include "servers/navigation/navigation_utilities.h"
36
37class NavigationPathQueryParameters2D : public RefCounted {
38 GDCLASS(NavigationPathQueryParameters2D, RefCounted);
39
40 NavigationUtilities::PathQueryParameters parameters;
41
42protected:
43 static void _bind_methods();
44
45public:
46 enum PathfindingAlgorithm {
47 PATHFINDING_ALGORITHM_ASTAR = 0,
48 };
49
50 enum PathPostProcessing {
51 PATH_POSTPROCESSING_CORRIDORFUNNEL = 0,
52 PATH_POSTPROCESSING_EDGECENTERED,
53 };
54
55 enum PathMetadataFlags {
56 PATH_METADATA_INCLUDE_NONE = NavigationUtilities::PathMetadataFlags::PATH_INCLUDE_NONE,
57 PATH_METADATA_INCLUDE_TYPES = NavigationUtilities::PathMetadataFlags::PATH_INCLUDE_TYPES,
58 PATH_METADATA_INCLUDE_RIDS = NavigationUtilities::PathMetadataFlags::PATH_INCLUDE_RIDS,
59 PATH_METADATA_INCLUDE_OWNERS = NavigationUtilities::PathMetadataFlags::PATH_INCLUDE_OWNERS,
60 PATH_METADATA_INCLUDE_ALL = NavigationUtilities::PathMetadataFlags::PATH_INCLUDE_ALL
61 };
62
63 const NavigationUtilities::PathQueryParameters &get_parameters() const { return parameters; }
64
65 void set_pathfinding_algorithm(const PathfindingAlgorithm p_pathfinding_algorithm);
66 PathfindingAlgorithm get_pathfinding_algorithm() const;
67
68 void set_path_postprocessing(const PathPostProcessing p_path_postprocessing);
69 PathPostProcessing get_path_postprocessing() const;
70
71 void set_map(const RID &p_map);
72 const RID &get_map() const;
73
74 void set_start_position(const Vector2 p_start_position);
75 Vector2 get_start_position() const;
76
77 void set_target_position(const Vector2 p_target_position);
78 Vector2 get_target_position() const;
79
80 void set_navigation_layers(uint32_t p_navigation_layers);
81 uint32_t get_navigation_layers() const;
82
83 void set_metadata_flags(BitField<NavigationPathQueryParameters2D::PathMetadataFlags> p_flags);
84 BitField<NavigationPathQueryParameters2D::PathMetadataFlags> get_metadata_flags() const;
85};
86
87VARIANT_ENUM_CAST(NavigationPathQueryParameters2D::PathfindingAlgorithm);
88VARIANT_ENUM_CAST(NavigationPathQueryParameters2D::PathPostProcessing);
89VARIANT_BITFIELD_CAST(NavigationPathQueryParameters2D::PathMetadataFlags);
90
91#endif // NAVIGATION_PATH_QUERY_PARAMETERS_2D_H
92