initial commit, 4.5 stable

editor/scene/3d/path_3d_editor_plugin.h

@@ -0,0 +1,189 @@
+/**************************************************************************/
+/*  path_3d_editor_plugin.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.                 */
+/**************************************************************************/
+
+#pragma once
+
+#include "editor/plugins/editor_plugin.h"
+#include "editor/scene/3d/node_3d_editor_gizmos.h"
+#include "scene/3d/camera_3d.h"
+#include "scene/3d/path_3d.h"
+
+class HBoxContainer;
+class MenuButton;
+class ConfirmationDialog;
+
+class Path3DGizmo : public EditorNode3DGizmo {
+	GDCLASS(Path3DGizmo, EditorNode3DGizmo);
+
+	// Map handle id to control point id and handle type.
+	enum HandleType {
+		HANDLE_TYPE_IN,
+		HANDLE_TYPE_OUT,
+		HANDLE_TYPE_TILT,
+	};
+
+	struct HandleInfo {
+		int point_idx; // Index of control point.
+		HandleType type; // Type of this handle.
+	};
+
+	Path3D *path = nullptr;
+	Ref<StandardMaterial3D> debug_material;
+	mutable Vector3 original;
+	mutable float orig_in_length;
+	mutable float orig_out_length;
+	mutable float disk_size = 0.8;
+
+	// Index that should have swapped control points for achieving an outwards curve.
+	int swapped_control_points_idx = -1;
+	bool control_points_overlapped = false;
+
+	// Cache information of secondary handles.
+	Vector<HandleInfo> _secondary_handles_info;
+
+	void _update_transform_gizmo();
+
+public:
+	virtual String get_handle_name(int p_id, bool p_secondary) const override;
+	virtual Variant get_handle_value(int p_id, bool p_secondary) const override;
+	virtual void set_handle(int p_id, bool p_secondary, Camera3D *p_camera, const Point2 &p_point) override;
+	virtual void commit_handle(int p_id, bool p_secondary, const Variant &p_restore, bool p_cancel = false) override;
+
+	virtual void redraw() override;
+	Path3DGizmo(Path3D *p_path = nullptr, float p_disk_size = 0.8);
+};
+
+class Path3DGizmoPlugin : public EditorNode3DGizmoPlugin {
+	GDCLASS(Path3DGizmoPlugin, EditorNode3DGizmoPlugin);
+
+	float disk_size = 0.8;
+
+	// Locking basis is meant to ensure a predictable behavior during translation of the curve points in "local space transform mode".
+	// Without the locking, the gizmo/point, in "local space transform mode", wouldn't follow a straight path and would curve and twitch in an unpredictable way.
+	HashMap<int, Basis> transformation_locked_basis;
+
+protected:
+	Ref<EditorNode3DGizmo> create_gizmo(Node3D *p_spatial) override;
+
+public:
+	virtual bool has_gizmo(Node3D *p_spatial) override;
+	String get_gizmo_name() const override;
+
+	virtual void redraw(EditorNode3DGizmo *p_gizmo) override;
+
+	virtual int subgizmos_intersect_ray(const EditorNode3DGizmo *p_gizmo, Camera3D *p_camera, const Vector2 &p_point) const override;
+	virtual Vector<int> subgizmos_intersect_frustum(const EditorNode3DGizmo *p_gizmo, const Camera3D *p_camera, const Vector<Plane> &p_frustum) const override;
+	virtual Transform3D get_subgizmo_transform(const EditorNode3DGizmo *p_gizmo, int p_id) const override;
+	virtual void set_subgizmo_transform(const EditorNode3DGizmo *p_gizmo, int p_id, Transform3D p_transform) override;
+	virtual void commit_subgizmos(const EditorNode3DGizmo *p_gizmo, const Vector<int> &p_ids, const Vector<Transform3D> &p_restore, bool p_cancel = false) override;
+
+	int get_priority() const override;
+	Path3DGizmoPlugin(float p_disk_size);
+};
+
+class Path3DEditorPlugin : public EditorPlugin {
+	GDCLASS(Path3DEditorPlugin, EditorPlugin);
+
+	friend class Path3DGizmo;
+	friend class Path3DGizmoPlugin;
+
+	Ref<Path3DGizmoPlugin> path_3d_gizmo_plugin;
+
+	HBoxContainer *topmenu_bar = nullptr;
+
+	HBoxContainer *toolbar = nullptr;
+	Button *curve_create = nullptr;
+	Button *curve_edit = nullptr;
+	Button *curve_edit_curve = nullptr;
+	Button *curve_edit_tilt = nullptr;
+	Button *curve_del = nullptr;
+	Button *curve_closed = nullptr;
+	Button *curve_clear_points = nullptr;
+	MenuButton *handle_menu = nullptr;
+
+	Button *create_curve_button = nullptr;
+	ConfirmationDialog *clear_points_dialog = nullptr;
+
+	float disk_size = 0.8;
+
+	enum Mode {
+		MODE_CREATE,
+		MODE_EDIT,
+		MODE_EDIT_CURVE,
+		MODE_EDIT_TILT,
+		MODE_DELETE,
+		ACTION_CLOSE
+	};
+
+	Path3D *path = nullptr;
+
+	void _update_theme();
+	void _update_toolbar();
+
+	void _mode_changed(int p_mode);
+	void _toggle_closed_curve();
+	void _handle_option_pressed(int p_option);
+	bool handle_clicked = false;
+	bool mirror_handle_angle = true;
+	bool mirror_handle_length = true;
+
+	void _create_curve();
+	void _confirm_clear_points();
+	void _clear_points();
+	void _clear_curve_points();
+	void _restore_curve_points(const PackedVector3Array &p_points);
+
+	enum HandleOption {
+		HANDLE_OPTION_ANGLE,
+		HANDLE_OPTION_LENGTH
+	};
+
+protected:
+	static void _bind_methods();
+
+public:
+	Path3D *get_edited_path() { return path; }
+
+	inline static Path3DEditorPlugin *singleton = nullptr;
+	virtual EditorPlugin::AfterGUIInput forward_3d_gui_input(Camera3D *p_camera, const Ref<InputEvent> &p_event) override;
+
+	virtual String get_plugin_name() const override { return "Path3D"; }
+	bool has_main_screen() const override { return false; }
+	virtual void edit(Object *p_object) override;
+	virtual bool handles(Object *p_object) const override;
+	virtual void make_visible(bool p_visible) override;
+
+	bool mirror_angle_enabled() { return mirror_handle_angle; }
+	bool mirror_length_enabled() { return mirror_handle_length; }
+	bool is_handle_clicked() { return handle_clicked; }
+	void set_handle_clicked(bool clicked) { handle_clicked = clicked; }
+
+	Path3DEditorPlugin();
+};