Merge ffe344d166 into 60a767032e

editor/limbo_ai_editor_plugin.cpp

@@ -457,6 +457,8 @@ void LimboAIEditor::_process_shortcut_input(const Ref<InputEvent> &p_event) {
 			_on_save_pressed();
 		} else if (LW_IS_SHORTCUT("limbo_ai/load_behavior_tree", p_event)) {
 			_popup_file_dialog(load_dialog);
+		} else if (LW_IS_SHORTCUT("limbo_ai/search_tree", p_event)) {
+			task_tree->tree_search_show_and_focus();
 		} else {
 			handled = false;
 		}
@@ -799,6 +801,9 @@ void LimboAIEditor::_misc_option_selected(int p_id) {
 			EDITOR_FILE_SYSTEM()->scan();
 			EDIT_SCRIPT(template_path);
 		} break;
+		case MISC_SEARCH_TREE: {
+			task_tree->tree_search_show_and_focus();
+		}
 	}
 }
 
@@ -1319,6 +1324,9 @@ void LimboAIEditor::_update_misc_menu() {
 	misc_menu->add_item(
 			FILE_EXISTS(_get_script_template_path()) ? TTR("Edit Script Template") : TTR("Create Script Template"),
 			MISC_CREATE_SCRIPT_TEMPLATE);
+	
+	misc_menu->add_separator();
+	misc_menu->add_icon_item(theme_cache.search_icon, ("Search Tree"), MISC_SEARCH_TREE);
 }
 
 void LimboAIEditor::_update_banners() {
@@ -1381,6 +1389,7 @@ void LimboAIEditor::_do_update_theme_item_cache() {
 	theme_cache.cut_icon = get_theme_icon(LW_NAME(ActionCut), LW_NAME(EditorIcons));
 	theme_cache.copy_icon = get_theme_icon(LW_NAME(ActionCopy), LW_NAME(EditorIcons));
 	theme_cache.paste_icon = get_theme_icon(LW_NAME(ActionPaste), LW_NAME(EditorIcons));
+	theme_cache.search_icon = get_theme_icon(LW_NAME(Search), LW_NAME(EditorIcons));
 
 	theme_cache.behavior_tree_icon = LimboUtility::get_singleton()->get_task_icon("BehaviorTree");
 	theme_cache.percent_icon = LimboUtility::get_singleton()->get_task_icon("LimboPercent");
@@ -1512,6 +1521,9 @@ LimboAIEditor::LimboAIEditor() {
 	LW_SHORTCUT("limbo_ai/open_debugger", TTR("Open Debugger"), (Key)(LW_KEY_MASK(CMD_OR_CTRL) | LW_KEY_MASK(ALT) | LW_KEY(D)));
 	LW_SHORTCUT("limbo_ai/jump_to_owner", TTR("Jump to Owner"), (Key)(LW_KEY_MASK(CMD_OR_CTRL) | LW_KEY(J)));
 	LW_SHORTCUT("limbo_ai/close_tab", TTR("Close Tab"), (Key)(LW_KEY_MASK(CMD_OR_CTRL) | LW_KEY(W)));
+	LW_SHORTCUT("limbo_ai/find_task", TTR("Find Task"), (Key)(LW_KEY_MASK(CMD_OR_CTRL) | LW_KEY(F)));
+	LW_SHORTCUT("limbo_ai/hide_tree_search", TTR("Hide BehaviorTrees Search Panel"), (Key)(LW_KEY(ESCAPE)));
+	LW_SHORTCUT("limbo_ai/search_tree", TTR("Shows the BehaviorTree Search Panel"), (Key)(LW_KEY_MASK(CMD_OR_CTRL) | LW_KEY(F)));
 
 	set_process_shortcut_input(true);
 

editor/limbo_ai_editor_plugin.h

@@ -20,6 +20,7 @@
 #include "owner_picker.h"
 #include "task_palette.h"
 #include "task_tree.h"
+#include "tree_search.h"
 
 #ifdef LIMBOAI_MODULE
 #include "core/object/class_db.h"
@@ -100,6 +101,7 @@ private:
 		MISC_LAYOUT_WIDESCREEN_OPTIMIZED,
 		MISC_PROJECT_SETTINGS,
 		MISC_CREATE_SCRIPT_TEMPLATE,
+		MISC_SEARCH_TREE
 	};
 
 	enum TabMenu {
@@ -134,6 +136,7 @@ private:
 		Ref<Texture2D> cut_icon;
 		Ref<Texture2D> copy_icon;
 		Ref<Texture2D> paste_icon;
+		Ref<Texture2D> search_icon;
 	} theme_cache;
 
 	EditorPlugin *plugin;

editor/task_tree.cpp

@@ -17,22 +17,23 @@
 #include "../bt/tasks/composites/bt_probability_selector.h"
 #include "../util/limbo_compat.h"
 #include "../util/limbo_utility.h"
+#include "tree_search.h"
 
 #ifdef LIMBOAI_MODULE
 #include "core/object/script_language.h"
 #include "editor/themes/editor_scale.h"
 #include "scene/gui/box_container.h"
-#include "scene/gui/texture_rect.h"
 #include "scene/gui/label.h"
+#include "scene/gui/texture_rect.h"
 #endif // LIMBOAI_MODULE
 
 #ifdef LIMBOAI_GDEXTENSION
 #include <godot_cpp/classes/editor_interface.hpp>
-#include <godot_cpp/classes/script.hpp>
 #include <godot_cpp/classes/h_box_container.hpp>
-#include <godot_cpp/classes/v_box_container.hpp>
-#include <godot_cpp/classes/texture_rect.hpp>
 #include <godot_cpp/classes/label.hpp>
+#include <godot_cpp/classes/script.hpp>
+#include <godot_cpp/classes/texture_rect.hpp>
+#include <godot_cpp/classes/v_box_container.hpp>
 using namespace godot;
 #endif // LIMBOAI_GDEXTENSION
 
@@ -46,6 +47,12 @@ TreeItem *TaskTree::_create_tree(const Ref<BTTask> &p_task, TreeItem *p_parent,
 		_create_tree(p_task->get_child(i), item);
 	}
 	_update_item(item);
+	
+	// update TreeSearch if root task was created
+	if (tree->get_root() == item){
+		tree_search->update_search(tree);
+	}
+
 	return item;
 }
 
@@ -105,6 +112,7 @@ void TaskTree::_update_item(TreeItem *p_item) {
 	if (!warning_text.is_empty()) {
 		p_item->add_button(0, theme_cache.task_warning_icon, 0, false, warning_text);
 	}
+	tree_search->on_item_edited(p_item); // this is necessary to preserve custom drawing from tree search.
 }
 
 void TaskTree::_update_tree() {
@@ -530,12 +538,15 @@ void TaskTree::_notification(int p_what) {
 			tree->connect("multi_selected", callable_mp(this, &TaskTree::_on_item_selected).unbind(3), CONNECT_DEFERRED);
 			tree->connect("item_activated", callable_mp(this, &TaskTree::_on_item_activated));
 			tree->connect("item_collapsed", callable_mp(this, &TaskTree::_on_item_collapsed));
+			tree_search_panel->connect("update_requested", callable_mp(this, &TaskTree::_update_tree));
+			tree_search_panel->connect("visibility_changed", callable_mp(this, &TaskTree::_update_tree));
 		} break;
 		case NOTIFICATION_THEME_CHANGED: {
 			_do_update_theme_item_cache();
 			_update_tree();
 		} break;
 	}
+
 }
 
 void TaskTree::_bind_methods() {
@@ -562,12 +573,24 @@ void TaskTree::_bind_methods() {
 			PropertyInfo(Variant::INT, "type")));
 }
 
+void TaskTree::tree_search_show_and_focus() {
+	ERR_FAIL_NULL(tree_search);
+	tree_search_panel->show_and_focus();
+}
+
 TaskTree::TaskTree() {
 	editable = true;
 	updating_tree = false;
 
+	// for Tree + TreeSearch, we want a VBoxContainer. For now, rather than changing this classes type, let's do nesting:
+	// TaskTree -> VBoxContainer -> [Tree, TreeSearchPanel]
+	VBoxContainer *vbox_container = memnew(VBoxContainer);
+	add_child(vbox_container);
+	vbox_container->set_anchors_preset(PRESET_FULL_RECT);
+
 	tree = memnew(Tree);
-	add_child(tree);
+	tree->set_v_size_flags(Control::SIZE_EXPAND_FILL);
+	vbox_container->add_child(tree);
 	tree->set_columns(2);
 	tree->set_column_expand(0, true);
 	tree->set_column_expand(1, false);
@@ -578,6 +601,10 @@ TaskTree::TaskTree() {
 	tree->set_select_mode(Tree::SelectMode::SELECT_MULTI);
 
 	tree->set_drag_forwarding(callable_mp(this, &TaskTree::_get_drag_data_fw), callable_mp(this, &TaskTree::_can_drop_data_fw), callable_mp(this, &TaskTree::_drop_data_fw));
+
+	tree_search_panel = memnew(TreeSearchPanel);
+	tree_search = Ref(memnew(TreeSearch(tree_search_panel)));
+	vbox_container->add_child(tree_search_panel);
 }
 
 TaskTree::~TaskTree() {

editor/task_tree.h

@@ -9,9 +9,13 @@
  * =============================================================================
  */
 
+#ifndef TASK_TREE_H
+#define TASK_TREE_H
+
 #ifdef TOOLS_ENABLED
 
 #include "../bt/behavior_tree.h"
+#include "tree_search.h"
 
 #ifdef LIMBOAI_MODULE
 #include "scene/gui/control.h"
@@ -43,6 +47,9 @@ private:
 	bool updating_tree;
 	HashMap<RECT_CACHE_KEY, Rect2> probability_rect_cache;
 
+	Ref<TreeSearch> tree_search;
+	TreeSearchPanel *tree_search_panel;
+
 	struct ThemeCache {
 		Ref<Font> comment_font;
 		Ref<Font> name_font;
@@ -96,6 +103,7 @@ public:
 	Ref<BTTask> get_selected() const;
 	Vector<Ref<BTTask>> get_selected_tasks() const;
 	void clear_selection();
+	void tree_search_show_and_focus();
 
 	Rect2 get_selected_probability_rect() const;
 	double get_selected_probability_weight() const;
@@ -109,3 +117,4 @@ public:
 };
 
 #endif // ! TOOLS_ENABLED
+#endif // ! TASK_TREE_H

editor/tree_search.cpp

@@ -0,0 +1,492 @@
+/**
+ * tree_search.cpp
+ * =============================================================================
+ * Copyright 2021-2024 Serhii Snitsaruk
+ *
+ * Use of this source code is governed by an MIT-style
+ * license that can be found in the LICENSE file or at
+ * https://opensource.org/licenses/MIT.
+ * =============================================================================
+ */
+
+#ifdef TOOLS_ENABLED
+
+#include "tree_search.h"
+
+#include "../util/limbo_compat.h" // for edscale
+#include "../util/limbo_string_names.h"
+#include "../util/limbo_utility.h"
+
+#ifdef LIMBOAI_MODULE
+#include "core/math/math_funcs.h"
+#include "editor/editor_interface.h"
+#include "editor/themes/editor_scale.h"
+#include "scene/gui/separator.h"
+#include "scene/main/viewport.h"
+#include "scene/resources/font.h"
+#include "scene/resources/style_box_flat.h"
+#endif // LIMBOAI_MODULE
+
+#ifdef LIMBOAI_GDEXTENSION
+#include <godot_cpp/classes/editor_interface.hpp> // for edge scale
+#include <godot_cpp/classes/font.hpp>
+#include <godot_cpp/classes/h_separator.hpp>
+#include <godot_cpp/classes/style_box_flat.hpp>
+#include <godot_cpp/classes/viewport.hpp>
+#include <godot_cpp/core/math.hpp>
+
+#endif // LIMBOAI_GDEXTENSION
+
+#define UPPER_BOUND (1 << 15) // for substring search.
+
+/* ------- TreeSearchPanel ------- */
+
+void TreeSearchPanel::_initialize_controls() {
+	line_edit_search = memnew(LineEdit);
+	check_button_filter_highlight = memnew(CheckBox);
+	close_button = memnew(Button);
+	label_filter = memnew(Label);
+
+	line_edit_search->set_placeholder(TTR("Search tree"));
+
+	label_filter->set_text(TTR("Filter"));
+
+	BUTTON_SET_ICON(close_button, get_theme_icon(LW_NAME(Close), LW_NAME(EditorIcons)));
+	close_button->set_theme_type_variation("FlatButton");
+
+	// positioning and sizing
+	this->set_anchors_and_offsets_preset(LayoutPreset::PRESET_BOTTOM_WIDE);
+	this->set_v_size_flags(SIZE_SHRINK_CENTER); // Do not expand vertically
+
+	line_edit_search->set_h_size_flags(SIZE_EXPAND_FILL);
+
+	_add_spacer(0.25); // otherwise the lineedits expand margin touches the left border.
+	add_child(line_edit_search);
+	_add_spacer(0.25);
+
+	add_child(check_button_filter_highlight);
+	add_child(label_filter);
+
+	_add_spacer(0.25);
+	add_child(close_button);
+	_add_spacer(0.25);
+}
+
+void TreeSearchPanel::_initialize_close_callbacks() {
+	Callable calleable_set_invisible = Callable(this, "set_visible").bind(false); // don't need a custom bind.
+	close_button->connect("pressed", calleable_set_invisible);
+	close_button->set_shortcut(LW_GET_SHORTCUT("limbo_ai/hide_tree_search"));
+}
+
+void TreeSearchPanel::_add_spacer(float p_width_multiplier) {
+	Control *spacer = memnew(Control);
+	spacer->set_custom_minimum_size(Vector2(8.0 * EDSCALE * p_width_multiplier, 0.0));
+	add_child(spacer);
+}
+
+void TreeSearchPanel::_emit_text_submitted(const String &p_text) {
+	this->emit_signal("text_submitted");
+}
+
+void TreeSearchPanel::_emit_update_requested() {
+	emit_signal("update_requested");
+}
+
+void TreeSearchPanel::_notification(int p_what) {
+	switch (p_what) {
+		case NOTIFICATION_READY: {
+			_initialize_controls();
+			line_edit_search->connect("text_changed", callable_mp(this, &TreeSearchPanel::_emit_update_requested).unbind(1));
+			_initialize_close_callbacks();
+			line_edit_search->connect("text_submitted", callable_mp(this, &TreeSearchPanel::_emit_text_submitted));
+			check_button_filter_highlight->connect("pressed", callable_mp(this, &TreeSearchPanel::_emit_update_requested));
+			break;
+		}
+	}
+}
+
+void TreeSearchPanel::_bind_methods() {
+	ADD_SIGNAL(MethodInfo("update_requested"));
+	ADD_SIGNAL(MethodInfo("text_submitted"));
+}
+
+TreeSearchPanel::TreeSearchPanel() {
+	this->set_visible(false);
+}
+
+bool TreeSearchPanel::has_focus() {
+	return false;
+}
+
+TreeSearchMode TreeSearchPanel::get_search_mode() {
+	if (!check_button_filter_highlight || !check_button_filter_highlight->is_pressed()) {
+		return TreeSearchMode::HIGHLIGHT;
+	}
+	return TreeSearchMode::FILTER;
+}
+
+String TreeSearchPanel::get_text() {
+	if (!line_edit_search)
+		return String();
+	return line_edit_search->get_text();
+}
+
+void TreeSearchPanel::show_and_focus() {
+	this->set_visible(true);
+	line_edit_search->grab_focus();
+}
+
+/* !TreeSearchPanel */
+
+/* ------- TreeSearch ------- */
+
+void TreeSearch::_filter_tree(const String &p_search_mask) {
+	if (matching_entries.size() == 0) {
+		return;
+	}
+
+	for (int i = 0; i < ordered_tree_items.size(); i++) {
+		TreeItem *cur_item = ordered_tree_items[i];
+
+		if (number_matches.has(cur_item)) {
+			continue;
+		}
+
+		TreeItem *first_counting_ancestor = cur_item;
+		while (first_counting_ancestor && !number_matches.has(first_counting_ancestor)) {
+			first_counting_ancestor = first_counting_ancestor->get_parent();
+		}
+		if (!first_counting_ancestor || !_vector_has_bsearch(matching_entries, first_counting_ancestor)) {
+			cur_item->set_visible(false);
+		}
+	}
+}
+
+void TreeSearch::_highlight_tree(const String &p_search_mask) {
+	callable_cache.clear();
+	for (int i = 0; i < ordered_tree_items.size(); i++) {
+		TreeItem *entry = ordered_tree_items[i];
+
+		int num_m = number_matches.has(entry) ? number_matches.get(entry) : 0;
+		if (num_m == 0) {
+			continue;
+		}
+
+		// make sure to also call any draw method already defined.
+		Callable parent_draw_method;
+		if (entry->get_cell_mode(0) == TreeItem::CELL_MODE_CUSTOM) {
+			parent_draw_method = entry->get_custom_draw_callback(0);
+		}
+
+		Callable draw_callback = callable_mp(this, &TreeSearch::_draw_highlight_item).bind(parent_draw_method);
+
+		// -- this is necessary because of the modularity of this implementation
+		// cache render properties of entry
+		String cached_text = entry->get_text(0);
+		Ref<Texture2D> cached_icon = entry->get_icon(0);
+		int cached_max_width = entry->get_icon_max_width(0);
+		callable_cache[entry] = draw_callback;
+
+		// this removes render properties in entry
+		entry->set_custom_draw_callback(0, draw_callback);
+		entry->set_cell_mode(0, TreeItem::CELL_MODE_CUSTOM);
+
+		// restore render properties
+		entry->set_text(0, cached_text);
+		entry->set_icon(0, cached_icon);
+		entry->set_icon_max_width(0, cached_max_width);
+	}
+}
+
+// custom draw callback for highlighting (bind the parent_drw_method to this)
+void TreeSearch::_draw_highlight_item(TreeItem *p_tree_item, Rect2 p_rect, Callable p_parent_draw_method) {
+	if (!p_tree_item){
+		return;
+	}
+	// call any parent draw methods such as for probability FIRST.
+	p_parent_draw_method.call(p_tree_item, p_rect);
+
+	// first part: outline
+	if (matching_entries.has(p_tree_item)) {
+		// font info
+		Ref<Font> font = p_tree_item->get_custom_font(0);
+		if (font.is_null()) {
+			font = p_tree_item->get_tree()->get_theme_font(LW_NAME(font));
+		}
+		ERR_FAIL_NULL(font);
+		float font_size = p_tree_item->get_custom_font_size(0);
+		if (font_size == -1) {
+			font_size = p_tree_item->get_tree()->get_theme_font_size(LW_NAME(font));
+		}
+
+		// substring size
+		String string_full = p_tree_item->get_text(0);
+		StringSearchIndices substring_idx = _substring_bounds(string_full, _get_search_mask());
+
+		String substring_match = string_full.substr(substring_idx.lower, substring_idx.upper - substring_idx.lower);
+		Vector2 substring_match_size = font->get_string_size(substring_match, HORIZONTAL_ALIGNMENT_LEFT, -1.f, font_size);
+
+		String substring_before = string_full.substr(0, substring_idx.lower);
+		Vector2 substring_before_size = font->get_string_size(substring_before, HORIZONTAL_ALIGNMENT_LEFT, -1.f, font_size);
+
+		// stylebox
+		Ref<StyleBox> stylebox = p_tree_item->get_tree()->get_theme_stylebox("Focus");
+		ERR_FAIL_NULL(stylebox);
+
+		// extract separation
+		float h_sep = p_tree_item->get_tree()->get_theme_constant("h_separation");
+
+		// compose draw rect
+		const Vector2 PADDING = Vector2(4., 2.);
+		Rect2 draw_rect = p_rect;
+
+		Vector2 rect_offset = Vector2(substring_before_size.x, 0);
+		rect_offset.x += p_tree_item->get_icon_max_width(0) * EDSCALE;
+		rect_offset.x += (h_sep + 4.) * EDSCALE; // TODO: Find better way to determine texts x-offset
+		rect_offset.y = (p_rect.size.y - substring_match_size.y) / 2; // center box vertically
+
+		draw_rect.position += rect_offset - PADDING / 2;
+		draw_rect.size = substring_match_size + PADDING;
+
+		// draw
+		stylebox->draw(p_tree_item->get_tree()->get_canvas_item(), draw_rect);
+	}
+
+	// second part: draw number (TODO: maybe use columns)
+	int num_mat = number_matches.has(p_tree_item) ? number_matches.get(p_tree_item) : 0;
+	if (num_mat > 0) {
+		float h_sep = p_tree_item->get_tree()->get_theme_constant("h_separation");
+		Ref<Font> font = tree_reference->get_theme_font("font");
+		float font_size = tree_reference->get_theme_font_size("font") * 0.75;
+
+		String num_string = String::num_int64(num_mat);
+		Vector2 string_size = font->get_string_size(num_string, HORIZONTAL_ALIGNMENT_CENTER, -1, font_size);
+		Vector2 text_pos = p_rect.position;
+
+		text_pos.x += p_rect.size.x - string_size.x - h_sep;
+		text_pos.y += font->get_descent(font_size) + p_rect.size.y / 2.; // center vertically
+
+		font->draw_string(tree_reference->get_canvas_item(), text_pos, num_string, HORIZONTAL_ALIGNMENT_CENTER, -1, font_size);
+	}
+}
+
+void TreeSearch::_update_matching_entries(const String &p_search_mask) {
+	Vector<TreeItem *> accum;
+	matching_entries = _find_matching_entries(tree_reference->get_root(), p_search_mask, accum);
+}
+
+/* this linearizes the tree into [ordered_tree_items] like so:
+ - i1
+	- i2
+	- i3
+ - i4 ---> [i1,i2,i3,i4]
+*/
+void TreeSearch::_update_ordered_tree_items(TreeItem *p_tree_item) {
+	if (!p_tree_item)
+		return;
+	if (p_tree_item == p_tree_item->get_tree()->get_root()) {
+		ordered_tree_items.clear();
+	}
+	// Add the current item to the list
+	ordered_tree_items.push_back(p_tree_item);
+
+	// Recursively collect items from the first child
+	TreeItem *child = p_tree_item->get_first_child();
+	while (child) {
+		_update_ordered_tree_items(child);
+		child = child->get_next();
+	}
+}
+
+void TreeSearch::_update_number_matches() {
+	number_matches.clear();
+	for (int i = 0; i < matching_entries.size(); i++) {
+		TreeItem *item = matching_entries[i];
+		while (item) {
+			int old_num_value = number_matches.has(item) ? number_matches.get(item) : 0;
+			number_matches[item] = old_num_value + 1;
+			item = item->get_parent();
+		}
+	}
+}
+
+String TreeSearch::_get_search_mask() {
+	ERR_FAIL_COND_V(!search_panel, "");
+	return search_panel->get_text();
+}
+
+Vector<TreeItem *> TreeSearch::_find_matching_entries(TreeItem *p_tree_item, const String &p_search_mask, Vector<TreeItem *> &p_accum) {
+	if (!p_tree_item)
+		return p_accum;
+	StringSearchIndices item_search_indices = _substring_bounds(p_tree_item->get_text(0), p_search_mask);
+	if (item_search_indices.hit())
+		p_accum.insert(p_accum.bsearch(p_tree_item, true), p_tree_item);
+
+	for (int i = 0; i < p_tree_item->get_child_count(); i++) {
+		TreeItem *child = p_tree_item->get_child(i);
+		_find_matching_entries(child, p_search_mask, p_accum);
+	}
+	return p_accum;
+}
+
+// Returns the lower and upper bounds of a substring. Does fuzzy search: Simply looks if words exist in right ordering.
+// Also ignores case if p_search_mask is lowercase. Example:
+// p_searcheable = "TimeLimit 2 sec", p_search_mask = limit 2 sec -> [4,14]. With p_search_mask = "LimiT 2 SEC" or "Limit sec 2" -> [-1,-1]
+TreeSearch::StringSearchIndices TreeSearch::_substring_bounds(const String &p_searchable, const String &p_search_mask) const {
+	StringSearchIndices result;
+	result.lower = UPPER_BOUND;
+	result.upper = 0;
+
+	if (p_search_mask.is_empty()) {
+		return result; // Early return if search_mask is empty.
+	}
+
+	// Determine if the search should be case-insensitive.
+	bool is_case_insensitive = (p_search_mask == p_search_mask.to_lower());
+	String searchable_processed = is_case_insensitive ? p_searchable.to_lower() : p_searchable;
+	PackedStringArray words = p_search_mask.split(" ");
+	int word_position = 0;
+	for (const String &word : words) {
+		if (word.is_empty()) {
+			continue; // Skip empty words.
+		}
+
+		String word_processed = is_case_insensitive ? word.to_lower() : word;
+
+		// Find the position of the next word in the searchable string.
+		word_position = searchable_processed.find(word_processed, word_position);
+
+		if (word_position < 0) {
+			// If any word is not found, return an empty StringSearchIndices.
+			return StringSearchIndices();
+		}
+
+		// Update lower and upper bounds.
+		result.lower = MIN(result.lower, word_position);
+		result.upper = MAX(result.upper, static_cast<int>(word_position + word.length()));
+	}
+
+	return result;
+}
+
+void TreeSearch::_select_item(TreeItem *p_item) {
+	if (!p_item)
+		return;
+	ERR_FAIL_COND(!tree_reference || p_item->get_tree() != tree_reference);
+
+	// first unfold ancestors
+	TreeItem *ancestor = p_item->get_parent();
+	while (ancestor) {
+		ancestor->set_collapsed(false);
+		ancestor = ancestor->get_parent();
+	}
+	//then scroll to [item]
+	tree_reference->scroll_to_item(p_item);
+
+	// ...and select it
+	tree_reference->deselect_all();
+	tree_reference->set_selected(p_item, 0);
+}
+
+void TreeSearch::_select_first_match() {
+	if (matching_entries.size() == 0) {
+		return;
+	}
+	for (int i = 0; i < ordered_tree_items.size(); i++) {
+		TreeItem *item = ordered_tree_items[i];
+		if (!_vector_has_bsearch(matching_entries, item)) {
+			continue;
+		}
+		String debug_string = "[";
+		_select_item(item);
+		return;
+	}
+}
+
+void TreeSearch::_select_next_match() {
+	if (matching_entries.size() == 0) {
+		return;
+	}
+	TreeItem *selected = tree_reference->get_selected(); // we care about a single item here.
+	if (!selected) {
+		_select_first_match();
+		return;
+	}
+
+	int selected_idx = -1;
+	for (int i = 0; i < ordered_tree_items.size(); i++) {
+		if (ordered_tree_items[i] == selected) {
+			selected_idx = i;
+			break;
+		}
+	}
+
+	// find the best fitting entry.
+	for (int i = 0; i < ordered_tree_items.size(); i++) {
+		TreeItem *item = ordered_tree_items[i];
+		if (!_vector_has_bsearch(matching_entries, item) || selected_idx >= i) {
+			continue;
+		}
+
+		_select_item(item);
+		return;
+	}
+	_select_first_match(); // wrap around.
+}
+
+template <typename T>
+inline bool TreeSearch::_vector_has_bsearch(Vector<T *> p_vec, T *element) {
+	int idx = p_vec.bsearch(element, true);
+	bool in_array = idx >= 0 && idx < p_vec.size();
+
+	return in_array && p_vec[idx] == element;
+}
+
+void TreeSearch::on_item_edited(TreeItem *item) {
+	if (item->get_cell_mode(0) != TreeItem::CELL_MODE_CUSTOM) {
+		return;
+	}
+
+	if (!callable_cache.has(item) || item->get_custom_draw_callback(0) == callable_cache.get(item)) {
+		return;
+	}
+
+	item->set_custom_draw_callback(0, callable_cache.get(item));
+}
+
+// Call this as a post-processing step for the already constructed tree.
+void TreeSearch::update_search(Tree *p_tree) {
+	ERR_FAIL_COND(!search_panel || !p_tree);
+
+	// ignore if panel not visible or no search string is given.
+	if (!search_panel->is_visible() || search_panel->get_text().length() == 0) {
+		return;
+	}
+
+	tree_reference = p_tree;
+
+	String search_mask = search_panel->get_text();
+	TreeSearchMode search_mode = search_panel->get_search_mode();
+
+	_update_ordered_tree_items(p_tree->get_root());
+	_update_matching_entries(search_mask);
+	_update_number_matches();
+
+	_highlight_tree(search_mask);
+	if (!search_panel->is_connected("text_submitted", callable_mp(this, &TreeSearch::_select_next_match))) {
+		search_panel->connect("text_submitted", callable_mp(this, &TreeSearch::_select_next_match));
+	}
+
+	if (search_mode == TreeSearchMode::FILTER) {
+		_filter_tree(search_mask);
+	}
+	
+}
+
+TreeSearch::TreeSearch(TreeSearchPanel *p_search_panel) {
+	search_panel = p_search_panel;
+}
+
+/* !TreeSearch */
+
+#endif // TOOLS_ENABLED

editor/tree_search.h

@@ -0,0 +1,126 @@
+/**
+ * tree_search.h
+ * =============================================================================
+ * Copyright 2021-2024 Serhii Snitsaruk
+ *
+ * Use of this source code is governed by an MIT-style
+ * license that can be found in the LICENSE file or at
+ * https://opensource.org/licenses/MIT.
+ * =============================================================================
+ */
+
+#ifdef TOOLS_ENABLED
+
+#ifndef TREE_SEARCH_H
+#define TREE_SEARCH_H
+
+#ifdef LIMBOAI_GDEXTENSION
+#include <godot_cpp/classes/check_box.hpp>
+#include <godot_cpp/classes/h_flow_container.hpp>
+#include <godot_cpp/classes/label.hpp>
+#include <godot_cpp/classes/line_edit.hpp>
+#include <godot_cpp/classes/tree.hpp>
+#include <godot_cpp/templates/hash_map.hpp>
+#endif // LIMBOAI_GDEXTENSION
+
+#ifdef LIMBOAI_MODULE
+#include "scene/gui/check_box.h"
+#include "scene/gui/flow_container.h"
+#include "scene/gui/label.h"
+#include "scene/gui/line_edit.h"
+#include "scene/gui/tree.h"
+#include "core/templates/hash_map.h"
+#endif // LIMBOAI_MODULE
+
+using namespace godot;
+
+enum TreeSearchMode {
+	HIGHLIGHT = 0,
+	FILTER = 1
+};
+
+class TreeSearchPanel : public HFlowContainer {
+	GDCLASS(TreeSearchPanel, HFlowContainer)
+private:
+	Button *toggle_button_filter_highlight;
+	Button *close_button;
+	Label *label_filter;
+	LineEdit *line_edit_search;
+	CheckBox *check_button_filter_highlight;
+	void _initialize_controls();
+	void _initialize_close_callbacks();
+	void _add_spacer(float width_multiplier = 1.f);
+
+	void _on_draw_highlight(TreeItem *p_item, Rect2 p_rect);
+	void _emit_text_submitted(const String &p_text);
+	void _emit_update_requested();
+	void _notification(int p_what);
+
+protected:
+	static void _bind_methods();
+
+public:
+	TreeSearchMode get_search_mode();
+	String get_text();
+	void show_and_focus();
+	TreeSearchPanel();
+	bool has_focus();
+};
+
+class TreeSearch : public RefCounted {
+	GDCLASS(TreeSearch, RefCounted)
+private:
+	struct StringSearchIndices {
+		// initialize to opposite bounds.
+		int lower = -1;
+		int upper = -1;
+
+		bool hit() {
+			return 0 <= lower && lower < upper;
+		}
+	};
+
+	TreeSearchPanel *search_panel;
+
+	// For TaskTree: These are updated when the tree is updated through TaskTree::_create_tree.
+	Tree *tree_reference;
+	Vector<TreeItem *> ordered_tree_items;
+	Vector<TreeItem *> matching_entries;
+	HashMap<TreeItem *, int> number_matches;
+	HashMap<TreeItem *, Callable> callable_cache;
+
+	// Update_search() calls these
+	void _filter_tree(const String &p_search_mask);
+	void _highlight_tree(const String &p_search_mask);
+
+	// Custom draw-Callback (bind inherited Callable).
+	void _draw_highlight_item(TreeItem *p_tree_item, Rect2 p_rect, Callable p_parent_draw_method);
+	
+	void _update_matching_entries(const String &p_search_mask);
+	void _update_ordered_tree_items(TreeItem *p_tree_item);
+	void _update_number_matches();
+
+	Vector<TreeItem *> _find_matching_entries(TreeItem *p_tree_item, const String &p_search_mask, Vector<TreeItem *> &p_buffer);
+	String _get_search_mask();
+	StringSearchIndices _substring_bounds(const String &p_searchable, const String &p_search_mask) const;
+
+	void _select_item(TreeItem *p_item);
+	void _select_first_match();
+	void _select_next_match();
+
+	template <typename T>
+	bool _vector_has_bsearch(Vector<T *> p_vec, T *element);
+
+protected:
+	static void _bind_methods() {}
+
+public:
+	void update_search(Tree *p_tree);
+	void on_item_edited(TreeItem *p_item);
+
+	TreeSearch(){ERR_FAIL_MSG("TreeSearch needs a TreeSearchPanel to work properly");}
+	TreeSearch(TreeSearchPanel * p_search_panel);
+};
+
+#endif // TREE_SEARCH_H
+#endif // ! TOOLS_ENABLED

register_types.cpp

@@ -106,6 +106,7 @@
 #include "util/limbo_string_names.h"
 #include "util/limbo_task_db.h"
 #include "util/limbo_utility.h"
+#include "editor/tree_search.h"
 
 #ifdef TOOLS_ENABLED
 #include "editor/debugger/behavior_tree_view.h"
@@ -267,6 +268,8 @@ void initialize_limboai_module(ModuleInitializationLevel p_level) {
 		GDREGISTER_CLASS(OwnerPicker);
 		GDREGISTER_CLASS(LimboAIEditor);
 		GDREGISTER_CLASS(LimboAIEditorPlugin);
+		GDREGISTER_INTERNAL_CLASS(TreeSearchPanel);
+		GDREGISTER_INTERNAL_CLASS(TreeSearch);
 #endif // LIMBOAI_GDEXTENSION
 
 		EditorPlugins::add_by_type<LimboAIEditorPlugin>();

util/limbo_string_names.cpp

@@ -46,6 +46,7 @@ LimboStringNames::LimboStringNames() {
 	button_up = SN("button_up");
 	call_deferred = SN("call_deferred");
 	changed = SN("changed");
+	Close = SN("Close");
 	dark_color_2 = SN("dark_color_2");
 	Debug = SN("Debug");
 	disabled_font_color = SN("disabled_font_color");

util/limbo_string_names.h

@@ -62,6 +62,7 @@ public:
 	StringName button_up;
 	StringName call_deferred;
 	StringName changed;
+	StringName Close;
 	StringName dark_color_2;
 	StringName Debug;
 	StringName disabled_font_color;