Rework editor docks #106503
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,99 @@ | ||
| <?xml version="1.0" encoding="UTF-8" ?> | ||
| <class name="EditorDock" inherits="MarginContainer" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd"> | ||
| <brief_description> | ||
| Dockable container for the editor. | ||
| </brief_description> | ||
| <description> | ||
| EditorDock is a [Container] node that can be docked in one of the editor's dock slots. Docks are added by plugins to provide space for controls related to an [EditorPlugin]. The editor comes with a few built-in docks, such as the Scene dock, FileSystem dock, etc. | ||
| You can add a dock by using [method EditorPlugin.add_dock]. The dock can be customized by changing its properties. | ||
| [codeblock] | ||
| extends EditorPlugin | ||
KoBeWi marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| # Dock reference. | ||
| var dock | ||
|
|
||
| # Plugin initialization. | ||
| func _enter_tree(): | ||
| dock = EditorDock.new() | ||
| dock.title = "My Dock" | ||
| dock.dock_icon = load("./dock_icon.png") | ||
| dock.default_slot = EditorPlugin.DOCK_SLOT_RIGHT_UL | ||
| var dock_content = preload("./dock_content.tscn").instantiate() | ||
| dock.add_child(dock_content) | ||
| add_dock(dock) | ||
KoBeWi marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| # Plugin clean-up. | ||
| func _exit_tree(): | ||
| remove_dock(dock) | ||
| dock.queue_free() | ||
| dock = null | ||
| [/codeblock] | ||
| </description> | ||
| <tutorials> | ||
| <link title="Making plugins">$DOCS_URL/plugins/editor/making_plugins.html</link> | ||
| </tutorials> | ||
| <methods> | ||
| <method name="_load_layout_from_config" qualifiers="virtual"> | ||
| <return type="void" /> | ||
| <param index="0" name="config" type="ConfigFile" /> | ||
| <param index="1" name="section" type="String" /> | ||
| <description> | ||
| Implement this method to handle loading of this dock's layout. It's equivalent to [method EditorPlugin._set_window_layout]. [param section] is a unique section based on [member layout_key]. | ||
| </description> | ||
| </method> | ||
| <method name="_save_layout_to_config" qualifiers="virtual const"> | ||
| <return type="void" /> | ||
| <param index="0" name="config" type="ConfigFile" /> | ||
| <param index="1" name="section" type="String" /> | ||
| <description> | ||
| Implement this method to handle saving of this dock's layout. It's equivalent to [method EditorPlugin._get_window_layout]. [param section] is a unique section based on [member layout_key]. | ||
| </description> | ||
| </method> | ||
| <method name="_update_layout" qualifiers="virtual"> | ||
| <return type="void" /> | ||
| <param index="0" name="layout" type="int" /> | ||
| <description> | ||
| Implement this method to handle the layout switching for this dock. [param layout] is one of [enum DockLayout] constants. | ||
| [codeblock] | ||
| _update_layout(layout): | ||
| box_container.vertical = (layout == DOCK_LAYOUT_VERTICAL) | ||
| [/codeblock] | ||
| </description> | ||
| </method> | ||
| </methods> | ||
| <members> | ||
| <member name="available_layouts" type="int" setter="set_available_layouts" getter="get_available_layouts" enum="EditorDock.DockLayout" is_bitfield="true" default="1"> | ||
| The available layouts for this dock, as a bitmask. | ||
| If you want to make all layouts available, use [code]available_layouts = DOCK_LAYOUT_VERTICAL | DOCK_LAYOUT_HORIZONTAL[/code]. | ||
| </member> | ||
| <member name="clip_contents" type="bool" setter="set_clip_contents" getter="is_clipping_contents" overrides="Control" default="true" /> | ||
| <member name="default_slot" type="int" setter="set_default_slot" getter="get_default_slot" enum="EditorPlugin.DockSlot" default="-1"> | ||
| The default dock slot used when adding the dock with [method EditorPlugin.add_dock]. | ||
| After the dock is added, it can be moved to a different slot and the editor will automatically remember its position between sessions. If you remove and re-add the dock, it will be reset to default. | ||
| </member> | ||
| <member name="dock_icon" type="Texture2D" setter="set_dock_icon" getter="get_dock_icon"> | ||
| The icon for the dock, as a texture. If specified, it will override [member icon_name]. | ||
| </member> | ||
| <member name="dock_shortcut" type="Shortcut" setter="set_dock_shortcut" getter="get_dock_shortcut"> | ||
| The shortcut used to open the dock. This property can only be set before this dock is added via [method EditorPlugin.add_dock]. | ||
| </member> | ||
| <member name="icon_name" type="StringName" setter="set_icon_name" getter="get_icon_name" default="&"""> | ||
| The icon for the dock, as a name from the [code]EditorIcons[/code] theme type in the editor theme. You can find the list of available icons [url=https://godot-editor-icons.github.io/]here[/url]. | ||
| </member> | ||
| <member name="layout_key" type="String" setter="set_layout_key" getter="get_layout_key" default=""""> | ||
| The key representing this dock in the editor's layout file. If empty, the dock's displayed name will be used instead. | ||
| </member> | ||
| <member name="title" type="String" setter="set_title" getter="get_title" default=""""> | ||
| The title of the dock's tab. If empty, the dock's [member Node.name] will be used. If the name is auto-generated (contains [code]@[/code]), the first child's name will be used instead. | ||
| </member> | ||
| </members> | ||
| <constants> | ||
| <constant name="DOCK_LAYOUT_VERTICAL" value="1" enum="DockLayout" is_bitfield="true"> | ||
| Allows placing the dock in the vertical dock slots on either sides of the editor. | ||
| [b]Note:[/b] Currently this flag has no effect, because the bottom panel is not a proper dock slot. This means that the dock can always be vertical. | ||
| </constant> | ||
| <constant name="DOCK_LAYOUT_HORIZONTAL" value="2" enum="DockLayout" is_bitfield="true"> | ||
| Allows placing the dock in the editor's bottom panel. Implement [method _update_layout] to handle changing layouts. | ||
| </constant> | ||
| </constants> | ||
| </class> | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,131 @@ | ||
| /**************************************************************************/ | ||
| /* editor_dock.cpp */ | ||
| /**************************************************************************/ | ||
| /* 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. */ | ||
| /**************************************************************************/ | ||
|
|
||
| #include "editor_dock.h" | ||
|
|
||
| #include "core/input/shortcut.h" | ||
| #include "core/io/config_file.h" | ||
|
|
||
| void EditorDock::_set_default_slot_bind(EditorPlugin::DockSlot p_slot) { | ||
| ERR_FAIL_INDEX(p_slot, EditorPlugin::DOCK_SLOT_MAX); | ||
| default_slot = (EditorDockManager::DockSlot)p_slot; | ||
| } | ||
|
|
||
| void EditorDock::_bind_methods() { | ||
kitbdev marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| ClassDB::bind_method(D_METHOD("set_title", "title"), &EditorDock::set_title); | ||
| ClassDB::bind_method(D_METHOD("get_title"), &EditorDock::get_title); | ||
| ADD_PROPERTY(PropertyInfo(Variant::STRING, "title"), "set_title", "get_title"); | ||
|
|
||
| ClassDB::bind_method(D_METHOD("set_layout_key", "layout_key"), &EditorDock::set_layout_key); | ||
| ClassDB::bind_method(D_METHOD("get_layout_key"), &EditorDock::get_layout_key); | ||
| ADD_PROPERTY(PropertyInfo(Variant::STRING, "layout_key"), "set_layout_key", "get_layout_key"); | ||
|
|
||
| ClassDB::bind_method(D_METHOD("set_icon_name", "icon_name"), &EditorDock::set_icon_name); | ||
| ClassDB::bind_method(D_METHOD("get_icon_name"), &EditorDock::get_icon_name); | ||
| ADD_PROPERTY(PropertyInfo(Variant::STRING_NAME, "icon_name"), "set_icon_name", "get_icon_name"); | ||
|
|
||
| ClassDB::bind_method(D_METHOD("set_dock_icon", "icon"), &EditorDock::set_dock_icon); | ||
| ClassDB::bind_method(D_METHOD("get_dock_icon"), &EditorDock::get_dock_icon); | ||
| ADD_PROPERTY(PropertyInfo(Variant::OBJECT, "dock_icon", PROPERTY_HINT_RESOURCE_TYPE, "Texture2D"), "set_dock_icon", "get_dock_icon"); | ||
|
|
||
| ClassDB::bind_method(D_METHOD("set_dock_shortcut", "shortcut"), &EditorDock::set_dock_shortcut); | ||
| ClassDB::bind_method(D_METHOD("get_dock_shortcut"), &EditorDock::get_dock_shortcut); | ||
| ADD_PROPERTY(PropertyInfo(Variant::OBJECT, "dock_shortcut", PROPERTY_HINT_RESOURCE_TYPE, "ShortCut"), "set_dock_shortcut", "get_dock_shortcut"); | ||
|
|
||
| ClassDB::bind_method(D_METHOD("set_default_slot", "slot"), &EditorDock::_set_default_slot_bind); | ||
| ClassDB::bind_method(D_METHOD("get_default_slot"), &EditorDock::_get_default_slot_bind); | ||
| ADD_PROPERTY(PropertyInfo(Variant::INT, "default_slot"), "set_default_slot", "get_default_slot"); | ||
|
|
||
| ClassDB::bind_method(D_METHOD("set_available_layouts", "layouts"), &EditorDock::set_available_layouts); | ||
| ClassDB::bind_method(D_METHOD("get_available_layouts"), &EditorDock::get_available_layouts); | ||
| ADD_PROPERTY(PropertyInfo(Variant::INT, "available_layouts", PROPERTY_HINT_FLAGS, "Vertical:1,Horizontal:2"), "set_available_layouts", "get_available_layouts"); | ||
|
|
||
| BIND_BITFIELD_FLAG(DOCK_LAYOUT_VERTICAL); | ||
| BIND_BITFIELD_FLAG(DOCK_LAYOUT_HORIZONTAL); | ||
|
|
||
| GDVIRTUAL_BIND(_update_layout, "layout"); | ||
| GDVIRTUAL_BIND(_save_layout_to_config, "config", "section"); | ||
| GDVIRTUAL_BIND(_load_layout_from_config, "config", "section"); | ||
| } | ||
|
|
||
| EditorDock::EditorDock() { | ||
| set_clip_contents(true); | ||
| add_user_signal(MethodInfo("tab_style_changed")); | ||
| } | ||
|
|
||
| void EditorDock::set_title(const String &p_title) { | ||
| if (title == p_title) { | ||
| return; | ||
| } | ||
| title = p_title; | ||
| emit_signal("tab_style_changed"); | ||
| } | ||
|
|
||
| void EditorDock::set_icon_name(const StringName &p_name) { | ||
| if (icon_name == p_name) { | ||
| return; | ||
| } | ||
| icon_name = p_name; | ||
| emit_signal("tab_style_changed"); | ||
| } | ||
|
|
||
| void EditorDock::set_dock_icon(const Ref<Texture2D> &p_icon) { | ||
| if (dock_icon == p_icon) { | ||
| return; | ||
| } | ||
| dock_icon = p_icon; | ||
| emit_signal("tab_style_changed"); | ||
| } | ||
|
|
||
| void EditorDock::set_default_slot(EditorDockManager::DockSlot p_slot) { | ||
| ERR_FAIL_INDEX(p_slot, EditorDockManager::DOCK_SLOT_MAX); | ||
| default_slot = p_slot; | ||
| } | ||
|
|
||
| String EditorDock::get_display_title() const { | ||
| if (!title.is_empty()) { | ||
| return title; | ||
| } | ||
|
|
||
| const String sname = get_name(); | ||
| if (sname.contains("@")) { | ||
| // Auto-generated name, try to use something better. | ||
| const Node *child = get_child_count() > 0 ? get_child(0) : nullptr; | ||
| if (child) { | ||
| // In user plugins, the child will usually be dock's content and have a proper name. | ||
| return child->get_name(); | ||
| } | ||
| } | ||
| return sname; | ||
| } | ||
|
|
||
| String EditorDock::get_effective_layout_key() const { | ||
| return layout_key.is_empty() ? get_display_title() : layout_key; | ||
| } | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.