Skip to content

Tree and TreeItem folding helpers and improvements #36926

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
FeatherAntennae wants to merge 1 commit into from
Closed

Tree and TreeItem folding helpers and improvements #36926

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions doc/classes/Tree.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -254,6 +254,14 @@
Causes the [Tree] to jump to the specified [TreeItem].
</description>
</method>
<method name="set_collapsed_all">
<return type="void" />
<argument index="0" name="collapsed" type="bool" />
<argument index="1" name="ignore_active_branches" type="bool" />
<description>
Collapses or uncollapses every [TreeItem] in the [Tree], recursively, starting from the root. If ignore_active_branches is [code]true[/code], the branch containing the currently selected TreeItem will be left in its current state.
</description>
</method>
<method name="set_column_clip_content">
<return type="void" />
<argument index="0" name="column" type="int" />
Expand Down
32 changes: 32 additions & 0 deletions doc/classes/TreeItem.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -336,6 +336,12 @@
Returns the [Tree] that owns this TreeItem.
</description>
</method>
<method name="has_expanded_child">
<return type="bool" />
<description>
Returns [code]true[/code] if the [TreeItem] has at least one child which is not collapsed and has at least one child of it's own.
</description>
</method>
<method name="is_button_disabled" qualifiers="const">
<return type="bool" />
<argument index="0" name="column" type="int" />
Expand Down Expand Up @@ -364,6 +370,12 @@
Returns [code]true[/code] if column [code]column[/code] is editable.
</description>
</method>
<method name="is_in_active_branch">
<return type="bool" />
<description>
Returns [code]true[/code] if the [TreeItem] or at least one of it's descendent have at least one column selected.
</description>
</method>
<method name="is_indeterminate" qualifiers="const">
<return type="bool" />
<argument index="0" name="column" type="int" />
Expand Down Expand Up @@ -457,6 +469,17 @@
If [code]true[/code], the column [code]column[/code] is checked. Clears column's indeterminate status.
</description>
</method>
<method name="set_collapsed_recursive">
<return type="void" />
<argument index="0" name="enable" type="bool" />
<argument index="1" name="ignore_active_branches" type="bool" />
<argument index="2" name="ignore_self" type="bool" />
<description>
Recursively collapse this [TreeItem] and all its descendants when [code]enable[/code] is [code]true[/code], otherwise expanding them.
If [code]ignore_active_branches[/code] is [code]true[/code], branches which contains a selected [TreeItem] will be ignored.
If [code]ignore_self[/code] is [code]true[/code], only descendants are affected.
</description>
</method>
<method name="set_custom_as_button">
<return type="void" />
<argument index="0" name="column" type="int" />
Expand Down Expand Up @@ -671,9 +694,18 @@
Sets the given column's tooltip text.
</description>
</method>
<method name="toggle_collapsed_recursive">
<return type="void" />
<description>
If the [TreeItem] is already collapsed, expands it and all of its children recursively.
If the [TreeItem] is expanded and has at least one expanded child, collapses all children recursively without collapsing the current [TreeItem].
If the [TreeItem] is expanded and all children are collapsed, collapses the [TreeItem].
</description>
</method>
<method name="uncollapse_tree">
<return type="void" />
<description>
Uncollapses the [TreeItem] and all of it's ancestor.
</description>
</method>
</methods>
Expand Down
22 changes: 2 additions & 20 deletions editor/debugger/script_editor_debugger.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1439,29 +1439,11 @@ void ScriptEditorDebugger::_error_selected() {
}

void ScriptEditorDebugger::_expand_errors_list() {
TreeItem *root = error_tree->get_root();
if (!root) {
return;
}

TreeItem *item = root->get_first_child();
while (item) {
item->set_collapsed(false);
item = item->get_next();
}
error_tree->set_collapsed_all(false, false);
}

void ScriptEditorDebugger::_collapse_errors_list() {
TreeItem *root = error_tree->get_root();
if (!root) {
return;
}

TreeItem *item = root->get_first_child();
while (item) {
item->set_collapsed(true);
item = item->get_next();
}
error_tree->set_collapsed_all(true, false);
}

void ScriptEditorDebugger::_clear_errors_list() {
Expand Down
25 changes: 2 additions & 23 deletions editor/plugins/visual_shader_editor_plugin.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4356,31 +4356,10 @@ void VisualShaderEditor::_tools_menu_option(int p_idx) {

switch (p_idx) {
case EXPAND_ALL:

while (category) {
category->set_collapsed(false);
TreeItem *sub_category = category->get_first_child();
while (sub_category) {
sub_category->set_collapsed(false);
sub_category = sub_category->get_next();
}
category = category->get_next();
}

category->set_collapsed_recursive(false, false, false);
break;

case COLLAPSE_ALL:

while (category) {
category->set_collapsed(true);
TreeItem *sub_category = category->get_first_child();
while (sub_category) {
sub_category->set_collapsed(true);
sub_category = sub_category->get_next();
}
category = category->get_next();
}

category->set_collapsed_recursive(true, false, false);
break;
default:
break;
Expand Down
58 changes: 2 additions & 56 deletions editor/scene_tree_dock.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -438,8 +438,8 @@ void SceneTreeDock::_tool_selected(int p_tool, bool p_confirm_override) {
}
}

bool collapsed = _is_collapsed_recursive(selected_item);
_set_collapsed_recursive(selected_item, !collapsed);
bool collapse = selected_item->has_expanded_child();
selected_item->set_collapsed_recursive(collapse, false, false);

tree->ensure_cursor_is_visible();

Expand Down Expand Up @@ -1175,17 +1175,6 @@ void SceneTreeDock::add_root_node(Node *p_node) {
editor_data->get_undo_redo().commit_action();
}

void SceneTreeDock::_node_collapsed(Object *p_obj) {
TreeItem *ti = Object::cast_to<TreeItem>(p_obj);
if (!ti) {
return;
}

if (Input::get_singleton()->is_key_pressed(Key::SHIFT)) {
_set_collapsed_recursive(ti, ti->is_collapsed());
}
}

void SceneTreeDock::_notification(int p_what) {
switch (p_what) {
case NOTIFICATION_READY: {
Expand Down Expand Up @@ -1903,48 +1892,6 @@ void SceneTreeDock::_do_reparent(Node *p_new_parent, int p_position_in_parent, V
editor_data->get_undo_redo().commit_action();
}

bool SceneTreeDock::_is_collapsed_recursive(TreeItem *p_item) const {
bool is_branch_collapsed = false;

List<TreeItem *> needs_check;
needs_check.push_back(p_item);

while (!needs_check.is_empty()) {
TreeItem *item = needs_check.back()->get();
needs_check.pop_back();

TreeItem *child = item->get_first_child();
is_branch_collapsed = item->is_collapsed() && child;

if (is_branch_collapsed) {
break;
}
while (child) {
needs_check.push_back(child);
child = child->get_next();
}
}
return is_branch_collapsed;
}

void SceneTreeDock::_set_collapsed_recursive(TreeItem *p_item, bool p_collapsed) {
List<TreeItem *> to_collapse;
to_collapse.push_back(p_item);

while (!to_collapse.is_empty()) {
TreeItem *item = to_collapse.back()->get();
to_collapse.pop_back();

item->set_collapsed(p_collapsed);

TreeItem *child = item->get_first_child();
while (child) {
to_collapse.push_back(child);
child = child->get_next();
}
}
}

void SceneTreeDock::_script_created(Ref<Script> p_script) {
List<Node *> selected = editor_selection->get_selected_node_list();

Expand Down Expand Up @@ -3465,7 +3412,6 @@ SceneTreeDock::SceneTreeDock(Node *p_scene_root, EditorSelection *p_editor_selec
scene_tree->connect("nodes_dragged", callable_mp(this, &SceneTreeDock::_nodes_drag_begin));

scene_tree->get_scene_tree()->connect("item_double_clicked", callable_mp(this, &SceneTreeDock::_focus_node));
scene_tree->get_scene_tree()->connect("item_collapsed", callable_mp(this, &SceneTreeDock::_node_collapsed));

editor_selection->connect("selection_changed", callable_mp(this, &SceneTreeDock::_selection_changed));

Expand Down
4 changes: 0 additions & 4 deletions editor/scene_tree_dock.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -133,7 +133,6 @@ class SceneTreeDock : public VBoxContainer {
HBoxContainer *tool_hbc = nullptr;
void _tool_selected(int p_tool, bool p_confirm_override = false);
void _property_selected(int p_idx);
void _node_collapsed(Object *p_obj);

Node *property_drop_node = nullptr;
String resource_drop_path;
Expand Down Expand Up @@ -184,9 +183,6 @@ class SceneTreeDock : public VBoxContainer {
void _node_reparent(NodePath p_path, bool p_keep_global_xform);
void _do_reparent(Node *p_new_parent, int p_position_in_parent, Vector<Node *> p_nodes, bool p_keep_global_xform);

bool _is_collapsed_recursive(TreeItem *p_item) const;
void _set_collapsed_recursive(TreeItem *p_item, bool p_collapsed);

void _set_owners(Node *p_owner, const Array &p_nodes);

enum ReplaceOwnerMode {
Expand Down
Loading