godot/editor/plugins/shader_editor_plugin.h

185 lines
6.0 KiB
C++
Raw Normal View History

2014-02-10 01:10:30 +00:00
/*************************************************************************/
/* shader_editor_plugin.h */
/*************************************************************************/
/* This file is part of: */
/* GODOT ENGINE */
/* https://godotengine.org */
2014-02-10 01:10:30 +00:00
/*************************************************************************/
/* Copyright (c) 2007-2022 Juan Linietsky, Ariel Manzur. */
/* Copyright (c) 2014-2022 Godot Engine contributors (cf. AUTHORS.md). */
2014-02-10 01:10:30 +00:00
/* */
/* 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. */
/*************************************************************************/
2014-02-10 01:10:30 +00:00
#ifndef SHADER_EDITOR_PLUGIN_H
#define SHADER_EDITOR_PLUGIN_H
#include "editor/code_editor.h"
#include "editor/editor_plugin.h"
#include "scene/gui/menu_button.h"
#include "scene/gui/panel_container.h"
#include "scene/gui/rich_text_label.h"
2014-02-10 01:10:30 +00:00
#include "scene/gui/tab_container.h"
#include "scene/gui/text_edit.h"
#include "scene/main/timer.h"
#include "scene/resources/shader.h"
#include "servers/rendering/shader_warnings.h"
2014-02-10 01:10:30 +00:00
class ShaderTextEditor : public CodeTextEditor {
GDCLASS(ShaderTextEditor, CodeTextEditor);
2014-02-10 01:10:30 +00:00
Color marked_line_color = Color(1, 1, 1);
struct WarningsComparator {
_ALWAYS_INLINE_ bool operator()(const ShaderWarning &p_a, const ShaderWarning &p_b) const { return (p_a.get_line() < p_b.get_line()); }
};
Ref<CodeHighlighter> syntax_highlighter;
RichTextLabel *warnings_panel = nullptr;
2014-02-10 01:10:30 +00:00
Ref<Shader> shader;
List<ShaderWarning> warnings;
2022-01-19 05:31:39 +00:00
Error last_compile_result = Error::OK;
2014-02-10 01:10:30 +00:00
void _check_shader_mode();
void _update_warning_panel();
2014-02-10 01:10:30 +00:00
protected:
2022-01-19 05:31:39 +00:00
void _notification(int p_what);
2014-02-10 01:10:30 +00:00
static void _bind_methods();
2020-07-10 10:34:39 +00:00
virtual void _load_theme_settings() override;
virtual void _code_complete_script(const String &p_code, List<ScriptLanguage::CodeCompletionOption> *r_options) override;
2014-02-10 01:10:30 +00:00
public:
2020-07-10 10:34:39 +00:00
virtual void _validate_script() override;
2014-02-10 01:10:30 +00:00
void reload_text();
void set_warnings_panel(RichTextLabel *p_warnings_panel);
2014-02-10 01:10:30 +00:00
Ref<Shader> get_edited_shader() const;
void set_edited_shader(const Ref<Shader> &p_shader);
2014-02-10 01:10:30 +00:00
ShaderTextEditor();
};
class ShaderEditor : public PanelContainer {
GDCLASS(ShaderEditor, PanelContainer);
2014-02-10 01:10:30 +00:00
enum {
EDIT_UNDO,
EDIT_REDO,
EDIT_CUT,
EDIT_COPY,
EDIT_PASTE,
EDIT_SELECT_ALL,
EDIT_MOVE_LINE_UP,
EDIT_MOVE_LINE_DOWN,
EDIT_INDENT_LEFT,
EDIT_INDENT_RIGHT,
EDIT_DELETE_LINE,
EDIT_DUPLICATE_SELECTION,
EDIT_TOGGLE_COMMENT,
EDIT_COMPLETE,
2014-02-10 01:10:30 +00:00
SEARCH_FIND,
SEARCH_FIND_NEXT,
SEARCH_FIND_PREV,
2014-02-10 01:10:30 +00:00
SEARCH_REPLACE,
SEARCH_GOTO_LINE,
BOOKMARK_TOGGLE,
BOOKMARK_GOTO_NEXT,
BOOKMARK_GOTO_PREV,
BOOKMARK_REMOVE_ALL,
2019-08-02 14:03:45 +00:00
HELP_DOCS,
2014-02-10 01:10:30 +00:00
};
MenuButton *edit_menu;
MenuButton *search_menu;
PopupMenu *bookmarks_menu;
2019-08-02 14:03:45 +00:00
MenuButton *help_menu;
PopupMenu *context_menu;
RichTextLabel *warnings_panel = nullptr;
2014-02-10 01:10:30 +00:00
uint64_t idle;
GotoLineDialog *goto_line_dialog;
ConfirmationDialog *erase_tab_confirm;
ConfirmationDialog *disk_changed;
2014-02-10 01:10:30 +00:00
ShaderTextEditor *shader_editor;
2017-08-12 16:52:50 +00:00
void _menu_option(int p_option);
2014-02-10 01:10:30 +00:00
mutable Ref<Shader> shader;
void _editor_settings_changed();
void _project_settings_changed();
2014-02-10 01:10:30 +00:00
void _check_for_external_edit();
void _reload_shader_from_disk();
void _show_warnings_panel(bool p_show);
void _warning_clicked(Variant p_line);
void _update_warnings(bool p_validate);
2014-02-10 01:10:30 +00:00
protected:
void _notification(int p_what);
static void _bind_methods();
void _make_context_menu(bool p_selection, Vector2 p_position);
void _text_edit_gui_input(const Ref<InputEvent> &ev);
2014-02-10 01:10:30 +00:00
2019-05-21 08:07:48 +00:00
void _update_bookmark_list();
void _bookmark_item_pressed(int p_idx);
public:
2014-02-10 01:10:30 +00:00
void apply_shaders();
void ensure_select_current();
void edit(const Ref<Shader> &p_shader);
2014-02-10 01:10:30 +00:00
void goto_line_selection(int p_line, int p_begin, int p_end);
2020-07-10 10:34:39 +00:00
virtual Size2 get_minimum_size() const override { return Size2(0, 200); }
void save_external_data(const String &p_str = "");
2014-02-10 01:10:30 +00:00
ShaderEditor();
2014-02-10 01:10:30 +00:00
};
class ShaderEditorPlugin : public EditorPlugin {
GDCLASS(ShaderEditorPlugin, EditorPlugin);
2014-02-10 01:10:30 +00:00
2015-01-11 23:52:42 +00:00
bool _2d;
2014-02-10 01:10:30 +00:00
ShaderEditor *shader_editor;
Button *button;
2014-02-10 01:10:30 +00:00
public:
2020-07-10 10:34:39 +00:00
virtual String get_name() const override { return "Shader"; }
bool has_main_screen() const override { return false; }
virtual void edit(Object *p_object) override;
virtual bool handles(Object *p_object) const override;
virtual void make_visible(bool p_visible) override;
virtual void selected_notify() override;
2014-02-10 01:10:30 +00:00
ShaderEditor *get_shader_editor() const { return shader_editor; }
2020-07-10 10:34:39 +00:00
virtual void save_external_data() override;
virtual void apply_changes() override;
2014-02-10 01:10:30 +00:00
ShaderEditorPlugin();
2014-02-10 01:10:30 +00:00
~ShaderEditorPlugin();
};
2014-02-10 01:10:30 +00:00
#endif