12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004 |
- /**************************************************************************/
- /* editor_node.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. */
- /**************************************************************************/
- #ifndef EDITOR_NODE_H
- #define EDITOR_NODE_H
- #include "core/object/script_language.h"
- #include "core/templates/safe_refcount.h"
- #include "editor/editor_data.h"
- #include "editor/editor_folding.h"
- #include "editor/plugins/editor_plugin.h"
- typedef void (*EditorNodeInitCallback)();
- typedef void (*EditorPluginInitializeCallback)();
- typedef bool (*EditorBuildCallback)();
- class AcceptDialog;
- class ColorPicker;
- class ConfirmationDialog;
- class Control;
- class FileDialog;
- class MenuBar;
- class MenuButton;
- class OptionButton;
- class Panel;
- class PanelContainer;
- class RichTextLabel;
- class SubViewport;
- class TextureProgressBar;
- class Tree;
- class VBoxContainer;
- class VSplitContainer;
- class Window;
- class AudioStreamImportSettingsDialog;
- class AudioStreamPreviewGenerator;
- class BackgroundProgress;
- class DependencyEditor;
- class DependencyErrorDialog;
- class DockSplitContainer;
- class DynamicFontImportSettingsDialog;
- class EditorAbout;
- class EditorBuildProfileManager;
- class EditorBottomPanel;
- class EditorCommandPalette;
- class EditorDockManager;
- class EditorExport;
- class EditorExportPreset;
- class EditorFeatureProfileManager;
- class EditorFileDialog;
- class EditorFolding;
- class EditorLayoutsDialog;
- class EditorLog;
- class EditorMainScreen;
- class EditorNativeShaderSourceVisualizer;
- class EditorPluginList;
- class EditorResourcePreview;
- class EditorResourceConversionPlugin;
- class EditorRunBar;
- class EditorSceneTabs;
- class EditorSelectionHistory;
- class EditorSettingsDialog;
- class EditorTitleBar;
- class ExportTemplateManager;
- class EditorQuickOpenDialog;
- class FBXImporterManager;
- class FileSystemDock;
- class HistoryDock;
- class OrphanResourcesDialog;
- class ProgressDialog;
- class ProjectExportDialog;
- class ProjectSettingsEditor;
- class SceneImportSettingsDialog;
- class SurfaceUpgradeTool;
- class SurfaceUpgradeDialog;
- struct EditorProgress {
- String task;
- bool force_background = false;
- bool step(const String &p_state, int p_step = -1, bool p_force_refresh = true);
- EditorProgress(const String &p_task, const String &p_label, int p_amount, bool p_can_cancel = false, bool p_force_background = false);
- ~EditorProgress();
- };
- class EditorNode : public Node {
- GDCLASS(EditorNode, Node);
- public:
- enum SceneNameCasing {
- SCENE_NAME_CASING_AUTO,
- SCENE_NAME_CASING_PASCAL_CASE,
- SCENE_NAME_CASING_SNAKE_CASE,
- SCENE_NAME_CASING_KEBAB_CASE,
- };
- enum ActionOnPlay {
- ACTION_ON_PLAY_DO_NOTHING,
- ACTION_ON_PLAY_OPEN_OUTPUT,
- ACTION_ON_PLAY_OPEN_DEBUGGER,
- };
- enum ActionOnStop {
- ACTION_ON_STOP_DO_NOTHING,
- ACTION_ON_STOP_CLOSE_BUTTOM_PANEL,
- };
- struct ExecuteThreadArgs {
- String path;
- List<String> args;
- String output;
- Thread execute_output_thread;
- Mutex execute_output_mutex;
- int exitcode = 0;
- SafeFlag done;
- };
- private:
- friend class EditorSceneTabs;
- friend class SurfaceUpgradeTool;
- enum MenuOptions {
- FILE_NEW_SCENE,
- FILE_NEW_INHERITED_SCENE,
- FILE_OPEN_SCENE,
- FILE_SAVE_SCENE,
- FILE_SAVE_SCENE_SILENTLY,
- FILE_SAVE_AS_SCENE,
- FILE_SAVE_ALL_SCENES,
- FILE_SAVE_AND_RUN,
- FILE_SAVE_AND_RUN_MAIN_SCENE,
- FILE_RUN_SCENE,
- FILE_SHOW_IN_FILESYSTEM,
- FILE_EXPORT_PROJECT,
- FILE_EXPORT_MESH_LIBRARY,
- FILE_INSTALL_ANDROID_SOURCE,
- FILE_EXPLORE_ANDROID_BUILD_TEMPLATES,
- FILE_SAVE_OPTIMIZED,
- FILE_OPEN_RECENT,
- FILE_OPEN_OLD_SCENE,
- FILE_QUICK_OPEN,
- FILE_QUICK_OPEN_SCENE,
- FILE_QUICK_OPEN_SCRIPT,
- FILE_OPEN_PREV,
- FILE_CLOSE,
- FILE_CLOSE_OTHERS,
- FILE_CLOSE_RIGHT,
- FILE_CLOSE_ALL,
- FILE_QUIT,
- FILE_EXTERNAL_OPEN_SCENE,
- EDIT_UNDO,
- EDIT_REDO,
- EDIT_RELOAD_SAVED_SCENE,
- TOOLS_ORPHAN_RESOURCES,
- TOOLS_BUILD_PROFILE_MANAGER,
- TOOLS_SURFACE_UPGRADE,
- TOOLS_CUSTOM,
- RESOURCE_SAVE,
- RESOURCE_SAVE_AS,
- RUN_SETTINGS,
- RUN_USER_DATA_FOLDER,
- RELOAD_CURRENT_PROJECT,
- RUN_PROJECT_MANAGER,
- VCS_MENU,
- RUN_VCS_METADATA,
- RUN_VCS_SETTINGS,
- SETTINGS_UPDATE_CONTINUOUSLY,
- SETTINGS_UPDATE_WHEN_CHANGED,
- SETTINGS_UPDATE_ALWAYS,
- SETTINGS_UPDATE_CHANGES,
- SETTINGS_UPDATE_SPINNER_HIDE,
- SETTINGS_PREFERENCES,
- SETTINGS_LAYOUT_SAVE,
- SETTINGS_LAYOUT_DELETE,
- SETTINGS_LAYOUT_DEFAULT,
- SETTINGS_EDITOR_DATA_FOLDER,
- SETTINGS_EDITOR_CONFIG_FOLDER,
- SETTINGS_MANAGE_EXPORT_TEMPLATES,
- SETTINGS_MANAGE_FBX_IMPORTER,
- SETTINGS_MANAGE_FEATURE_PROFILES,
- SETTINGS_INSTALL_ANDROID_BUILD_TEMPLATE,
- SETTINGS_PICK_MAIN_SCENE,
- SETTINGS_TOGGLE_FULLSCREEN,
- SETTINGS_HELP,
- SCENE_TAB_CLOSE,
- EDITOR_SCREENSHOT,
- EDITOR_OPEN_SCREENSHOT,
- HELP_SEARCH,
- HELP_COMMAND_PALETTE,
- HELP_DOCS,
- HELP_FORUM,
- HELP_REPORT_A_BUG,
- HELP_COPY_SYSTEM_INFO,
- HELP_SUGGEST_A_FEATURE,
- HELP_SEND_DOCS_FEEDBACK,
- HELP_COMMUNITY,
- HELP_ABOUT,
- HELP_SUPPORT_GODOT_DEVELOPMENT,
- SET_RENDERER_NAME_SAVE_AND_RESTART,
- IMPORT_PLUGIN_BASE = 100,
- TOOL_MENU_BASE = 1000
- };
- enum {
- MAX_INIT_CALLBACKS = 128,
- MAX_BUILD_CALLBACKS = 128
- };
- struct ExportDefer {
- String preset;
- String path;
- bool debug = false;
- bool pack_only = false;
- bool android_build_template = false;
- bool patch = false;
- Vector<String> patches;
- } export_defer;
- static EditorNode *singleton;
- EditorData editor_data;
- EditorFolding editor_folding;
- EditorSelectionHistory editor_history;
- EditorCommandPalette *command_palette = nullptr;
- EditorQuickOpenDialog *quick_open_dialog = nullptr;
- EditorExport *editor_export = nullptr;
- EditorLog *log = nullptr;
- EditorNativeShaderSourceVisualizer *native_shader_source_visualizer = nullptr;
- EditorPluginList *editor_plugins_force_input_forwarding = nullptr;
- EditorPluginList *editor_plugins_force_over = nullptr;
- EditorPluginList *editor_plugins_over = nullptr;
- EditorQuickOpenDialog *quick_open_color_palette = nullptr;
- EditorResourcePreview *resource_preview = nullptr;
- EditorSelection *editor_selection = nullptr;
- EditorSettingsDialog *editor_settings_dialog = nullptr;
- HistoryDock *history_dock = nullptr;
- ProjectExportDialog *project_export = nullptr;
- ProjectSettingsEditor *project_settings_editor = nullptr;
- FBXImporterManager *fbx_importer_manager = nullptr;
- Vector<EditorPlugin *> editor_plugins;
- bool _initializing_plugins = false;
- HashMap<String, EditorPlugin *> addon_name_to_plugin;
- LocalVector<String> pending_addons;
- HashMap<ObjectID, HashSet<EditorPlugin *>> active_plugins;
- bool is_main_screen_editing = false;
- Control *gui_base = nullptr;
- VBoxContainer *main_vbox = nullptr;
- OptionButton *renderer = nullptr;
- ConfirmationDialog *video_restart_dialog = nullptr;
- int renderer_current = 0;
- String renderer_request;
- // Split containers.
- DockSplitContainer *left_l_hsplit = nullptr;
- DockSplitContainer *left_l_vsplit = nullptr;
- DockSplitContainer *left_r_hsplit = nullptr;
- DockSplitContainer *left_r_vsplit = nullptr;
- DockSplitContainer *main_hsplit = nullptr;
- DockSplitContainer *right_hsplit = nullptr;
- DockSplitContainer *right_l_vsplit = nullptr;
- DockSplitContainer *right_r_vsplit = nullptr;
- DockSplitContainer *center_split = nullptr;
- // Main tabs.
- EditorSceneTabs *scene_tabs = nullptr;
- int tab_closing_idx = 0;
- List<String> tabs_to_close;
- int tab_closing_menu_option = -1;
- bool exiting = false;
- bool dimmed = false;
- DisplayServer::WindowMode prev_mode = DisplayServer::WINDOW_MODE_MAXIMIZED;
- int old_split_ofs = 0;
- VSplitContainer *top_split = nullptr;
- Control *vp_base = nullptr;
- Label *project_title = nullptr;
- Control *left_menu_spacer = nullptr;
- Control *right_menu_spacer = nullptr;
- EditorTitleBar *title_bar = nullptr;
- EditorRunBar *project_run_bar = nullptr;
- MenuBar *main_menu = nullptr;
- PopupMenu *apple_menu = nullptr;
- PopupMenu *file_menu = nullptr;
- PopupMenu *project_menu = nullptr;
- PopupMenu *debug_menu = nullptr;
- PopupMenu *settings_menu = nullptr;
- PopupMenu *help_menu = nullptr;
- PopupMenu *tool_menu = nullptr;
- PopupMenu *export_as_menu = nullptr;
- Button *export_button = nullptr;
- Button *search_button = nullptr;
- TextureProgressBar *audio_vu = nullptr;
- Timer *screenshot_timer = nullptr;
- uint64_t started_timestamp = 0;
- RichTextLabel *load_errors = nullptr;
- AcceptDialog *load_error_dialog = nullptr;
- bool load_errors_queued_to_display = false;
- RichTextLabel *execute_outputs = nullptr;
- AcceptDialog *execute_output_dialog = nullptr;
- Ref<Theme> theme;
- Timer *system_theme_timer = nullptr;
- bool follow_system_theme = false;
- bool use_system_accent_color = false;
- bool last_dark_mode_state = false;
- Color last_system_base_color = Color(0, 0, 0, 0);
- Color last_system_accent_color = Color(0, 0, 0, 0);
- PopupMenu *recent_scenes = nullptr;
- String _recent_scene;
- List<String> previous_scenes;
- String defer_load_scene;
- Node *_last_instantiated_scene = nullptr;
- ConfirmationDialog *confirmation = nullptr;
- ConfirmationDialog *save_confirmation = nullptr;
- ConfirmationDialog *import_confirmation = nullptr;
- ConfirmationDialog *pick_main_scene = nullptr;
- Button *select_current_scene_button = nullptr;
- AcceptDialog *accept = nullptr;
- AcceptDialog *save_accept = nullptr;
- EditorAbout *about = nullptr;
- AcceptDialog *warning = nullptr;
- EditorPlugin *plugin_to_save = nullptr;
- int overridden_default_layout = -1;
- Ref<ConfigFile> default_layout;
- PopupMenu *editor_layouts = nullptr;
- EditorLayoutsDialog *layout_dialog = nullptr;
- ConfirmationDialog *gradle_build_manage_templates = nullptr;
- ConfirmationDialog *install_android_build_template = nullptr;
- ConfirmationDialog *remove_android_build_template = nullptr;
- Label *install_android_build_template_message = nullptr;
- OptionButton *choose_android_export_profile = nullptr;
- Ref<EditorExportPreset> android_export_preset;
- PopupMenu *vcs_actions_menu = nullptr;
- EditorFileDialog *file = nullptr;
- ExportTemplateManager *export_template_manager = nullptr;
- EditorFeatureProfileManager *feature_profile_manager = nullptr;
- EditorBuildProfileManager *build_profile_manager = nullptr;
- EditorFileDialog *file_templates = nullptr;
- EditorFileDialog *file_export_lib = nullptr;
- EditorFileDialog *file_script = nullptr;
- EditorFileDialog *file_android_build_source = nullptr;
- String current_path;
- MenuButton *update_spinner = nullptr;
- EditorMainScreen *editor_main_screen = nullptr;
- AudioStreamPreviewGenerator *audio_preview_gen = nullptr;
- ProgressDialog *progress_dialog = nullptr;
- BackgroundProgress *progress_hb = nullptr;
- DependencyErrorDialog *dependency_error = nullptr;
- HashMap<String, HashSet<String>> dependency_errors;
- DependencyEditor *dependency_fixer = nullptr;
- OrphanResourcesDialog *orphan_resources = nullptr;
- ConfirmationDialog *open_imported = nullptr;
- Button *new_inherited_button = nullptr;
- String open_import_request;
- EditorDockManager *editor_dock_manager = nullptr;
- Timer *editor_layout_save_delay_timer = nullptr;
- Timer *scan_changes_timer = nullptr;
- Button *distraction_free = nullptr;
- Callable palette_file_selected_callback;
- EditorBottomPanel *bottom_panel = nullptr;
- Tree *disk_changed_list = nullptr;
- ConfirmationDialog *disk_changed = nullptr;
- bool scene_distraction_free = false;
- bool script_distraction_free = false;
- bool changing_scene = false;
- bool cmdline_export_mode = false;
- bool convert_old = false;
- bool immediate_dialog_confirmed = false;
- bool opening_prev = false;
- bool restoring_scenes = false;
- bool unsaved_cache = true;
- bool requested_first_scan = false;
- bool waiting_for_first_scan = true;
- bool load_editor_layout_done = false;
- int current_menu_option = 0;
- SubViewport *scene_root = nullptr; // Root of the scene being edited.
- Object *current = nullptr;
- Ref<Resource> saving_resource;
- HashSet<Ref<Resource>> saving_resources_in_path;
- uint64_t update_spinner_step_msec = 0;
- uint64_t update_spinner_step_frame = 0;
- int update_spinner_step = 0;
- String _tmp_import_path;
- String external_file;
- String open_navigate;
- String saving_scene;
- EditorProgress *save_scene_progress = nullptr;
- DynamicFontImportSettingsDialog *fontdata_import_settings = nullptr;
- SceneImportSettingsDialog *scene_import_settings = nullptr;
- AudioStreamImportSettingsDialog *audio_stream_import_settings = nullptr;
- String import_reload_fn;
- HashSet<String> textfile_extensions;
- HashSet<String> other_file_extensions;
- HashSet<FileDialog *> file_dialogs;
- HashSet<EditorFileDialog *> editor_file_dialogs;
- Vector<Ref<EditorResourceConversionPlugin>> resource_conversion_plugins;
- PrintHandlerList print_handler;
- HashMap<String, Ref<Texture2D>> icon_type_cache;
- SurfaceUpgradeTool *surface_upgrade_tool = nullptr;
- SurfaceUpgradeDialog *surface_upgrade_dialog = nullptr;
- bool run_surface_upgrade_tool = false;
- bool was_window_windowed_last = false;
- bool unfocused_low_processor_usage_mode_enabled = true;
- static EditorBuildCallback build_callbacks[MAX_BUILD_CALLBACKS];
- static EditorPluginInitializeCallback plugin_init_callbacks[MAX_INIT_CALLBACKS];
- static int build_callback_count;
- static int plugin_init_callback_count;
- static Vector<EditorNodeInitCallback> _init_callbacks;
- String _get_system_info() const;
- bool _should_display_update_spinner() const;
- static void _dependency_error_report(const String &p_path, const String &p_dep, const String &p_type) {
- DEV_ASSERT(Thread::get_caller_id() == Thread::get_main_id());
- if (!singleton->dependency_errors.has(p_path)) {
- singleton->dependency_errors[p_path] = HashSet<String>();
- }
- singleton->dependency_errors[p_path].insert(p_dep + "::" + p_type);
- }
- static Ref<Texture2D> _file_dialog_get_icon(const String &p_path);
- static void _file_dialog_register(FileDialog *p_dialog);
- static void _file_dialog_unregister(FileDialog *p_dialog);
- static void _editor_file_dialog_register(EditorFileDialog *p_dialog);
- static void _editor_file_dialog_unregister(EditorFileDialog *p_dialog);
- static void _file_access_close_error_notify(const String &p_str);
- static void _file_access_close_error_notify_impl(const String &p_str);
- static void _print_handler(void *p_this, const String &p_string, bool p_error, bool p_rich);
- static void _print_handler_impl(const String &p_string, bool p_error, bool p_rich);
- static void _resource_saved(Ref<Resource> p_resource, const String &p_path);
- static void _resource_loaded(Ref<Resource> p_resource, const String &p_path);
- void _update_theme(bool p_skip_creation = false);
- void _build_icon_type_cache();
- void _enable_pending_addons();
- void _dialog_action(String p_file);
- void _add_to_history(const Object *p_object, const String &p_property, bool p_inspector_only);
- void _edit_current(bool p_skip_foreign = false, bool p_skip_inspector_update = false);
- void _dialog_display_save_error(String p_file, Error p_error);
- void _dialog_display_load_error(String p_file, Error p_error);
- void _menu_option(int p_option);
- void _menu_confirm_current();
- void _menu_option_confirm(int p_option, bool p_confirmed);
- void _android_build_source_selected(const String &p_file);
- void _android_export_preset_selected(int p_index);
- void _request_screenshot();
- void _screenshot(bool p_use_utc = false);
- void _save_screenshot(NodePath p_path);
- void _check_system_theme_changed();
- void _tool_menu_option(int p_idx);
- void _export_as_menu_option(int p_idx);
- void _update_file_menu_opened();
- void _update_file_menu_closed();
- void _palette_quick_open_dialog();
- void _remove_plugin_from_enabled(const String &p_name);
- void _plugin_over_edit(EditorPlugin *p_plugin, Object *p_object);
- void _plugin_over_self_own(EditorPlugin *p_plugin);
- void _fs_changed();
- void _resources_reimporting(const Vector<String> &p_resources);
- void _resources_reimported(const Vector<String> &p_resources);
- void _sources_changed(bool p_exist);
- void _node_renamed();
- void _save_editor_states(const String &p_file, int p_idx = -1);
- void _load_editor_plugin_states_from_config(const Ref<ConfigFile> &p_config_file);
- void _update_title();
- void _version_control_menu_option(int p_idx);
- void _close_messages();
- void _show_messages();
- void _vp_resized();
- void _titlebar_resized();
- void _viewport_resized();
- void _update_undo_redo_allowed();
- int _save_external_resources(bool p_also_save_external_data = false);
- void _set_current_scene(int p_idx);
- void _set_current_scene_nocheck(int p_idx);
- bool _validate_scene_recursive(const String &p_filename, Node *p_node);
- void _save_scene(String p_file, int idx = -1);
- void _save_all_scenes();
- int _next_unsaved_scene(bool p_valid_filename, int p_start = 0);
- void _discard_changes(const String &p_str = String());
- void _scene_tab_closed(int p_tab);
- void _cancel_close_scene_tab();
- void _inherit_request(String p_file);
- void _instantiate_request(const Vector<String> &p_files);
- void _quick_opened(const String &p_file_path);
- void _open_command_palette();
- void _project_run_started();
- void _project_run_stopped();
- void _add_to_recent_scenes(const String &p_scene);
- void _update_recent_scenes();
- void _open_recent_scene(int p_idx);
- void _dropped_files(const Vector<String> &p_files);
- void _add_dropped_files_recursive(const Vector<String> &p_files, String to_path);
- void _update_vsync_mode();
- void _update_from_settings();
- void _gdextensions_reloaded();
- void _renderer_selected(int);
- void _update_renderer_color();
- void _add_renderer_entry(const String &p_renderer_name, bool p_mark_overridden);
- void _exit_editor(int p_exit_code);
- virtual void shortcut_input(const Ref<InputEvent> &p_event) override;
- bool has_main_screen() const { return true; }
- void _remove_edited_scene(bool p_change_tab = true);
- void _remove_scene(int index, bool p_change_tab = true);
- bool _find_and_save_resource(Ref<Resource> p_res, HashMap<Ref<Resource>, bool> &processed, int32_t flags);
- bool _find_and_save_edited_subresources(Object *obj, HashMap<Ref<Resource>, bool> &processed, int32_t flags);
- void _save_edited_subresources(Node *scene, HashMap<Ref<Resource>, bool> &processed, int32_t flags);
- void _mark_unsaved_scenes();
- void _find_node_types(Node *p_node, int &count_2d, int &count_3d);
- void _save_scene_with_preview(String p_file, int p_idx = -1);
- void _close_save_scene_progress();
- bool _find_scene_in_use(Node *p_node, const String &p_path) const;
- void _proceed_closing_scene_tabs();
- bool _is_closing_editor() const;
- Dictionary _get_main_scene_state();
- void _set_main_scene_state(Dictionary p_state, Node *p_for_scene);
- void _save_editor_layout();
- void _load_editor_layout();
- void _save_central_editor_layout_to_config(Ref<ConfigFile> p_config_file);
- void _load_central_editor_layout_from_config(Ref<ConfigFile> p_config_file);
- void _save_window_settings_to_config(Ref<ConfigFile> p_layout, const String &p_section);
- void _save_open_scenes_to_config(Ref<ConfigFile> p_layout);
- void _load_open_scenes_from_config(Ref<ConfigFile> p_layout);
- void _update_layouts_menu();
- void _layout_menu_option(int p_id);
- void _update_addon_config();
- void _toggle_distraction_free_mode();
- void _inherit_imported(const String &p_action);
- void _open_imported();
- void _update_update_spinner();
- void _resources_changed(const Vector<String> &p_resources);
- void _scan_external_changes();
- void _reload_modified_scenes();
- void _reload_project_settings();
- void _resave_scenes(String p_str);
- void _feature_profile_changed();
- bool _is_class_editor_disabled_by_feature_profile(const StringName &p_class);
- Ref<Texture2D> _get_class_or_script_icon(const String &p_class, const Ref<Script> &p_script, const String &p_fallback = "Object", bool p_fallback_script_to_theme = false);
- void _pick_main_scene_custom_action(const String &p_custom_action_name);
- void _immediate_dialog_confirmed();
- void _begin_first_scan();
- void _notify_nodes_scene_reimported(Node *p_node, Array p_reimported_nodes);
- void _remove_all_not_owned_children(Node *p_node, Node *p_owner);
- void _progress_dialog_visibility_changed();
- void _load_error_dialog_visibility_changed();
- protected:
- friend class FileSystemDock;
- static void _bind_methods();
- void _notification(int p_what);
- public:
- // Public for use with callable_mp.
- void init_plugins();
- void _on_plugin_ready(Object *p_script, const String &p_activate_name);
- bool call_build();
- // This is a very naive estimation, but we need something now. Will be reworked later.
- bool is_editor_ready() const { return is_inside_tree() && !waiting_for_first_scan; }
- static EditorNode *get_singleton() { return singleton; }
- static EditorLog *get_log() { return singleton->log; }
- static EditorData &get_editor_data() { return singleton->editor_data; }
- static EditorFolding &get_editor_folding() { return singleton->editor_folding; }
- static EditorTitleBar *get_title_bar() { return singleton->title_bar; }
- static VSplitContainer *get_top_split() { return singleton->top_split; }
- static EditorBottomPanel *get_bottom_panel() { return singleton->bottom_panel; }
- static EditorMainScreen *get_editor_main_screen() { return singleton->editor_main_screen; }
- static String adjust_scene_name_casing(const String &p_root_name);
- static String adjust_script_name_casing(const String &p_file_name, ScriptLanguage::ScriptNameCasing p_auto_casing);
- static bool has_unsaved_changes() { return singleton->unsaved_cache; }
- static void disambiguate_filenames(const Vector<String> p_full_paths, Vector<String> &r_filenames);
- static void add_io_error(const String &p_error);
- static void add_io_warning(const String &p_warning);
- static void progress_add_task(const String &p_task, const String &p_label, int p_steps, bool p_can_cancel = false);
- static bool progress_task_step(const String &p_task, const String &p_state, int p_step = -1, bool p_force_refresh = true);
- static void progress_end_task(const String &p_task);
- static void progress_add_task_bg(const String &p_task, const String &p_label, int p_steps);
- static void progress_task_step_bg(const String &p_task, int p_step = -1);
- static void progress_end_task_bg(const String &p_task);
- static void add_editor_plugin(EditorPlugin *p_editor, bool p_config_changed = false);
- static void remove_editor_plugin(EditorPlugin *p_editor, bool p_config_changed = false);
- static void add_extension_editor_plugin(const StringName &p_class_name);
- static void remove_extension_editor_plugin(const StringName &p_class_name);
- static void add_plugin_init_callback(EditorPluginInitializeCallback p_callback);
- static void add_init_callback(EditorNodeInitCallback p_callback) { _init_callbacks.push_back(p_callback); }
- static void add_build_callback(EditorBuildCallback p_callback);
- static bool immediate_confirmation_dialog(const String &p_text, const String &p_ok_text = TTR("Ok"), const String &p_cancel_text = TTR("Cancel"), uint32_t p_wrap_width = 0);
- static void cleanup();
- EditorPluginList *get_editor_plugins_force_input_forwarding() { return editor_plugins_force_input_forwarding; }
- EditorPluginList *get_editor_plugins_force_over() { return editor_plugins_force_over; }
- EditorPluginList *get_editor_plugins_over() { return editor_plugins_over; }
- EditorSelection *get_editor_selection() { return editor_selection; }
- EditorSelectionHistory *get_editor_selection_history() { return &editor_history; }
- ProjectSettingsEditor *get_project_settings() { return project_settings_editor; }
- void trigger_menu_option(int p_option, bool p_confirmed);
- bool has_previous_scenes() const;
- void new_inherited_scene() { _menu_option_confirm(FILE_NEW_INHERITED_SCENE, false); }
- void update_distraction_free_mode();
- void set_distraction_free_mode(bool p_enter);
- bool is_distraction_free_mode_enabled() const;
- void set_addon_plugin_enabled(const String &p_addon, bool p_enabled, bool p_config_changed = false);
- bool is_addon_plugin_enabled(const String &p_addon) const;
- void edit_node(Node *p_node);
- void edit_resource(const Ref<Resource> &p_resource);
- void save_resource_in_path(const Ref<Resource> &p_resource, const String &p_path);
- void save_resource(const Ref<Resource> &p_resource);
- void save_resource_as(const Ref<Resource> &p_resource, const String &p_at_path = String());
- void ensure_uid_file(const String &p_new_resource_path);
- void show_about() { _menu_option_confirm(HELP_ABOUT, false); }
- void push_item(Object *p_object, const String &p_property = "", bool p_inspector_only = false);
- void push_item_no_inspector(Object *p_object);
- void edit_previous_item();
- void edit_item(Object *p_object, Object *p_editing_owner);
- void push_node_item(Node *p_node);
- void hide_unused_editors(const Object *p_editing_owner = nullptr);
- void replace_resources_in_object(
- Object *p_object,
- const Vector<Ref<Resource>> &p_source_resources,
- const Vector<Ref<Resource>> &p_target_resource);
- void replace_resources_in_scenes(
- const Vector<Ref<Resource>> &p_source_resources,
- const Vector<Ref<Resource>> &p_target_resource);
- void open_request(const String &p_path, bool p_set_inherited = false);
- void edit_foreign_resource(Ref<Resource> p_resource);
- bool is_resource_read_only(Ref<Resource> p_resource, bool p_foreign_resources_are_writable = false);
- String get_multiwindow_support_tooltip_text() const;
- bool is_changing_scene() const;
- SubViewport *get_scene_root() { return scene_root; } // Root of the scene being edited.
- void set_edited_scene(Node *p_scene);
- void set_edited_scene_root(Node *p_scene, bool p_auto_add);
- Node *get_edited_scene() { return editor_data.get_edited_scene_root(); }
- void fix_dependencies(const String &p_for_file);
- int new_scene();
- Error load_scene(const String &p_scene, bool p_ignore_broken_deps = false, bool p_set_inherited = false, bool p_force_open_imported = false, bool p_silent_change_tab = false);
- Error load_resource(const String &p_resource, bool p_ignore_broken_deps = false);
- HashMap<StringName, Variant> get_modified_properties_for_node(Node *p_node, bool p_node_references_only);
- HashMap<StringName, Variant> get_modified_properties_reference_to_nodes(Node *p_node, List<Node *> &p_nodes_referenced_by);
- void set_unfocused_low_processor_usage_mode_enabled(bool p_enabled);
- struct AdditiveNodeEntry {
- Node *node = nullptr;
- NodePath parent;
- Node *owner = nullptr;
- int index = 0;
- // Used if the original parent node is lost
- Transform2D transform_2d;
- Transform3D transform_3d;
- };
- struct ConnectionWithNodePath {
- Connection connection;
- NodePath node_path;
- };
- struct ModificationNodeEntry {
- HashMap<StringName, Variant> property_table;
- List<ConnectionWithNodePath> connections_to;
- List<Connection> connections_from;
- List<Node::GroupInfo> groups;
- };
- struct InstanceModificationsEntry {
- Node *original_node;
- String instance_path;
- List<Node *> instance_list;
- HashMap<NodePath, ModificationNodeEntry> modifications;
- List<AdditiveNodeEntry> addition_list;
- };
- struct SceneModificationsEntry {
- List<InstanceModificationsEntry> instance_list;
- HashMap<NodePath, ModificationNodeEntry> other_instances_modifications;
- };
- struct SceneEditorDataEntry {
- bool is_editable;
- bool is_display_folded;
- };
- HashMap<int, SceneModificationsEntry> scenes_modification_table;
- List<String> scenes_reimported;
- List<String> resources_reimported;
- void update_node_from_node_modification_entry(Node *p_node, ModificationNodeEntry &p_node_modification);
- void get_scene_editor_data_for_node(Node *p_root, Node *p_node, HashMap<NodePath, SceneEditorDataEntry> &p_table);
- void get_preload_scene_modification_table(
- Node *p_edited_scene,
- Node *p_reimported_root,
- Node *p_node, InstanceModificationsEntry &p_instance_modifications);
- void get_preload_modifications_reference_to_nodes(
- Node *p_root,
- Node *p_node,
- HashSet<Node *> &p_excluded_nodes,
- List<Node *> &p_instance_list_with_children,
- HashMap<NodePath, ModificationNodeEntry> &p_modification_table);
- void get_children_nodes(Node *p_node, List<Node *> &p_nodes);
- bool is_additional_node_in_scene(Node *p_edited_scene, Node *p_reimported_root, Node *p_node);
- void replace_history_reimported_nodes(Node *p_original_root_node, Node *p_new_root_node, Node *p_node);
- bool is_scene_open(const String &p_path);
- bool is_multi_window_enabled() const;
- void setup_color_picker(ColorPicker *p_picker);
- void request_instantiate_scene(const String &p_path);
- void request_instantiate_scenes(const Vector<String> &p_files);
- void set_convert_old_scene(bool p_old) { convert_old = p_old; }
- void notify_all_debug_sessions_exited();
- OS::ProcessID has_child_process(OS::ProcessID p_pid) const;
- void stop_child_process(OS::ProcessID p_pid);
- Ref<Theme> get_editor_theme() const { return theme; }
- void update_preview_themes(int p_mode);
- Ref<Script> get_object_custom_type_base(const Object *p_object) const;
- StringName get_object_custom_type_name(const Object *p_object) const;
- Ref<Texture2D> get_object_icon(const Object *p_object, const String &p_fallback = "Object");
- Ref<Texture2D> get_class_icon(const String &p_class, const String &p_fallback = "");
- bool is_object_of_custom_type(const Object *p_object, const StringName &p_class);
- void show_accept(const String &p_text, const String &p_title);
- void show_save_accept(const String &p_text, const String &p_title);
- void show_warning(const String &p_text, const String &p_title = TTR("Warning!"));
- void _copy_warning(const String &p_str);
- Error export_preset(const String &p_preset, const String &p_path, bool p_debug, bool p_pack_only, bool p_android_build_template, bool p_patch, const Vector<String> &p_patches);
- bool is_project_exporting() const;
- Control *get_gui_base() { return gui_base; }
- void save_scene_to_path(String p_file, bool p_with_preview = true) {
- if (p_with_preview) {
- _save_scene_with_preview(p_file);
- } else {
- _save_scene(p_file);
- }
- }
- bool is_scene_in_use(const String &p_path);
- void save_editor_layout_delayed();
- void save_default_environment();
- void open_export_template_manager();
- void reload_scene(const String &p_path);
- void find_all_instances_inheriting_path_in_node(Node *p_root, Node *p_node, const String &p_instance_path, HashSet<Node *> &p_instance_list);
- void preload_reimporting_with_path_in_edited_scenes(const List<String> &p_scenes);
- void reload_instances_with_path_in_edited_scenes();
- bool is_exiting() const { return exiting; }
- Dictionary drag_resource(const Ref<Resource> &p_res, Control *p_from);
- Dictionary drag_files_and_dirs(const Vector<String> &p_paths, Control *p_from);
- EditorQuickOpenDialog *get_quick_open_dialog() { return quick_open_dialog; }
- void add_tool_menu_item(const String &p_name, const Callable &p_callback);
- void add_tool_submenu_item(const String &p_name, PopupMenu *p_submenu);
- void remove_tool_menu_item(const String &p_name);
- PopupMenu *get_export_as_menu();
- void save_all_scenes();
- void save_scene_if_open(const String &p_scene_path);
- void save_scene_list(const HashSet<String> &p_scene_paths);
- void save_before_run();
- void try_autosave();
- void restart_editor(bool p_goto_project_manager = false);
- void unload_editor_addons();
- void dim_editor(bool p_dimming);
- bool is_editor_dimmed() const;
- void edit_current() { _edit_current(); }
- bool has_scenes_in_session();
- void undo();
- void redo();
- int execute_and_show_output(const String &p_title, const String &p_path, const List<String> &p_arguments, bool p_close_on_ok = true, bool p_close_on_errors = false, String *r_output = nullptr);
- EditorNode();
- ~EditorNode();
- void add_resource_conversion_plugin(const Ref<EditorResourceConversionPlugin> &p_plugin);
- void remove_resource_conversion_plugin(const Ref<EditorResourceConversionPlugin> &p_plugin);
- Vector<Ref<EditorResourceConversionPlugin>> find_resource_conversion_plugin_for_resource(const Ref<Resource> &p_for_resource);
- Vector<Ref<EditorResourceConversionPlugin>> find_resource_conversion_plugin_for_type_name(const String &p_type);
- bool ensure_main_scene(bool p_from_native);
- };
- class EditorPluginList : public Object {
- private:
- Vector<EditorPlugin *> plugins_list;
- public:
- void set_plugins_list(Vector<EditorPlugin *> p_plugins_list) {
- plugins_list = p_plugins_list;
- }
- Vector<EditorPlugin *> &get_plugins_list() {
- return plugins_list;
- }
- void make_visible(bool p_visible);
- void edit(Object *p_object);
- bool forward_gui_input(const Ref<InputEvent> &p_event);
- void forward_canvas_draw_over_viewport(Control *p_overlay);
- void forward_canvas_force_draw_over_viewport(Control *p_overlay);
- EditorPlugin::AfterGUIInput forward_3d_gui_input(Camera3D *p_camera, const Ref<InputEvent> &p_event, bool serve_when_force_input_enabled);
- void forward_3d_draw_over_viewport(Control *p_overlay);
- void forward_3d_force_draw_over_viewport(Control *p_overlay);
- void add_plugin(EditorPlugin *p_plugin);
- void remove_plugin(EditorPlugin *p_plugin);
- void clear();
- bool is_empty();
- EditorPluginList();
- ~EditorPluginList();
- };
- struct EditorProgressBG {
- String task;
- void step(int p_step = -1) { EditorNode::progress_task_step_bg(task, p_step); }
- EditorProgressBG(const String &p_task, const String &p_label, int p_amount) {
- EditorNode::progress_add_task_bg(p_task, p_label, p_amount);
- task = p_task;
- }
- ~EditorProgressBG() { EditorNode::progress_end_task_bg(task); }
- };
- #endif // EDITOR_NODE_H
|