2023-01-05 13:25:55 +01:00
|
|
|
/**************************************************************************/
|
|
|
|
/* path_2d.h */
|
|
|
|
/**************************************************************************/
|
|
|
|
/* This file is part of: */
|
|
|
|
/* GODOT ENGINE */
|
|
|
|
/* https://godotengine.org */
|
|
|
|
/**************************************************************************/
|
|
|
|
/* Copyright (c) 2014-present Godot Engine contributors (see AUTHORS.md). */
|
|
|
|
/* Copyright (c) 2007-2014 Juan Linietsky, Ariel Manzur. */
|
|
|
|
/* */
|
|
|
|
/* Permission is hereby granted, free of charge, to any person obtaining */
|
|
|
|
/* a copy of this software and associated documentation files (the */
|
|
|
|
/* "Software"), to deal in the Software without restriction, including */
|
|
|
|
/* without limitation the rights to use, copy, modify, merge, publish, */
|
|
|
|
/* distribute, sublicense, and/or sell copies of the Software, and to */
|
|
|
|
/* permit persons to whom the Software is furnished to do so, subject to */
|
|
|
|
/* the following conditions: */
|
|
|
|
/* */
|
|
|
|
/* The above copyright notice and this permission notice shall be */
|
|
|
|
/* included in all copies or substantial portions of the Software. */
|
|
|
|
/* */
|
|
|
|
/* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, */
|
|
|
|
/* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF */
|
|
|
|
/* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. */
|
|
|
|
/* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY */
|
|
|
|
/* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, */
|
|
|
|
/* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE */
|
|
|
|
/* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */
|
|
|
|
/**************************************************************************/
|
2018-01-05 00:50:27 +01:00
|
|
|
|
2014-02-10 02:10:30 +01:00
|
|
|
#ifndef PATH_2D_H
|
|
|
|
#define PATH_2D_H
|
|
|
|
|
|
|
|
#include "scene/2d/node_2d.h"
|
2017-03-05 16:44:50 +01:00
|
|
|
#include "scene/resources/curve.h"
|
2014-02-10 02:10:30 +01:00
|
|
|
|
2020-11-08 21:43:56 +01:00
|
|
|
class Timer;
|
|
|
|
|
2014-02-10 02:10:30 +01:00
|
|
|
class Path2D : public Node2D {
|
2017-03-05 16:44:50 +01:00
|
|
|
GDCLASS(Path2D, Node2D);
|
2014-02-10 02:10:30 +01:00
|
|
|
|
|
|
|
Ref<Curve2D> curve;
|
|
|
|
|
|
|
|
void _curve_changed();
|
|
|
|
|
|
|
|
protected:
|
|
|
|
void _notification(int p_what);
|
|
|
|
static void _bind_methods();
|
|
|
|
|
2017-03-05 16:44:50 +01:00
|
|
|
public:
|
2019-10-21 23:37:07 +02:00
|
|
|
#ifdef TOOLS_ENABLED
|
2020-07-10 12:34:39 +02:00
|
|
|
virtual Rect2 _edit_get_rect() const override;
|
|
|
|
virtual bool _edit_use_rect() const override;
|
|
|
|
virtual bool _edit_is_selected_on_click(const Point2 &p_point, double p_tolerance) const override;
|
2019-10-21 23:37:07 +02:00
|
|
|
#endif
|
2017-12-27 09:28:02 +01:00
|
|
|
|
2017-03-05 16:44:50 +01:00
|
|
|
void set_curve(const Ref<Curve2D> &p_curve);
|
2014-02-10 02:10:30 +01:00
|
|
|
Ref<Curve2D> get_curve() const;
|
|
|
|
|
2020-06-12 13:16:14 +02:00
|
|
|
Path2D() {}
|
2014-02-10 02:10:30 +01:00
|
|
|
};
|
|
|
|
|
2014-07-06 16:49:27 +02:00
|
|
|
class PathFollow2D : public Node2D {
|
2017-03-05 16:44:50 +01:00
|
|
|
GDCLASS(PathFollow2D, Node2D);
|
2014-07-06 16:49:27 +02:00
|
|
|
|
2017-03-05 16:44:50 +01:00
|
|
|
public:
|
2014-07-06 16:49:27 +02:00
|
|
|
private:
|
2020-12-11 15:54:03 +01:00
|
|
|
Path2D *path = nullptr;
|
2022-08-23 23:41:41 +02:00
|
|
|
real_t progress = 0.0;
|
2020-11-08 21:43:56 +01:00
|
|
|
Timer *update_timer = nullptr;
|
2021-02-07 22:29:31 +01:00
|
|
|
real_t h_offset = 0.0;
|
|
|
|
real_t v_offset = 0.0;
|
2020-12-11 15:54:03 +01:00
|
|
|
bool cubic = true;
|
|
|
|
bool loop = true;
|
|
|
|
bool rotates = true;
|
2014-07-06 16:49:27 +02:00
|
|
|
|
|
|
|
void _update_transform();
|
|
|
|
|
|
|
|
protected:
|
2022-08-12 22:57:11 +02:00
|
|
|
void _validate_property(PropertyInfo &p_property) const;
|
2014-07-06 16:49:27 +02:00
|
|
|
|
|
|
|
void _notification(int p_what);
|
|
|
|
static void _bind_methods();
|
|
|
|
|
2017-03-05 16:44:50 +01:00
|
|
|
public:
|
2020-11-08 21:43:56 +01:00
|
|
|
void path_changed();
|
|
|
|
|
2022-08-23 23:41:41 +02:00
|
|
|
void set_progress(real_t p_progress);
|
|
|
|
real_t get_progress() const;
|
2014-07-06 16:49:27 +02:00
|
|
|
|
2021-01-30 05:10:32 +01:00
|
|
|
void set_h_offset(real_t p_h_offset);
|
|
|
|
real_t get_h_offset() const;
|
2014-07-06 16:49:27 +02:00
|
|
|
|
2021-01-30 05:10:32 +01:00
|
|
|
void set_v_offset(real_t p_v_offset);
|
|
|
|
real_t get_v_offset() const;
|
2014-07-06 16:49:27 +02:00
|
|
|
|
2022-08-23 23:41:41 +02:00
|
|
|
void set_progress_ratio(real_t p_ratio);
|
|
|
|
real_t get_progress_ratio() const;
|
2014-07-06 16:49:27 +02:00
|
|
|
|
|
|
|
void set_loop(bool p_loop);
|
|
|
|
bool has_loop() const;
|
|
|
|
|
2023-02-07 18:48:33 +01:00
|
|
|
void set_rotation_enabled(bool p_enabled);
|
|
|
|
bool is_rotation_enabled() const;
|
2014-07-06 16:49:27 +02:00
|
|
|
|
2023-02-07 18:48:33 +01:00
|
|
|
void set_cubic_interpolation_enabled(bool p_enabled);
|
|
|
|
bool is_cubic_interpolation_enabled() const;
|
2014-07-06 16:49:27 +02:00
|
|
|
|
2024-02-17 19:03:21 +01:00
|
|
|
PackedStringArray get_configuration_warnings() const override;
|
2016-05-17 23:27:15 +02:00
|
|
|
|
2020-12-11 15:54:03 +01:00
|
|
|
PathFollow2D() {}
|
2014-07-06 16:49:27 +02:00
|
|
|
};
|
|
|
|
|
2014-02-10 02:10:30 +01:00
|
|
|
#endif // PATH_2D_H
|