2023-01-05 13:25:55 +01:00
|
|
|
/**************************************************************************/
|
|
|
|
/* scene_tree_editor.h */
|
|
|
|
/**************************************************************************/
|
|
|
|
/* 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. */
|
|
|
|
/**************************************************************************/
|
2018-01-05 00:50:27 +01:00
|
|
|
|
2014-02-10 02:10:30 +01:00
|
|
|
#ifndef SCENE_TREE_EDITOR_H
|
|
|
|
#define SCENE_TREE_EDITOR_H
|
|
|
|
|
2023-07-08 19:15:17 +02:00
|
|
|
#include "scene/gui/check_button.h"
|
2014-02-10 02:10:30 +01:00
|
|
|
#include "scene/gui/dialogs.h"
|
2017-03-05 16:44:50 +01:00
|
|
|
#include "scene/gui/tree.h"
|
2019-08-10 14:28:17 +02:00
|
|
|
|
2023-04-05 17:14:46 +02:00
|
|
|
class EditorSelection;
|
2023-07-17 23:40:27 +02:00
|
|
|
class TextureRect;
|
2023-04-05 17:14:46 +02:00
|
|
|
|
2014-02-10 02:10:30 +01:00
|
|
|
class SceneTreeEditor : public Control {
|
2017-03-05 16:44:50 +01:00
|
|
|
GDCLASS(SceneTreeEditor, Control);
|
2014-02-10 02:10:30 +01:00
|
|
|
|
2022-04-04 15:06:57 +02:00
|
|
|
EditorSelection *editor_selection = nullptr;
|
2014-02-10 02:10:30 +01:00
|
|
|
|
2021-04-25 16:40:58 +02:00
|
|
|
enum SceneTreeEditorButton {
|
2017-03-05 16:44:50 +01:00
|
|
|
BUTTON_SUBSCENE = 0,
|
|
|
|
BUTTON_VISIBILITY = 1,
|
|
|
|
BUTTON_SCRIPT = 2,
|
|
|
|
BUTTON_LOCK = 3,
|
|
|
|
BUTTON_GROUP = 4,
|
|
|
|
BUTTON_WARNING = 5,
|
|
|
|
BUTTON_SIGNALS = 6,
|
|
|
|
BUTTON_GROUPS = 7,
|
2018-06-07 17:46:14 +02:00
|
|
|
BUTTON_PIN = 8,
|
2022-04-16 12:23:32 +02:00
|
|
|
BUTTON_UNIQUE = 9,
|
2014-02-10 02:10:30 +01:00
|
|
|
};
|
|
|
|
|
2022-04-04 15:06:57 +02:00
|
|
|
Tree *tree = nullptr;
|
|
|
|
Node *selected = nullptr;
|
2014-09-03 04:13:40 +02:00
|
|
|
ObjectID instance_node;
|
2014-02-10 02:10:30 +01:00
|
|
|
|
2016-05-16 17:23:40 +02:00
|
|
|
String filter;
|
2022-09-16 15:10:28 +02:00
|
|
|
String filter_term_warning;
|
2023-07-08 19:15:17 +02:00
|
|
|
bool show_all_nodes = false;
|
2016-05-16 17:23:40 +02:00
|
|
|
|
2022-04-04 15:06:57 +02:00
|
|
|
AcceptDialog *error = nullptr;
|
|
|
|
AcceptDialog *warning = nullptr;
|
2014-03-14 02:57:24 +01:00
|
|
|
|
2021-08-09 19:14:06 +02:00
|
|
|
bool auto_expand_selected = true;
|
2022-02-15 15:56:58 +01:00
|
|
|
bool connect_to_script_mode = false;
|
|
|
|
bool connecting_signal = false;
|
2019-04-12 04:21:48 +02:00
|
|
|
|
2014-02-10 02:10:30 +01:00
|
|
|
int blocked;
|
2016-03-09 00:00:52 +01:00
|
|
|
|
2017-03-05 16:44:50 +01:00
|
|
|
void _compute_hash(Node *p_node, uint64_t &hash);
|
2014-02-10 02:10:30 +01:00
|
|
|
|
2022-05-24 17:24:25 +02:00
|
|
|
void _add_nodes(Node *p_node, TreeItem *p_parent);
|
2014-02-10 02:10:30 +01:00
|
|
|
void _test_update_tree();
|
2022-05-24 17:24:25 +02:00
|
|
|
bool _update_filter(TreeItem *p_parent = nullptr, bool p_scroll_to_selected = false);
|
2022-09-05 08:22:20 +02:00
|
|
|
bool _item_matches_all_terms(TreeItem *p_item, PackedStringArray p_terms);
|
2014-02-10 02:10:30 +01:00
|
|
|
void _tree_changed();
|
2021-02-18 19:52:29 +01:00
|
|
|
void _tree_process_mode_changed();
|
2014-02-10 02:10:30 +01:00
|
|
|
void _node_removed(Node *p_node);
|
2019-05-24 15:27:22 +02:00
|
|
|
void _node_renamed(Node *p_node);
|
2016-03-09 00:00:52 +01:00
|
|
|
|
2017-03-05 16:44:50 +01:00
|
|
|
TreeItem *_find(TreeItem *p_node, const NodePath &p_path);
|
2014-02-10 02:10:30 +01:00
|
|
|
void _notification(int p_what);
|
2021-07-23 10:34:21 +02:00
|
|
|
void _selected_changed();
|
2017-11-26 12:49:21 +01:00
|
|
|
void _deselect_items();
|
2023-04-23 18:32:59 +02:00
|
|
|
void _rename_node(Node *p_node, const String &p_name);
|
2014-02-10 02:10:30 +01:00
|
|
|
|
|
|
|
void _cell_collapsed(Object *p_obj);
|
|
|
|
|
|
|
|
uint64_t last_hash;
|
|
|
|
|
|
|
|
bool can_rename;
|
|
|
|
bool can_open_instance;
|
2022-02-15 15:56:58 +01:00
|
|
|
bool updating_tree = false;
|
|
|
|
bool show_enabled_subscene = false;
|
2022-08-29 12:10:32 +02:00
|
|
|
bool is_scene_tree_dock = false;
|
2016-03-09 00:00:52 +01:00
|
|
|
|
2014-02-10 02:10:30 +01:00
|
|
|
void _renamed();
|
2016-03-09 00:00:52 +01:00
|
|
|
|
2022-05-19 17:00:06 +02:00
|
|
|
HashSet<Node *> marked;
|
2022-02-15 15:56:58 +01:00
|
|
|
bool marked_selectable = false;
|
|
|
|
bool marked_children_selectable = false;
|
|
|
|
bool display_foreign = false;
|
|
|
|
bool tree_dirty = true;
|
|
|
|
bool pending_test_update = false;
|
2016-03-09 00:00:52 +01:00
|
|
|
static void _bind_methods();
|
2014-02-10 02:10:30 +01:00
|
|
|
|
2021-09-18 09:33:18 +02:00
|
|
|
void _cell_button_pressed(Object *p_item, int p_column, int p_id, MouseButton p_button);
|
2018-01-01 09:05:00 +01:00
|
|
|
void _toggle_visible(Node *p_node);
|
2017-08-12 18:52:50 +02:00
|
|
|
void _cell_multi_selected(Object *p_object, int p_cell, bool p_selected);
|
2014-02-10 02:10:30 +01:00
|
|
|
void _update_selection(TreeItem *item);
|
|
|
|
void _node_script_changed(Node *p_node);
|
|
|
|
void _node_visibility_changed(Node *p_node);
|
2016-12-28 14:12:08 +01:00
|
|
|
void _update_visibility_color(Node *p_node, TreeItem *p_item);
|
2023-08-28 02:37:47 +02:00
|
|
|
void _set_item_custom_color(TreeItem *p_item, Color p_color);
|
2014-02-10 02:10:30 +01:00
|
|
|
|
|
|
|
void _selection_changed();
|
2023-11-01 14:56:14 +01:00
|
|
|
Node *get_scene_node() const;
|
2016-05-11 16:46:08 +02:00
|
|
|
|
2017-03-05 16:44:50 +01:00
|
|
|
Variant get_drag_data_fw(const Point2 &p_point, Control *p_from);
|
|
|
|
bool can_drop_data_fw(const Point2 &p_point, const Variant &p_data, Control *p_from) const;
|
|
|
|
void drop_data_fw(const Point2 &p_point, const Variant &p_data, Control *p_from);
|
2016-05-11 16:46:08 +02:00
|
|
|
|
2021-09-18 09:33:18 +02:00
|
|
|
void _empty_clicked(const Vector2 &p_pos, MouseButton p_button);
|
|
|
|
void _rmb_select(const Vector2 &p_pos, MouseButton p_button = MouseButton::RIGHT);
|
2016-05-16 04:41:48 +02:00
|
|
|
|
2017-03-05 16:44:50 +01:00
|
|
|
void _warning_changed(Node *p_for_node);
|
2016-05-17 23:27:15 +02:00
|
|
|
|
2022-04-04 15:06:57 +02:00
|
|
|
Timer *update_timer = nullptr;
|
2016-05-17 23:27:15 +02:00
|
|
|
|
2016-10-27 16:32:41 +02:00
|
|
|
List<StringName> *script_types;
|
|
|
|
bool _is_script_type(const StringName &p_type) const;
|
|
|
|
|
2018-06-28 01:50:25 +02:00
|
|
|
Vector<StringName> valid_types;
|
|
|
|
|
2014-02-10 02:10:30 +01:00
|
|
|
public:
|
2020-12-06 16:09:18 +01:00
|
|
|
// Public for use with callable_mp.
|
|
|
|
void _update_tree(bool p_scroll_to_selected = false);
|
|
|
|
|
2017-03-05 16:44:50 +01:00
|
|
|
void set_filter(const String &p_filter);
|
2016-05-16 17:23:40 +02:00
|
|
|
String get_filter() const;
|
2022-09-16 15:10:28 +02:00
|
|
|
String get_filter_term_warning();
|
2023-07-08 19:15:17 +02:00
|
|
|
void set_show_all_nodes(bool p_show_all_nodes);
|
2014-02-10 02:10:30 +01:00
|
|
|
|
2022-08-29 12:10:32 +02:00
|
|
|
void set_as_scene_tree_dock();
|
2014-02-10 02:10:30 +01:00
|
|
|
void set_display_foreign_nodes(bool p_display);
|
2016-03-09 00:00:52 +01:00
|
|
|
|
2022-05-19 17:00:06 +02:00
|
|
|
void set_marked(const HashSet<Node *> &p_marked, bool p_selectable = false, bool p_children_selectable = true);
|
2017-03-05 16:44:50 +01:00
|
|
|
void set_marked(Node *p_marked, bool p_selectable = false, bool p_children_selectable = true);
|
|
|
|
void set_selected(Node *p_node, bool p_emit_selected = true);
|
2014-02-10 02:10:30 +01:00
|
|
|
Node *get_selected();
|
2017-03-05 16:44:50 +01:00
|
|
|
void set_can_rename(bool p_can_rename) { can_rename = p_can_rename; }
|
2014-02-10 02:10:30 +01:00
|
|
|
void set_editor_selection(EditorSelection *p_selection);
|
|
|
|
|
2017-03-05 16:44:50 +01:00
|
|
|
void set_show_enabled_subscene(bool p_show) { show_enabled_subscene = p_show; }
|
2018-06-28 01:50:25 +02:00
|
|
|
void set_valid_types(const Vector<StringName> &p_valid);
|
2014-09-03 04:13:40 +02:00
|
|
|
|
2014-04-19 21:46:52 +02:00
|
|
|
void update_tree() { _update_tree(); }
|
|
|
|
|
2021-08-09 19:14:06 +02:00
|
|
|
void set_auto_expand_selected(bool p_auto, bool p_update_settings);
|
2019-04-12 04:21:48 +02:00
|
|
|
void set_connect_to_script_mode(bool p_enable);
|
2019-06-06 04:13:57 +02:00
|
|
|
void set_connecting_signal(bool p_enable);
|
2019-04-12 04:21:48 +02:00
|
|
|
|
2017-03-05 16:44:50 +01:00
|
|
|
Tree *get_scene_tree() { return tree; }
|
2015-06-22 05:03:19 +02:00
|
|
|
|
2021-04-27 17:43:49 +02:00
|
|
|
void update_warning();
|
|
|
|
|
2017-03-05 16:44:50 +01:00
|
|
|
SceneTreeEditor(bool p_label = true, bool p_can_rename = false, bool p_can_open_instance = false);
|
2014-02-10 02:10:30 +01:00
|
|
|
~SceneTreeEditor();
|
|
|
|
};
|
|
|
|
|
|
|
|
class SceneTreeDialog : public ConfirmationDialog {
|
2017-03-05 16:44:50 +01:00
|
|
|
GDCLASS(SceneTreeDialog, ConfirmationDialog);
|
2014-02-10 02:10:30 +01:00
|
|
|
|
2023-07-17 23:40:27 +02:00
|
|
|
VBoxContainer *content = nullptr;
|
2022-04-04 15:06:57 +02:00
|
|
|
SceneTreeEditor *tree = nullptr;
|
|
|
|
LineEdit *filter = nullptr;
|
2023-07-08 19:15:17 +02:00
|
|
|
CheckButton *show_all_nodes = nullptr;
|
2023-07-17 23:40:27 +02:00
|
|
|
LocalVector<TextureRect *> valid_type_icons;
|
2014-02-10 02:10:30 +01:00
|
|
|
|
|
|
|
void _select();
|
2016-03-09 00:00:52 +01:00
|
|
|
void _cancel();
|
2022-07-14 06:03:27 +02:00
|
|
|
void _selected_changed();
|
2019-07-06 19:09:34 +02:00
|
|
|
void _filter_changed(const String &p_filter);
|
2023-07-08 19:15:17 +02:00
|
|
|
void _show_all_nodes_changed(bool p_button_pressed);
|
2014-02-10 02:10:30 +01:00
|
|
|
|
|
|
|
protected:
|
|
|
|
void _notification(int p_what);
|
|
|
|
static void _bind_methods();
|
|
|
|
|
2017-03-05 16:44:50 +01:00
|
|
|
public:
|
2020-07-11 18:45:19 +02:00
|
|
|
void popup_scenetree_dialog();
|
2023-07-17 23:40:27 +02:00
|
|
|
void set_valid_types(const Vector<StringName> &p_valid);
|
|
|
|
|
2015-06-22 05:03:19 +02:00
|
|
|
SceneTreeEditor *get_scene_tree() { return tree; }
|
2021-03-12 16:40:17 +01:00
|
|
|
LineEdit *get_filter_line_edit() { return filter; }
|
2023-07-17 23:40:27 +02:00
|
|
|
|
2014-02-10 02:10:30 +01:00
|
|
|
SceneTreeDialog();
|
|
|
|
~SceneTreeDialog();
|
|
|
|
};
|
|
|
|
|
2022-07-23 23:41:51 +02:00
|
|
|
#endif // SCENE_TREE_EDITOR_H
|