/**************************************************************************/ /* path_3d_editor_plugin.cpp */ /**************************************************************************/ /* 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. */ /**************************************************************************/ #include "path_3d_editor_plugin.h" #include "core/math/geometry_2d.h" #include "core/math/geometry_3d.h" #include "core/os/keyboard.h" #include "editor/editor_node.h" #include "editor/editor_settings.h" #include "editor/editor_string_names.h" #include "editor/editor_undo_redo_manager.h" #include "node_3d_editor_plugin.h" #include "scene/gui/dialogs.h" #include "scene/gui/menu_button.h" #include "scene/resources/curve.h" String Path3DGizmo::get_handle_name(int p_id, bool p_secondary) const { Ref c = path->get_curve(); if (c.is_null()) { return ""; } // Primary handles: position. if (!p_secondary) { return TTR("Curve Point #") + itos(p_id); } // Secondary handles: in, out, tilt. const HandleInfo info = _secondary_handles_info[p_id]; switch (info.type) { case HandleType::HANDLE_TYPE_IN: return TTR("Handle In #") + itos(info.point_idx); case HandleType::HANDLE_TYPE_OUT: return TTR("Handle Out #") + itos(info.point_idx); case HandleType::HANDLE_TYPE_TILT: return TTR("Handle Tilt #") + itos(info.point_idx); } return ""; } Variant Path3DGizmo::get_handle_value(int p_id, bool p_secondary) const { Ref c = path->get_curve(); if (c.is_null()) { return Variant(); } // Primary handles: position. if (!p_secondary) { original = c->get_point_position(p_id); return original; } // Secondary handles: in, out, tilt. const HandleInfo info = _secondary_handles_info[p_id]; Vector3 ofs; switch (info.type) { case HandleType::HANDLE_TYPE_TILT: return c->get_point_tilt(info.point_idx); case HandleType::HANDLE_TYPE_IN: ofs = c->get_point_in(info.point_idx); break; case HandleType::HANDLE_TYPE_OUT: ofs = c->get_point_out(info.point_idx); break; } original = ofs + c->get_point_position(info.point_idx); return ofs; } void Path3DGizmo::set_handle(int p_id, bool p_secondary, Camera3D *p_camera, const Point2 &p_point) { Ref c = path->get_curve(); if (c.is_null()) { return; } const Transform3D gt = path->get_global_transform(); const Transform3D gi = gt.affine_inverse(); const Vector3 ray_from = p_camera->project_ray_origin(p_point); const Vector3 ray_dir = p_camera->project_ray_normal(p_point); const Plane p = Plane(p_camera->get_transform().basis.get_column(2), gt.xform(original)); // Primary handles: position. if (!p_secondary) { Vector3 inters; // 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()) { float snap = Node3DEditor::get_singleton()->get_translate_snap(); inters.snapf(snap); } Vector3 local = gi.xform(inters); c->set_point_position(idx, local); } return; } // Secondary handles: in, out, tilt. const HandleInfo info = _secondary_handles_info[p_id]; switch (info.type) { case HandleType::HANDLE_TYPE_OUT: case HandleType::HANDLE_TYPE_IN: { const int idx = info.point_idx; const Vector3 base = c->get_point_position(idx); Vector3 inters; if (p.intersects_ray(ray_from, ray_dir, &inters)) { if (!Path3DEditorPlugin::singleton->is_handle_clicked()) { orig_in_length = c->get_point_in(idx).length(); orig_out_length = c->get_point_out(idx).length(); Path3DEditorPlugin::singleton->set_handle_clicked(true); } Vector3 local = gi.xform(inters) - base; if (Node3DEditor::get_singleton()->is_snap_enabled()) { float snap = Node3DEditor::get_singleton()->get_translate_snap(); local.snapf(snap); } if (info.type == HandleType::HANDLE_TYPE_IN) { c->set_point_in(idx, local); if (Path3DEditorPlugin::singleton->mirror_angle_enabled()) { c->set_point_out(idx, Path3DEditorPlugin::singleton->mirror_length_enabled() ? -local : (-local.normalized() * orig_out_length)); } } else { c->set_point_out(idx, local); if (Path3DEditorPlugin::singleton->mirror_angle_enabled()) { c->set_point_in(idx, Path3DEditorPlugin::singleton->mirror_length_enabled() ? -local : (-local.normalized() * orig_in_length)); } } } break; } case HandleType::HANDLE_TYPE_TILT: { const int idx = info.point_idx; const Vector3 position = c->get_point_position(idx); const Basis posture = c->get_point_baked_posture(idx); const Vector3 tangent = -posture.get_column(2); const Vector3 up = posture.get_column(1); const Plane tilt_plane_global = gt.xform(Plane(tangent, position)); Vector3 intersection; if (tilt_plane_global.intersects_ray(ray_from, ray_dir, &intersection)) { Vector3 direction = gi.xform(intersection) - position; real_t tilt_angle = up.signed_angle_to(direction, tangent); if (Node3DEditor::get_singleton()->is_snap_enabled()) { real_t snap_degrees = Node3DEditor::get_singleton()->get_rotate_snap(); tilt_angle = Math::deg_to_rad(Math::snapped(Math::rad_to_deg(tilt_angle), snap_degrees)); } c->set_point_tilt(idx, tilt_angle); } break; } } } void Path3DGizmo::commit_handle(int p_id, bool p_secondary, const Variant &p_restore, bool p_cancel) { Ref c = path->get_curve(); if (c.is_null()) { return; } 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; switch (info.type) { case HandleType::HANDLE_TYPE_OUT: { if (p_cancel) { c->set_point_out(idx, p_restore); return; } ur->create_action(TTR("Set Curve Out Position")); ur->add_do_method(c.ptr(), "set_point_out", idx, c->get_point_out(idx)); ur->add_undo_method(c.ptr(), "set_point_out", idx, p_restore); if (Path3DEditorPlugin::singleton->mirror_angle_enabled()) { ur->add_do_method(c.ptr(), "set_point_in", idx, Path3DEditorPlugin::singleton->mirror_length_enabled() ? -c->get_point_out(idx) : (-c->get_point_out(idx).normalized() * orig_in_length)); ur->add_undo_method(c.ptr(), "set_point_in", idx, Path3DEditorPlugin::singleton->mirror_length_enabled() ? -static_cast(p_restore) : (-static_cast(p_restore).normalized() * orig_in_length)); } ur->commit_action(); break; } case HandleType::HANDLE_TYPE_IN: { if (p_cancel) { c->set_point_in(idx, p_restore); return; } ur->create_action(TTR("Set Curve In Position")); ur->add_do_method(c.ptr(), "set_point_in", idx, c->get_point_in(idx)); ur->add_undo_method(c.ptr(), "set_point_in", idx, p_restore); if (Path3DEditorPlugin::singleton->mirror_angle_enabled()) { ur->add_do_method(c.ptr(), "set_point_out", idx, Path3DEditorPlugin::singleton->mirror_length_enabled() ? -c->get_point_in(idx) : (-c->get_point_in(idx).normalized() * orig_out_length)); ur->add_undo_method(c.ptr(), "set_point_out", idx, Path3DEditorPlugin::singleton->mirror_length_enabled() ? -static_cast(p_restore) : (-static_cast(p_restore).normalized() * orig_out_length)); } ur->commit_action(); break; } case HandleType::HANDLE_TYPE_TILT: { if (p_cancel) { c->set_point_tilt(idx, p_restore); return; } ur->create_action(TTR("Set Curve Point Tilt")); ur->add_do_method(c.ptr(), "set_point_tilt", idx, c->get_point_tilt(idx)); ur->add_undo_method(c.ptr(), "set_point_tilt", idx, p_restore); ur->commit_action(); break; } } } void Path3DGizmo::redraw() { clear(); Ref path_material = gizmo_plugin->get_material("path_material", this); 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(); if (c.is_null()) { return; } real_t interval = 0.1; const real_t length = c->get_baked_length(); // 1. Draw curve and bones. if (length > CMP_EPSILON) { const int sample_count = int(length / interval) + 2; interval = length / (sample_count - 1); // Recalculate real interval length. Vector frames; frames.resize(sample_count); { Transform3D *w = frames.ptrw(); for (int i = 0; i < sample_count; i++) { w[i] = c->sample_baked_with_rotation(i * interval, true, true); } } const Transform3D *r = frames.ptr(); Vector _collision_segments; _collision_segments.resize((sample_count - 1) * 2); Vector3 *_collisions_ptr = _collision_segments.ptrw(); Vector bones; bones.resize(sample_count * 4); Vector3 *bones_ptr = bones.ptrw(); Vector ribbon; ribbon.resize(sample_count); Vector3 *ribbon_ptr = ribbon.ptrw(); for (int i = 0; i < sample_count; i++) { const Vector3 p1 = r[i].origin; const Vector3 side = r[i].basis.get_column(0); const Vector3 up = r[i].basis.get_column(1); const Vector3 forward = r[i].basis.get_column(2); // Collision segments. if (i != sample_count - 1) { const Vector3 p2 = r[i + 1].origin; _collisions_ptr[(i * 2)] = p1; _collisions_ptr[(i * 2) + 1] = p2; } // Path3D as a ribbon. ribbon_ptr[i] = p1; // Fish Bone. const Vector3 p_left = p1 + (side + forward - up * 0.3) * 0.06; const Vector3 p_right = p1 + (-side + forward - up * 0.3) * 0.06; const int bone_idx = i * 4; bones_ptr[bone_idx] = p1; bones_ptr[bone_idx + 1] = p_left; bones_ptr[bone_idx + 2] = p1; bones_ptr[bone_idx + 3] = p_right; } add_collision_segments(_collision_segments); add_lines(bones, path_material); add_vertices(ribbon, path_material, Mesh::PRIMITIVE_LINE_STRIP); } // 2. Draw handles when selected. 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); primary_handle_points.append(pos); HandleInfo info; info.point_idx = idx; // Collect in-handles except for the first point. if (idx > 0 && Path3DEditorPlugin::singleton->curve_edit_curve->is_pressed()) { const Vector3 in = c->get_point_in(idx); 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); } // Collect out-handles except for the last point. if (idx < c->get_point_count() - 1 && Path3DEditorPlugin::singleton->curve_edit_curve->is_pressed()) { const Vector3 out = c->get_point_out(idx); 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); } // Collect tilt-handles. if (Path3DEditorPlugin::singleton->curve_edit_tilt->is_pressed()) { // Tilt handle. { info.type = HandleType::HANDLE_TYPE_TILT; const int handle_idx = idx * 3 + 2; collected_secondary_handle_ids.append(handle_idx); _secondary_handles_info.write[handle_idx] = info; const Basis posture = c->get_point_baked_posture(idx, true); const Vector3 up = posture.get_column(1); secondary_handle_points.append(pos + up * disk_size); tilt_handle_lines.append(pos); tilt_handle_lines.append(pos + up * disk_size); } // Tilt disk. { const Basis posture = c->get_point_baked_posture(idx, false); const Vector3 up = posture.get_column(1); const Vector3 side = posture.get_column(0); PackedVector3Array disk; disk.append(pos); const int n = 36; for (int i = 0; i <= n; i++) { const float a = Math_TAU * i / n; const Vector3 edge = sin(a) * side + cos(a) * up; disk.append(pos + edge * disk_size); } add_vertices(disk, path_tilt_material, Mesh::PRIMITIVE_LINE_STRIP); } } } if (handle_lines.size() > 1) { add_lines(handle_lines, path_thin_material); } if (tilt_handle_lines.size() > 1) { 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); } // Draw the gizmo plugin manually, because handles are registered. In which case, the caller code skips drawing the gizmo plugin. gizmo_plugin->redraw(this); } } void Path3DGizmo::_update_transform_gizmo() { Node3DEditor::get_singleton()->update_transform_gizmo(); } Path3DGizmo::Path3DGizmo(Path3D *p_path, float p_disk_size) { path = p_path; disk_size = p_disk_size; set_node_3d(p_path); orig_in_length = 0; orig_out_length = 0; // 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(SceneStringName(pressed), callable_mp(this, &Path3DGizmo::redraw)); Path3DEditorPlugin::singleton->curve_edit_curve->connect(SceneStringName(pressed), callable_mp(this, &Path3DGizmo::redraw)); Path3DEditorPlugin::singleton->curve_create->connect(SceneStringName(pressed), callable_mp(this, &Path3DGizmo::redraw)); Path3DEditorPlugin::singleton->curve_del->connect(SceneStringName(pressed), callable_mp(this, &Path3DGizmo::redraw)); Path3DEditorPlugin::singleton->curve_close->connect(SceneStringName(pressed), callable_mp(this, &Path3DGizmo::redraw)); } EditorPlugin::AfterGUIInput Path3DEditorPlugin::forward_3d_gui_input(Camera3D *p_camera, const Ref &p_event) { if (!path) { return EditorPlugin::AFTER_GUI_INPUT_PASS; } Ref c = path->get_curve(); if (c.is_null()) { return EditorPlugin::AFTER_GUI_INPUT_PASS; } Transform3D gt = path->get_global_transform(); Transform3D it = gt.affine_inverse(); static const int click_dist = 10; //should make global Ref mb = p_event; if (mb.is_valid()) { Point2 mbpos(mb->get_position().x, mb->get_position().y); Node3DEditorViewport *viewport = nullptr; for (uint32_t i = 0; i < Node3DEditor::VIEWPORTS_COUNT; i++) { Node3DEditorViewport *vp = Node3DEditor::get_singleton()->get_editor_viewport(i); if (vp->get_camera_3d() == p_camera) { viewport = vp; break; } } ERR_FAIL_NULL_V(viewport, EditorPlugin::AFTER_GUI_INPUT_PASS); if (!mb->is_pressed()) { set_handle_clicked(false); } if (mb->is_pressed() && mb->get_button_index() == MouseButton::LEFT && (curve_create->is_pressed() || (curve_edit->is_pressed() && mb->is_command_or_control_pressed()))) { //click into curve, break it down Vector v3a = c->tessellate(); int rc = v3a.size(); int closest_seg = -1; Vector3 closest_seg_point; if (rc >= 2) { int idx = 0; const Vector3 *r = v3a.ptr(); float closest_d = 1e20; if (viewport->point_to_screen(gt.xform(c->get_point_position(0))).distance_to(mbpos) < click_dist) { return EditorPlugin::AFTER_GUI_INPUT_PASS; //nope, existing } for (int i = 0; i < c->get_point_count() - 1; i++) { //find the offset and point index of the place to break up int j = idx; if (viewport->point_to_screen(gt.xform(c->get_point_position(i + 1))).distance_to(mbpos) < click_dist) { return EditorPlugin::AFTER_GUI_INPUT_PASS; //nope, existing } while (j < rc && c->get_point_position(i + 1) != r[j]) { Vector3 from = r[j]; Vector3 to = r[j + 1]; real_t cdist = from.distance_to(to); from = gt.xform(from); to = gt.xform(to); if (cdist > 0) { Vector2 s[2]; s[0] = viewport->point_to_screen(from); s[1] = viewport->point_to_screen(to); Vector2 inters = Geometry2D::get_closest_point_to_segment(mbpos, s); float d = inters.distance_to(mbpos); if (d < 10 && d < closest_d) { closest_d = d; closest_seg = i; Vector3 ray_from = viewport->get_ray_pos(mbpos); Vector3 ray_dir = viewport->get_ray(mbpos); Vector3 ra, rb; Geometry3D::get_closest_points_between_segments(ray_from, ray_from + ray_dir * 4096, from, to, ra, rb); closest_seg_point = it.xform(rb); } } j++; } if (idx == j) { idx++; //force next } else { idx = j; //swap } if (j == rc) { break; } } } EditorUndoRedoManager *ur = EditorUndoRedoManager::get_singleton(); if (closest_seg != -1) { //subdivide ur->create_action(TTR("Split Path")); ur->add_do_method(c.ptr(), "add_point", closest_seg_point, Vector3(), Vector3(), closest_seg + 1); ur->add_undo_method(c.ptr(), "remove_point", closest_seg + 1); ur->commit_action(); return EditorPlugin::AFTER_GUI_INPUT_STOP; } else { Vector3 origin; if (c->get_point_count() == 0) { origin = path->get_transform().get_origin(); } else { origin = gt.xform(c->get_point_position(c->get_point_count() - 1)); } Plane p(p_camera->get_transform().basis.get_column(2), origin); Vector3 ray_from = viewport->get_ray_pos(mbpos); Vector3 ray_dir = viewport->get_ray(mbpos); Vector3 inters; if (p.intersects_ray(ray_from, ray_dir, &inters)) { ur->create_action(TTR("Add Point to Curve")); ur->add_do_method(c.ptr(), "add_point", it.xform(inters), Vector3(), Vector3(), -1); ur->add_undo_method(c.ptr(), "remove_point", c->get_point_count()); ur->commit_action(); return EditorPlugin::AFTER_GUI_INPUT_STOP; } //add new at pos } } else if (mb->is_pressed() && ((mb->get_button_index() == MouseButton::LEFT && curve_del->is_pressed()) || (mb->get_button_index() == MouseButton::RIGHT && curve_edit->is_pressed()))) { for (int i = 0; i < c->get_point_count(); i++) { real_t dist_to_p = viewport->point_to_screen(gt.xform(c->get_point_position(i))).distance_to(mbpos); real_t dist_to_p_out = viewport->point_to_screen(gt.xform(c->get_point_position(i) + c->get_point_out(i))).distance_to(mbpos); real_t dist_to_p_in = viewport->point_to_screen(gt.xform(c->get_point_position(i) + c->get_point_in(i))).distance_to(mbpos); real_t dist_to_p_up = viewport->point_to_screen(gt.xform(c->get_point_position(i) + c->get_point_baked_posture(i, true).get_column(1) * disk_size)).distance_to(mbpos); // Find the offset and point index of the place to break up. // Also check for the control points. if (dist_to_p < click_dist) { EditorUndoRedoManager *ur = EditorUndoRedoManager::get_singleton(); ur->create_action(TTR("Remove Path Point")); ur->add_do_method(c.ptr(), "remove_point", i); ur->add_undo_method(c.ptr(), "add_point", c->get_point_position(i), c->get_point_in(i), c->get_point_out(i), i); ur->commit_action(); return EditorPlugin::AFTER_GUI_INPUT_STOP; } else if (dist_to_p_out < click_dist) { EditorUndoRedoManager *ur = EditorUndoRedoManager::get_singleton(); ur->create_action(TTR("Reset Out-Control Point")); ur->add_do_method(c.ptr(), "set_point_out", i, Vector3()); ur->add_undo_method(c.ptr(), "set_point_out", i, c->get_point_out(i)); ur->commit_action(); return EditorPlugin::AFTER_GUI_INPUT_STOP; } else if (dist_to_p_in < click_dist) { EditorUndoRedoManager *ur = EditorUndoRedoManager::get_singleton(); ur->create_action(TTR("Reset In-Control Point")); ur->add_do_method(c.ptr(), "set_point_in", i, Vector3()); ur->add_undo_method(c.ptr(), "set_point_in", i, c->get_point_in(i)); ur->commit_action(); return EditorPlugin::AFTER_GUI_INPUT_STOP; } else if (dist_to_p_up < click_dist) { EditorUndoRedoManager *ur = EditorUndoRedoManager::get_singleton(); ur->create_action(TTR("Reset Point Tilt")); ur->add_do_method(c.ptr(), "set_point_tilt", i, 0.0f); ur->add_undo_method(c.ptr(), "set_point_tilt", i, c->get_point_tilt(i)); ur->commit_action(); return EditorPlugin::AFTER_GUI_INPUT_STOP; } } } } return EditorPlugin::AFTER_GUI_INPUT_PASS; } void Path3DEditorPlugin::edit(Object *p_object) { if (p_object) { path = Object::cast_to(p_object); if (path) { if (path->get_curve().is_valid()) { path->get_curve()->emit_signal(CoreStringName(changed)); } } } else { Path3D *pre = path; path = nullptr; if (pre) { pre->get_curve()->emit_signal(CoreStringName(changed)); } } update_overlays(); //collision_polygon_editor->edit(Object::cast_to(p_object)); } bool Path3DEditorPlugin::handles(Object *p_object) const { return p_object->is_class("Path3D"); } void Path3DEditorPlugin::make_visible(bool p_visible) { if (p_visible) { topmenu_bar->show(); } else { topmenu_bar->hide(); { Path3D *pre = path; path = nullptr; if (pre && pre->get_curve().is_valid()) { pre->get_curve()->emit_signal(CoreStringName(changed)); } } } } 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() { Ref c = path->get_curve(); if (c.is_null()) { return; } if (c->get_point_count() < 2) { return; } if (c->get_point_position(0) == c->get_point_position(c->get_point_count() - 1)) { return; } EditorUndoRedoManager *ur = EditorUndoRedoManager::get_singleton(); ur->create_action(TTR("Close Curve")); ur->add_do_method(c.ptr(), "add_point", c->get_point_position(0), c->get_point_in(0), c->get_point_out(0), -1); ur->add_undo_method(c.ptr(), "remove_point", c->get_point_count()); ur->commit_action(); } void Path3DEditorPlugin::_handle_option_pressed(int p_option) { PopupMenu *pm; pm = handle_menu->get_popup(); switch (p_option) { case HANDLE_OPTION_ANGLE: { bool is_checked = pm->is_item_checked(HANDLE_OPTION_ANGLE); mirror_handle_angle = !is_checked; pm->set_item_checked(HANDLE_OPTION_ANGLE, mirror_handle_angle); pm->set_item_disabled(HANDLE_OPTION_LENGTH, !mirror_handle_angle); } break; case HANDLE_OPTION_LENGTH: { bool is_checked = pm->is_item_checked(HANDLE_OPTION_LENGTH); mirror_handle_length = !is_checked; pm->set_item_checked(HANDLE_OPTION_LENGTH, mirror_handle_length); } break; } } void Path3DEditorPlugin::_confirm_clear_points() { if (!path || path->get_curve().is_null() || path->get_curve()->get_point_count() == 0) { return; } clear_points_dialog->reset_size(); clear_points_dialog->popup_centered(); } void Path3DEditorPlugin::_clear_points() { EditorUndoRedoManager *undo_redo = EditorUndoRedoManager::get_singleton(); PackedVector3Array points = path->get_curve()->get_points().duplicate(); undo_redo->create_action(TTR("Clear Curve Points")); undo_redo->add_do_method(this, "_clear_curve_points"); undo_redo->add_undo_method(this, "_restore_curve_points", points); undo_redo->commit_action(); } void Path3DEditorPlugin::_clear_curve_points() { if (!path || path->get_curve().is_null() || path->get_curve()->get_point_count() == 0) { return; } Ref curve = path->get_curve(); curve->clear_points(); } void Path3DEditorPlugin::_restore_curve_points(const PackedVector3Array &p_points) { if (!path || path->get_curve().is_null()) { return; } Ref curve = path->get_curve(); if (curve->get_point_count() > 0) { curve->clear_points(); } for (int i = 0; i < p_points.size(); i += 3) { curve->add_point(p_points[i + 2], p_points[i], p_points[i + 1]); } } void Path3DEditorPlugin::_update_theme() { // TODO: Split the EditorPlugin instance from the UI instance and connect this properly. // 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))); curve_clear_points->set_icon(EditorNode::get_singleton()->get_editor_theme()->get_icon(SNAME("Clear"), EditorStringName(EditorIcons))); } void Path3DEditorPlugin::_notification(int p_what) { switch (p_what) { case NOTIFICATION_ENTER_TREE: { curve_create->connect(SceneStringName(pressed), callable_mp(this, &Path3DEditorPlugin::_mode_changed).bind(MODE_CREATE)); curve_edit_curve->connect(SceneStringName(pressed), callable_mp(this, &Path3DEditorPlugin::_mode_changed).bind(MODE_EDIT_CURVE)); curve_edit_tilt->connect(SceneStringName(pressed), callable_mp(this, &Path3DEditorPlugin::_mode_changed).bind(MODE_EDIT_TILT)); curve_edit->connect(SceneStringName(pressed), callable_mp(this, &Path3DEditorPlugin::_mode_changed).bind(MODE_EDIT)); curve_del->connect(SceneStringName(pressed), callable_mp(this, &Path3DEditorPlugin::_mode_changed).bind(MODE_DELETE)); curve_close->connect(SceneStringName(pressed), callable_mp(this, &Path3DEditorPlugin::_close_curve)); _update_theme(); } break; case NOTIFICATION_READY: { // FIXME: This can trigger theme updates when the nodes that we want to update are not yet available. // The toolbar should be extracted to a dedicated control and theme updates should be handled through // the notification. Node3DEditor::get_singleton()->connect(SceneStringName(theme_changed), callable_mp(this, &Path3DEditorPlugin::_update_theme)); } break; } } void Path3DEditorPlugin::_bind_methods() { ClassDB::bind_method(D_METHOD("_clear_curve_points"), &Path3DEditorPlugin::_clear_curve_points); ClassDB::bind_method(D_METHOD("_restore_curve_points"), &Path3DEditorPlugin::_restore_curve_points); } Path3DEditorPlugin *Path3DEditorPlugin::singleton = nullptr; Path3DEditorPlugin::Path3DEditorPlugin() { path = nullptr; singleton = this; mirror_handle_angle = true; mirror_handle_length = true; disk_size = EDITOR_DEF_RST("editors/3d_gizmos/gizmo_settings/path3d_tilt_disk_size", 0.8); 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(); Node3DEditor::get_singleton()->add_control_to_menu_panel(topmenu_bar); curve_edit = memnew(Button); 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+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") + "\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); curve_create->set_focus_mode(Control::FOCUS_NONE); curve_create->set_tooltip_text(TTR("Add Point (in empty space)") + "\n" + TTR("Split Segment (in curve)")); topmenu_bar->add_child(curve_create); curve_del = memnew(Button); curve_del->set_theme_type_variation("FlatButton"); curve_del->set_toggle_mode(true); curve_del->set_focus_mode(Control::FOCUS_NONE); curve_del->set_tooltip_text(TTR("Delete Point")); topmenu_bar->add_child(curve_del); curve_close = memnew(Button); curve_close->set_theme_type_variation("FlatButton"); curve_close->set_focus_mode(Control::FOCUS_NONE); curve_close->set_tooltip_text(TTR("Close Curve")); topmenu_bar->add_child(curve_close); curve_clear_points = memnew(Button); curve_clear_points->set_theme_type_variation("FlatButton"); curve_clear_points->set_focus_mode(Control::FOCUS_NONE); curve_clear_points->set_tooltip_text(TTR("Clear Points")); curve_clear_points->connect(SceneStringName(pressed), callable_mp(this, &Path3DEditorPlugin::_confirm_clear_points)); topmenu_bar->add_child(curve_clear_points); clear_points_dialog = memnew(ConfirmationDialog); clear_points_dialog->set_title(TTR("Please Confirm...")); clear_points_dialog->set_text(TTR("Remove all curve points?")); clear_points_dialog->connect("confirmed", callable_mp(this, &Path3DEditorPlugin::_clear_points)); topmenu_bar->add_child(clear_points_dialog); handle_menu = memnew(MenuButton); handle_menu->set_flat(false); handle_menu->set_theme_type_variation("FlatMenuButton"); handle_menu->set_text(TTR("Options")); topmenu_bar->add_child(handle_menu); PopupMenu *menu; menu = handle_menu->get_popup(); menu->add_check_item(TTR("Mirror Handle Angles")); menu->set_item_checked(HANDLE_OPTION_ANGLE, mirror_handle_angle); menu->add_check_item(TTR("Mirror Handle Lengths")); menu->set_item_checked(HANDLE_OPTION_LENGTH, mirror_handle_length); menu->connect("id_pressed", callable_mp(this, &Path3DEditorPlugin::_handle_option_pressed)); curve_edit->set_pressed(true); } Path3DEditorPlugin::~Path3DEditorPlugin() { } Ref Path3DGizmoPlugin::create_gizmo(Node3D *p_spatial) { Ref ref; Path3D *path = Object::cast_to(p_spatial); if (path) { ref = Ref(memnew(Path3DGizmo(path, disk_size))); } return ref; } bool Path3DGizmoPlugin::has_gizmo(Node3D *p_spatial) { return Object::cast_to(p_spatial) != nullptr; } String Path3DGizmoPlugin::get_gizmo_name() const { return "Path3D"; } void Path3DGizmoPlugin::redraw(EditorNode3DGizmo *p_gizmo) { Path3D *path = Object::cast_to(p_gizmo->get_node_3d()); ERR_FAIL_NULL(path); Ref curve = path->get_curve(); Ref handle_material = get_material("handles", p_gizmo); PackedVector3Array handles; 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); } } if (handles.size()) { p_gizmo->add_vertices(handles, handle_material, Mesh::PRIMITIVE_POINTS); } } int Path3DGizmoPlugin::subgizmos_intersect_ray(const EditorNode3DGizmo *p_gizmo, Camera3D *p_camera, const Vector2 &p_point) const { Path3D *path = Object::cast_to(p_gizmo->get_node_3d()); ERR_FAIL_NULL_V(path, -1); Ref curve = path->get_curve(); ERR_FAIL_COND_V(curve.is_null(), -1); 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; } Vector Path3DGizmoPlugin::subgizmos_intersect_frustum(const EditorNode3DGizmo *p_gizmo, const Camera3D *p_camera, const Vector &p_frustum) const { Vector contained_points; Path3D *path = Object::cast_to(p_gizmo->get_node_3d()); ERR_FAIL_NULL_V(path, contained_points); Ref curve = path->get_curve(); ERR_FAIL_COND_V(curve.is_null(), contained_points); 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); } } } return contained_points; } Transform3D Path3DGizmoPlugin::get_subgizmo_transform(const EditorNode3DGizmo *p_gizmo, int p_id) const { Path3D *path = Object::cast_to(p_gizmo->get_node_3d()); ERR_FAIL_NULL_V(path, Transform3D()); Ref curve = path->get_curve(); ERR_FAIL_COND_V(curve.is_null(), Transform3D()); ERR_FAIL_INDEX_V(p_id, curve->get_point_count(), Transform3D()); Basis basis = transformation_locked_basis.has(p_id) ? transformation_locked_basis[p_id] : curve->get_point_baked_posture(p_id, true); Vector3 pos = curve->get_point_position(p_id); Transform3D t = Transform3D(basis, pos); return t; } void Path3DGizmoPlugin::set_subgizmo_transform(const EditorNode3DGizmo *p_gizmo, int p_id, Transform3D p_transform) { Path3D *path = Object::cast_to(p_gizmo->get_node_3d()); ERR_FAIL_NULL(path); Ref curve = path->get_curve(); ERR_FAIL_COND(curve.is_null()); ERR_FAIL_INDEX(p_id, curve->get_point_count()); if (!transformation_locked_basis.has(p_id)) { transformation_locked_basis[p_id] = Basis(curve->get_point_baked_posture(p_id, true)); } curve->set_point_position(p_id, p_transform.origin); } void Path3DGizmoPlugin::commit_subgizmos(const EditorNode3DGizmo *p_gizmo, const Vector &p_ids, const Vector &p_restore, bool p_cancel) { Path3D *path = Object::cast_to(p_gizmo->get_node_3d()); ERR_FAIL_NULL(path); Ref curve = path->get_curve(); ERR_FAIL_COND(curve.is_null()); transformation_locked_basis.clear(); if (p_cancel) { for (int i = 0; i < p_ids.size(); ++i) { curve->set_point_position(p_ids[i], p_restore[i].origin); } return; } EditorUndoRedoManager *undo_redo = EditorUndoRedoManager::get_singleton(); undo_redo->create_action(TTR("Set Curve Point Position")); for (int i = 0; i < p_ids.size(); ++i) { const int idx = p_ids[i]; undo_redo->add_do_method(curve.ptr(), "set_point_position", idx, curve->get_point_position(idx)); undo_redo->add_undo_method(curve.ptr(), "set_point_position", idx, p_restore[i].origin); } undo_redo->commit_action(); } int Path3DGizmoPlugin::get_priority() const { return -1; } Path3DGizmoPlugin::Path3DGizmoPlugin(float p_disk_size) { Color path_color = SceneTree::get_singleton()->get_debug_paths_color(); Color path_tilt_color = EDITOR_DEF_RST("editors/3d_gizmos/gizmo_colors/path_tilt", Color(1.0, 1.0, 0.4, 0.9)); disk_size = p_disk_size; create_material("path_material", path_color); create_material("path_thin_material", Color(0.6, 0.6, 0.6)); create_material("path_tilt_material", path_tilt_color); create_material("path_tilt_muted_material", path_tilt_color * 0.7); create_handle_material("handles", false, EditorNode::get_singleton()->get_editor_theme()->get_icon(SNAME("EditorPathSmoothHandle"), EditorStringName(EditorIcons))); create_handle_material("sec_handles", false, EditorNode::get_singleton()->get_editor_theme()->get_icon(SNAME("EditorCurveHandle"), EditorStringName(EditorIcons))); }