Propery selecotor cahnge UI and scope variable

Update VisualScriptPropertySelector user interface.
Issues Icons not showing
This commit is contained in:
David Cambré 2021-11-10 20:53:28 +01:00
parent 1aa3c8419b
commit 7f2814c6cf
3 changed files with 767 additions and 112 deletions

View file

@ -1926,7 +1926,7 @@ void VisualScriptEditor::_generic_search(String p_base_type, Vector2 pos, bool n
port_action_pos = graph->get_viewport()->get_mouse_position() - graph->get_global_position();
}
new_connect_node_select->select_from_visual_script(p_base_type, false, false); // neither connecting nor reset text
new_connect_node_select->select_from_script(script, "", false, false); // neither connecting nor reset text
// Ensure that the dialog fits inside the graph.
Size2 bounds = graph->get_global_position() + graph->get_size() - new_connect_node_select->get_size();

View file

@ -41,6 +41,7 @@
#include "modules/visual_script/visual_script_nodes.h"
#include "scene/main/node.h"
#include "scene/main/window.h"
#include <editor/editor_feature_profile.cpp>
void VisualScriptPropertySelector::_text_changed(const String &p_newtext) {
_update_search();
@ -55,20 +56,20 @@ void VisualScriptPropertySelector::_sbox_input(const Ref<InputEvent> &p_ie) {
case KEY_DOWN:
case KEY_PAGEUP:
case KEY_PAGEDOWN: {
search_options->gui_input(k);
results_tree->gui_input(k);
search_box->accept_event();
TreeItem *root = search_options->get_root();
TreeItem *root = results_tree->get_root();
if (!root->get_first_child()) {
break;
}
TreeItem *current = search_options->get_selected();
TreeItem *current = results_tree->get_selected();
TreeItem *item = search_options->get_next_selected(root);
TreeItem *item = results_tree->get_next_selected(root);
while (item) {
item->deselect(0);
item = search_options->get_next_selected(item);
item = results_tree->get_next_selected(item);
}
current->select(0);
@ -80,65 +81,135 @@ void VisualScriptPropertySelector::_sbox_input(const Ref<InputEvent> &p_ie) {
}
}
void VisualScriptPropertySelector::_update_icons() {
search_box->set_right_icon(vbox->get_theme_icon(SNAME("Search"), SNAME("EditorIcons")));
search_box->set_clear_button_enabled(true);
search_box->add_theme_icon_override("right_icon", vbox->get_theme_icon(SNAME("Search"), SNAME("EditorIcons")));
case_sensitive_button->set_icon(vbox->get_theme_icon(SNAME("MatchCase"), SNAME("EditorIcons")));
hierarchy_button->set_icon(vbox->get_theme_icon(SNAME("ClassList"), SNAME("EditorIcons")));
if (is_visible()) {
_update_search();
}
}
void VisualScriptPropertySelector::_update_search() {
int search_flags = filter_combo->get_selected_id();
int scope_flags = scope_combo->get_selected_id();
if (case_sensitive_button->is_pressed()) {
search_flags |= SEARCH_CASE_SENSITIVE;
}
if (hierarchy_button->is_pressed()) {
search_flags |= SEARCH_SHOW_HIERARCHY;
}
// const String search_text = search_box->get_text().replace(" ", "_"); !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
const String term = search_box->get_text();
// ADJUSTS Scope depending on keywords here.
//search = Ref<Runner>(memnew(Runner(results_tree, results_tree, term, search_flags)));
search = Ref<Runner>(memnew(Runner(results_tree, results_tree, term, search_flags, scope_flags)));
set_process(true);
//_update_search_old();
}
void VisualScriptPropertySelector::_update_search_old() {
set_title(TTR("Search VisualScript"));
search_options->clear();
results_tree->clear();
help_bit->set_text("");
TreeItem *root = search_options->create_item();
bool found = false;
TreeItem *root = results_tree->create_item();
// Allow using spaces in place of underscores in the search string (makes the search more fault-tolerant).
const String search_text = search_box->get_text().replace(" ", "_");
StringName base = base_type;
List<StringName> base_list;
if (!script.is_null()) {
base_list.push_back(script->get_path());
}
// ClassDB::get_inheriters_from_class(); !!!!!!!!!
// // To get all inheritors / successors
// To get unfilterd all classes list check
// // bool EditorHelpSearch::Runner::_phase_match_classes_init() {
// // iterator_doc = EditorHelp::get_doc_data()->class_list.front();
while (base) {
base_list.push_back(base);
base = ClassDB::get_parent_class_nocheck(base);
base = ClassDB::get_parent_class(base);
}
TreeItem *category = nullptr;
bool found = false;
Ref<Texture2D> type_icons[Variant::VARIANT_MAX] = {
vbox->get_theme_icon(SNAME("Variant"), SNAME("EditorIcons")),
vbox->get_theme_icon(SNAME("bool"), SNAME("EditorIcons")),
vbox->get_theme_icon(SNAME("int"), SNAME("EditorIcons")),
vbox->get_theme_icon(SNAME("float"), SNAME("EditorIcons")),
vbox->get_theme_icon(SNAME("String"), SNAME("EditorIcons")),
vbox->get_theme_icon(SNAME("Vector2"), SNAME("EditorIcons")),
vbox->get_theme_icon(SNAME("Vector2i"), SNAME("EditorIcons")),
vbox->get_theme_icon(SNAME("Rect2"), SNAME("EditorIcons")),
vbox->get_theme_icon(SNAME("Rect2i"), SNAME("EditorIcons")),
vbox->get_theme_icon(SNAME("Vector3"), SNAME("EditorIcons")),
vbox->get_theme_icon(SNAME("Vector3i"), SNAME("EditorIcons")),
vbox->get_theme_icon(SNAME("Transform2D"), SNAME("EditorIcons")),
vbox->get_theme_icon(SNAME("Plane"), SNAME("EditorIcons")),
vbox->get_theme_icon(SNAME("Quaternion"), SNAME("EditorIcons")),
vbox->get_theme_icon(SNAME("AABB"), SNAME("EditorIcons")),
vbox->get_theme_icon(SNAME("Basis"), SNAME("EditorIcons")),
vbox->get_theme_icon(SNAME("Transform3D"), SNAME("EditorIcons")),
vbox->get_theme_icon(SNAME("Color"), SNAME("EditorIcons")),
vbox->get_theme_icon(SNAME("StringName"), SNAME("EditorIcons")),
vbox->get_theme_icon(SNAME("NodePath"), SNAME("EditorIcons")),
vbox->get_theme_icon(SNAME("RID"), SNAME("EditorIcons")),
vbox->get_theme_icon(SNAME("MiniObject"), SNAME("EditorIcons")),
vbox->get_theme_icon(SNAME("Callable"), SNAME("EditorIcons")),
vbox->get_theme_icon(SNAME("Signal"), SNAME("EditorIcons")),
vbox->get_theme_icon(SNAME("Dictionary"), SNAME("EditorIcons")),
vbox->get_theme_icon(SNAME("Array"), SNAME("EditorIcons")),
vbox->get_theme_icon(SNAME("PackedByteArray"), SNAME("EditorIcons")),
vbox->get_theme_icon(SNAME("PackedInt32Array"), SNAME("EditorIcons")),
vbox->get_theme_icon(SNAME("PackedInt64Array"), SNAME("EditorIcons")),
vbox->get_theme_icon(SNAME("PackedFloat32Array"), SNAME("EditorIcons")),
vbox->get_theme_icon(SNAME("PackedFloat64Array"), SNAME("EditorIcons")),
vbox->get_theme_icon(SNAME("PackedStringArray"), SNAME("EditorIcons")),
vbox->get_theme_icon(SNAME("PackedVector2Array"), SNAME("EditorIcons")),
vbox->get_theme_icon(SNAME("PackedVector3Array"), SNAME("EditorIcons")),
vbox->get_theme_icon(SNAME("PackedColorArray"), SNAME("EditorIcons"))
};
for (const StringName &E : base_list) {
List<MethodInfo> methods;
List<PropertyInfo> props;
TreeItem *category = nullptr;
Ref<Texture2D> type_icons[Variant::VARIANT_MAX] = {
vbc->get_theme_icon(SNAME("Variant"), SNAME("EditorIcons")),
vbc->get_theme_icon(SNAME("bool"), SNAME("EditorIcons")),
vbc->get_theme_icon(SNAME("int"), SNAME("EditorIcons")),
vbc->get_theme_icon(SNAME("float"), SNAME("EditorIcons")),
vbc->get_theme_icon(SNAME("String"), SNAME("EditorIcons")),
vbc->get_theme_icon(SNAME("Vector2"), SNAME("EditorIcons")),
vbc->get_theme_icon(SNAME("Vector2i"), SNAME("EditorIcons")),
vbc->get_theme_icon(SNAME("Rect2"), SNAME("EditorIcons")),
vbc->get_theme_icon(SNAME("Rect2i"), SNAME("EditorIcons")),
vbc->get_theme_icon(SNAME("Vector3"), SNAME("EditorIcons")),
vbc->get_theme_icon(SNAME("Vector3i"), SNAME("EditorIcons")),
vbc->get_theme_icon(SNAME("Transform2D"), SNAME("EditorIcons")),
vbc->get_theme_icon(SNAME("Plane"), SNAME("EditorIcons")),
vbc->get_theme_icon(SNAME("Quaternion"), SNAME("EditorIcons")),
vbc->get_theme_icon(SNAME("AABB"), SNAME("EditorIcons")),
vbc->get_theme_icon(SNAME("Basis"), SNAME("EditorIcons")),
vbc->get_theme_icon(SNAME("Transform3D"), SNAME("EditorIcons")),
vbc->get_theme_icon(SNAME("Color"), SNAME("EditorIcons")),
vbc->get_theme_icon(SNAME("StringName"), SNAME("EditorIcons")),
vbc->get_theme_icon(SNAME("NodePath"), SNAME("EditorIcons")),
vbc->get_theme_icon(SNAME("RID"), SNAME("EditorIcons")),
vbc->get_theme_icon(SNAME("MiniObject"), SNAME("EditorIcons")),
vbc->get_theme_icon(SNAME("Callable"), SNAME("EditorIcons")),
vbc->get_theme_icon(SNAME("Signal"), SNAME("EditorIcons")),
vbc->get_theme_icon(SNAME("Dictionary"), SNAME("EditorIcons")),
vbc->get_theme_icon(SNAME("Array"), SNAME("EditorIcons")),
vbc->get_theme_icon(SNAME("PackedByteArray"), SNAME("EditorIcons")),
vbc->get_theme_icon(SNAME("PackedInt32Array"), SNAME("EditorIcons")),
vbc->get_theme_icon(SNAME("PackedInt64Array"), SNAME("EditorIcons")),
vbc->get_theme_icon(SNAME("PackedFloat32Array"), SNAME("EditorIcons")),
vbc->get_theme_icon(SNAME("PackedFloat64Array"), SNAME("EditorIcons")),
vbc->get_theme_icon(SNAME("PackedStringArray"), SNAME("EditorIcons")),
vbc->get_theme_icon(SNAME("PackedVector2Array"), SNAME("EditorIcons")),
vbc->get_theme_icon(SNAME("PackedVector3Array"), SNAME("EditorIcons")),
vbc->get_theme_icon(SNAME("PackedColorArray"), SNAME("EditorIcons"))
};
if (instance) {
print_error("select from instance needs to tested or removed"); // Debugging !! remove line befor squashing PR !
instance->get_property_list(&props, true);
instance->get_method_list(&methods);
} else if (type != Variant::NIL) {
Variant v;
Callable::CallError ce;
Variant::construct(type, v, nullptr, 0, ce);
v.get_property_list(&props);
v.get_method_list(&methods);
} else if (ClassDB::class_exists(E)) {
ClassDB::get_method_list(E, &methods, true, true);
ClassDB::get_property_list(E, &props, true);
} else {
Object *obj = ObjectDB::get_instance(script->get_instance_id());
if (Object::cast_to<Script>(obj)) {
Object::cast_to<Script>(obj)->get_script_property_list(&props);
Object::cast_to<Script>(obj)->get_script_method_list(&methods);
}
}
{
String b = String(E);
category = search_options->create_item(root);
category = results_tree->create_item(root);
if (category) {
category->set_text(0, b.replace_first("*", ""));
category->set_selectable(0, false);
@ -149,16 +220,6 @@ void VisualScriptPropertySelector::_update_search() {
}
}
if (properties || seq_connect) {
if (instance) {
instance->get_property_list(&props, true);
} else {
Object *obj = ObjectDB::get_instance(script);
if (Object::cast_to<Script>(obj)) {
Object::cast_to<Script>(obj)->get_script_property_list(&props);
} else {
ClassDB::get_property_list(E, &props, true);
}
}
for (const PropertyInfo &F : props) {
if (!(F.usage & PROPERTY_USAGE_EDITOR) && !(F.usage & PROPERTY_USAGE_SCRIPT_VARIABLE)) {
continue;
@ -176,7 +237,7 @@ void VisualScriptPropertySelector::_update_search() {
String input = search_box->get_text().capitalize();
if (input == String() || get_text_raw.findn(input) != -1 || get_text.findn(input) != -1) {
TreeItem *item = search_options->create_item(category ? category : root);
TreeItem *item = results_tree->create_item(category ? category : root);
item->set_text(0, get_text);
item->set_metadata(0, F.name);
item->set_icon(0, type_icons[F.type]);
@ -189,7 +250,7 @@ void VisualScriptPropertySelector::_update_search() {
}
if (input == String() || set_text_raw.findn(input) != -1 || set_text.findn(input) != -1) {
TreeItem *item = search_options->create_item(category ? category : root);
TreeItem *item = results_tree->create_item(category ? category : root);
item->set_text(0, set_text);
item->set_metadata(0, F.name);
item->set_icon(0, type_icons[F.type]);
@ -201,21 +262,6 @@ void VisualScriptPropertySelector::_update_search() {
}
}
}
{
if (type != Variant::NIL) {
Variant v;
Callable::CallError ce;
Variant::construct(type, v, nullptr, 0, ce);
v.get_method_list(&methods);
} else {
Object *obj = ObjectDB::get_instance(script);
if (Object::cast_to<Script>(obj)) {
Object::cast_to<Script>(obj)->get_script_method_list(&methods);
}
ClassDB::get_method_list(E, &methods, true, true);
}
}
for (List<MethodInfo>::Element *M = methods.front(); M; M = M->next()) {
String name = M->get().name.get_slice(":", 0);
if (name.begins_with("_") && !(M->get().flags & METHOD_FLAG_VIRTUAL)) {
@ -259,9 +305,9 @@ void VisualScriptPropertySelector::_update_search() {
continue;
}
TreeItem *item = search_options->create_item(category ? category : root);
TreeItem *item = results_tree->create_item(category ? category : root);
item->set_text(0, desc);
item->set_icon(0, vbc->get_theme_icon(SNAME("MemberMethod"), SNAME("EditorIcons")));
item->set_icon(0, vbox->get_theme_icon(SNAME("MemberMethod"), SNAME("EditorIcons")));
item->set_metadata(0, name);
item->set_selectable(0, true);
@ -312,7 +358,7 @@ void VisualScriptPropertySelector::_update_search() {
get_visual_node_names("", Set<String>(), found, root, search_box);
}
TreeItem *selected_item = search_options->search_item_text(search_box->get_text());
TreeItem *selected_item = results_tree->search_item_text(search_box->get_text());
if (!found && selected_item != nullptr) {
selected_item->select(0);
found = true;
@ -321,11 +367,23 @@ void VisualScriptPropertySelector::_update_search() {
get_ok_button()->set_disabled(root->get_first_child() == nullptr);
}
void VisualScriptPropertySelector::_search_box_text_changed(const String &p_text) {
_update_search();
}
void VisualScriptPropertySelector::_filter_combo_item_selected(int p_option) {
_update_search();
}
void VisualScriptPropertySelector::_scope_combo_item_selected(int p_option) {
_update_search();
}
void VisualScriptPropertySelector::create_visualscript_item(const String &name, TreeItem *const root, const String &search_input, const String &text) {
if (search_input == String() || text.findn(search_input) != -1) {
TreeItem *item = search_options->create_item(root);
TreeItem *item = results_tree->create_item(root);
item->set_text(0, text);
item->set_icon(0, vbc->get_theme_icon(SNAME("VisualScript"), SNAME("EditorIcons")));
item->set_icon(0, vbox->get_theme_icon(SNAME("VisualScript"), SNAME("EditorIcons")));
item->set_metadata(0, name);
item->set_metadata(1, "action");
item->set_selectable(0, true);
@ -376,7 +434,7 @@ void VisualScriptPropertySelector::get_visual_node_names(const String &root_filt
continue;
}
TreeItem *item = search_options->create_item(root);
TreeItem *item = results_tree->create_item(root);
Ref<VisualScriptNode> vnode = VisualScriptLanguage::singleton->create_node_from_name(E);
Ref<VisualScriptOperator> vnode_operator = vnode;
String type_name;
@ -409,7 +467,7 @@ void VisualScriptPropertySelector::get_visual_node_names(const String &root_filt
}
item->set_text(0, type_name + String("").join(desc));
item->set_icon(0, vbc->get_theme_icon(SNAME("VisualScript"), SNAME("EditorIcons")));
item->set_icon(0, vbox->get_theme_icon(SNAME("VisualScript"), SNAME("EditorIcons")));
item->set_selectable(0, true);
item->set_metadata(0, E);
item->set_selectable(0, true);
@ -421,7 +479,7 @@ void VisualScriptPropertySelector::get_visual_node_names(const String &root_filt
}
void VisualScriptPropertySelector::_confirmed() {
TreeItem *ti = search_options->get_selected();
TreeItem *ti = results_tree->get_selected();
if (!ti) {
return;
}
@ -432,7 +490,7 @@ void VisualScriptPropertySelector::_confirmed() {
void VisualScriptPropertySelector::_item_selected() {
help_bit->set_text("");
TreeItem *item = search_options->get_selected();
TreeItem *item = results_tree->get_selected();
if (!item) {
return;
}
@ -533,8 +591,37 @@ void VisualScriptPropertySelector::_hide_requested() {
}
void VisualScriptPropertySelector::_notification(int p_what) {
if (p_what == NOTIFICATION_ENTER_TREE) {
connect("confirmed", callable_mp(this, &VisualScriptPropertySelector::_confirmed));
switch (p_what) {
case EditorSettings::NOTIFICATION_EDITOR_SETTINGS_CHANGED: {
_update_icons();
} break;
case NOTIFICATION_ENTER_TREE: {
connect("confirmed", callable_mp(this, &VisualScriptPropertySelector::_confirmed));
_update_icons();
} break;
case NOTIFICATION_PROCESS: {
// Update background search.
if (search.is_valid()) {
if (search->work()) {
// Search done.
// Only point to the match if it's a new search, and not just reopening a old one.
//if (!old_search) {
// results_tree->ensure_cursor_is_visible();
//} else {
// old_search = false;
//}
get_ok_button()->set_disabled(!results_tree->get_selected());
search = Ref<Runner>();
set_process(false);
}
} else {
set_process(false);
}
} break;
}
}
@ -590,7 +677,7 @@ void VisualScriptPropertySelector::select_from_script(const Ref<Script> &p_scrip
base_type = p_script->get_instance_base_type();
selected = p_current;
type = Variant::NIL;
script = p_script->get_instance_id();
script = p_script;
properties = true;
visual_script_generic = false;
instance = nullptr;
@ -705,29 +792,486 @@ void VisualScriptPropertySelector::_bind_methods() {
}
VisualScriptPropertySelector::VisualScriptPropertySelector() {
vbc = memnew(VBoxContainer);
add_child(vbc);
//set_child_rect(vbc);
search_box = memnew(LineEdit);
vbc->add_margin_child(TTR("Search:"), search_box);
search_box->connect("text_changed", callable_mp(this, &VisualScriptPropertySelector::_text_changed));
search_box->connect("gui_input", callable_mp(this, &VisualScriptPropertySelector::_sbox_input));
search_options = memnew(Tree);
vbc->add_margin_child(TTR("Matches:"), search_options, true);
get_ok_button()->set_text(TTR("Open"));
get_ok_button()->set_disabled(true);
register_text_enter(search_box);
set_hide_on_ok(false);
search_options->connect("item_activated", callable_mp(this, &VisualScriptPropertySelector::_confirmed));
search_options->connect("cell_selected", callable_mp(this, &VisualScriptPropertySelector::_item_selected));
search_options->set_hide_root(true);
search_options->set_hide_folding(true);
virtuals_only = false;
seq_connect = false;
vbox = memnew(VBoxContainer);
add_child(vbox);
// Create the search box and filter controls (at the top).
HBoxContainer *hbox = memnew(HBoxContainer);
vbox->add_margin_child(TTR("Search:"), hbox);
search_box = memnew(LineEdit);
search_box->set_custom_minimum_size(Size2(200, 0) * EDSCALE);
search_box->set_h_size_flags(Control::SIZE_EXPAND_FILL);
search_box->connect("text_changed", callable_mp(this, &VisualScriptPropertySelector::_text_changed));
search_box->connect("gui_input", callable_mp(this, &VisualScriptPropertySelector::_sbox_input));
register_text_enter(search_box);
hbox->add_child(search_box);
case_sensitive_button = memnew(Button);
// case_sensitive_button->set_flat(true); comented until update icon is working
case_sensitive_button->set_tooltip(TTR("Case Sensitive"));
case_sensitive_button->connect("pressed", callable_mp(this, &VisualScriptPropertySelector::_update_search));
case_sensitive_button->set_toggle_mode(true);
case_sensitive_button->set_focus_mode(Control::FOCUS_NONE);
hbox->add_child(case_sensitive_button);
hierarchy_button = memnew(Button);
// hierarchy_button->set_flat(true); comented until update icon is working
hierarchy_button->set_tooltip(TTR("Show Hierarchy"));
hierarchy_button->connect("pressed", callable_mp(this, &VisualScriptPropertySelector::_update_search));
hierarchy_button->set_toggle_mode(true);
hierarchy_button->set_pressed(true);
hierarchy_button->set_focus_mode(Control::FOCUS_NONE);
hbox->add_child(hierarchy_button);
filter_combo = memnew(OptionButton);
filter_combo->set_custom_minimum_size(Size2(200, 0) * EDSCALE);
filter_combo->set_stretch_ratio(0); // Fixed width.
filter_combo->add_item(TTR("Display All"), SEARCH_ALL);
filter_combo->add_separator();
filter_combo->add_item(TTR("Classes Only"), SEARCH_CLASSES);
filter_combo->add_item(TTR("Constructors Only"), SEARCH_CONSTRUCTORS);
filter_combo->add_item(TTR("Methods Only"), SEARCH_METHODS);
filter_combo->add_item(TTR("Operators Only"), SEARCH_OPERATORS);
filter_combo->add_item(TTR("Signals Only"), SEARCH_SIGNALS);
filter_combo->add_item(TTR("Constants Only"), SEARCH_CONSTANTS);
filter_combo->add_item(TTR("Properties Only"), SEARCH_PROPERTIES);
filter_combo->add_item(TTR("Theme Properties Only"), SEARCH_THEME_ITEMS);
filter_combo->connect("item_selected", callable_mp(this, &VisualScriptPropertySelector::_filter_combo_item_selected));
hbox->add_child(filter_combo);
scope_combo = memnew(OptionButton);
scope_combo->set_custom_minimum_size(Size2(200, 0) * EDSCALE);
scope_combo->set_stretch_ratio(0); // Fixed width.
scope_combo->add_item(TTR("Search All"), SCOPE_ALL);
scope_combo->add_separator();
scope_combo->add_item(TTR("Search Base"), SCOPE_BASE);
scope_combo->add_item(TTR("Search Inheriters"), SCOPE_INHERITERS);
scope_combo->add_item(TTR("Search Unrelated"), SCOPE_UNRELATED);
scope_combo->connect("item_selected", callable_mp(this, &VisualScriptPropertySelector::_scope_combo_item_selected));
hbox->add_child(scope_combo);
results_tree = memnew(Tree);
results_tree->set_v_size_flags(Control::SIZE_EXPAND_FILL);
results_tree->connect("item_activated", callable_mp(this, &VisualScriptPropertySelector::_confirmed));
results_tree->connect("cell_selected", callable_mp(this, &VisualScriptPropertySelector::_item_selected));
results_tree->set_hide_root(true);
results_tree->set_hide_folding(true);
results_tree->set_columns(3);
results_tree->set_column_expand(1, false);
results_tree->set_column_expand(2, false);
vbox->add_margin_child(TTR("Matches:"), results_tree, true);
help_bit = memnew(EditorHelpBit);
vbc->add_margin_child(TTR("Description:"), help_bit);
vbox->add_margin_child(TTR("Description:"), help_bit);
help_bit->connect("request_hide", callable_mp(this, &VisualScriptPropertySelector::_hide_requested));
search_options->set_columns(3);
search_options->set_column_expand(1, false);
search_options->set_column_expand(2, false);
get_ok_button()->set_text(TTR("Open"));
get_ok_button()->set_disabled(true);
set_hide_on_ok(false);
}
bool VisualScriptPropertySelector::Runner::_is_class_disabled_by_feature_profile(const StringName &p_class) {
Ref<EditorFeatureProfile> profile = EditorFeatureProfileManager::get_singleton()->get_current_profile();
if (profile.is_null()) {
return false;
}
StringName class_name = p_class;
while (class_name != StringName()) {
if (!ClassDB::class_exists(class_name)) {
return false;
}
if (profile->is_class_disabled(class_name)) {
return true;
}
class_name = ClassDB::get_parent_class(class_name);
}
return false;
}
bool VisualScriptPropertySelector::Runner::_slice() {
bool phase_done = false;
switch (phase) {
case PHASE_MATCH_CLASSES_INIT:
phase_done = _phase_match_classes_init();
break;
case PHASE_MATCH_CLASSES:
phase_done = _phase_match_classes();
break;
case PHASE_CLASS_ITEMS_INIT:
phase_done = _phase_class_items_init();
break;
case PHASE_CLASS_ITEMS:
phase_done = _phase_class_items();
break;
case PHASE_MEMBER_ITEMS_INIT:
phase_done = _phase_member_items_init();
break;
case PHASE_MEMBER_ITEMS:
phase_done = _phase_member_items();
break;
case PHASE_SELECT_MATCH:
phase_done = _phase_select_match();
break;
case PHASE_MAX:
return true;
default:
WARN_PRINT("Invalid or unhandled phase in EditorHelpSearch::Runner, aborting search.");
return true;
};
if (phase_done) {
phase++;
}
return false;
}
bool VisualScriptPropertySelector::Runner::_phase_match_classes_init() {
iterator_doc = EditorHelp::get_doc_data()->class_list.front();
matches.clear();
matched_item = nullptr;
match_highest_score = 0;
return true;
}
bool VisualScriptPropertySelector::Runner::_phase_match_classes() {
DocData::ClassDoc &class_doc = iterator_doc->value();
if (!_is_class_disabled_by_feature_profile(class_doc.name)) {
matches[class_doc.name] = ClassMatch();
ClassMatch &match = matches[class_doc.name];
match.doc = &class_doc;
// Match scope /temp to remove build errros
if (scope_flags & SCOPE_ALL) {
match.name = term == "" || _match_string(term, class_doc.name);
}
// Match class name.
if (search_flags & SEARCH_CLASSES) {
match.name = term == "" || _match_string(term, class_doc.name);
}
// Match members if the term is long enough.
if (term.length() > 1) {
if (search_flags & SEARCH_CONSTRUCTORS) {
for (int i = 0; i < class_doc.constructors.size(); i++) {
String method_name = (search_flags & SEARCH_CASE_SENSITIVE) ? class_doc.constructors[i].name : class_doc.constructors[i].name.to_lower();
if (method_name.find(term) > -1 ||
(term.begins_with(".") && method_name.begins_with(term.substr(1))) ||
(term.ends_with("(") && method_name.ends_with(term.left(term.length() - 1).strip_edges())) ||
(term.begins_with(".") && term.ends_with("(") && method_name == term.substr(1, term.length() - 2).strip_edges())) {
match.constructors.push_back(const_cast<DocData::MethodDoc *>(&class_doc.constructors[i]));
}
}
}
if (search_flags & SEARCH_METHODS) {
for (int i = 0; i < class_doc.methods.size(); i++) {
String method_name = (search_flags & SEARCH_CASE_SENSITIVE) ? class_doc.methods[i].name : class_doc.methods[i].name.to_lower();
if (method_name.find(term) > -1 ||
(term.begins_with(".") && method_name.begins_with(term.substr(1))) ||
(term.ends_with("(") && method_name.ends_with(term.left(term.length() - 1).strip_edges())) ||
(term.begins_with(".") && term.ends_with("(") && method_name == term.substr(1, term.length() - 2).strip_edges())) {
match.methods.push_back(const_cast<DocData::MethodDoc *>(&class_doc.methods[i]));
}
}
}
if (search_flags & SEARCH_OPERATORS) {
for (int i = 0; i < class_doc.operators.size(); i++) {
String method_name = (search_flags & SEARCH_CASE_SENSITIVE) ? class_doc.operators[i].name : class_doc.operators[i].name.to_lower();
if (method_name.find(term) > -1 ||
(term.begins_with(".") && method_name.begins_with(term.substr(1))) ||
(term.ends_with("(") && method_name.ends_with(term.left(term.length() - 1).strip_edges())) ||
(term.begins_with(".") && term.ends_with("(") && method_name == term.substr(1, term.length() - 2).strip_edges())) {
match.operators.push_back(const_cast<DocData::MethodDoc *>(&class_doc.operators[i]));
}
}
}
if (search_flags & SEARCH_SIGNALS) {
for (int i = 0; i < class_doc.signals.size(); i++) {
if (_match_string(term, class_doc.signals[i].name)) {
match.signals.push_back(const_cast<DocData::MethodDoc *>(&class_doc.signals[i]));
}
}
}
if (search_flags & SEARCH_CONSTANTS) {
for (int i = 0; i < class_doc.constants.size(); i++) {
if (_match_string(term, class_doc.constants[i].name)) {
match.constants.push_back(const_cast<DocData::ConstantDoc *>(&class_doc.constants[i]));
}
}
}
if (search_flags & SEARCH_PROPERTIES) {
for (int i = 0; i < class_doc.properties.size(); i++) {
if (_match_string(term, class_doc.properties[i].name) || _match_string(term, class_doc.properties[i].getter) || _match_string(term, class_doc.properties[i].setter)) {
match.properties.push_back(const_cast<DocData::PropertyDoc *>(&class_doc.properties[i]));
}
}
}
if (search_flags & SEARCH_THEME_ITEMS) {
for (int i = 0; i < class_doc.theme_properties.size(); i++) {
if (_match_string(term, class_doc.theme_properties[i].name)) {
match.theme_properties.push_back(const_cast<DocData::ThemeItemDoc *>(&class_doc.theme_properties[i]));
}
}
}
}
}
iterator_doc = iterator_doc->next();
return !iterator_doc;
}
bool VisualScriptPropertySelector::Runner::_phase_class_items_init() {
iterator_match = matches.front();
results_tree->clear();
root_item = results_tree->create_item();
class_items.clear();
return true;
}
bool VisualScriptPropertySelector::Runner::_phase_class_items() {
ClassMatch &match = iterator_match->value();
if (search_flags & SEARCH_SHOW_HIERARCHY) {
if (match.required()) {
_create_class_hierarchy(match);
}
} else {
if (match.name) {
_create_class_item(root_item, match.doc, false);
}
}
iterator_match = iterator_match->next();
return !iterator_match;
}
bool VisualScriptPropertySelector::Runner::_phase_member_items_init() {
iterator_match = matches.front();
return true;
}
bool VisualScriptPropertySelector::Runner::_phase_member_items() {
ClassMatch &match = iterator_match->value();
TreeItem *parent = (search_flags & SEARCH_SHOW_HIERARCHY) ? class_items[match.doc->name] : root_item;
bool constructor_created = false;
for (int i = 0; i < match.methods.size(); i++) {
String text = match.methods[i]->name;
if (!constructor_created) {
if (match.doc->name == match.methods[i]->name) {
text += " " + TTR("(constructors)");
constructor_created = true;
}
} else {
if (match.doc->name == match.methods[i]->name) {
continue;
}
}
_create_method_item(parent, match.doc, text, match.methods[i]);
}
for (int i = 0; i < match.signals.size(); i++) {
_create_signal_item(parent, match.doc, match.signals[i]);
}
for (int i = 0; i < match.constants.size(); i++) {
_create_constant_item(parent, match.doc, match.constants[i]);
}
for (int i = 0; i < match.properties.size(); i++) {
_create_property_item(parent, match.doc, match.properties[i]);
}
for (int i = 0; i < match.theme_properties.size(); i++) {
_create_theme_property_item(parent, match.doc, match.theme_properties[i]);
}
iterator_match = iterator_match->next();
return !iterator_match;
}
bool VisualScriptPropertySelector::Runner::_phase_select_match() {
if (matched_item) {
matched_item->select(0);
}
return true;
}
bool VisualScriptPropertySelector::Runner::_match_string(const String &p_term, const String &p_string) const {
if (search_flags & SEARCH_CASE_SENSITIVE) {
return p_string.find(p_term) > -1;
} else {
return p_string.findn(p_term) > -1;
}
}
void VisualScriptPropertySelector::Runner::_match_item(TreeItem *p_item, const String &p_text) {
float inverse_length = 1.f / float(p_text.length());
// Favor types where search term is a substring close to the start of the type.
float w = 0.5f;
int pos = p_text.findn(term);
float score = (pos > -1) ? 1.0f - w * MIN(1, 3 * pos * inverse_length) : MAX(0.f, .9f - w);
// Favor shorter items: they resemble the search term more.
w = 0.1f;
score *= (1 - w) + w * (term.length() * inverse_length);
if (match_highest_score == 0 || score > match_highest_score) {
matched_item = p_item;
match_highest_score = score;
}
}
TreeItem *VisualScriptPropertySelector::Runner::_create_class_hierarchy(const ClassMatch &p_match) {
if (class_items.has(p_match.doc->name)) {
return class_items[p_match.doc->name];
}
// Ensure parent nodes are created first.
TreeItem *parent = root_item;
if (p_match.doc->inherits != "") {
if (class_items.has(p_match.doc->inherits)) {
parent = class_items[p_match.doc->inherits];
} else {
ClassMatch &base_match = matches[p_match.doc->inherits];
parent = _create_class_hierarchy(base_match);
}
}
TreeItem *class_item = _create_class_item(parent, p_match.doc, !p_match.name);
class_items[p_match.doc->name] = class_item;
return class_item;
}
TreeItem *VisualScriptPropertySelector::Runner::_create_class_item(TreeItem *p_parent, const DocData::ClassDoc *p_doc, bool p_gray) {
Ref<Texture2D> icon = empty_icon;
if (ui_service->has_theme_icon(p_doc->name, "EditorIcons")) {
icon = ui_service->get_theme_icon(p_doc->name, "EditorIcons");
} else if (ClassDB::class_exists(p_doc->name) && ClassDB::is_parent_class(p_doc->name, "Object")) {
icon = ui_service->get_theme_icon(SNAME("Object"), SNAME("EditorIcons"));
}
String tooltip = p_doc->brief_description.strip_edges();
TreeItem *item = results_tree->create_item(p_parent);
item->set_icon(0, icon);
item->set_text(0, p_doc->name);
item->set_text(1, TTR("Class"));
item->set_tooltip(0, tooltip);
item->set_tooltip(1, tooltip);
item->set_metadata(0, "class_name:" + p_doc->name);
if (p_gray) {
item->set_custom_color(0, disabled_color);
item->set_custom_color(1, disabled_color);
}
_match_item(item, p_doc->name);
return item;
}
TreeItem *VisualScriptPropertySelector::Runner::_create_method_item(TreeItem *p_parent, const DocData::ClassDoc *p_class_doc, const String &p_text, const DocData::MethodDoc *p_doc) {
String tooltip = p_doc->return_type + " " + p_class_doc->name + "." + p_doc->name + "(";
for (int i = 0; i < p_doc->arguments.size(); i++) {
const DocData::ArgumentDoc &arg = p_doc->arguments[i];
tooltip += arg.type + " " + arg.name;
if (arg.default_value != "") {
tooltip += " = " + arg.default_value;
}
if (i < p_doc->arguments.size() - 1) {
tooltip += ", ";
}
}
tooltip += ")";
return _create_member_item(p_parent, p_class_doc->name, "MemberMethod", p_doc->name, p_text, TTRC("Method"), "method", tooltip);
}
TreeItem *VisualScriptPropertySelector::Runner::_create_signal_item(TreeItem *p_parent, const DocData::ClassDoc *p_class_doc, const DocData::MethodDoc *p_doc) {
String tooltip = p_doc->return_type + " " + p_class_doc->name + "." + p_doc->name + "(";
for (int i = 0; i < p_doc->arguments.size(); i++) {
const DocData::ArgumentDoc &arg = p_doc->arguments[i];
tooltip += arg.type + " " + arg.name;
if (arg.default_value != "") {
tooltip += " = " + arg.default_value;
}
if (i < p_doc->arguments.size() - 1) {
tooltip += ", ";
}
}
tooltip += ")";
return _create_member_item(p_parent, p_class_doc->name, "MemberSignal", p_doc->name, p_doc->name, TTRC("Signal"), "signal", tooltip);
}
TreeItem *VisualScriptPropertySelector::Runner::_create_constant_item(TreeItem *p_parent, const DocData::ClassDoc *p_class_doc, const DocData::ConstantDoc *p_doc) {
String tooltip = p_class_doc->name + "." + p_doc->name;
return _create_member_item(p_parent, p_class_doc->name, "MemberConstant", p_doc->name, p_doc->name, TTRC("Constant"), "constant", tooltip);
}
TreeItem *VisualScriptPropertySelector::Runner::_create_property_item(TreeItem *p_parent, const DocData::ClassDoc *p_class_doc, const DocData::PropertyDoc *p_doc) {
String tooltip = p_doc->type + " " + p_class_doc->name + "." + p_doc->name;
tooltip += "\n " + p_class_doc->name + "." + p_doc->setter + "(value) setter";
tooltip += "\n " + p_class_doc->name + "." + p_doc->getter + "() getter";
return _create_member_item(p_parent, p_class_doc->name, "MemberProperty", p_doc->name, p_doc->name, TTRC("Property"), "property", tooltip);
}
TreeItem *VisualScriptPropertySelector::Runner::_create_theme_property_item(TreeItem *p_parent, const DocData::ClassDoc *p_class_doc, const DocData::ThemeItemDoc *p_doc) {
String tooltip = p_doc->type + " " + p_class_doc->name + "." + p_doc->name;
return _create_member_item(p_parent, p_class_doc->name, "MemberTheme", p_doc->name, p_doc->name, TTRC("Theme Property"), "theme_item", tooltip);
}
TreeItem *VisualScriptPropertySelector::Runner::_create_member_item(TreeItem *p_parent, const String &p_class_name, const String &p_icon, const String &p_name, const String &p_text, const String &p_type, const String &p_metatype, const String &p_tooltip) {
Ref<Texture2D> icon;
String text;
if (search_flags & SEARCH_SHOW_HIERARCHY) {
icon = ui_service->get_theme_icon(p_icon, SNAME("EditorIcons"));
text = p_text;
} else {
icon = ui_service->get_theme_icon(p_icon, SNAME("EditorIcons"));
/*// In flat mode, show the class icon.
if (ui_service->has_icon(p_class_name, "EditorIcons"))
icon = ui_service->get_icon(p_class_name, "EditorIcons");
else if (ClassDB::is_parent_class(p_class_name, "Object"))
icon = ui_service->get_icon("Object", "EditorIcons");*/
text = p_class_name + "." + p_text;
}
TreeItem *item = results_tree->create_item(p_parent);
item->set_icon(0, icon);
item->set_text(0, text);
item->set_text(1, TTRGET(p_type));
item->set_tooltip(0, p_tooltip);
item->set_tooltip(1, p_tooltip);
item->set_metadata(0, "class_" + p_metatype + ":" + p_class_name + ":" + p_name);
_match_item(item, p_name);
return item;
}
bool VisualScriptPropertySelector::Runner::work(uint64_t slot) {
// Return true when the search has been completed, otherwise false.
const uint64_t until = OS::get_singleton()->get_ticks_usec() + slot;
while (!_slice()) {
if (OS::get_singleton()->get_ticks_usec() > until) {
return false;
}
}
return true;
}
VisualScriptPropertySelector::Runner::Runner(Control *p_icon_service, Tree *p_results_tree, const String &p_term, int p_search_flags, int p_scope_flags) :
ui_service(p_icon_service),
results_tree(p_results_tree),
term((p_search_flags & SEARCH_CASE_SENSITIVE) == 0 ? p_term.strip_edges().to_lower() : p_term.strip_edges()),
search_flags(p_search_flags),
scope_flags(p_scope_flags),
empty_icon(ui_service->get_theme_icon(SNAME("ArrowRight"), SNAME("EditorIcons"))),
disabled_color(ui_service->get_theme_color(SNAME("disabled_font_color"), SNAME("Editor"))) {
}

View file

@ -38,12 +38,49 @@
class VisualScriptPropertySelector : public ConfirmationDialog {
GDCLASS(VisualScriptPropertySelector, ConfirmationDialog);
enum SearchFlags {
SEARCH_CLASSES = 1 << 0,
SEARCH_CONSTRUCTORS = 1 << 1,
SEARCH_METHODS = 1 << 2,
SEARCH_OPERATORS = 1 << 3,
SEARCH_SIGNALS = 1 << 4,
SEARCH_CONSTANTS = 1 << 5,
SEARCH_PROPERTIES = 1 << 6,
SEARCH_THEME_ITEMS = 1 << 7,
SEARCH_ALL = SEARCH_CLASSES | SEARCH_CONSTRUCTORS | SEARCH_METHODS | SEARCH_OPERATORS | SEARCH_SIGNALS | SEARCH_CONSTANTS | SEARCH_PROPERTIES | SEARCH_THEME_ITEMS,
SEARCH_CASE_SENSITIVE = 1 << 29,
SEARCH_SHOW_HIERARCHY = 1 << 30,
};
enum ScopeFlags {
SCOPE_BASE = 1 << 0,
SCOPE_INHERITERS = 1 << 1,
SCOPE_UNRELATED = 1 << 2,
SCOPE_ALL = SCOPE_BASE | SCOPE_INHERITERS | SCOPE_UNRELATED
};
LineEdit *search_box;
Tree *search_options;
Button *search_base_button;
Button *search_inheritors_button;
Button *search_unrelated_button;
Button *case_sensitive_button;
Button *hierarchy_button;
OptionButton *filter_combo;
OptionButton *scope_combo;
Tree *results_tree;
class Runner;
Ref<Runner> search;
void _text_changed(const String &p_newtext);
void _sbox_input(const Ref<InputEvent> &p_ie);
void _update_icons();
void _update_search();
void _update_search_old();
void _search_box_text_changed(const String &p_text);
void _filter_combo_item_selected(int p_option);
void _scope_combo_item_selected(int p_option);
void create_visualscript_item(const String &name, TreeItem *const root, const String &search_input, const String &text);
void get_visual_node_names(const String &root_filter, const Set<String> &p_modifiers, bool &found, TreeItem *const root, LineEdit *const search_box);
@ -60,11 +97,11 @@ class VisualScriptPropertySelector : public ConfirmationDialog {
String selected;
Variant::Type type;
String base_type;
ObjectID script;
Ref<Script> script;
Object *instance;
bool virtuals_only;
bool seq_connect;
VBoxContainer *vbc;
VBoxContainer *vbox;
Vector<Variant::Type> type_filter;
@ -88,4 +125,78 @@ public:
VisualScriptPropertySelector();
};
class VisualScriptPropertySelector::Runner : public RefCounted {
enum Phase {
PHASE_MATCH_CLASSES_INIT,
PHASE_MATCH_CLASSES,
PHASE_CLASS_ITEMS_INIT,
PHASE_CLASS_ITEMS,
PHASE_MEMBER_ITEMS_INIT,
PHASE_MEMBER_ITEMS,
PHASE_SELECT_MATCH,
PHASE_MAX
};
int phase = 0;
struct ClassMatch {
DocData::ClassDoc *doc;
bool name = false;
Vector<DocData::MethodDoc *> constructors;
Vector<DocData::MethodDoc *> methods;
Vector<DocData::MethodDoc *> operators;
Vector<DocData::MethodDoc *> signals;
Vector<DocData::ConstantDoc *> constants;
Vector<DocData::PropertyDoc *> properties;
Vector<DocData::ThemeItemDoc *> theme_properties;
bool required() {
return name || methods.size() || signals.size() || constants.size() || properties.size() || theme_properties.size();
}
};
Control *ui_service;
Tree *results_tree;
String term;
int search_flags;
int scope_flags;
Ref<Texture2D> empty_icon;
Color disabled_color;
Map<String, DocData::ClassDoc>::Element *iterator_doc = nullptr;
Map<String, ClassMatch> matches;
Map<String, ClassMatch>::Element *iterator_match = nullptr;
TreeItem *root_item = nullptr;
Map<String, TreeItem *> class_items;
TreeItem *matched_item = nullptr;
float match_highest_score = 0;
bool _is_class_disabled_by_feature_profile(const StringName &p_class);
bool _slice();
bool _phase_match_classes_init();
bool _phase_match_classes();
bool _phase_class_items_init();
bool _phase_class_items();
bool _phase_member_items_init();
bool _phase_member_items();
bool _phase_select_match();
bool _match_string(const String &p_term, const String &p_string) const;
void _match_item(TreeItem *p_item, const String &p_text);
TreeItem *_create_class_hierarchy(const ClassMatch &p_match);
TreeItem *_create_class_item(TreeItem *p_parent, const DocData::ClassDoc *p_doc, bool p_gray);
TreeItem *_create_method_item(TreeItem *p_parent, const DocData::ClassDoc *p_class_doc, const String &p_text, const DocData::MethodDoc *p_doc);
TreeItem *_create_signal_item(TreeItem *p_parent, const DocData::ClassDoc *p_class_doc, const DocData::MethodDoc *p_doc);
TreeItem *_create_constant_item(TreeItem *p_parent, const DocData::ClassDoc *p_class_doc, const DocData::ConstantDoc *p_doc);
TreeItem *_create_property_item(TreeItem *p_parent, const DocData::ClassDoc *p_class_doc, const DocData::PropertyDoc *p_doc);
TreeItem *_create_theme_property_item(TreeItem *p_parent, const DocData::ClassDoc *p_class_doc, const DocData::ThemeItemDoc *p_doc);
TreeItem *_create_member_item(TreeItem *p_parent, const String &p_class_name, const String &p_icon, const String &p_name, const String &p_text, const String &p_type, const String &p_metatype, const String &p_tooltip);
public:
bool work(uint64_t slot = 100000);
Runner(Control *p_icon_service, Tree *p_results_tree, const String &p_term, int p_search_flags, int p_scope_flags);
};
#endif // VISUALSCRIPT_PROPERTYSELECTOR_H