1/**************************************************************************/
2/* navigation_link_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_LINK_2D_H
32#define NAVIGATION_LINK_2D_H
33
34#include "scene/2d/node_2d.h"
35
36class NavigationLink2D : public Node2D {
37 GDCLASS(NavigationLink2D, Node2D);
38
39 bool enabled = true;
40 RID link;
41 bool bidirectional = true;
42 uint32_t navigation_layers = 1;
43 Vector2 end_position;
44 Vector2 start_position;
45 real_t enter_cost = 0.0;
46 real_t travel_cost = 1.0;
47
48 Transform2D current_global_transform;
49
50protected:
51 static void _bind_methods();
52 void _notification(int p_what);
53
54#ifndef DISABLE_DEPRECATED
55 bool _set(const StringName &p_name, const Variant &p_value);
56 bool _get(const StringName &p_name, Variant &r_ret) const;
57#endif // DISABLE_DEPRECATED
58
59public:
60#ifdef TOOLS_ENABLED
61 virtual Rect2 _edit_get_rect() const override;
62 virtual bool _edit_is_selected_on_click(const Point2 &p_point, double p_tolerance) const override;
63#endif
64
65 void set_enabled(bool p_enabled);
66 bool is_enabled() const { return enabled; }
67
68 void set_bidirectional(bool p_bidirectional);
69 bool is_bidirectional() const { return bidirectional; }
70
71 void set_navigation_layers(uint32_t p_navigation_layers);
72 uint32_t get_navigation_layers() const { return navigation_layers; }
73
74 void set_navigation_layer_value(int p_layer_number, bool p_value);
75 bool get_navigation_layer_value(int p_layer_number) const;
76
77 void set_start_position(Vector2 p_position);
78 Vector2 get_start_position() const { return start_position; }
79
80 void set_end_position(Vector2 p_position);
81 Vector2 get_end_position() const { return end_position; }
82
83 void set_global_start_position(Vector2 p_position);
84 Vector2 get_global_start_position() const;
85
86 void set_global_end_position(Vector2 p_position);
87 Vector2 get_global_end_position() const;
88
89 void set_enter_cost(real_t p_enter_cost);
90 real_t get_enter_cost() const { return enter_cost; }
91
92 void set_travel_cost(real_t p_travel_cost);
93 real_t get_travel_cost() const { return travel_cost; }
94
95 PackedStringArray get_configuration_warnings() const override;
96
97 NavigationLink2D();
98 ~NavigationLink2D();
99};
100
101#endif // NAVIGATION_LINK_2D_H
102