d95794ec8a
As many open source projects have started doing it, we're removing the current year from the copyright notice, so that we don't need to bump it every year. It seems like only the first year of publication is technically relevant for copyright notices, and even that seems to be something that many companies stopped listing altogether (in a version controlled codebase, the commits are a much better source of date of publication than a hardcoded copyright statement). We also now list Godot Engine contributors first as we're collectively the current maintainers of the project, and we clarify that the "exclusive" copyright of the co-founders covers the timespan before opensourcing (their further contributions are included as part of Godot Engine contributors). Also fixed "cf." Frenchism - it's meant as "refer to / see".
127 lines
4.1 KiB
C++
127 lines
4.1 KiB
C++
/**************************************************************************/
|
|
/* path_3d.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. */
|
|
/**************************************************************************/
|
|
|
|
#ifndef PATH_3D_H
|
|
#define PATH_3D_H
|
|
|
|
#include "scene/3d/node_3d.h"
|
|
#include "scene/resources/curve.h"
|
|
|
|
class Path3D : public Node3D {
|
|
GDCLASS(Path3D, Node3D);
|
|
|
|
Ref<Curve3D> curve;
|
|
|
|
void _curve_changed();
|
|
|
|
RID debug_instance;
|
|
Ref<ArrayMesh> debug_mesh;
|
|
|
|
private:
|
|
void _update_debug_mesh();
|
|
|
|
protected:
|
|
void _notification(int p_what);
|
|
|
|
static void _bind_methods();
|
|
|
|
public:
|
|
void set_curve(const Ref<Curve3D> &p_curve);
|
|
Ref<Curve3D> get_curve() const;
|
|
|
|
Path3D();
|
|
~Path3D();
|
|
};
|
|
|
|
class PathFollow3D : public Node3D {
|
|
GDCLASS(PathFollow3D, Node3D);
|
|
|
|
public:
|
|
enum RotationMode {
|
|
ROTATION_NONE,
|
|
ROTATION_Y,
|
|
ROTATION_XY,
|
|
ROTATION_XYZ,
|
|
ROTATION_ORIENTED
|
|
};
|
|
|
|
static Transform3D correct_posture(Transform3D p_transform, PathFollow3D::RotationMode p_rotation_mode);
|
|
|
|
private:
|
|
Path3D *path = nullptr;
|
|
real_t progress = 0.0;
|
|
real_t h_offset = 0.0;
|
|
real_t v_offset = 0.0;
|
|
bool cubic = true;
|
|
bool loop = true;
|
|
bool tilt_enabled = true;
|
|
RotationMode rotation_mode = ROTATION_XYZ;
|
|
|
|
void _update_transform(bool p_update_xyz_rot = true);
|
|
|
|
protected:
|
|
void _validate_property(PropertyInfo &p_property) const;
|
|
|
|
void _notification(int p_what);
|
|
static void _bind_methods();
|
|
|
|
public:
|
|
void set_progress(real_t p_progress);
|
|
real_t get_progress() const;
|
|
|
|
void set_h_offset(real_t p_h_offset);
|
|
real_t get_h_offset() const;
|
|
|
|
void set_v_offset(real_t p_v_offset);
|
|
real_t get_v_offset() const;
|
|
|
|
void set_progress_ratio(real_t p_ratio);
|
|
real_t get_progress_ratio() const;
|
|
|
|
void set_loop(bool p_loop);
|
|
bool has_loop() const;
|
|
|
|
void set_tilt_enabled(bool p_enable);
|
|
bool is_tilt_enabled() const;
|
|
|
|
void set_rotation_mode(RotationMode p_rotation_mode);
|
|
RotationMode get_rotation_mode() const;
|
|
|
|
void set_cubic_interpolation(bool p_enable);
|
|
bool get_cubic_interpolation() const;
|
|
|
|
PackedStringArray get_configuration_warnings() const override;
|
|
|
|
PathFollow3D() {}
|
|
};
|
|
|
|
VARIANT_ENUM_CAST(PathFollow3D::RotationMode);
|
|
|
|
#endif // PATH_3D_H
|