1/**************************************************************************/
2/* path_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 PATH_2D_H
32#define PATH_2D_H
33
34#include "scene/2d/node_2d.h"
35#include "scene/resources/curve.h"
36
37class Timer;
38
39class Path2D : public Node2D {
40 GDCLASS(Path2D, Node2D);
41
42 Ref<Curve2D> curve;
43
44 void _curve_changed();
45
46protected:
47 void _notification(int p_what);
48 static void _bind_methods();
49
50public:
51#ifdef TOOLS_ENABLED
52 virtual Rect2 _edit_get_rect() const override;
53 virtual bool _edit_use_rect() const override;
54 virtual bool _edit_is_selected_on_click(const Point2 &p_point, double p_tolerance) const override;
55#endif
56
57 void set_curve(const Ref<Curve2D> &p_curve);
58 Ref<Curve2D> get_curve() const;
59
60 Path2D() {}
61};
62
63class PathFollow2D : public Node2D {
64 GDCLASS(PathFollow2D, Node2D);
65
66public:
67private:
68 Path2D *path = nullptr;
69 real_t progress = 0.0;
70 Timer *update_timer = nullptr;
71 real_t h_offset = 0.0;
72 real_t v_offset = 0.0;
73 bool cubic = true;
74 bool loop = true;
75 bool rotates = true;
76
77 void _update_transform();
78
79protected:
80 void _validate_property(PropertyInfo &p_property) const;
81
82 void _notification(int p_what);
83 static void _bind_methods();
84
85public:
86 void path_changed();
87
88 void set_progress(real_t p_progress);
89 real_t get_progress() const;
90
91 void set_h_offset(real_t p_h_offset);
92 real_t get_h_offset() const;
93
94 void set_v_offset(real_t p_v_offset);
95 real_t get_v_offset() const;
96
97 void set_progress_ratio(real_t p_ratio);
98 real_t get_progress_ratio() const;
99
100 void set_loop(bool p_loop);
101 bool has_loop() const;
102
103 void set_rotation_enabled(bool p_enabled);
104 bool is_rotation_enabled() const;
105
106 void set_cubic_interpolation_enabled(bool p_enabled);
107 bool is_cubic_interpolation_enabled() const;
108
109 PackedStringArray get_configuration_warnings() const override;
110
111 PathFollow2D() {}
112};
113
114#endif // PATH_2D_H
115