godot/scene/3d/path_3d.h

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

128 lines
4.1 KiB
C++
Raw Normal View History

2014-02-10 01:10:30 +00:00
/*************************************************************************/
/* path_3d.h */
2014-02-10 01:10:30 +00:00
/*************************************************************************/
/* This file is part of: */
/* GODOT ENGINE */
/* https://godotengine.org */
2014-02-10 01:10:30 +00:00
/*************************************************************************/
/* Copyright (c) 2007-2022 Juan Linietsky, Ariel Manzur. */
/* Copyright (c) 2014-2022 Godot Engine contributors (cf. AUTHORS.md). */
2014-02-10 01:10:30 +00:00
/* */
/* 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
2015-04-18 17:38:54 +00:00
#include "scene/3d/node_3d.h"
2015-04-18 17:38:54 +00:00
#include "scene/resources/curve.h"
class Path3D : public Node3D {
GDCLASS(Path3D, Node3D);
2015-04-18 17:38:54 +00:00
Ref<Curve3D> curve;
void _curve_changed();
RID debug_instance;
Ref<ArrayMesh> debug_mesh;
private:
void _update_debug_mesh();
2015-04-18 17:38:54 +00:00
protected:
void _notification(int p_what);
2015-04-18 17:38:54 +00:00
static void _bind_methods();
public:
void set_curve(const Ref<Curve3D> &p_curve);
Ref<Curve3D> get_curve() const;
Path3D();
~Path3D();
2015-04-18 17:38:54 +00:00
};
class PathFollow3D : public Node3D {
GDCLASS(PathFollow3D, Node3D);
2015-04-18 17:38:54 +00:00
public:
2015-04-18 17:38:54 +00:00
enum RotationMode {
ROTATION_NONE,
ROTATION_Y,
ROTATION_XY,
ROTATION_XYZ,
ROTATION_ORIENTED
2015-04-18 17:38:54 +00:00
};
static Transform3D correct_posture(Transform3D p_transform, PathFollow3D::RotationMode p_rotation_mode);
2015-04-18 17:38:54 +00:00
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;
2015-04-18 17:38:54 +00:00
void _update_transform(bool p_update_xyz_rot = true);
2015-04-18 17:38:54 +00:00
protected:
void _validate_property(PropertyInfo &p_property) const;
2015-04-18 17:38:54 +00:00
void _notification(int p_what);
static void _bind_methods();
public:
void set_progress(real_t p_progress);
real_t get_progress() const;
2015-04-18 17:38:54 +00:00
2021-01-30 00:55:54 +00:00
void set_h_offset(real_t p_h_offset);
real_t get_h_offset() const;
2015-04-18 17:38:54 +00:00
2021-01-30 00:55:54 +00:00
void set_v_offset(real_t p_v_offset);
real_t get_v_offset() const;
2015-04-18 17:38:54 +00:00
void set_progress_ratio(real_t p_ratio);
real_t get_progress_ratio() const;
2015-04-18 17:38:54 +00:00
void set_loop(bool p_loop);
bool has_loop() const;
void set_tilt_enabled(bool p_enable);
bool is_tilt_enabled() const;
2015-04-18 17:38:54 +00:00
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() {}
2015-04-18 17:38:54 +00:00
};
VARIANT_ENUM_CAST(PathFollow3D::RotationMode);
2015-04-18 17:38:54 +00:00
#endif // PATH_3D_H