From 5c83d14698c454d38b7e1eb2dd50f7013ee39ba4 Mon Sep 17 00:00:00 2001 From: matricola787 Date: Sun, 24 Mar 2024 13:43:17 +0100 Subject: [PATCH] UX and stability improvements for Path3D node --- editor/icons/CurveTilt.svg | 1 + editor/plugins/node_3d_editor_plugin.cpp | 4 + editor/plugins/node_3d_editor_plugin.h | 1 + editor/plugins/path_3d_editor_plugin.cpp | 138 ++++++++++++++--------- editor/plugins/path_3d_editor_plugin.h | 7 ++ 5 files changed, 100 insertions(+), 51 deletions(-) create mode 100644 editor/icons/CurveTilt.svg diff --git a/editor/icons/CurveTilt.svg b/editor/icons/CurveTilt.svg new file mode 100644 index 00000000000..4cf7c5bff33 --- /dev/null +++ b/editor/icons/CurveTilt.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/editor/plugins/node_3d_editor_plugin.cpp b/editor/plugins/node_3d_editor_plugin.cpp index f38d42f6812..10b7e34693a 100644 --- a/editor/plugins/node_3d_editor_plugin.cpp +++ b/editor/plugins/node_3d_editor_plugin.cpp @@ -7789,6 +7789,10 @@ Vector Node3DEditor::get_subgizmo_selection() { return ret; } +void Node3DEditor::clear_subgizmo_selection(Object *p_obj) { + _clear_subgizmo_selection(p_obj); +} + void Node3DEditor::add_control_to_menu_panel(Control *p_control) { ERR_FAIL_NULL(p_control); ERR_FAIL_COND(p_control->get_parent()); diff --git a/editor/plugins/node_3d_editor_plugin.h b/editor/plugins/node_3d_editor_plugin.h index 091432b35a2..51ceb7339c4 100644 --- a/editor/plugins/node_3d_editor_plugin.h +++ b/editor/plugins/node_3d_editor_plugin.h @@ -893,6 +893,7 @@ public: bool is_current_selected_gizmo(const EditorNode3DGizmo *p_gizmo); bool is_subgizmo_selected(int p_id); Vector get_subgizmo_selection(); + void clear_subgizmo_selection(Object *p_obj = nullptr); Ref get_current_hover_gizmo() const { return current_hover_gizmo; } void set_current_hover_gizmo(Ref p_gizmo) { current_hover_gizmo = p_gizmo; } diff --git a/editor/plugins/path_3d_editor_plugin.cpp b/editor/plugins/path_3d_editor_plugin.cpp index ffdc06ceee5..bda48d97ee1 100644 --- a/editor/plugins/path_3d_editor_plugin.cpp +++ b/editor/plugins/path_3d_editor_plugin.cpp @@ -111,7 +111,7 @@ void Path3DGizmo::set_handle(int p_id, bool p_secondary, Camera3D *p_camera, con // Primary handles: position. if (!p_secondary) { Vector3 inters; - // Special cas for primary handle, the handle id equals control point id. + // Special case for primary handle, the handle id equals control point id. const int idx = p_id; if (p.intersects_ray(ray_from, ray_dir, &inters)) { if (Node3DEditor::get_singleton()->is_snap_enabled()) { @@ -200,6 +200,22 @@ void Path3DGizmo::commit_handle(int p_id, bool p_secondary, const Variant &p_res EditorUndoRedoManager *ur = EditorUndoRedoManager::get_singleton(); + // Primary handles: position. + if (!p_secondary && !Path3DEditorPlugin::singleton->curve_edit->is_pressed()) { + // Special case for primary handle, the handle id equals control point id. + const int idx = p_id; + if (p_cancel) { + c->set_point_position(idx, p_restore); + return; + } + ur->create_action(TTR("Set Curve Point Position")); + ur->add_do_method(c.ptr(), "set_point_position", idx, c->get_point_position(idx)); + ur->add_undo_method(c.ptr(), "set_point_position", idx, p_restore); + ur->commit_action(); + + return; + } + // Secondary handles: in, out, tilt. const HandleInfo info = _secondary_handles_info[p_id]; const int idx = info.point_idx; @@ -263,6 +279,7 @@ void Path3DGizmo::redraw() { Ref path_thin_material = gizmo_plugin->get_material("path_thin_material", this); Ref path_tilt_material = gizmo_plugin->get_material("path_tilt_material", this); Ref path_tilt_muted_material = gizmo_plugin->get_material("path_tilt_muted_material", this); + Ref handles_material = gizmo_plugin->get_material("handles"); Ref sec_handles_material = gizmo_plugin->get_material("sec_handles"); Ref c = path->get_curve(); @@ -340,56 +357,50 @@ void Path3DGizmo::redraw() { if (Path3DEditorPlugin::singleton->get_edited_path() == path) { PackedVector3Array handle_lines; PackedVector3Array tilt_handle_lines; + PackedVector3Array primary_handle_points; PackedVector3Array secondary_handle_points; PackedInt32Array collected_secondary_handle_ids; // Avoid shadowing member on Node3DEditorGizmo. _secondary_handles_info.resize(c->get_point_count() * 3); for (int idx = 0; idx < c->get_point_count(); idx++) { + // Collect primary-handles. const Vector3 pos = c->get_point_position(idx); - bool is_current_point_selected = is_subgizmo_selected(idx); - bool is_previous_point_selected = is_subgizmo_selected(idx - 1); - bool is_following_point_selected = is_subgizmo_selected(idx + 1); + primary_handle_points.append(pos); HandleInfo info; info.point_idx = idx; // Collect in-handles except for the first point. - if (idx > 0 && (is_current_point_selected || is_previous_point_selected)) { + if (idx > 0 && Path3DEditorPlugin::singleton->curve_edit_curve->is_pressed()) { const Vector3 in = c->get_point_in(idx); - // Display in-handles only when they are "initialized". - if (in.length_squared() > 0) { - info.type = HandleType::HANDLE_TYPE_IN; - const int handle_idx = idx * 3 + 0; - collected_secondary_handle_ids.append(handle_idx); - _secondary_handles_info.write[handle_idx] = info; + info.type = HandleType::HANDLE_TYPE_IN; + const int handle_idx = idx * 3 + 0; + collected_secondary_handle_ids.append(handle_idx); + _secondary_handles_info.write[handle_idx] = info; - secondary_handle_points.append(pos + in); - handle_lines.append(pos); - handle_lines.append(pos + in); - } + secondary_handle_points.append(pos + in); + handle_lines.append(pos); + handle_lines.append(pos + in); } // Collect out-handles except for the last point. - if (idx < c->get_point_count() - 1 && (is_current_point_selected || is_following_point_selected)) { + if (idx < c->get_point_count() - 1 && Path3DEditorPlugin::singleton->curve_edit_curve->is_pressed()) { const Vector3 out = c->get_point_out(idx); - // Display out-handles only when they are "initialized". - if (out.length_squared() > 0) { - info.type = HandleType::HANDLE_TYPE_OUT; - const int handle_idx = idx * 3 + 1; - collected_secondary_handle_ids.append(handle_idx); - _secondary_handles_info.write[handle_idx] = info; + info.type = HandleType::HANDLE_TYPE_OUT; + const int handle_idx = idx * 3 + 1; + collected_secondary_handle_ids.append(handle_idx); + _secondary_handles_info.write[handle_idx] = info; - secondary_handle_points.append(pos + out); - handle_lines.append(pos); - handle_lines.append(pos + out); - } + secondary_handle_points.append(pos + out); + handle_lines.append(pos); + handle_lines.append(pos + out); } // Collect tilt-handles. - if (is_current_point_selected || is_previous_point_selected || is_following_point_selected) { + if (Path3DEditorPlugin::singleton->curve_edit_tilt->is_pressed()) { // Tilt handle. { info.type = HandleType::HANDLE_TYPE_TILT; @@ -419,7 +430,7 @@ void Path3DGizmo::redraw() { const Vector3 edge = sin(a) * side + cos(a) * up; disk.append(pos + edge * disk_size); } - add_vertices(disk, is_current_point_selected ? path_tilt_material : path_tilt_muted_material, Mesh::PRIMITIVE_LINE_STRIP); + add_vertices(disk, path_tilt_material, Mesh::PRIMITIVE_LINE_STRIP); } } } @@ -432,6 +443,9 @@ void Path3DGizmo::redraw() { add_lines(tilt_handle_lines, path_tilt_material); } + if (!Path3DEditorPlugin::singleton->curve_edit->is_pressed() && primary_handle_points.size()) { + add_handles(primary_handle_points, handles_material); + } if (secondary_handle_points.size()) { add_handles(secondary_handle_points, sec_handles_material, collected_secondary_handle_ids, false, true); } @@ -453,6 +467,12 @@ Path3DGizmo::Path3DGizmo(Path3D *p_path, float p_disk_size) { // Connecting to a signal once, rather than plaguing the implementation with calls to `Node3DEditor::update_transform_gizmo`. path->connect("curve_changed", callable_mp(this, &Path3DGizmo::_update_transform_gizmo)); + + Path3DEditorPlugin::singleton->curve_edit->connect("pressed", callable_mp(this, &Path3DGizmo::redraw)); + Path3DEditorPlugin::singleton->curve_edit_curve->connect("pressed", callable_mp(this, &Path3DGizmo::redraw)); + Path3DEditorPlugin::singleton->curve_create->connect("pressed", callable_mp(this, &Path3DGizmo::redraw)); + Path3DEditorPlugin::singleton->curve_del->connect("pressed", callable_mp(this, &Path3DGizmo::redraw)); + Path3DEditorPlugin::singleton->curve_close->connect("pressed", callable_mp(this, &Path3DGizmo::redraw)); } EditorPlugin::AfterGUIInput Path3DEditorPlugin::forward_3d_gui_input(Camera3D *p_camera, const Ref &p_event) { @@ -612,9 +632,6 @@ EditorPlugin::AfterGUIInput Path3DEditorPlugin::forward_3d_gui_input(Camera3D *p } } } - if (curve_edit_curve->is_pressed()) { - mb->set_shift_pressed(true); - } } return EditorPlugin::AFTER_GUI_INPUT_PASS; @@ -663,8 +680,11 @@ void Path3DEditorPlugin::make_visible(bool p_visible) { void Path3DEditorPlugin::_mode_changed(int p_mode) { curve_create->set_pressed(p_mode == MODE_CREATE); curve_edit_curve->set_pressed(p_mode == MODE_EDIT_CURVE); + curve_edit_tilt->set_pressed(p_mode == MODE_EDIT_TILT); curve_edit->set_pressed(p_mode == MODE_EDIT); curve_del->set_pressed(p_mode == MODE_DELETE); + + Node3DEditor::get_singleton()->clear_subgizmo_selection(); } void Path3DEditorPlugin::_close_curve() { @@ -709,6 +729,7 @@ void Path3DEditorPlugin::_update_theme() { // See the 2D path editor for inspiration. curve_edit->set_icon(EditorNode::get_singleton()->get_editor_theme()->get_icon(SNAME("CurveEdit"), EditorStringName(EditorIcons))); curve_edit_curve->set_icon(EditorNode::get_singleton()->get_editor_theme()->get_icon(SNAME("CurveCurve"), EditorStringName(EditorIcons))); + curve_edit_tilt->set_icon(EditorNode::get_singleton()->get_editor_theme()->get_icon(SNAME("CurveTilt"), EditorStringName(EditorIcons))); curve_create->set_icon(EditorNode::get_singleton()->get_editor_theme()->get_icon(SNAME("CurveCreate"), EditorStringName(EditorIcons))); curve_del->set_icon(EditorNode::get_singleton()->get_editor_theme()->get_icon(SNAME("CurveDelete"), EditorStringName(EditorIcons))); curve_close->set_icon(EditorNode::get_singleton()->get_editor_theme()->get_icon(SNAME("CurveClose"), EditorStringName(EditorIcons))); @@ -719,6 +740,7 @@ void Path3DEditorPlugin::_notification(int p_what) { case NOTIFICATION_ENTER_TREE: { curve_create->connect("pressed", callable_mp(this, &Path3DEditorPlugin::_mode_changed).bind(MODE_CREATE)); curve_edit_curve->connect("pressed", callable_mp(this, &Path3DEditorPlugin::_mode_changed).bind(MODE_EDIT_CURVE)); + curve_edit_tilt->connect("pressed", callable_mp(this, &Path3DEditorPlugin::_mode_changed).bind(MODE_EDIT_TILT)); curve_edit->connect("pressed", callable_mp(this, &Path3DEditorPlugin::_mode_changed).bind(MODE_EDIT)); curve_del->connect("pressed", callable_mp(this, &Path3DEditorPlugin::_mode_changed).bind(MODE_DELETE)); curve_close->connect("pressed", callable_mp(this, &Path3DEditorPlugin::_close_curve)); @@ -750,6 +772,7 @@ Path3DEditorPlugin::Path3DEditorPlugin() { Ref gizmo_plugin = memnew(Path3DGizmoPlugin(disk_size)); Node3DEditor::get_singleton()->add_gizmo_plugin(gizmo_plugin); + path_3d_gizmo_plugin = gizmo_plugin; topmenu_bar = memnew(HBoxContainer); topmenu_bar->hide(); @@ -759,16 +782,23 @@ Path3DEditorPlugin::Path3DEditorPlugin() { curve_edit->set_theme_type_variation("FlatButton"); curve_edit->set_toggle_mode(true); curve_edit->set_focus_mode(Control::FOCUS_NONE); - curve_edit->set_tooltip_text(TTR("Select Points") + "\n" + TTR("Shift+Drag: Select Control Points") + "\n" + keycode_get_string((Key)KeyModifierMask::CMD_OR_CTRL) + TTR("Click: Add Point") + "\n" + TTR("Right Click: Delete Point")); + curve_edit->set_tooltip_text(TTR("Select Points") + "\n" + TTR("Shift+Click: Select multiple Points") + "\n" + keycode_get_string((Key)KeyModifierMask::CMD_OR_CTRL) + TTR("Click: Add Point") + "\n" + TTR("Right Click: Delete Point")); topmenu_bar->add_child(curve_edit); curve_edit_curve = memnew(Button); curve_edit_curve->set_theme_type_variation("FlatButton"); curve_edit_curve->set_toggle_mode(true); curve_edit_curve->set_focus_mode(Control::FOCUS_NONE); - curve_edit_curve->set_tooltip_text(TTR("Select Control Points (Shift+Drag)")); + curve_edit_curve->set_tooltip_text(TTR("Select Control Points") + "\n" + TTR("Shift+Click: Drag out Control Points")); topmenu_bar->add_child(curve_edit_curve); + curve_edit_tilt = memnew(Button); + curve_edit_tilt->set_theme_type_variation("FlatButton"); + curve_edit_tilt->set_toggle_mode(true); + curve_edit_tilt->set_focus_mode(Control::FOCUS_NONE); + curve_edit_tilt->set_tooltip_text(TTR("Select Tilt Handles")); + topmenu_bar->add_child(curve_edit_tilt); + curve_create = memnew(Button); curve_create->set_theme_type_variation("FlatButton"); curve_create->set_toggle_mode(true); @@ -838,11 +868,13 @@ void Path3DGizmoPlugin::redraw(EditorNode3DGizmo *p_gizmo) { Ref handle_material = get_material("handles", p_gizmo); PackedVector3Array handles; - for (int idx = 0; idx < curve->get_point_count(); ++idx) { - // Collect handles. - const Vector3 pos = curve->get_point_position(idx); + if (Path3DEditorPlugin::singleton->curve_edit->is_pressed()) { + for (int idx = 0; idx < curve->get_point_count(); ++idx) { + // Collect handles. + const Vector3 pos = curve->get_point_position(idx); - handles.append(pos); + handles.append(pos); + } } if (handles.size()) { @@ -856,10 +888,12 @@ int Path3DGizmoPlugin::subgizmos_intersect_ray(const EditorNode3DGizmo *p_gizmo, Ref curve = path->get_curve(); ERR_FAIL_COND_V(curve.is_null(), -1); - for (int idx = 0; idx < curve->get_point_count(); ++idx) { - Vector3 pos = path->get_global_transform().xform(curve->get_point_position(idx)); - if (p_camera->unproject_position(pos).distance_to(p_point) < 20) { - return idx; + if (Path3DEditorPlugin::singleton->curve_edit->is_pressed()) { + for (int idx = 0; idx < curve->get_point_count(); ++idx) { + Vector3 pos = path->get_global_transform().xform(curve->get_point_position(idx)); + if (p_camera->unproject_position(pos).distance_to(p_point) < 20) { + return idx; + } } } return -1; @@ -873,18 +907,20 @@ Vector Path3DGizmoPlugin::subgizmos_intersect_frustum(const EditorNode3DGiz Ref curve = path->get_curve(); ERR_FAIL_COND_V(curve.is_null(), contained_points); - for (int idx = 0; idx < curve->get_point_count(); ++idx) { - Vector3 pos = path->get_global_transform().xform(curve->get_point_position(idx)); - bool is_contained_in_frustum = true; - for (int i = 0; i < p_frustum.size(); ++i) { - if (p_frustum[i].distance_to(pos) > 0) { - is_contained_in_frustum = false; - break; + if (Path3DEditorPlugin::singleton->curve_edit->is_pressed()) { + for (int idx = 0; idx < curve->get_point_count(); ++idx) { + Vector3 pos = path->get_global_transform().xform(curve->get_point_position(idx)); + bool is_contained_in_frustum = true; + for (int i = 0; i < p_frustum.size(); ++i) { + if (p_frustum[i].distance_to(pos) > 0) { + is_contained_in_frustum = false; + break; + } } - } - if (is_contained_in_frustum) { - contained_points.push_back(idx); + if (is_contained_in_frustum) { + contained_points.push_back(idx); + } } } diff --git a/editor/plugins/path_3d_editor_plugin.h b/editor/plugins/path_3d_editor_plugin.h index 931ac7128ce..39b3c3c6a37 100644 --- a/editor/plugins/path_3d_editor_plugin.h +++ b/editor/plugins/path_3d_editor_plugin.h @@ -106,10 +106,16 @@ public: class Path3DEditorPlugin : public EditorPlugin { GDCLASS(Path3DEditorPlugin, EditorPlugin); + friend class Path3DGizmo; + friend class Path3DGizmoPlugin; + + Ref path_3d_gizmo_plugin; + HBoxContainer *topmenu_bar = 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_close = nullptr; MenuButton *handle_menu = nullptr; @@ -120,6 +126,7 @@ class Path3DEditorPlugin : public EditorPlugin { MODE_CREATE, MODE_EDIT, MODE_EDIT_CURVE, + MODE_EDIT_TILT, MODE_DELETE, ACTION_CLOSE };