/**************************************************************************/ /* editor_inspector.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 "editor_inspector.h" #include "core/os/keyboard.h" #include "editor/doc_tools.h" #include "editor/editor_feature_profile.h" #include "editor/editor_node.h" #include "editor/editor_property_name_processor.h" #include "editor/editor_scale.h" #include "editor/editor_settings.h" #include "editor/editor_string_names.h" #include "editor/editor_undo_redo_manager.h" #include "editor/gui/editor_validation_panel.h" #include "editor/inspector_dock.h" #include "editor/plugins/script_editor_plugin.h" #include "multi_node_edit.h" #include "scene/gui/spin_box.h" #include "scene/gui/texture_rect.h" #include "scene/property_utils.h" #include "scene/resources/packed_scene.h" #include "scene/resources/style_box_flat.h" bool EditorInspector::_property_path_matches(const String &p_property_path, const String &p_filter, EditorPropertyNameProcessor::Style p_style) { if (p_property_path.findn(p_filter) != -1) { return true; } const Vector prop_sections = p_property_path.split("/"); for (int i = 0; i < prop_sections.size(); i++) { if (p_filter.is_subsequence_ofn(EditorPropertyNameProcessor::get_singleton()->process_name(prop_sections[i], p_style))) { return true; } } return false; } Size2 EditorProperty::get_minimum_size() const { Size2 ms; Ref font = get_theme_font(SNAME("font"), SNAME("Tree")); int font_size = get_theme_font_size(SNAME("font_size"), SNAME("Tree")); ms.height = font->get_height(font_size) + 4 * EDSCALE; for (int i = 0; i < get_child_count(); i++) { Control *c = Object::cast_to(get_child(i)); if (!c) { continue; } if (c->is_set_as_top_level()) { continue; } if (!c->is_visible()) { continue; } if (c == bottom_editor) { continue; } Size2 minsize = c->get_combined_minimum_size(); ms.width = MAX(ms.width, minsize.width); ms.height = MAX(ms.height, minsize.height); } if (keying) { Ref key = get_editor_theme_icon(SNAME("Key")); ms.width += key->get_width() + get_theme_constant(SNAME("hseparator"), SNAME("Tree")); } if (deletable) { Ref key = get_editor_theme_icon(SNAME("Close")); ms.width += key->get_width() + get_theme_constant(SNAME("hseparator"), SNAME("Tree")); } if (checkable) { Ref check = get_theme_icon(SNAME("checked"), SNAME("CheckBox")); ms.width += check->get_width() + get_theme_constant(SNAME("h_separation"), SNAME("CheckBox")) + get_theme_constant(SNAME("hseparator"), SNAME("Tree")); } if (bottom_editor != nullptr && bottom_editor->is_visible()) { ms.height += get_theme_constant(SNAME("v_separation")); Size2 bems = bottom_editor->get_combined_minimum_size(); //bems.width += get_constant("item_margin", "Tree"); ms.height += bems.height; ms.width = MAX(ms.width, bems.width); } return ms; } void EditorProperty::emit_changed(const StringName &p_property, const Variant &p_value, const StringName &p_field, bool p_changing) { Variant args[4] = { p_property, p_value, p_field, p_changing }; const Variant *argptrs[4] = { &args[0], &args[1], &args[2], &args[3] }; cache[p_property] = p_value; emit_signalp(SNAME("property_changed"), (const Variant **)argptrs, 4); } void EditorProperty::_notification(int p_what) { switch (p_what) { case NOTIFICATION_SORT_CHILDREN: { Size2 size = get_size(); Rect2 rect; Rect2 bottom_rect; right_child_rect = Rect2(); bottom_child_rect = Rect2(); { int child_room = size.width * (1.0 - split_ratio); Ref font = get_theme_font(SNAME("font"), SNAME("Tree")); int font_size = get_theme_font_size(SNAME("font_size"), SNAME("Tree")); int height = font->get_height(font_size) + 4 * EDSCALE; bool no_children = true; //compute room needed for (int i = 0; i < get_child_count(); i++) { Control *c = Object::cast_to(get_child(i)); if (!c) { continue; } if (c->is_set_as_top_level()) { continue; } if (!c->is_visible()) { continue; } if (c == bottom_editor) { continue; } Size2 minsize = c->get_combined_minimum_size(); child_room = MAX(child_room, minsize.width); height = MAX(height, minsize.height); no_children = false; } if (no_children) { text_size = size.width; rect = Rect2(size.width - 1, 0, 1, height); } else { text_size = MAX(0, size.width - (child_room + 4 * EDSCALE)); if (is_layout_rtl()) { rect = Rect2(1, 0, child_room, height); } else { rect = Rect2(size.width - child_room, 0, child_room, height); } } if (bottom_editor) { int m = 0; //get_constant("item_margin", "Tree"); bottom_rect = Rect2(m, rect.size.height + get_theme_constant(SNAME("v_separation")), size.width - m, bottom_editor->get_combined_minimum_size().height); } if (keying) { Ref key; if (use_keying_next()) { key = get_editor_theme_icon(SNAME("KeyNext")); } else { key = get_editor_theme_icon(SNAME("Key")); } rect.size.x -= key->get_width() + get_theme_constant(SNAME("hseparator"), SNAME("Tree")); if (is_layout_rtl()) { rect.position.x += key->get_width() + get_theme_constant(SNAME("hseparator"), SNAME("Tree")); } if (no_children) { text_size -= key->get_width() + 4 * EDSCALE; } } if (deletable) { Ref close; close = get_editor_theme_icon(SNAME("Close")); rect.size.x -= close->get_width() + get_theme_constant(SNAME("hseparator"), SNAME("Tree")); if (is_layout_rtl()) { rect.position.x += close->get_width() + get_theme_constant(SNAME("hseparator"), SNAME("Tree")); } if (no_children) { text_size -= close->get_width() + 4 * EDSCALE; } } } //set children for (int i = 0; i < get_child_count(); i++) { Control *c = Object::cast_to(get_child(i)); if (!c) { continue; } if (c->is_set_as_top_level()) { continue; } if (c == bottom_editor) { continue; } fit_child_in_rect(c, rect); right_child_rect = rect; } if (bottom_editor) { fit_child_in_rect(bottom_editor, bottom_rect); bottom_child_rect = bottom_rect; } queue_redraw(); //need to redraw text } break; case NOTIFICATION_DRAW: { Ref font = get_theme_font(SNAME("font"), SNAME("Tree")); int font_size = get_theme_font_size(SNAME("font_size"), SNAME("Tree")); bool rtl = is_layout_rtl(); Size2 size = get_size(); if (bottom_editor) { size.height = bottom_editor->get_offset(SIDE_TOP) - get_theme_constant(SNAME("v_separation")); } else if (label_reference) { size.height = label_reference->get_size().height; } Ref sb = get_theme_stylebox(selected ? SNAME("bg_selected") : SNAME("bg")); draw_style_box(sb, Rect2(Vector2(), size)); Ref bg_stylebox = get_theme_stylebox(SNAME("child_bg")); if (draw_top_bg && right_child_rect != Rect2()) { draw_style_box(bg_stylebox, right_child_rect); } if (bottom_child_rect != Rect2()) { draw_style_box(bg_stylebox, bottom_child_rect); } Color color; if (draw_warning || draw_prop_warning) { color = get_theme_color(is_read_only() ? SNAME("readonly_warning_color") : SNAME("warning_color")); } else { color = get_theme_color(is_read_only() ? SNAME("readonly_color") : SNAME("property_color")); } if (label.contains(".")) { // FIXME: Move this to the project settings editor, as this is only used // for project settings feature tag overrides. color.a = 0.5; } int ofs = get_theme_constant(SNAME("font_offset")); int text_limit = text_size - ofs; if (checkable) { Ref checkbox; if (checked) { checkbox = get_editor_theme_icon(SNAME("GuiChecked")); } else { checkbox = get_editor_theme_icon(SNAME("GuiUnchecked")); } Color color2(1, 1, 1); if (check_hover) { color2.r *= 1.2; color2.g *= 1.2; color2.b *= 1.2; } check_rect = Rect2(ofs, ((size.height - checkbox->get_height()) / 2), checkbox->get_width(), checkbox->get_height()); if (rtl) { draw_texture(checkbox, Vector2(size.width - check_rect.position.x - checkbox->get_width(), check_rect.position.y), color2); } else { draw_texture(checkbox, check_rect.position, color2); } int check_ofs = get_theme_constant(SNAME("hseparator"), SNAME("Tree")) + checkbox->get_width() + get_theme_constant(SNAME("h_separation"), SNAME("CheckBox")); ofs += check_ofs; text_limit -= check_ofs; } else { check_rect = Rect2(); } if (can_revert && !is_read_only()) { Ref reload_icon = get_editor_theme_icon(SNAME("ReloadSmall")); text_limit -= reload_icon->get_width() + get_theme_constant(SNAME("hseparator"), SNAME("Tree")) * 2; revert_rect = Rect2(ofs + text_limit, (size.height - reload_icon->get_height()) / 2, reload_icon->get_width(), reload_icon->get_height()); Color color2(1, 1, 1); if (revert_hover) { color2.r *= 1.2; color2.g *= 1.2; color2.b *= 1.2; } if (rtl) { draw_texture(reload_icon, Vector2(size.width - revert_rect.position.x - reload_icon->get_width(), revert_rect.position.y), color2); } else { draw_texture(reload_icon, revert_rect.position, color2); } } else { revert_rect = Rect2(); } if (!pin_hidden && pinned) { Ref pinned_icon = get_editor_theme_icon(SNAME("Pin")); int margin_w = get_theme_constant(SNAME("hseparator"), SNAME("Tree")) * 2; int total_icon_w = margin_w + pinned_icon->get_width(); int text_w = font->get_string_size(label, rtl ? HORIZONTAL_ALIGNMENT_RIGHT : HORIZONTAL_ALIGNMENT_LEFT, text_limit - total_icon_w, font_size).x; int y = (size.height - pinned_icon->get_height()) / 2; if (rtl) { draw_texture(pinned_icon, Vector2(size.width - ofs - text_w - total_icon_w, y), color); } else { draw_texture(pinned_icon, Vector2(ofs + text_w + margin_w, y), color); } text_limit -= total_icon_w; } int v_ofs = (size.height - font->get_height(font_size)) / 2; if (rtl) { draw_string(font, Point2(size.width - ofs - text_limit, v_ofs + font->get_ascent(font_size)), label, HORIZONTAL_ALIGNMENT_RIGHT, text_limit, font_size, color); } else { draw_string(font, Point2(ofs, v_ofs + font->get_ascent(font_size)), label, HORIZONTAL_ALIGNMENT_LEFT, text_limit, font_size, color); } ofs = size.width; if (keying) { Ref key; if (use_keying_next()) { key = get_editor_theme_icon(SNAME("KeyNext")); } else { key = get_editor_theme_icon(SNAME("Key")); } ofs -= key->get_width() + get_theme_constant(SNAME("hseparator"), SNAME("Tree")); Color color2(1, 1, 1); if (keying_hover) { color2.r *= 1.2; color2.g *= 1.2; color2.b *= 1.2; } keying_rect = Rect2(ofs, ((size.height - key->get_height()) / 2), key->get_width(), key->get_height()); if (rtl) { draw_texture(key, Vector2(size.width - keying_rect.position.x - key->get_width(), keying_rect.position.y), color2); } else { draw_texture(key, keying_rect.position, color2); } } else { keying_rect = Rect2(); } if (deletable) { Ref close; close = get_editor_theme_icon(SNAME("Close")); ofs -= close->get_width() + get_theme_constant(SNAME("hseparator"), SNAME("Tree")); Color color2(1, 1, 1); if (delete_hover) { color2.r *= 1.2; color2.g *= 1.2; color2.b *= 1.2; } delete_rect = Rect2(ofs, ((size.height - close->get_height()) / 2), close->get_width(), close->get_height()); if (rtl) { draw_texture(close, Vector2(size.width - delete_rect.position.x - close->get_width(), delete_rect.position.y), color2); } else { draw_texture(close, delete_rect.position, color2); } } else { delete_rect = Rect2(); } } break; } } void EditorProperty::set_label(const String &p_label) { label = p_label; queue_redraw(); } String EditorProperty::get_label() const { return label; } Object *EditorProperty::get_edited_object() { return object; } StringName EditorProperty::get_edited_property() const { return property; } EditorInspector *EditorProperty::get_parent_inspector() const { Node *parent = get_parent(); while (parent) { EditorInspector *ei = Object::cast_to(parent); if (ei) { return ei; } parent = parent->get_parent(); } ERR_FAIL_V_MSG(nullptr, "EditorProperty is outside inspector."); } void EditorProperty::set_doc_path(const String &p_doc_path) { doc_path = p_doc_path; } void EditorProperty::update_property() { GDVIRTUAL_CALL(_update_property); } void EditorProperty::_set_read_only(bool p_read_only) { } void EditorProperty::set_read_only(bool p_read_only) { read_only = p_read_only; if (GDVIRTUAL_CALL(_set_read_only, p_read_only)) { return; } _set_read_only(p_read_only); } bool EditorProperty::is_read_only() const { return read_only; } Variant EditorPropertyRevert::get_property_revert_value(Object *p_object, const StringName &p_property, bool *r_is_valid) { if (p_object->property_can_revert(p_property)) { if (r_is_valid) { *r_is_valid = true; } return p_object->property_get_revert(p_property); } return PropertyUtils::get_property_default_value(p_object, p_property, r_is_valid); } bool EditorPropertyRevert::can_property_revert(Object *p_object, const StringName &p_property, const Variant *p_custom_current_value) { bool is_valid_revert = false; Variant revert_value = EditorPropertyRevert::get_property_revert_value(p_object, p_property, &is_valid_revert); if (!is_valid_revert) { return false; } Variant current_value = p_custom_current_value ? *p_custom_current_value : p_object->get(p_property); return PropertyUtils::is_property_value_different(current_value, revert_value); } StringName EditorProperty::_get_revert_property() const { return property; } void EditorProperty::update_editor_property_status() { if (property == StringName()) { return; //no property, so nothing to do } bool new_pinned = false; if (can_pin) { Node *node = Object::cast_to(object); CRASH_COND(!node); new_pinned = node->is_property_pinned(property); } bool new_warning = false; if (object->has_method("_get_property_warning")) { new_warning = !String(object->call("_get_property_warning", property)).is_empty(); } Variant current = object->get(_get_revert_property()); bool new_can_revert = EditorPropertyRevert::can_property_revert(object, property, ¤t) && !is_read_only(); bool new_checked = checked; if (checkable) { // for properties like theme overrides. bool valid = false; Variant value = object->get(property, &valid); if (valid) { new_checked = value.get_type() != Variant::NIL; } } if (new_can_revert != can_revert || new_pinned != pinned || new_checked != checked || new_warning != draw_prop_warning) { if (new_can_revert != can_revert) { emit_signal(SNAME("property_can_revert_changed"), property, new_can_revert); } draw_prop_warning = new_warning; can_revert = new_can_revert; pinned = new_pinned; checked = new_checked; queue_redraw(); } } bool EditorProperty::use_keying_next() const { List plist; object->get_property_list(&plist, true); for (List::Element *I = plist.front(); I; I = I->next()) { PropertyInfo &p = I->get(); if (p.name == property) { return (p.usage & PROPERTY_USAGE_KEYING_INCREMENTS); } } return false; } void EditorProperty::set_checkable(bool p_checkable) { checkable = p_checkable; queue_redraw(); queue_sort(); } bool EditorProperty::is_checkable() const { return checkable; } void EditorProperty::set_checked(bool p_checked) { checked = p_checked; queue_redraw(); } bool EditorProperty::is_checked() const { return checked; } void EditorProperty::set_draw_warning(bool p_draw_warning) { draw_warning = p_draw_warning; queue_redraw(); } void EditorProperty::set_keying(bool p_keying) { keying = p_keying; queue_redraw(); queue_sort(); } void EditorProperty::set_deletable(bool p_deletable) { deletable = p_deletable; queue_redraw(); queue_sort(); } bool EditorProperty::is_deletable() const { return deletable; } bool EditorProperty::is_keying() const { return keying; } bool EditorProperty::is_draw_warning() const { return draw_warning; } void EditorProperty::_focusable_focused(int p_index) { if (!selectable) { return; } bool already_selected = selected; selected = true; selected_focusable = p_index; queue_redraw(); if (!already_selected && selected) { emit_signal(SNAME("selected"), property, selected_focusable); } } void EditorProperty::add_focusable(Control *p_control) { p_control->connect("focus_entered", callable_mp(this, &EditorProperty::_focusable_focused).bind(focusables.size())); focusables.push_back(p_control); } void EditorProperty::select(int p_focusable) { bool already_selected = selected; if (!selectable) { return; } if (p_focusable >= 0) { ERR_FAIL_INDEX(p_focusable, focusables.size()); focusables[p_focusable]->grab_focus(); } else { selected = true; queue_redraw(); } if (!already_selected && selected) { emit_signal(SNAME("selected"), property, selected_focusable); } } void EditorProperty::deselect() { selected = false; selected_focusable = -1; queue_redraw(); } bool EditorProperty::is_selected() const { return selected; } void EditorProperty::gui_input(const Ref &p_event) { ERR_FAIL_COND(p_event.is_null()); if (property == StringName()) { return; } Ref me = p_event; if (me.is_valid()) { Vector2 mpos = me->get_position(); if (is_layout_rtl()) { mpos.x = get_size().x - mpos.x; } bool button_left = me->get_button_mask().has_flag(MouseButtonMask::LEFT); bool new_keying_hover = keying_rect.has_point(mpos) && !button_left; if (new_keying_hover != keying_hover) { keying_hover = new_keying_hover; queue_redraw(); } bool new_delete_hover = delete_rect.has_point(mpos) && !button_left; if (new_delete_hover != delete_hover) { delete_hover = new_delete_hover; queue_redraw(); } bool new_revert_hover = revert_rect.has_point(mpos) && !button_left; if (new_revert_hover != revert_hover) { revert_hover = new_revert_hover; queue_redraw(); } bool new_check_hover = check_rect.has_point(mpos) && !button_left; if (new_check_hover != check_hover) { check_hover = new_check_hover; queue_redraw(); } } Ref mb = p_event; if (mb.is_valid() && mb->is_pressed() && mb->get_button_index() == MouseButton::LEFT) { Vector2 mpos = mb->get_position(); if (is_layout_rtl()) { mpos.x = get_size().x - mpos.x; } select(); if (keying_rect.has_point(mpos)) { accept_event(); emit_signal(SNAME("property_keyed"), property, use_keying_next()); if (use_keying_next()) { if (property == "frame_coords" && (object->is_class("Sprite2D") || object->is_class("Sprite3D"))) { Vector2i new_coords = object->get(property); new_coords.x++; if (new_coords.x >= int64_t(object->get("hframes"))) { new_coords.x = 0; new_coords.y++; } if (new_coords.x < int64_t(object->get("hframes")) && new_coords.y < int64_t(object->get("vframes"))) { call_deferred(SNAME("emit_changed"), property, new_coords, "", false); } } else { if (int64_t(object->get(property)) + 1 < (int64_t(object->get("hframes")) * int64_t(object->get("vframes")))) { call_deferred(SNAME("emit_changed"), property, object->get(property).operator int64_t() + 1, "", false); } } call_deferred(SNAME("update_property")); } } if (delete_rect.has_point(mpos)) { accept_event(); emit_signal(SNAME("property_deleted"), property); } if (revert_rect.has_point(mpos)) { accept_event(); get_viewport()->gui_release_focus(); bool is_valid_revert = false; Variant revert_value = EditorPropertyRevert::get_property_revert_value(object, property, &is_valid_revert); ERR_FAIL_COND(!is_valid_revert); emit_changed(_get_revert_property(), revert_value); update_property(); } if (check_rect.has_point(mpos)) { accept_event(); checked = !checked; queue_redraw(); emit_signal(SNAME("property_checked"), property, checked); } } else if (mb.is_valid() && mb->is_pressed() && mb->get_button_index() == MouseButton::RIGHT) { accept_event(); _update_popup(); menu->set_position(get_screen_position() + get_local_mouse_position()); menu->reset_size(); menu->popup(); select(); return; } } void EditorProperty::shortcut_input(const Ref &p_event) { if (!selected || !p_event->is_pressed()) { return; } const Ref k = p_event; if (k.is_valid() && k->is_pressed()) { if (ED_IS_SHORTCUT("property_editor/copy_value", p_event)) { menu_option(MENU_COPY_VALUE); accept_event(); } else if (ED_IS_SHORTCUT("property_editor/paste_value", p_event) && !is_read_only()) { menu_option(MENU_PASTE_VALUE); accept_event(); } else if (ED_IS_SHORTCUT("property_editor/copy_property_path", p_event)) { menu_option(MENU_COPY_PROPERTY_PATH); accept_event(); } } } const Color *EditorProperty::_get_property_colors() { static Color c[4]; c[0] = get_theme_color(SNAME("property_color_x"), EditorStringName(Editor)); c[1] = get_theme_color(SNAME("property_color_y"), EditorStringName(Editor)); c[2] = get_theme_color(SNAME("property_color_z"), EditorStringName(Editor)); c[3] = get_theme_color(SNAME("property_color_w"), EditorStringName(Editor)); return c; } void EditorProperty::set_label_reference(Control *p_control) { label_reference = p_control; } void EditorProperty::set_bottom_editor(Control *p_control) { bottom_editor = p_control; } Variant EditorProperty::_get_cache_value(const StringName &p_prop, bool &r_valid) const { return object->get(p_prop, &r_valid); } bool EditorProperty::is_cache_valid() const { if (object) { for (const KeyValue &E : cache) { bool valid; Variant value = _get_cache_value(E.key, valid); if (!valid || value != E.value) { return false; } } } return true; } void EditorProperty::update_cache() { cache.clear(); if (object && property != StringName()) { bool valid; Variant value = _get_cache_value(property, valid); if (valid) { cache[property] = value; } } } Variant EditorProperty::get_drag_data(const Point2 &p_point) { if (property == StringName()) { return Variant(); } Dictionary dp; dp["type"] = "obj_property"; dp["object"] = object; dp["property"] = property; dp["value"] = object->get(property); Label *drag_label = memnew(Label); drag_label->set_text(property); set_drag_preview(drag_label); return dp; } void EditorProperty::set_use_folding(bool p_use_folding) { use_folding = p_use_folding; } bool EditorProperty::is_using_folding() const { return use_folding; } void EditorProperty::expand_all_folding() { } void EditorProperty::collapse_all_folding() { } void EditorProperty::expand_revertable() { } void EditorProperty::set_selectable(bool p_selectable) { selectable = p_selectable; } bool EditorProperty::is_selectable() const { return selectable; } void EditorProperty::set_name_split_ratio(float p_ratio) { split_ratio = p_ratio; } float EditorProperty::get_name_split_ratio() const { return split_ratio; } void EditorProperty::set_object_and_property(Object *p_object, const StringName &p_property) { object = p_object; property = p_property; _update_pin_flags(); } static bool _is_value_potential_override(Node *p_node, const String &p_property) { // Consider a value is potentially overriding another if either of the following is true: // a) The node is foreign (inheriting or an instance), so the original value may come from another scene. // b) The node belongs to the scene, but the original value comes from somewhere but the builtin class (i.e., a script). Node *edited_scene = EditorNode::get_singleton()->get_edited_scene(); Vector states_stack = PropertyUtils::get_node_states_stack(p_node, edited_scene); if (states_stack.size()) { return true; } else { bool is_valid_default = false; bool is_class_default = false; PropertyUtils::get_property_default_value(p_node, p_property, &is_valid_default, &states_stack, false, nullptr, &is_class_default); return !is_class_default; } } void EditorProperty::_update_pin_flags() { can_pin = false; pin_hidden = true; if (read_only) { return; } if (Node *node = Object::cast_to(object)) { // Avoid errors down the road by ignoring nodes which are not part of a scene if (!node->get_owner()) { bool is_scene_root = false; for (int i = 0; i < EditorNode::get_editor_data().get_edited_scene_count(); ++i) { if (EditorNode::get_editor_data().get_edited_scene_root(i) == node) { is_scene_root = true; break; } } if (!is_scene_root) { return; } } if (!_is_value_potential_override(node, property)) { return; } pin_hidden = false; { HashSet storable_properties; node->get_storable_properties(storable_properties); if (storable_properties.has(node->get_property_store_alias(property))) { can_pin = true; } } } } Control *EditorProperty::make_custom_tooltip(const String &p_text) const { EditorHelpBit *tooltip = nullptr; if (has_doc_tooltip) { tooltip = memnew(EditorHelpTooltip(p_text)); } if (object->has_method("_get_property_warning")) { String warn = object->call("_get_property_warning", property); if (!warn.is_empty()) { String prev_text; if (tooltip == nullptr) { tooltip = memnew(EditorHelpBit()); tooltip->set_text(p_text); tooltip->get_rich_text()->set_custom_minimum_size(Size2(360 * EDSCALE, 0)); } else { prev_text = tooltip->get_rich_text()->get_text() + "\n"; } tooltip->set_text(prev_text + "[b][color=" + get_theme_color(SNAME("warning_color")).to_html(false) + "]" + warn + "[/color][/b]"); } } return tooltip; } void EditorProperty::menu_option(int p_option) { switch (p_option) { case MENU_COPY_VALUE: { InspectorDock::get_inspector_singleton()->set_property_clipboard(object->get(property)); } break; case MENU_PASTE_VALUE: { emit_changed(property, InspectorDock::get_inspector_singleton()->get_property_clipboard()); } break; case MENU_COPY_PROPERTY_PATH: { DisplayServer::get_singleton()->clipboard_set(property_path); } break; case MENU_PIN_VALUE: { emit_signal(SNAME("property_pinned"), property, !pinned); queue_redraw(); } break; case MENU_OPEN_DOCUMENTATION: { ScriptEditor::get_singleton()->goto_help(doc_path); EditorNode::get_singleton()->set_visible_editor(EditorNode::EDITOR_SCRIPT); } break; } } void EditorProperty::_bind_methods() { ClassDB::bind_method(D_METHOD("set_label", "text"), &EditorProperty::set_label); ClassDB::bind_method(D_METHOD("get_label"), &EditorProperty::get_label); ClassDB::bind_method(D_METHOD("set_read_only", "read_only"), &EditorProperty::set_read_only); ClassDB::bind_method(D_METHOD("is_read_only"), &EditorProperty::is_read_only); ClassDB::bind_method(D_METHOD("set_checkable", "checkable"), &EditorProperty::set_checkable); ClassDB::bind_method(D_METHOD("is_checkable"), &EditorProperty::is_checkable); ClassDB::bind_method(D_METHOD("set_checked", "checked"), &EditorProperty::set_checked); ClassDB::bind_method(D_METHOD("is_checked"), &EditorProperty::is_checked); ClassDB::bind_method(D_METHOD("set_draw_warning", "draw_warning"), &EditorProperty::set_draw_warning); ClassDB::bind_method(D_METHOD("is_draw_warning"), &EditorProperty::is_draw_warning); ClassDB::bind_method(D_METHOD("set_keying", "keying"), &EditorProperty::set_keying); ClassDB::bind_method(D_METHOD("is_keying"), &EditorProperty::is_keying); ClassDB::bind_method(D_METHOD("set_deletable", "deletable"), &EditorProperty::set_deletable); ClassDB::bind_method(D_METHOD("is_deletable"), &EditorProperty::is_deletable); ClassDB::bind_method(D_METHOD("get_edited_property"), &EditorProperty::get_edited_property); ClassDB::bind_method(D_METHOD("get_edited_object"), &EditorProperty::get_edited_object); ClassDB::bind_method(D_METHOD("update_property"), &EditorProperty::update_property); ClassDB::bind_method(D_METHOD("add_focusable", "control"), &EditorProperty::add_focusable); ClassDB::bind_method(D_METHOD("set_bottom_editor", "editor"), &EditorProperty::set_bottom_editor); ClassDB::bind_method(D_METHOD("emit_changed", "property", "value", "field", "changing"), &EditorProperty::emit_changed, DEFVAL(StringName()), DEFVAL(false)); ADD_PROPERTY(PropertyInfo(Variant::STRING, "label"), "set_label", "get_label"); ADD_PROPERTY(PropertyInfo(Variant::BOOL, "read_only"), "set_read_only", "is_read_only"); ADD_PROPERTY(PropertyInfo(Variant::BOOL, "checkable"), "set_checkable", "is_checkable"); ADD_PROPERTY(PropertyInfo(Variant::BOOL, "checked"), "set_checked", "is_checked"); ADD_PROPERTY(PropertyInfo(Variant::BOOL, "draw_warning"), "set_draw_warning", "is_draw_warning"); ADD_PROPERTY(PropertyInfo(Variant::BOOL, "keying"), "set_keying", "is_keying"); ADD_PROPERTY(PropertyInfo(Variant::BOOL, "deletable"), "set_deletable", "is_deletable"); ADD_SIGNAL(MethodInfo("property_changed", PropertyInfo(Variant::STRING_NAME, "property"), PropertyInfo(Variant::NIL, "value", PROPERTY_HINT_NONE, "", PROPERTY_USAGE_NIL_IS_VARIANT), PropertyInfo(Variant::STRING_NAME, "field"), PropertyInfo(Variant::BOOL, "changing"))); ADD_SIGNAL(MethodInfo("multiple_properties_changed", PropertyInfo(Variant::PACKED_STRING_ARRAY, "properties"), PropertyInfo(Variant::ARRAY, "value"))); ADD_SIGNAL(MethodInfo("property_keyed", PropertyInfo(Variant::STRING_NAME, "property"))); ADD_SIGNAL(MethodInfo("property_deleted", PropertyInfo(Variant::STRING_NAME, "property"))); ADD_SIGNAL(MethodInfo("property_keyed_with_value", PropertyInfo(Variant::STRING_NAME, "property"), PropertyInfo(Variant::NIL, "value", PROPERTY_HINT_NONE, "", PROPERTY_USAGE_NIL_IS_VARIANT))); ADD_SIGNAL(MethodInfo("property_checked", PropertyInfo(Variant::STRING_NAME, "property"), PropertyInfo(Variant::BOOL, "checked"))); ADD_SIGNAL(MethodInfo("property_pinned", PropertyInfo(Variant::STRING_NAME, "property"), PropertyInfo(Variant::BOOL, "pinned"))); ADD_SIGNAL(MethodInfo("property_can_revert_changed", PropertyInfo(Variant::STRING_NAME, "property"), PropertyInfo(Variant::BOOL, "can_revert"))); ADD_SIGNAL(MethodInfo("resource_selected", PropertyInfo(Variant::STRING, "path"), PropertyInfo(Variant::OBJECT, "resource", PROPERTY_HINT_RESOURCE_TYPE, "Resource"))); ADD_SIGNAL(MethodInfo("object_id_selected", PropertyInfo(Variant::STRING_NAME, "property"), PropertyInfo(Variant::INT, "id"))); ADD_SIGNAL(MethodInfo("selected", PropertyInfo(Variant::STRING, "path"), PropertyInfo(Variant::INT, "focusable_idx"))); GDVIRTUAL_BIND(_update_property) GDVIRTUAL_BIND(_set_read_only, "read_only") ClassDB::bind_method(D_METHOD("_update_editor_property_status"), &EditorProperty::update_editor_property_status); } EditorProperty::EditorProperty() { object = nullptr; split_ratio = 0.5; text_size = 0; property_usage = 0; selected_focusable = -1; label_reference = nullptr; bottom_editor = nullptr; menu = nullptr; set_process_shortcut_input(true); } void EditorProperty::_update_popup() { if (menu) { menu->clear(); } else { menu = memnew(PopupMenu); add_child(menu); menu->connect("id_pressed", callable_mp(this, &EditorProperty::menu_option)); } menu->add_icon_shortcut(get_editor_theme_icon(SNAME("ActionCopy")), ED_GET_SHORTCUT("property_editor/copy_value"), MENU_COPY_VALUE); menu->add_icon_shortcut(get_editor_theme_icon(SNAME("ActionPaste")), ED_GET_SHORTCUT("property_editor/paste_value"), MENU_PASTE_VALUE); menu->add_icon_shortcut(get_editor_theme_icon(SNAME("CopyNodePath")), ED_GET_SHORTCUT("property_editor/copy_property_path"), MENU_COPY_PROPERTY_PATH); menu->set_item_disabled(MENU_PASTE_VALUE, is_read_only()); if (!pin_hidden) { menu->add_separator(); if (can_pin) { menu->add_icon_check_item(get_editor_theme_icon(SNAME("Pin")), TTR("Pin Value"), MENU_PIN_VALUE); menu->set_item_checked(menu->get_item_index(MENU_PIN_VALUE), pinned); } else { menu->add_icon_check_item(get_editor_theme_icon(SNAME("Pin")), vformat(TTR("Pin Value [Disabled because '%s' is editor-only]"), property), MENU_PIN_VALUE); menu->set_item_disabled(menu->get_item_index(MENU_PIN_VALUE), true); } menu->set_item_tooltip(menu->get_item_index(MENU_PIN_VALUE), TTR("Pinning a value forces it to be saved even if it's equal to the default.")); } if (!doc_path.is_empty()) { menu->add_separator(); menu->add_icon_item(get_editor_theme_icon(SNAME("Help")), TTR("Open Documentation"), MENU_OPEN_DOCUMENTATION); } } //////////////////////////////////////////////// //////////////////////////////////////////////// void EditorInspectorPlugin::add_custom_control(Control *control) { AddedEditor ae; ae.property_editor = control; added_editors.push_back(ae); } void EditorInspectorPlugin::add_property_editor(const String &p_for_property, Control *p_prop, bool p_add_to_end) { AddedEditor ae; ae.properties.push_back(p_for_property); ae.property_editor = p_prop; ae.add_to_end = p_add_to_end; added_editors.push_back(ae); } void EditorInspectorPlugin::add_property_editor_for_multiple_properties(const String &p_label, const Vector &p_properties, Control *p_prop) { AddedEditor ae; ae.properties = p_properties; ae.property_editor = p_prop; ae.label = p_label; added_editors.push_back(ae); } bool EditorInspectorPlugin::can_handle(Object *p_object) { bool success = false; GDVIRTUAL_CALL(_can_handle, p_object, success); return success; } void EditorInspectorPlugin::parse_begin(Object *p_object) { GDVIRTUAL_CALL(_parse_begin, p_object); } void EditorInspectorPlugin::parse_category(Object *p_object, const String &p_category) { GDVIRTUAL_CALL(_parse_category, p_object, p_category); } void EditorInspectorPlugin::parse_group(Object *p_object, const String &p_group) { GDVIRTUAL_CALL(_parse_group, p_object, p_group); } bool EditorInspectorPlugin::parse_property(Object *p_object, const Variant::Type p_type, const String &p_path, const PropertyHint p_hint, const String &p_hint_text, const BitField p_usage, const bool p_wide) { bool ret = false; GDVIRTUAL_CALL(_parse_property, p_object, p_type, p_path, p_hint, p_hint_text, p_usage, p_wide, ret); return ret; } void EditorInspectorPlugin::parse_end(Object *p_object) { GDVIRTUAL_CALL(_parse_end, p_object); } void EditorInspectorPlugin::_bind_methods() { ClassDB::bind_method(D_METHOD("add_custom_control", "control"), &EditorInspectorPlugin::add_custom_control); ClassDB::bind_method(D_METHOD("add_property_editor", "property", "editor", "add_to_end"), &EditorInspectorPlugin::add_property_editor, DEFVAL(false)); ClassDB::bind_method(D_METHOD("add_property_editor_for_multiple_properties", "label", "properties", "editor"), &EditorInspectorPlugin::add_property_editor_for_multiple_properties); GDVIRTUAL_BIND(_can_handle, "object") GDVIRTUAL_BIND(_parse_begin, "object") GDVIRTUAL_BIND(_parse_category, "object", "category") GDVIRTUAL_BIND(_parse_group, "object", "group") GDVIRTUAL_BIND(_parse_property, "object", "type", "name", "hint_type", "hint_string", "usage_flags", "wide"); GDVIRTUAL_BIND(_parse_end, "object") } //////////////////////////////////////////////// //////////////////////////////////////////////// void EditorInspectorCategory::_notification(int p_what) { switch (p_what) { case NOTIFICATION_ENTER_TREE: case NOTIFICATION_THEME_CHANGED: { menu->set_item_icon(menu->get_item_index(MENU_OPEN_DOCS), get_editor_theme_icon(SNAME("Help"))); } break; case NOTIFICATION_DRAW: { Ref sb = get_theme_stylebox(SNAME("bg")); draw_style_box(sb, Rect2(Vector2(), get_size())); Ref font = get_theme_font(SNAME("bold"), EditorStringName(EditorFonts)); int font_size = get_theme_font_size(SNAME("bold_size"), EditorStringName(EditorFonts)); int hs = get_theme_constant(SNAME("h_separation"), SNAME("Tree")); int icon_size = get_theme_constant(SNAME("class_icon_size"), EditorStringName(Editor)); int w = font->get_string_size(label, HORIZONTAL_ALIGNMENT_LEFT, -1, font_size).width; if (icon.is_valid()) { w += hs + icon_size; } int ofs = (get_size().width - w) / 2; if (icon.is_valid()) { Size2 rect_size = Size2(icon_size, icon_size); Point2 rect_pos = Point2(ofs, (get_size().height - icon_size) / 2).floor(); draw_texture_rect(icon, Rect2(rect_pos, rect_size)); ofs += hs + icon_size; } Color color = get_theme_color(SNAME("font_color"), SNAME("Tree")); draw_string(font, Point2(ofs, font->get_ascent(font_size) + (get_size().height - font->get_height(font_size)) / 2).floor(), label, HORIZONTAL_ALIGNMENT_LEFT, get_size().width, font_size, color); } break; } } Control *EditorInspectorCategory::make_custom_tooltip(const String &p_text) const { return doc_class_name.is_empty() ? nullptr : memnew(EditorHelpTooltip(p_text)); } Size2 EditorInspectorCategory::get_minimum_size() const { Ref font = get_theme_font(SNAME("bold"), EditorStringName(EditorFonts)); int font_size = get_theme_font_size(SNAME("bold_size"), EditorStringName(EditorFonts)); Size2 ms; ms.height = font->get_height(font_size); if (icon.is_valid()) { int icon_size = get_theme_constant(SNAME("class_icon_size"), EditorStringName(Editor)); ms.height = MAX(icon_size, ms.height); } ms.height += get_theme_constant(SNAME("v_separation"), SNAME("Tree")); return ms; } void EditorInspectorCategory::_handle_menu_option(int p_option) { switch (p_option) { case MENU_OPEN_DOCS: ScriptEditor::get_singleton()->goto_help("class:" + doc_class_name); EditorNode::get_singleton()->set_visible_editor(EditorNode::EDITOR_SCRIPT); break; } } void EditorInspectorCategory::gui_input(const Ref &p_event) { if (doc_class_name.is_empty()) { return; } const Ref &mb_event = p_event; if (mb_event.is_null() || !mb_event->is_pressed() || mb_event->get_button_index() != MouseButton::RIGHT) { return; } menu->set_item_disabled(menu->get_item_index(MENU_OPEN_DOCS), !EditorHelp::get_doc_data()->class_list.has(doc_class_name)); menu->set_position(get_screen_position() + mb_event->get_position()); menu->reset_size(); menu->popup(); } EditorInspectorCategory::EditorInspectorCategory() { menu = memnew(PopupMenu); menu->connect("id_pressed", callable_mp(this, &EditorInspectorCategory::_handle_menu_option)); menu->add_item(TTR("Open Documentation"), MENU_OPEN_DOCS); add_child(menu); } //////////////////////////////////////////////// //////////////////////////////////////////////// void EditorInspectorSection::_test_unfold() { if (!vbox_added) { add_child(vbox); move_child(vbox, 0); vbox_added = true; } } Ref EditorInspectorSection::_get_arrow() { Ref arrow; if (foldable) { if (object->editor_is_section_unfolded(section)) { arrow = get_theme_icon(SNAME("arrow"), SNAME("Tree")); } else { if (is_layout_rtl()) { arrow = get_theme_icon(SNAME("arrow_collapsed_mirrored"), SNAME("Tree")); } else { arrow = get_theme_icon(SNAME("arrow_collapsed"), SNAME("Tree")); } } } return arrow; } int EditorInspectorSection::_get_header_height() { Ref font = get_theme_font(SNAME("bold"), EditorStringName(EditorFonts)); int font_size = get_theme_font_size(SNAME("bold_size"), EditorStringName(EditorFonts)); int header_height = font->get_height(font_size); Ref arrow = _get_arrow(); if (arrow.is_valid()) { header_height = MAX(header_height, arrow->get_height()); } header_height += get_theme_constant(SNAME("v_separation"), SNAME("Tree")); return header_height; } void EditorInspectorSection::_notification(int p_what) { switch (p_what) { case NOTIFICATION_THEME_CHANGED: { update_minimum_size(); } break; case NOTIFICATION_SORT_CHILDREN: { if (!vbox_added) { return; } int inspector_margin = get_theme_constant(SNAME("inspector_margin"), EditorStringName(Editor)); int section_indent_size = get_theme_constant(SNAME("indent_size"), SNAME("EditorInspectorSection")); if (indent_depth > 0 && section_indent_size > 0) { inspector_margin += indent_depth * section_indent_size; } Ref section_indent_style = get_theme_stylebox(SNAME("indent_box"), SNAME("EditorInspectorSection")); if (indent_depth > 0 && section_indent_style.is_valid()) { inspector_margin += section_indent_style->get_margin(SIDE_LEFT) + section_indent_style->get_margin(SIDE_RIGHT); } Size2 size = get_size() - Vector2(inspector_margin, 0); int header_height = _get_header_height(); Vector2 offset = Vector2(is_layout_rtl() ? 0 : inspector_margin, header_height); for (int i = 0; i < get_child_count(); i++) { Control *c = Object::cast_to(get_child(i)); if (!c) { continue; } if (c->is_set_as_top_level()) { continue; } fit_child_in_rect(c, Rect2(offset, size)); } } break; case NOTIFICATION_DRAW: { int section_indent = 0; int section_indent_size = get_theme_constant(SNAME("indent_size"), SNAME("EditorInspectorSection")); if (indent_depth > 0 && section_indent_size > 0) { section_indent = indent_depth * section_indent_size; } Ref section_indent_style = get_theme_stylebox(SNAME("indent_box"), SNAME("EditorInspectorSection")); if (indent_depth > 0 && section_indent_style.is_valid()) { section_indent += section_indent_style->get_margin(SIDE_LEFT) + section_indent_style->get_margin(SIDE_RIGHT); } int header_width = get_size().width - section_indent; int header_offset_x = 0.0; bool rtl = is_layout_rtl(); if (!rtl) { header_offset_x += section_indent; } // Draw header area. int header_height = _get_header_height(); Rect2 header_rect = Rect2(Vector2(header_offset_x, 0.0), Vector2(header_width, header_height)); Color c = bg_color; c.a *= 0.4; if (foldable && header_rect.has_point(get_local_mouse_position())) { c = c.lightened(Input::get_singleton()->is_mouse_button_pressed(MouseButton::LEFT) ? -0.05 : 0.2); } draw_rect(header_rect, c); // Draw header title, folding arrow and count of revertable properties. { int separation = Math::round(2 * EDSCALE); int margin_start = section_indent + separation; int margin_end = separation; // - Arrow. Ref arrow = _get_arrow(); if (arrow.is_valid()) { Point2 arrow_position; if (rtl) { arrow_position.x = get_size().width - (margin_start + arrow->get_width()); } else { arrow_position.x = margin_start; } arrow_position.y = (header_height - arrow->get_height()) / 2; draw_texture(arrow, arrow_position); margin_start += arrow->get_width(); } int available = get_size().width - (margin_start + margin_end); // - Count of revertable properties. String num_revertable_str; int num_revertable_width = 0; bool folded = foldable && !object->editor_is_section_unfolded(section); Ref font = get_theme_font(SNAME("bold"), EditorStringName(EditorFonts)); int font_size = get_theme_font_size(SNAME("bold_size"), EditorStringName(EditorFonts)); Color font_color = get_theme_color(SNAME("font_color"), EditorStringName(Editor)); if (folded && revertable_properties.size()) { int label_width = font->get_string_size(label, HORIZONTAL_ALIGNMENT_LEFT, available, font_size, TextServer::JUSTIFICATION_KASHIDA | TextServer::JUSTIFICATION_CONSTRAIN_ELLIPSIS).x; Ref light_font = get_theme_font(SNAME("main"), EditorStringName(EditorFonts)); int light_font_size = get_theme_font_size(SNAME("main_size"), EditorStringName(EditorFonts)); Color light_font_color = get_theme_color(SNAME("disabled_font_color"), EditorStringName(Editor)); // Can we fit the long version of the revertable count text? num_revertable_str = vformat(TTRN("(%d change)", "(%d changes)", revertable_properties.size()), revertable_properties.size()); num_revertable_width = light_font->get_string_size(num_revertable_str, HORIZONTAL_ALIGNMENT_LEFT, -1.0f, light_font_size, TextServer::JUSTIFICATION_NONE).x; if (label_width + separation + num_revertable_width > available) { // We'll have to use the short version. num_revertable_str = vformat("(%d)", revertable_properties.size()); num_revertable_width = light_font->get_string_size(num_revertable_str, HORIZONTAL_ALIGNMENT_LEFT, -1.0f, light_font_size, TextServer::JUSTIFICATION_NONE).x; } Point2 text_offset = Point2( margin_end, light_font->get_ascent(light_font_size) + (header_height - light_font->get_height(light_font_size)) / 2); if (!rtl) { text_offset.x = get_size().width - (text_offset.x + num_revertable_width); } draw_string(light_font, text_offset, num_revertable_str, HORIZONTAL_ALIGNMENT_LEFT, -1.0f, light_font_size, light_font_color, TextServer::JUSTIFICATION_NONE); margin_end += num_revertable_width + separation; available -= num_revertable_width + separation; } // - Label. Point2 text_offset = Point2( margin_start, font->get_ascent(font_size) + (header_height - font->get_height(font_size)) / 2); if (rtl) { text_offset.x = margin_end; } HorizontalAlignment text_align = rtl ? HORIZONTAL_ALIGNMENT_RIGHT : HORIZONTAL_ALIGNMENT_LEFT; draw_string(font, text_offset, label, text_align, available, font_size, font_color, TextServer::JUSTIFICATION_KASHIDA | TextServer::JUSTIFICATION_CONSTRAIN_ELLIPSIS); } // Draw dropping highlight. if (dropping && !vbox->is_visible_in_tree()) { Color accent_color = get_theme_color(SNAME("accent_color"), EditorStringName(Editor)); draw_rect(Rect2(Point2(), get_size()), accent_color, false); } // Draw section indentation. if (section_indent_style.is_valid() && section_indent > 0) { Rect2 indent_rect = Rect2(Vector2(), Vector2(indent_depth * section_indent_size, get_size().height)); if (rtl) { indent_rect.position.x = get_size().width - section_indent + section_indent_style->get_margin(SIDE_RIGHT); } else { indent_rect.position.x = section_indent_style->get_margin(SIDE_LEFT); } draw_style_box(section_indent_style, indent_rect); } } break; case NOTIFICATION_DRAG_BEGIN: { dropping_for_unfold = true; } break; case NOTIFICATION_DRAG_END: { dropping_for_unfold = false; } break; case NOTIFICATION_MOUSE_ENTER: { if (dropping || dropping_for_unfold) { dropping_unfold_timer->start(); } queue_redraw(); } break; case NOTIFICATION_MOUSE_EXIT: { if (dropping || dropping_for_unfold) { dropping_unfold_timer->stop(); } queue_redraw(); } break; } } Size2 EditorInspectorSection::get_minimum_size() const { Size2 ms; for (int i = 0; i < get_child_count(); i++) { Control *c = Object::cast_to(get_child(i)); if (!c) { continue; } if (c->is_set_as_top_level()) { continue; } if (!c->is_visible()) { continue; } Size2 minsize = c->get_combined_minimum_size(); ms.width = MAX(ms.width, minsize.width); ms.height = MAX(ms.height, minsize.height); } Ref font = get_theme_font(SNAME("font"), SNAME("Tree")); int font_size = get_theme_font_size(SNAME("font_size"), SNAME("Tree")); ms.height += font->get_height(font_size) + get_theme_constant(SNAME("v_separation"), SNAME("Tree")); ms.width += get_theme_constant(SNAME("inspector_margin"), EditorStringName(Editor)); int section_indent_size = get_theme_constant(SNAME("indent_size"), SNAME("EditorInspectorSection")); if (indent_depth > 0 && section_indent_size > 0) { ms.width += indent_depth * section_indent_size; } Ref section_indent_style = get_theme_stylebox(SNAME("indent_box"), SNAME("EditorInspectorSection")); if (indent_depth > 0 && section_indent_style.is_valid()) { ms.width += section_indent_style->get_margin(SIDE_LEFT) + section_indent_style->get_margin(SIDE_RIGHT); } return ms; } void EditorInspectorSection::setup(const String &p_section, const String &p_label, Object *p_object, const Color &p_bg_color, bool p_foldable, int p_indent_depth) { section = p_section; label = p_label; object = p_object; bg_color = p_bg_color; foldable = p_foldable; indent_depth = p_indent_depth; if (!foldable && !vbox_added) { add_child(vbox); move_child(vbox, 0); vbox_added = true; } if (foldable) { _test_unfold(); if (object->editor_is_section_unfolded(section)) { vbox->show(); } else { vbox->hide(); } } } void EditorInspectorSection::gui_input(const Ref &p_event) { ERR_FAIL_COND(p_event.is_null()); if (!foldable) { return; } Ref mb = p_event; if (mb.is_valid() && mb->is_pressed() && mb->get_button_index() == MouseButton::LEFT) { if (object->editor_is_section_unfolded(section)) { int header_height = _get_header_height(); if (mb->get_position().y >= header_height) { return; } } accept_event(); bool should_unfold = !object->editor_is_section_unfolded(section); if (should_unfold) { unfold(); } else { fold(); } } else if (mb.is_valid() && !mb->is_pressed()) { queue_redraw(); } } VBoxContainer *EditorInspectorSection::get_vbox() { return vbox; } void EditorInspectorSection::unfold() { if (!foldable) { return; } _test_unfold(); object->editor_set_section_unfold(section, true); vbox->show(); queue_redraw(); } void EditorInspectorSection::fold() { if (!foldable) { return; } if (!vbox_added) { return; } object->editor_set_section_unfold(section, false); vbox->hide(); queue_redraw(); } void EditorInspectorSection::set_bg_color(const Color &p_bg_color) { bg_color = p_bg_color; queue_redraw(); } bool EditorInspectorSection::has_revertable_properties() const { return !revertable_properties.is_empty(); } void EditorInspectorSection::property_can_revert_changed(const String &p_path, bool p_can_revert) { bool had_revertable_properties = has_revertable_properties(); if (p_can_revert) { revertable_properties.insert(p_path); } else { revertable_properties.erase(p_path); } if (has_revertable_properties() != had_revertable_properties) { queue_redraw(); } } void EditorInspectorSection::_bind_methods() { ClassDB::bind_method(D_METHOD("setup", "section", "label", "object", "bg_color", "foldable"), &EditorInspectorSection::setup); ClassDB::bind_method(D_METHOD("get_vbox"), &EditorInspectorSection::get_vbox); ClassDB::bind_method(D_METHOD("unfold"), &EditorInspectorSection::unfold); ClassDB::bind_method(D_METHOD("fold"), &EditorInspectorSection::fold); } EditorInspectorSection::EditorInspectorSection() { vbox = memnew(VBoxContainer); dropping_unfold_timer = memnew(Timer); dropping_unfold_timer->set_wait_time(0.6); dropping_unfold_timer->set_one_shot(true); add_child(dropping_unfold_timer); dropping_unfold_timer->connect("timeout", callable_mp(this, &EditorInspectorSection::unfold)); } EditorInspectorSection::~EditorInspectorSection() { if (!vbox_added) { memdelete(vbox); } } //////////////////////////////////////////////// //////////////////////////////////////////////// int EditorInspectorArray::_get_array_count() { if (mode == MODE_USE_MOVE_ARRAY_ELEMENT_FUNCTION) { List object_property_list; object->get_property_list(&object_property_list); return _extract_properties_as_array(object_property_list).size(); } else if (mode == MODE_USE_COUNT_PROPERTY) { bool valid; int count_val = object->get(count_property, &valid); ERR_FAIL_COND_V_MSG(!valid, 0, vformat("%s is not a valid property to be used as array count.", count_property)); return count_val; } return 0; } void EditorInspectorArray::_add_button_pressed() { _move_element(-1, -1); } void EditorInspectorArray::_paginator_page_changed(int p_page) { emit_signal("page_change_request", p_page); } void EditorInspectorArray::_rmb_popup_id_pressed(int p_id) { switch (p_id) { case OPTION_MOVE_UP: if (popup_array_index_pressed > 0) { _move_element(popup_array_index_pressed, popup_array_index_pressed - 1); } break; case OPTION_MOVE_DOWN: if (popup_array_index_pressed < count - 1) { _move_element(popup_array_index_pressed, popup_array_index_pressed + 2); } break; case OPTION_NEW_BEFORE: _move_element(-1, popup_array_index_pressed); break; case OPTION_NEW_AFTER: _move_element(-1, popup_array_index_pressed + 1); break; case OPTION_REMOVE: _move_element(popup_array_index_pressed, -1); break; case OPTION_CLEAR_ARRAY: _clear_array(); break; case OPTION_RESIZE_ARRAY: new_size_spin_box->set_value(count); resize_dialog->get_ok_button()->set_disabled(true); resize_dialog->popup_centered(Size2(250, 0) * EDSCALE); new_size_spin_box->get_line_edit()->grab_focus(); new_size_spin_box->get_line_edit()->select_all(); break; default: break; } } void EditorInspectorArray::_control_dropping_draw() { int drop_position = _drop_position(); if (dropping && drop_position >= 0) { Vector2 from; Vector2 to; if (drop_position < elements_vbox->get_child_count()) { Transform2D xform = Object::cast_to(elements_vbox->get_child(drop_position))->get_transform(); from = xform.xform(Vector2()); to = xform.xform(Vector2(elements_vbox->get_size().x, 0)); } else { Control *child = Object::cast_to(elements_vbox->get_child(drop_position - 1)); Transform2D xform = child->get_transform(); from = xform.xform(Vector2(0, child->get_size().y)); to = xform.xform(Vector2(elements_vbox->get_size().x, child->get_size().y)); } Color color = get_theme_color(SNAME("accent_color"), EditorStringName(Editor)); control_dropping->draw_line(from, to, color, 2); } } void EditorInspectorArray::_vbox_visibility_changed() { control_dropping->set_visible(vbox->is_visible_in_tree()); } void EditorInspectorArray::_panel_draw(int p_index) { ERR_FAIL_INDEX(p_index, (int)array_elements.size()); Ref style = get_theme_stylebox(SNAME("Focus"), EditorStringName(EditorStyles)); if (!style.is_valid()) { return; } if (array_elements[p_index].panel->has_focus()) { array_elements[p_index].panel->draw_style_box(style, Rect2(Vector2(), array_elements[p_index].panel->get_size())); } } void EditorInspectorArray::_panel_gui_input(Ref p_event, int p_index) { ERR_FAIL_INDEX(p_index, (int)array_elements.size()); if (read_only) { return; } Ref key_ref = p_event; if (key_ref.is_valid()) { const InputEventKey &key = **key_ref; if (array_elements[p_index].panel->has_focus() && key.is_pressed() && key.get_keycode() == Key::KEY_DELETE) { _move_element(begin_array_index + p_index, -1); array_elements[p_index].panel->accept_event(); } } Ref mb = p_event; if (mb.is_valid()) { if (movable && mb->get_button_index() == MouseButton::RIGHT) { array_elements[p_index].panel->accept_event(); popup_array_index_pressed = begin_array_index + p_index; rmb_popup->set_item_disabled(OPTION_MOVE_UP, popup_array_index_pressed == 0); rmb_popup->set_item_disabled(OPTION_MOVE_DOWN, popup_array_index_pressed == count - 1); rmb_popup->set_position(get_screen_position() + mb->get_position()); rmb_popup->reset_size(); rmb_popup->popup(); } } } void EditorInspectorArray::_move_element(int p_element_index, int p_to_pos) { String action_name; if (p_element_index < 0) { action_name = vformat(TTR("Add element to property array with prefix %s."), array_element_prefix); } else if (p_to_pos < 0) { action_name = vformat(TTR("Remove element %d from property array with prefix %s."), p_element_index, array_element_prefix); } else { action_name = vformat(TTR("Move element %d to position %d in property array with prefix %s."), p_element_index, p_to_pos, array_element_prefix); } EditorUndoRedoManager *undo_redo = EditorUndoRedoManager::get_singleton(); undo_redo->create_action(action_name); if (mode == MODE_USE_MOVE_ARRAY_ELEMENT_FUNCTION) { // Call the function. Callable move_function = EditorNode::get_editor_data().get_move_array_element_function(object->get_class_name()); if (move_function.is_valid()) { move_function.call(undo_redo, object, array_element_prefix, p_element_index, p_to_pos); } else { WARN_PRINT(vformat("Could not find a function to move arrays elements for class %s. Register a move element function using EditorData::add_move_array_element_function", object->get_class_name())); } } else if (mode == MODE_USE_COUNT_PROPERTY) { ERR_FAIL_COND(p_to_pos < -1 || p_to_pos > count); if (!swap_method.is_empty()) { ERR_FAIL_COND(!object->has_method(swap_method)); // Swap method was provided, use it. if (p_element_index < 0) { // Add an element at position undo_redo->add_do_property(object, count_property, count + 1); if (p_to_pos >= 0) { for (int i = count; i > p_to_pos; i--) { undo_redo->add_do_method(object, swap_method, i, i - 1); } for (int i = p_to_pos; i < count; i++) { undo_redo->add_undo_method(object, swap_method, i, i + 1); } } undo_redo->add_undo_property(object, count_property, count); } else if (p_to_pos < 0) { if (count > 0) { // Remove element at position undo_redo->add_undo_property(object, count_property, count); List object_property_list; object->get_property_list(&object_property_list); for (int i = p_element_index; i < count - 1; i++) { undo_redo->add_do_method(object, swap_method, i, i + 1); } for (int i = count; i > p_element_index; i--) { undo_redo->add_undo_method(object, swap_method, i, i - 1); } String erase_prefix = String(array_element_prefix) + itos(p_element_index); for (const PropertyInfo &E : object_property_list) { if (E.name.begins_with(erase_prefix)) { undo_redo->add_undo_property(object, E.name, object->get(E.name)); } } undo_redo->add_do_property(object, count_property, count - 1); } } else { if (p_to_pos > p_element_index) { p_to_pos--; } if (p_to_pos < p_element_index) { for (int i = p_element_index; i > p_to_pos; i--) { undo_redo->add_do_method(object, swap_method, i, i - 1); } for (int i = p_to_pos; i < p_element_index; i++) { undo_redo->add_undo_method(object, swap_method, i, i + 1); } } else if (p_to_pos > p_element_index) { for (int i = p_element_index; i < p_to_pos; i++) { undo_redo->add_do_method(object, swap_method, i, i + 1); } for (int i = p_to_pos; i > p_element_index; i--) { undo_redo->add_undo_method(object, swap_method, i, i - 1); } } } } else { // Use standard properties. List object_property_list; object->get_property_list(&object_property_list); Array properties_as_array = _extract_properties_as_array(object_property_list); properties_as_array.resize(count); // For undoing things undo_redo->add_undo_property(object, count_property, properties_as_array.size()); for (int i = 0; i < (int)properties_as_array.size(); i++) { Dictionary d = Dictionary(properties_as_array[i]); Array keys = d.keys(); for (int j = 0; j < keys.size(); j++) { String key = keys[j]; undo_redo->add_undo_property(object, vformat(key, i), d[key]); } } if (p_element_index < 0) { // Add an element. properties_as_array.insert(p_to_pos < 0 ? properties_as_array.size() : p_to_pos, Dictionary()); } else if (p_to_pos < 0) { // Delete the element. properties_as_array.remove_at(p_element_index); } else { // Move the element. properties_as_array.insert(p_to_pos, properties_as_array[p_element_index].duplicate()); properties_as_array.remove_at(p_to_pos < p_element_index ? p_element_index + 1 : p_element_index); } // Change the array size then set the properties. undo_redo->add_do_property(object, count_property, properties_as_array.size()); for (int i = 0; i < (int)properties_as_array.size(); i++) { Dictionary d = properties_as_array[i]; Array keys = d.keys(); for (int j = 0; j < keys.size(); j++) { String key = keys[j]; undo_redo->add_do_property(object, vformat(key, i), d[key]); } } } } undo_redo->commit_action(); // Handle page change and update counts. if (p_element_index < 0) { int added_index = p_to_pos < 0 ? count : p_to_pos; emit_signal(SNAME("page_change_request"), added_index / page_length); count += 1; } else if (p_to_pos < 0) { count -= 1; if (page == max_page && (MAX(0, count - 1) / page_length != max_page)) { emit_signal(SNAME("page_change_request"), max_page - 1); } } else if (p_to_pos == begin_array_index - 1) { emit_signal(SNAME("page_change_request"), page - 1); } else if (p_to_pos > end_array_index) { emit_signal(SNAME("page_change_request"), page + 1); } begin_array_index = page * page_length; end_array_index = MIN(count, (page + 1) * page_length); max_page = MAX(0, count - 1) / page_length; } void EditorInspectorArray::_clear_array() { EditorUndoRedoManager *undo_redo = EditorUndoRedoManager::get_singleton(); undo_redo->create_action(vformat(TTR("Clear Property Array with Prefix %s"), array_element_prefix)); if (mode == MODE_USE_MOVE_ARRAY_ELEMENT_FUNCTION) { for (int i = count - 1; i >= 0; i--) { // Call the function. Callable move_function = EditorNode::get_editor_data().get_move_array_element_function(object->get_class_name()); if (move_function.is_valid()) { move_function.call(undo_redo, object, array_element_prefix, i, -1); } else { WARN_PRINT(vformat("Could not find a function to move arrays elements for class %s. Register a move element function using EditorData::add_move_array_element_function", object->get_class_name())); } } } else if (mode == MODE_USE_COUNT_PROPERTY) { List object_property_list; object->get_property_list(&object_property_list); Array properties_as_array = _extract_properties_as_array(object_property_list); properties_as_array.resize(count); // For undoing things undo_redo->add_undo_property(object, count_property, count); for (int i = 0; i < (int)properties_as_array.size(); i++) { Dictionary d = Dictionary(properties_as_array[i]); Array keys = d.keys(); for (int j = 0; j < keys.size(); j++) { String key = keys[j]; undo_redo->add_undo_property(object, vformat(key, i), d[key]); } } // Change the array size then set the properties. undo_redo->add_do_property(object, count_property, 0); } undo_redo->commit_action(); // Handle page change and update counts. emit_signal(SNAME("page_change_request"), 0); count = 0; begin_array_index = 0; end_array_index = 0; max_page = 0; } void EditorInspectorArray::_resize_array(int p_size) { ERR_FAIL_COND(p_size < 0); if (p_size == count) { return; } EditorUndoRedoManager *undo_redo = EditorUndoRedoManager::get_singleton(); undo_redo->create_action(vformat(TTR("Resize Property Array with Prefix %s"), array_element_prefix)); if (p_size > count) { if (mode == MODE_USE_MOVE_ARRAY_ELEMENT_FUNCTION) { for (int i = count; i < p_size; i++) { // Call the function. Callable move_function = EditorNode::get_editor_data().get_move_array_element_function(object->get_class_name()); if (move_function.is_valid()) { move_function.call(undo_redo, object, array_element_prefix, -1, -1); } else { WARN_PRINT(vformat("Could not find a function to move arrays elements for class %s. Register a move element function using EditorData::add_move_array_element_function", object->get_class_name())); } } } else if (mode == MODE_USE_COUNT_PROPERTY) { undo_redo->add_undo_property(object, count_property, count); undo_redo->add_do_property(object, count_property, p_size); } } else { if (mode == MODE_USE_MOVE_ARRAY_ELEMENT_FUNCTION) { for (int i = count - 1; i > p_size - 1; i--) { // Call the function. Callable move_function = EditorNode::get_editor_data().get_move_array_element_function(object->get_class_name()); if (move_function.is_valid()) { move_function.call(undo_redo, object, array_element_prefix, i, -1); } else { WARN_PRINT(vformat("Could not find a function to move arrays elements for class %s. Register a move element function using EditorData::add_move_array_element_function", object->get_class_name())); } } } else if (mode == MODE_USE_COUNT_PROPERTY) { List object_property_list; object->get_property_list(&object_property_list); Array properties_as_array = _extract_properties_as_array(object_property_list); properties_as_array.resize(count); // For undoing things undo_redo->add_undo_property(object, count_property, count); for (int i = count - 1; i > p_size - 1; i--) { Dictionary d = Dictionary(properties_as_array[i]); Array keys = d.keys(); for (int j = 0; j < keys.size(); j++) { String key = keys[j]; undo_redo->add_undo_property(object, vformat(key, i), d[key]); } } // Change the array size then set the properties. undo_redo->add_do_property(object, count_property, p_size); } } undo_redo->commit_action(); // Handle page change and update counts. emit_signal(SNAME("page_change_request"), 0); /* count = 0; begin_array_index = 0; end_array_index = 0; max_page = 0; */ } Array EditorInspectorArray::_extract_properties_as_array(const List &p_list) { Array output; for (const PropertyInfo &pi : p_list) { if (pi.name.begins_with(array_element_prefix)) { String str = pi.name.trim_prefix(array_element_prefix); int to_char_index = 0; while (to_char_index < str.length()) { if (!is_digit(str[to_char_index])) { break; } to_char_index++; } if (to_char_index > 0) { int array_index = str.left(to_char_index).to_int(); Error error = OK; if (array_index >= output.size()) { error = output.resize(array_index + 1); } if (error == OK) { String format_string = String(array_element_prefix) + "%d" + str.substr(to_char_index); Dictionary dict = output[array_index]; dict[format_string] = object->get(pi.name); output[array_index] = dict; } else { WARN_PRINT(vformat("Array element %s has an index too high. Array allocation failed.", pi.name)); } } } } return output; } int EditorInspectorArray::_drop_position() const { for (int i = 0; i < (int)array_elements.size(); i++) { const ArrayElement &ae = array_elements[i]; Size2 size = ae.panel->get_size(); Vector2 mp = ae.panel->get_local_mouse_position(); if (Rect2(Vector2(), size).has_point(mp)) { if (mp.y < size.y / 2) { return i; } else { return i + 1; } } } return -1; } void EditorInspectorArray::_resize_dialog_confirmed() { if (int(new_size_spin_box->get_value()) == count) { return; } resize_dialog->hide(); _resize_array(int(new_size_spin_box->get_value())); } void EditorInspectorArray::_new_size_spin_box_value_changed(float p_value) { resize_dialog->get_ok_button()->set_disabled(int(p_value) == count); } void EditorInspectorArray::_new_size_spin_box_text_submitted(String p_text) { _resize_dialog_confirmed(); } void EditorInspectorArray::_setup() { // Setup counts. count = _get_array_count(); begin_array_index = page * page_length; end_array_index = MIN(count, (page + 1) * page_length); max_page = MAX(0, count - 1) / page_length; array_elements.resize(MAX(0, end_array_index - begin_array_index)); if (page < 0 || page > max_page) { WARN_PRINT(vformat("Invalid page number %d", page)); page = CLAMP(page, 0, max_page); } Ref numbers_font; int numbers_min_w = 0; if (numbered) { numbers_font = get_theme_font(SNAME("bold"), EditorStringName(EditorFonts)); int digits_found = count; String test; while (digits_found) { test += "8"; digits_found /= 10; } numbers_min_w = numbers_font->get_string_size(test).width; } for (int i = 0; i < (int)array_elements.size(); i++) { ArrayElement &ae = array_elements[i]; // Panel and its hbox. ae.panel = memnew(PanelContainer); ae.panel->set_focus_mode(FOCUS_ALL); ae.panel->set_mouse_filter(MOUSE_FILTER_PASS); SET_DRAG_FORWARDING_GCD(ae.panel, EditorInspectorArray); int element_position = begin_array_index + i; ae.panel->set_meta("index", element_position); ae.panel->set_tooltip_text(vformat(TTR("Element %d: %s%d*"), element_position, array_element_prefix, element_position)); ae.panel->connect("focus_entered", callable_mp((CanvasItem *)ae.panel, &PanelContainer::queue_redraw)); ae.panel->connect("focus_exited", callable_mp((CanvasItem *)ae.panel, &PanelContainer::queue_redraw)); ae.panel->connect("draw", callable_mp(this, &EditorInspectorArray::_panel_draw).bind(i)); ae.panel->connect("gui_input", callable_mp(this, &EditorInspectorArray::_panel_gui_input).bind(i)); ae.panel->add_theme_style_override(SNAME("panel"), i % 2 ? odd_style : even_style); elements_vbox->add_child(ae.panel); ae.margin = memnew(MarginContainer); ae.margin->set_mouse_filter(MOUSE_FILTER_PASS); if (is_inside_tree()) { Size2 min_size = get_theme_stylebox(SNAME("Focus"), EditorStringName(EditorStyles))->get_minimum_size(); ae.margin->begin_bulk_theme_override(); ae.margin->add_theme_constant_override("margin_left", min_size.x / 2); ae.margin->add_theme_constant_override("margin_top", min_size.y / 2); ae.margin->add_theme_constant_override("margin_right", min_size.x / 2); ae.margin->add_theme_constant_override("margin_bottom", min_size.y / 2); ae.margin->end_bulk_theme_override(); } ae.panel->add_child(ae.margin); ae.hbox = memnew(HBoxContainer); ae.hbox->set_h_size_flags(SIZE_EXPAND_FILL); ae.hbox->set_v_size_flags(SIZE_EXPAND_FILL); ae.margin->add_child(ae.hbox); // Move button. if (movable) { VBoxContainer *move_vbox = memnew(VBoxContainer); move_vbox->set_v_size_flags(SIZE_EXPAND_FILL); move_vbox->set_alignment(BoxContainer::ALIGNMENT_CENTER); ae.hbox->add_child(move_vbox); if (element_position > 0) { ae.move_up = memnew(Button); ae.move_up->set_icon(get_editor_theme_icon(SNAME("MoveUp"))); ae.move_up->connect("pressed", callable_mp(this, &EditorInspectorArray::_move_element).bind(element_position, element_position - 1)); move_vbox->add_child(ae.move_up); } ae.move_texture_rect = memnew(TextureRect); ae.move_texture_rect->set_stretch_mode(TextureRect::STRETCH_KEEP_CENTERED); ae.move_texture_rect->set_default_cursor_shape(Control::CURSOR_MOVE); if (is_inside_tree()) { ae.move_texture_rect->set_texture(get_editor_theme_icon(SNAME("TripleBar"))); } move_vbox->add_child(ae.move_texture_rect); if (element_position < _get_array_count() - 1) { ae.move_down = memnew(Button); ae.move_down->set_icon(get_editor_theme_icon(SNAME("MoveDown"))); ae.move_down->connect("pressed", callable_mp(this, &EditorInspectorArray::_move_element).bind(element_position, element_position + 2)); move_vbox->add_child(ae.move_down); } } if (numbered) { ae.number = memnew(Label); ae.number->add_theme_font_override("font", numbers_font); ae.number->set_custom_minimum_size(Size2(numbers_min_w, 0)); ae.number->set_horizontal_alignment(HORIZONTAL_ALIGNMENT_RIGHT); ae.number->set_vertical_alignment(VERTICAL_ALIGNMENT_CENTER); ae.number->set_text(itos(element_position)); ae.hbox->add_child(ae.number); } // Right vbox. ae.vbox = memnew(VBoxContainer); ae.vbox->set_h_size_flags(SIZE_EXPAND_FILL); ae.vbox->set_v_size_flags(SIZE_EXPAND_FILL); ae.hbox->add_child(ae.vbox); ae.erase = memnew(Button); ae.erase->set_icon(get_editor_theme_icon(SNAME("Remove"))); ae.erase->set_v_size_flags(SIZE_SHRINK_CENTER); ae.erase->connect("pressed", callable_mp(this, &EditorInspectorArray::_remove_item).bind(element_position)); ae.hbox->add_child(ae.erase); } // Hide/show the add button. add_button->set_visible(page == max_page); // Add paginator if there's more than 1 page. if (max_page > 0) { EditorPaginator *paginator = memnew(EditorPaginator); paginator->update(page, max_page); paginator->connect("page_changed", callable_mp(this, &EditorInspectorArray::_paginator_page_changed)); vbox->add_child(paginator); } } void EditorInspectorArray::_remove_item(int p_index) { _move_element(p_index, -1); } Variant EditorInspectorArray::get_drag_data_fw(const Point2 &p_point, Control *p_from) { if (!movable) { return Variant(); } int index = p_from->get_meta("index"); Dictionary dict; dict["type"] = "property_array_element"; dict["property_array_prefix"] = array_element_prefix; dict["index"] = index; return dict; } void EditorInspectorArray::drop_data_fw(const Point2 &p_point, const Variant &p_data, Control *p_from) { Dictionary dict = p_data; int to_drop = dict["index"]; int drop_position = _drop_position(); if (drop_position < 0) { return; } _move_element(to_drop, begin_array_index + drop_position); } bool EditorInspectorArray::can_drop_data_fw(const Point2 &p_point, const Variant &p_data, Control *p_from) const { if (!movable || read_only) { return false; } // First, update drawing. control_dropping->queue_redraw(); if (p_data.get_type() != Variant::DICTIONARY) { return false; } Dictionary dict = p_data; int drop_position = _drop_position(); if (!dict.has("type") || dict["type"] != "property_array_element" || String(dict["property_array_prefix"]) != array_element_prefix || drop_position < 0) { return false; } // Check in dropping at the given index does indeed move the item. int moved_array_index = (int)dict["index"]; int drop_array_index = begin_array_index + drop_position; return drop_array_index != moved_array_index && drop_array_index - 1 != moved_array_index; } void EditorInspectorArray::_notification(int p_what) { switch (p_what) { case NOTIFICATION_ENTER_TREE: case NOTIFICATION_THEME_CHANGED: { Color color = get_theme_color(SNAME("dark_color_1"), EditorStringName(Editor)); odd_style->set_bg_color(color.darkened(-0.08)); even_style->set_bg_color(color.darkened(0.08)); for (ArrayElement &ae : array_elements) { if (ae.move_texture_rect) { ae.move_texture_rect->set_texture(get_editor_theme_icon(SNAME("TripleBar"))); } if (ae.move_up) { ae.move_up->set_icon(get_editor_theme_icon(SNAME("MoveUp"))); } if (ae.move_down) { ae.move_down->set_icon(get_editor_theme_icon(SNAME("MoveDown"))); } Size2 min_size = get_theme_stylebox(SNAME("Focus"), EditorStringName(EditorStyles))->get_minimum_size(); ae.margin->begin_bulk_theme_override(); ae.margin->add_theme_constant_override("margin_left", min_size.x / 2); ae.margin->add_theme_constant_override("margin_top", min_size.y / 2); ae.margin->add_theme_constant_override("margin_right", min_size.x / 2); ae.margin->add_theme_constant_override("margin_bottom", min_size.y / 2); ae.margin->end_bulk_theme_override(); if (ae.erase) { ae.erase->set_icon(get_editor_theme_icon(SNAME("Remove"))); } } add_button->set_icon(get_editor_theme_icon(SNAME("Add"))); update_minimum_size(); } break; case NOTIFICATION_DRAG_BEGIN: { Dictionary dict = get_viewport()->gui_get_drag_data(); if (dict.has("type") && dict["type"] == "property_array_element" && String(dict["property_array_prefix"]) == array_element_prefix) { dropping = true; control_dropping->queue_redraw(); } } break; case NOTIFICATION_DRAG_END: { if (dropping) { dropping = false; control_dropping->queue_redraw(); } } break; } } void EditorInspectorArray::_bind_methods() { ADD_SIGNAL(MethodInfo("page_change_request")); } void EditorInspectorArray::setup_with_move_element_function(Object *p_object, String p_label, const StringName &p_array_element_prefix, int p_page, const Color &p_bg_color, bool p_foldable, bool p_movable, bool p_numbered, int p_page_length, const String &p_add_item_text) { count_property = ""; mode = MODE_USE_MOVE_ARRAY_ELEMENT_FUNCTION; array_element_prefix = p_array_element_prefix; page = p_page; movable = p_movable; page_length = p_page_length; numbered = p_numbered; EditorInspectorSection::setup(String(p_array_element_prefix) + "_array", p_label, p_object, p_bg_color, p_foldable, 0); _setup(); } void EditorInspectorArray::setup_with_count_property(Object *p_object, String p_label, const StringName &p_count_property, const StringName &p_array_element_prefix, int p_page, const Color &p_bg_color, bool p_foldable, bool p_movable, bool p_numbered, int p_page_length, const String &p_add_item_text, const String &p_swap_method) { count_property = p_count_property; mode = MODE_USE_COUNT_PROPERTY; array_element_prefix = p_array_element_prefix; page = p_page; movable = p_movable; page_length = p_page_length; numbered = p_numbered; swap_method = p_swap_method; add_button->set_text(p_add_item_text); EditorInspectorSection::setup(String(count_property) + "_array", p_label, p_object, p_bg_color, p_foldable, 0); _setup(); } VBoxContainer *EditorInspectorArray::get_vbox(int p_index) { if (p_index >= begin_array_index && p_index < end_array_index) { return array_elements[p_index - begin_array_index].vbox; } else if (p_index < 0) { return vbox; } else { return nullptr; } } EditorInspectorArray::EditorInspectorArray(bool p_read_only) { read_only = p_read_only; set_mouse_filter(Control::MOUSE_FILTER_STOP); odd_style.instantiate(); even_style.instantiate(); rmb_popup = memnew(PopupMenu); rmb_popup->add_item(TTR("Move Up"), OPTION_MOVE_UP); rmb_popup->add_item(TTR("Move Down"), OPTION_MOVE_DOWN); rmb_popup->add_separator(); rmb_popup->add_item(TTR("Insert New Before"), OPTION_NEW_BEFORE); rmb_popup->add_item(TTR("Insert New After"), OPTION_NEW_AFTER); rmb_popup->add_separator(); rmb_popup->add_item(TTR("Remove"), OPTION_REMOVE); rmb_popup->add_separator(); rmb_popup->add_item(TTR("Clear Array"), OPTION_CLEAR_ARRAY); rmb_popup->add_item(TTR("Resize Array..."), OPTION_RESIZE_ARRAY); rmb_popup->connect("id_pressed", callable_mp(this, &EditorInspectorArray::_rmb_popup_id_pressed)); add_child(rmb_popup); elements_vbox = memnew(VBoxContainer); elements_vbox->add_theme_constant_override("separation", 0); vbox->add_child(elements_vbox); add_button = EditorInspector::create_inspector_action_button(TTR("Add Element")); add_button->connect("pressed", callable_mp(this, &EditorInspectorArray::_add_button_pressed)); add_button->set_disabled(read_only); vbox->add_child(add_button); control_dropping = memnew(Control); control_dropping->connect("draw", callable_mp(this, &EditorInspectorArray::_control_dropping_draw)); control_dropping->set_mouse_filter(Control::MOUSE_FILTER_IGNORE); add_child(control_dropping); resize_dialog = memnew(AcceptDialog); resize_dialog->set_title(TTRC("Resize Array")); resize_dialog->add_cancel_button(); resize_dialog->connect("confirmed", callable_mp(this, &EditorInspectorArray::_resize_dialog_confirmed)); add_child(resize_dialog); VBoxContainer *resize_dialog_vbox = memnew(VBoxContainer); resize_dialog->add_child(resize_dialog_vbox); new_size_spin_box = memnew(SpinBox); new_size_spin_box->set_max(16384); new_size_spin_box->connect("value_changed", callable_mp(this, &EditorInspectorArray::_new_size_spin_box_value_changed)); new_size_spin_box->get_line_edit()->connect("text_submitted", callable_mp(this, &EditorInspectorArray::_new_size_spin_box_text_submitted)); new_size_spin_box->set_editable(!read_only); resize_dialog_vbox->add_margin_child(TTRC("New Size:"), new_size_spin_box); vbox->connect("visibility_changed", callable_mp(this, &EditorInspectorArray::_vbox_visibility_changed)); } //////////////////////////////////////////////// //////////////////////////////////////////////// void EditorPaginator::_first_page_button_pressed() { emit_signal("page_changed", 0); } void EditorPaginator::_prev_page_button_pressed() { emit_signal("page_changed", MAX(0, page - 1)); } void EditorPaginator::_page_line_edit_text_submitted(String p_text) { if (p_text.is_valid_int()) { int new_page = p_text.to_int() - 1; new_page = MIN(MAX(0, new_page), max_page); page_line_edit->set_text(Variant(new_page)); emit_signal("page_changed", new_page); } else { page_line_edit->set_text(Variant(page)); } } void EditorPaginator::_next_page_button_pressed() { emit_signal("page_changed", MIN(max_page, page + 1)); } void EditorPaginator::_last_page_button_pressed() { emit_signal("page_changed", max_page); } void EditorPaginator::update(int p_page, int p_max_page) { page = p_page; max_page = p_max_page; // Update buttons. first_page_button->set_disabled(page == 0); prev_page_button->set_disabled(page == 0); next_page_button->set_disabled(page == max_page); last_page_button->set_disabled(page == max_page); // Update page number and page count. page_line_edit->set_text(vformat("%d", page + 1)); page_count_label->set_text(vformat("/ %d", max_page + 1)); } void EditorPaginator::_notification(int p_what) { switch (p_what) { case NOTIFICATION_ENTER_TREE: case NOTIFICATION_THEME_CHANGED: { first_page_button->set_icon(get_editor_theme_icon(SNAME("PageFirst"))); prev_page_button->set_icon(get_editor_theme_icon(SNAME("PagePrevious"))); next_page_button->set_icon(get_editor_theme_icon(SNAME("PageNext"))); last_page_button->set_icon(get_editor_theme_icon(SNAME("PageLast"))); } break; } } void EditorPaginator::_bind_methods() { ADD_SIGNAL(MethodInfo("page_changed", PropertyInfo(Variant::INT, "page"))); } EditorPaginator::EditorPaginator() { set_h_size_flags(SIZE_EXPAND_FILL); set_alignment(ALIGNMENT_CENTER); first_page_button = memnew(Button); first_page_button->set_flat(true); first_page_button->connect("pressed", callable_mp(this, &EditorPaginator::_first_page_button_pressed)); add_child(first_page_button); prev_page_button = memnew(Button); prev_page_button->set_flat(true); prev_page_button->connect("pressed", callable_mp(this, &EditorPaginator::_prev_page_button_pressed)); add_child(prev_page_button); page_line_edit = memnew(LineEdit); page_line_edit->connect("text_submitted", callable_mp(this, &EditorPaginator::_page_line_edit_text_submitted)); page_line_edit->add_theme_constant_override("minimum_character_width", 2); add_child(page_line_edit); page_count_label = memnew(Label); add_child(page_count_label); next_page_button = memnew(Button); next_page_button->set_flat(true); next_page_button->connect("pressed", callable_mp(this, &EditorPaginator::_next_page_button_pressed)); add_child(next_page_button); last_page_button = memnew(Button); last_page_button->set_flat(true); last_page_button->connect("pressed", callable_mp(this, &EditorPaginator::_last_page_button_pressed)); add_child(last_page_button); } //////////////////////////////////////////////// //////////////////////////////////////////////// Ref EditorInspector::inspector_plugins[MAX_PLUGINS]; int EditorInspector::inspector_plugin_count = 0; EditorProperty *EditorInspector::instantiate_property_editor(Object *p_object, const Variant::Type p_type, const String &p_path, PropertyHint p_hint, const String &p_hint_text, const uint32_t p_usage, const bool p_wide) { for (int i = inspector_plugin_count - 1; i >= 0; i--) { inspector_plugins[i]->parse_property(p_object, p_type, p_path, p_hint, p_hint_text, p_usage, p_wide); if (inspector_plugins[i]->added_editors.size()) { for (int j = 1; j < inspector_plugins[i]->added_editors.size(); j++) { //only keep first one memdelete(inspector_plugins[i]->added_editors[j].property_editor); } EditorProperty *prop = Object::cast_to(inspector_plugins[i]->added_editors[0].property_editor); if (prop) { inspector_plugins[i]->added_editors.clear(); return prop; } else { memdelete(inspector_plugins[i]->added_editors[0].property_editor); inspector_plugins[i]->added_editors.clear(); } } } return nullptr; } void EditorInspector::add_inspector_plugin(const Ref &p_plugin) { ERR_FAIL_COND(inspector_plugin_count == MAX_PLUGINS); for (int i = 0; i < inspector_plugin_count; i++) { if (inspector_plugins[i] == p_plugin) { return; //already exists } } inspector_plugins[inspector_plugin_count++] = p_plugin; } void EditorInspector::remove_inspector_plugin(const Ref &p_plugin) { ERR_FAIL_COND(inspector_plugin_count == MAX_PLUGINS); int idx = -1; for (int i = 0; i < inspector_plugin_count; i++) { if (inspector_plugins[i] == p_plugin) { idx = i; break; } } ERR_FAIL_COND_MSG(idx == -1, "Trying to remove nonexistent inspector plugin."); for (int i = idx; i < inspector_plugin_count - 1; i++) { inspector_plugins[i] = inspector_plugins[i + 1]; } inspector_plugins[inspector_plugin_count - 1] = Ref(); inspector_plugin_count--; } void EditorInspector::cleanup_plugins() { for (int i = 0; i < inspector_plugin_count; i++) { inspector_plugins[i].unref(); } inspector_plugin_count = 0; } Button *EditorInspector::create_inspector_action_button(const String &p_text) { Button *button = memnew(Button); button->set_text(p_text); button->set_theme_type_variation(SNAME("InspectorActionButton")); button->set_h_size_flags(SIZE_SHRINK_CENTER); return button; } bool EditorInspector::is_main_editor_inspector() const { return InspectorDock::get_singleton() && InspectorDock::get_inspector_singleton() == this; } String EditorInspector::get_selected_path() const { return property_selected; } void EditorInspector::_parse_added_editors(VBoxContainer *current_vbox, EditorInspectorSection *p_section, Ref ped) { for (const EditorInspectorPlugin::AddedEditor &F : ped->added_editors) { EditorProperty *ep = Object::cast_to(F.property_editor); current_vbox->add_child(F.property_editor); if (ep) { ep->object = object; ep->connect("property_changed", callable_mp(this, &EditorInspector::_property_changed).bind(false)); ep->connect("property_keyed", callable_mp(this, &EditorInspector::_property_keyed)); ep->connect("property_deleted", callable_mp(this, &EditorInspector::_property_deleted), CONNECT_DEFERRED); ep->connect("property_keyed_with_value", callable_mp(this, &EditorInspector::_property_keyed_with_value)); ep->connect("property_checked", callable_mp(this, &EditorInspector::_property_checked)); ep->connect("property_pinned", callable_mp(this, &EditorInspector::_property_pinned)); ep->connect("selected", callable_mp(this, &EditorInspector::_property_selected)); ep->connect("multiple_properties_changed", callable_mp(this, &EditorInspector::_multiple_properties_changed)); ep->connect("resource_selected", callable_mp(this, &EditorInspector::_resource_selected), CONNECT_DEFERRED); ep->connect("object_id_selected", callable_mp(this, &EditorInspector::_object_id_selected), CONNECT_DEFERRED); if (F.properties.size()) { if (F.properties.size() == 1) { //since it's one, associate: ep->property = F.properties[0]; ep->property_path = property_prefix + F.properties[0]; ep->property_usage = 0; } if (!F.label.is_empty()) { ep->set_label(F.label); } for (int i = 0; i < F.properties.size(); i++) { String prop = F.properties[i]; if (!editor_property_map.has(prop)) { editor_property_map[prop] = List(); } editor_property_map[prop].push_back(ep); } } if (p_section) { ep->connect("property_can_revert_changed", callable_mp(p_section, &EditorInspectorSection::property_can_revert_changed)); } ep->set_read_only(read_only); ep->update_property(); ep->_update_pin_flags(); ep->update_editor_property_status(); ep->set_deletable(deletable_properties); ep->update_cache(); } } ped->added_editors.clear(); } bool EditorInspector::_is_property_disabled_by_feature_profile(const StringName &p_property) { Ref profile = EditorFeatureProfileManager::get_singleton()->get_current_profile(); if (profile.is_null()) { return false; } StringName class_name = object->get_class(); while (class_name != StringName()) { if (profile->is_class_property_disabled(class_name, p_property)) { return true; } if (profile->is_class_disabled(class_name)) { //won't see properties of a disabled class return true; } class_name = ClassDB::get_parent_class(class_name); } return false; } void EditorInspector::update_tree() { // Store currently selected and focused elements to restore after the update. // TODO: Can be useful to store more context for the focusable, such as the caret position in LineEdit. StringName current_selected = property_selected; int current_focusable = -1; if (property_focusable != -1) { // Check that focusable is actually focusable. bool restore_focus = false; Control *focused = get_viewport() ? get_viewport()->gui_get_focus_owner() : nullptr; if (focused) { Node *parent = focused->get_parent(); while (parent) { EditorInspector *inspector = Object::cast_to(parent); if (inspector) { restore_focus = inspector == this; // May be owned by another inspector. break; // Exit after the first inspector is found, since there may be nested ones. } parent = parent->get_parent(); } } if (restore_focus) { current_focusable = property_focusable; } } // Only hide plugins if we are not editing any object. // This should be handled outside of the update_tree call anyway (see EditorInspector::edit), but might as well keep it safe. _clear(!object); if (!object) { return; } List> valid_plugins; for (int i = inspector_plugin_count - 1; i >= 0; i--) { //start by last, so lastly added can override newly added if (!inspector_plugins[i]->can_handle(object)) { continue; } valid_plugins.push_back(inspector_plugins[i]); } // Decide if properties should be drawn with the warning color (yellow), // or if the whole object should be considered read-only. bool draw_warning = false; bool all_read_only = false; if (is_inside_tree()) { if (object->has_method("_is_read_only")) { all_read_only = object->call("_is_read_only"); } Node *nod = Object::cast_to(object); Node *es = EditorNode::get_singleton()->get_edited_scene(); if (nod && es != nod && nod->get_owner() != es) { // Draw in warning color edited nodes that are not in the currently edited scene, // as changes may be lost in the future. draw_warning = true; } else { if (!all_read_only) { Resource *res = Object::cast_to(object); if (res) { all_read_only = EditorNode::get_singleton()->is_resource_read_only(res); } } } } String filter = search_box ? search_box->get_text() : ""; String group; String group_base; String subgroup; String subgroup_base; int section_depth = 0; VBoxContainer *category_vbox = nullptr; List plist; object->get_property_list(&plist, true); HashMap> vbox_per_path; HashMap editor_inspector_array_per_prefix; Color sscolor = get_theme_color(SNAME("prop_subsection"), EditorStringName(Editor)); // Get the lists of editors to add the beginning. for (Ref &ped : valid_plugins) { ped->parse_begin(object); _parse_added_editors(main_vbox, nullptr, ped); } StringName doc_name; // Get the lists of editors for properties. for (List::Element *E_property = plist.front(); E_property; E_property = E_property->next()) { PropertyInfo &p = E_property->get(); if (p.usage & PROPERTY_USAGE_SUBGROUP) { // Setup a property sub-group. subgroup = p.name; Vector hint_parts = p.hint_string.split(","); subgroup_base = hint_parts[0]; if (hint_parts.size() > 1) { section_depth = hint_parts[1].to_int(); } else { section_depth = 0; } continue; } else if (p.usage & PROPERTY_USAGE_GROUP) { // Setup a property group. group = p.name; Vector hint_parts = p.hint_string.split(","); group_base = hint_parts[0]; if (hint_parts.size() > 1) { section_depth = hint_parts[1].to_int(); } else { section_depth = 0; } subgroup = ""; subgroup_base = ""; continue; } else if (p.usage & PROPERTY_USAGE_CATEGORY) { // Setup a property category. group = ""; group_base = ""; subgroup = ""; subgroup_base = ""; section_depth = 0; if (!show_categories) { continue; } // Hide the "MultiNodeEdit" category for MultiNodeEdit. if (Object::cast_to(object) && p.name == "MultiNodeEdit") { continue; } // Iterate over remaining properties. If no properties in category, skip the category. List::Element *N = E_property->next(); bool valid = true; while (N) { if (!N->get().name.begins_with("metadata/_") && N->get().usage & PROPERTY_USAGE_EDITOR && (!filter.is_empty() || !restrict_to_basic || (N->get().usage & PROPERTY_USAGE_EDITOR_BASIC_SETTING))) { break; } if (N->get().usage & PROPERTY_USAGE_CATEGORY) { valid = false; break; } N = N->next(); } if (!valid) { continue; // Empty, ignore it. } // Create an EditorInspectorCategory and add it to the inspector. EditorInspectorCategory *category = memnew(EditorInspectorCategory); main_vbox->add_child(category); category_vbox = nullptr; //reset // `hint_script` should contain a native class name or a script path. // Otherwise the category was probably added via `@export_category` or `_get_property_list()`. if (p.hint_string.is_empty()) { category->label = p.name; category->set_tooltip_text(p.name); continue; // Do not add an icon, do not change the current class (`doc_name`). } String type = p.name; String label = p.name; doc_name = p.name; // Use category's owner script to update some of its information. if (!EditorNode::get_editor_data().is_type_recognized(type) && p.hint_string.length() && ResourceLoader::exists(p.hint_string)) { Ref