godot/editor/project_manager.h

261 lines
8.1 KiB
C++

/**************************************************************************/
/* project_manager.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 PROJECT_MANAGER_H
#define PROJECT_MANAGER_H
#include "scene/gui/dialogs.h"
#include "scene/gui/scroll_container.h"
class CheckBox;
class EditorAbout;
class EditorAssetLibrary;
class EditorFileDialog;
class EditorTitleBar;
class HFlowContainer;
class LineEdit;
class LinkButton;
class MarginContainer;
class OptionButton;
class PanelContainer;
class ProjectDialog;
class ProjectList;
class QuickSettingsDialog;
class RichTextLabel;
class TabContainer;
class VBoxContainer;
class ProjectManager : public Control {
GDCLASS(ProjectManager, Control);
static ProjectManager *singleton;
// Utility data.
static Ref<Texture2D> _file_dialog_get_icon(const String &p_path);
static Ref<Texture2D> _file_dialog_get_thumbnail(const String &p_path);
HashMap<String, Ref<Texture2D>> icon_type_cache;
void _build_icon_type_cache(Ref<Theme> p_theme);
// Main layout.
Ref<Theme> theme;
void _update_size_limits();
void _update_theme(bool p_skip_creation = false);
void _titlebar_resized();
MarginContainer *root_container = nullptr;
Panel *background_panel = nullptr;
VBoxContainer *main_vbox = nullptr;
EditorTitleBar *title_bar = nullptr;
Control *left_menu_spacer = nullptr;
Control *left_spacer = nullptr;
Control *right_menu_spacer = nullptr;
Control *right_spacer = nullptr;
Button *title_bar_logo = nullptr;
HBoxContainer *main_view_toggles = nullptr;
Button *quick_settings_button = nullptr;
enum MainViewTab {
MAIN_VIEW_PROJECTS,
MAIN_VIEW_ASSETLIB,
MAIN_VIEW_MAX
};
MainViewTab current_main_view = MAIN_VIEW_PROJECTS;
HashMap<MainViewTab, Control *> main_view_map;
HashMap<MainViewTab, Button *> main_view_toggle_map;
PanelContainer *main_view_container = nullptr;
Ref<ButtonGroup> main_view_toggles_group;
Button *_add_main_view(MainViewTab p_id, const String &p_name, const Ref<Texture2D> &p_icon, Control *p_view_control);
void _set_main_view_icon(MainViewTab p_id, const Ref<Texture2D> &p_icon);
void _select_main_view(int p_id);
VBoxContainer *local_projects_vb = nullptr;
EditorAssetLibrary *asset_library = nullptr;
EditorAbout *about_dialog = nullptr;
void _show_about();
void _open_asset_library_confirmed();
AcceptDialog *error_dialog = nullptr;
void _show_error(const String &p_message, const Size2 &p_min_size = Size2());
void _dim_window();
// Quick settings.
QuickSettingsDialog *quick_settings_dialog = nullptr;
void _show_quick_settings();
void _restart_confirmed();
// Footer.
LinkButton *version_btn = nullptr;
void _version_button_pressed();
// Project list.
VBoxContainer *empty_list_placeholder = nullptr;
Button *empty_list_create_project = nullptr;
Button *empty_list_import_project = nullptr;
Button *empty_list_open_assetlib = nullptr;
Label *empty_list_online_warning = nullptr;
void _update_list_placeholder();
ProjectList *project_list = nullptr;
bool initialized = false;
LineEdit *search_box = nullptr;
Label *loading_label = nullptr;
OptionButton *filter_option = nullptr;
PanelContainer *project_list_panel = nullptr;
Button *create_btn = nullptr;
Button *import_btn = nullptr;
Button *scan_btn = nullptr;
Button *open_btn = nullptr;
Button *run_btn = nullptr;
Button *rename_btn = nullptr;
Button *manage_tags_btn = nullptr;
Button *erase_btn = nullptr;
Button *erase_missing_btn = nullptr;
EditorFileDialog *scan_dir = nullptr;
ConfirmationDialog *erase_ask = nullptr;
Label *erase_ask_label = nullptr;
// Comment out for now until we have a better warning system to
// ensure users delete their project only.
//CheckBox *delete_project_contents = nullptr;
ConfirmationDialog *erase_missing_ask = nullptr;
ConfirmationDialog *multi_open_ask = nullptr;
ConfirmationDialog *multi_run_ask = nullptr;
ProjectDialog *project_dialog = nullptr;
void _scan_projects();
void _run_project();
void _run_project_confirm();
void _open_selected_projects();
void _open_selected_projects_ask();
void _open_selected_projects_with_migration();
void _install_project(const String &p_zip_path, const String &p_title);
void _import_project();
void _new_project();
void _rename_project();
void _erase_project();
void _erase_missing_projects();
void _erase_project_confirm();
void _erase_missing_projects_confirm();
void _update_project_buttons();
void _on_project_created(const String &dir);
void _on_projects_updated();
void _on_order_option_changed(int p_idx);
void _on_search_term_changed(const String &p_term);
void _on_search_term_submitted(const String &p_text);
// Project tag management.
HashSet<String> tag_set;
PackedStringArray current_project_tags;
PackedStringArray forbidden_tag_characters{ "/", "\\", "-" };
ConfirmationDialog *tag_manage_dialog = nullptr;
HFlowContainer *project_tags = nullptr;
HFlowContainer *all_tags = nullptr;
Label *tag_edit_error = nullptr;
Button *create_tag_btn = nullptr;
ConfirmationDialog *create_tag_dialog = nullptr;
LineEdit *new_tag_name = nullptr;
Label *tag_error = nullptr;
void _manage_project_tags();
void _add_project_tag(const String &p_tag);
void _delete_project_tag(const String &p_tag);
void _apply_project_tags();
void _set_new_tag_name(const String p_name);
void _create_new_tag();
// Project converter/migration tool.
ConfirmationDialog *ask_full_convert_dialog = nullptr;
ConfirmationDialog *ask_update_settings = nullptr;
Button *full_convert_button = nullptr;
String version_convert_feature;
#ifndef DISABLE_DEPRECATED
void _minor_project_migrate();
#endif
void _full_convert_button_pressed();
void _perform_full_project_conversion();
// Input and I/O.
virtual void shortcut_input(const Ref<InputEvent> &p_ev) override;
void _files_dropped(PackedStringArray p_files);
protected:
void _notification(int p_what);
public:
static ProjectManager *get_singleton() { return singleton; }
// Project list.
bool is_initialized() const { return initialized; }
LineEdit *get_search_box();
// Project tag management.
void add_new_tag(const String &p_tag);
ProjectManager();
~ProjectManager();
};
#endif // PROJECT_MANAGER_H