76a43c93cd
Add optional parameter to specify whether applying rotation to the
PathFollow3D's Transform is necessary, preventing erroneous updates.
(cherry picked from commit be3a1769fe)
117 lines
3.7 KiB
C++
117 lines
3.7 KiB
C++
/*************************************************************************/
|
|
/* path.h */
|
|
/*************************************************************************/
|
|
/* This file is part of: */
|
|
/* GODOT ENGINE */
|
|
/* https://godotengine.org */
|
|
/*************************************************************************/
|
|
/* Copyright (c) 2007-2020 Juan Linietsky, Ariel Manzur. */
|
|
/* Copyright (c) 2014-2020 Godot Engine contributors (cf. AUTHORS.md). */
|
|
/* */
|
|
/* 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_H
|
|
#define PATH_H
|
|
|
|
#include "scene/3d/spatial.h"
|
|
#include "scene/resources/curve.h"
|
|
|
|
class Path : public Spatial {
|
|
|
|
GDCLASS(Path, Spatial);
|
|
|
|
Ref<Curve3D> curve;
|
|
|
|
void _curve_changed();
|
|
|
|
protected:
|
|
void _notification(int p_what);
|
|
static void _bind_methods();
|
|
|
|
public:
|
|
void set_curve(const Ref<Curve3D> &p_curve);
|
|
Ref<Curve3D> get_curve() const;
|
|
|
|
Path();
|
|
};
|
|
|
|
class PathFollow : public Spatial {
|
|
|
|
GDCLASS(PathFollow, Spatial);
|
|
|
|
public:
|
|
enum RotationMode {
|
|
|
|
ROTATION_NONE,
|
|
ROTATION_Y,
|
|
ROTATION_XY,
|
|
ROTATION_XYZ,
|
|
ROTATION_ORIENTED
|
|
};
|
|
|
|
private:
|
|
Path *path;
|
|
real_t delta_offset; // change in offset since last _update_transform
|
|
real_t offset;
|
|
real_t h_offset;
|
|
real_t v_offset;
|
|
bool cubic;
|
|
bool loop;
|
|
RotationMode rotation_mode;
|
|
|
|
void _update_transform(bool p_update_xyz_rot = true);
|
|
|
|
protected:
|
|
virtual void _validate_property(PropertyInfo &property) const;
|
|
|
|
void _notification(int p_what);
|
|
static void _bind_methods();
|
|
|
|
public:
|
|
void set_offset(float p_offset);
|
|
float get_offset() const;
|
|
|
|
void set_h_offset(float p_h_offset);
|
|
float get_h_offset() const;
|
|
|
|
void set_v_offset(float p_v_offset);
|
|
float get_v_offset() const;
|
|
|
|
void set_unit_offset(float p_unit_offset);
|
|
float get_unit_offset() const;
|
|
|
|
void set_loop(bool p_loop);
|
|
bool has_loop() 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;
|
|
|
|
String get_configuration_warning() const;
|
|
|
|
PathFollow();
|
|
};
|
|
|
|
VARIANT_ENUM_CAST(PathFollow::RotationMode);
|
|
|
|
#endif // PATH_H
|