58126e479c
This commit adds the default theme context, which replaces the need to manually check the project and the default theme all the time; simplifies related code. It also adds framework for custom theme contexts, to be used by the editor. Custom contexts can be attached to any node, and not necessarily a GUI/Window node. Contexts do no break theme inheritance and only define which global themes a node uses as a fallback. Contexts propagate NOTIFICATION_THEME_CHANGED when one of their global themes changes. This ensures that global themes act just like themes assigned to individual nodes and can be previewed live in the editor.
406 lines
14 KiB
C++
406 lines
14 KiB
C++
/**************************************************************************/
|
|
/* theme_db.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 "theme_db.h"
|
|
|
|
#include "core/config/project_settings.h"
|
|
#include "core/io/resource_loader.h"
|
|
#include "scene/gui/control.h"
|
|
#include "scene/main/node.h"
|
|
#include "scene/main/window.h"
|
|
#include "scene/resources/font.h"
|
|
#include "scene/resources/style_box.h"
|
|
#include "scene/resources/texture.h"
|
|
#include "scene/resources/theme.h"
|
|
#include "scene/theme/default_theme.h"
|
|
#include "servers/text_server.h"
|
|
|
|
// Default engine theme creation and configuration.
|
|
|
|
void ThemeDB::initialize_theme() {
|
|
// Default theme-related project settings.
|
|
|
|
// Allow creating the default theme at a different scale to suit higher/lower base resolutions.
|
|
float default_theme_scale = GLOBAL_DEF(PropertyInfo(Variant::FLOAT, "gui/theme/default_theme_scale", PROPERTY_HINT_RANGE, "0.5,8,0.01", PROPERTY_USAGE_DEFAULT | PROPERTY_USAGE_RESTART_IF_CHANGED), 1.0);
|
|
|
|
String project_theme_path = GLOBAL_DEF_RST(PropertyInfo(Variant::STRING, "gui/theme/custom", PROPERTY_HINT_FILE, "*.tres,*.res,*.theme", PROPERTY_USAGE_DEFAULT | PROPERTY_USAGE_RESTART_IF_CHANGED), "");
|
|
String project_font_path = GLOBAL_DEF_RST(PropertyInfo(Variant::STRING, "gui/theme/custom_font", PROPERTY_HINT_FILE, "*.tres,*.res,*.otf,*.ttf,*.woff,*.woff2,*.fnt,*.font,*.pfb,*.pfm", PROPERTY_USAGE_DEFAULT | PROPERTY_USAGE_RESTART_IF_CHANGED), "");
|
|
|
|
TextServer::FontAntialiasing font_antialiasing = (TextServer::FontAntialiasing)(int)GLOBAL_DEF_RST(PropertyInfo(Variant::INT, "gui/theme/default_font_antialiasing", PROPERTY_HINT_ENUM, "None,Grayscale,LCD Subpixel", PROPERTY_USAGE_DEFAULT | PROPERTY_USAGE_RESTART_IF_CHANGED), 1);
|
|
TextServer::Hinting font_hinting = (TextServer::Hinting)(int)GLOBAL_DEF_RST(PropertyInfo(Variant::INT, "gui/theme/default_font_hinting", PROPERTY_HINT_ENUM, "None,Light,Normal", PROPERTY_USAGE_DEFAULT | PROPERTY_USAGE_RESTART_IF_CHANGED), TextServer::HINTING_LIGHT);
|
|
TextServer::SubpixelPositioning font_subpixel_positioning = (TextServer::SubpixelPositioning)(int)GLOBAL_DEF_RST(PropertyInfo(Variant::INT, "gui/theme/default_font_subpixel_positioning", PROPERTY_HINT_ENUM, "Disabled,Auto,One Half of a Pixel,One Quarter of a Pixel", PROPERTY_USAGE_DEFAULT | PROPERTY_USAGE_RESTART_IF_CHANGED), TextServer::SUBPIXEL_POSITIONING_AUTO);
|
|
|
|
const bool font_msdf = GLOBAL_DEF_RST("gui/theme/default_font_multichannel_signed_distance_field", false);
|
|
const bool font_generate_mipmaps = GLOBAL_DEF_RST("gui/theme/default_font_generate_mipmaps", false);
|
|
|
|
GLOBAL_DEF_RST(PropertyInfo(Variant::INT, "gui/theme/lcd_subpixel_layout", PROPERTY_HINT_ENUM, "Disabled,Horizontal RGB,Horizontal BGR,Vertical RGB,Vertical BGR"), 1);
|
|
ProjectSettings::get_singleton()->set_restart_if_changed("gui/theme/lcd_subpixel_layout", false);
|
|
|
|
// Attempt to load custom project theme and font.
|
|
|
|
if (!project_theme_path.is_empty()) {
|
|
Ref<Theme> theme = ResourceLoader::load(project_theme_path);
|
|
if (theme.is_valid()) {
|
|
set_project_theme(theme);
|
|
} else {
|
|
ERR_PRINT("Error loading custom project theme '" + project_theme_path + "'");
|
|
}
|
|
}
|
|
|
|
Ref<Font> project_font;
|
|
if (!project_font_path.is_empty()) {
|
|
project_font = ResourceLoader::load(project_font_path);
|
|
if (project_font.is_valid()) {
|
|
set_fallback_font(project_font);
|
|
} else {
|
|
ERR_PRINT("Error loading custom project font '" + project_font_path + "'");
|
|
}
|
|
}
|
|
|
|
// Always generate the default theme to serve as a fallback for all required theme definitions.
|
|
|
|
if (RenderingServer::get_singleton()) {
|
|
make_default_theme(default_theme_scale, project_font, font_subpixel_positioning, font_hinting, font_antialiasing, font_msdf, font_generate_mipmaps);
|
|
}
|
|
|
|
_init_default_theme_context();
|
|
}
|
|
|
|
void ThemeDB::initialize_theme_noproject() {
|
|
if (RenderingServer::get_singleton()) {
|
|
make_default_theme(1.0, Ref<Font>());
|
|
}
|
|
|
|
_init_default_theme_context();
|
|
}
|
|
|
|
void ThemeDB::finalize_theme() {
|
|
if (!RenderingServer::get_singleton()) {
|
|
WARN_PRINT("Finalizing theme when there is no RenderingServer is an error; check the order of operations.");
|
|
}
|
|
|
|
_finalize_theme_contexts();
|
|
default_theme.unref();
|
|
|
|
fallback_font.unref();
|
|
fallback_icon.unref();
|
|
fallback_stylebox.unref();
|
|
}
|
|
|
|
// Global Theme resources.
|
|
|
|
void ThemeDB::set_default_theme(const Ref<Theme> &p_default) {
|
|
default_theme = p_default;
|
|
}
|
|
|
|
Ref<Theme> ThemeDB::get_default_theme() {
|
|
return default_theme;
|
|
}
|
|
|
|
void ThemeDB::set_project_theme(const Ref<Theme> &p_project_default) {
|
|
project_theme = p_project_default;
|
|
}
|
|
|
|
Ref<Theme> ThemeDB::get_project_theme() {
|
|
return project_theme;
|
|
}
|
|
|
|
// Universal fallback values for theme item types.
|
|
|
|
void ThemeDB::set_fallback_base_scale(float p_base_scale) {
|
|
if (fallback_base_scale == p_base_scale) {
|
|
return;
|
|
}
|
|
|
|
fallback_base_scale = p_base_scale;
|
|
emit_signal(SNAME("fallback_changed"));
|
|
}
|
|
|
|
float ThemeDB::get_fallback_base_scale() {
|
|
return fallback_base_scale;
|
|
}
|
|
|
|
void ThemeDB::set_fallback_font(const Ref<Font> &p_font) {
|
|
if (fallback_font == p_font) {
|
|
return;
|
|
}
|
|
|
|
fallback_font = p_font;
|
|
emit_signal(SNAME("fallback_changed"));
|
|
}
|
|
|
|
Ref<Font> ThemeDB::get_fallback_font() {
|
|
return fallback_font;
|
|
}
|
|
|
|
void ThemeDB::set_fallback_font_size(int p_font_size) {
|
|
if (fallback_font_size == p_font_size) {
|
|
return;
|
|
}
|
|
|
|
fallback_font_size = p_font_size;
|
|
emit_signal(SNAME("fallback_changed"));
|
|
}
|
|
|
|
int ThemeDB::get_fallback_font_size() {
|
|
return fallback_font_size;
|
|
}
|
|
|
|
void ThemeDB::set_fallback_icon(const Ref<Texture2D> &p_icon) {
|
|
if (fallback_icon == p_icon) {
|
|
return;
|
|
}
|
|
|
|
fallback_icon = p_icon;
|
|
emit_signal(SNAME("fallback_changed"));
|
|
}
|
|
|
|
Ref<Texture2D> ThemeDB::get_fallback_icon() {
|
|
return fallback_icon;
|
|
}
|
|
|
|
void ThemeDB::set_fallback_stylebox(const Ref<StyleBox> &p_stylebox) {
|
|
if (fallback_stylebox == p_stylebox) {
|
|
return;
|
|
}
|
|
|
|
fallback_stylebox = p_stylebox;
|
|
emit_signal(SNAME("fallback_changed"));
|
|
}
|
|
|
|
Ref<StyleBox> ThemeDB::get_fallback_stylebox() {
|
|
return fallback_stylebox;
|
|
}
|
|
|
|
void ThemeDB::get_native_type_dependencies(const StringName &p_base_type, List<StringName> *p_list) {
|
|
ERR_FAIL_NULL(p_list);
|
|
|
|
// TODO: It may make sense to stop at Control/Window, because their parent classes cannot be used in
|
|
// a meaningful way.
|
|
StringName class_name = p_base_type;
|
|
while (class_name != StringName()) {
|
|
p_list->push_back(class_name);
|
|
class_name = ClassDB::get_parent_class_nocheck(class_name);
|
|
}
|
|
}
|
|
|
|
// Global theme contexts.
|
|
|
|
ThemeContext *ThemeDB::create_theme_context(Node *p_node, List<Ref<Theme>> &p_themes) {
|
|
ERR_FAIL_COND_V(!p_node->is_inside_tree(), nullptr);
|
|
ERR_FAIL_COND_V(theme_contexts.has(p_node), nullptr);
|
|
ERR_FAIL_COND_V(p_themes.is_empty(), nullptr);
|
|
|
|
ThemeContext *context = memnew(ThemeContext);
|
|
context->node = p_node;
|
|
context->parent = get_nearest_theme_context(p_node);
|
|
context->set_themes(p_themes);
|
|
|
|
theme_contexts[p_node] = context;
|
|
_propagate_theme_context(p_node, context);
|
|
|
|
p_node->connect("tree_exited", callable_mp(this, &ThemeDB::destroy_theme_context).bind(p_node));
|
|
|
|
return context;
|
|
}
|
|
|
|
void ThemeDB::destroy_theme_context(Node *p_node) {
|
|
ERR_FAIL_COND(!theme_contexts.has(p_node));
|
|
|
|
p_node->disconnect("tree_exited", callable_mp(this, &ThemeDB::destroy_theme_context));
|
|
|
|
ThemeContext *context = theme_contexts[p_node];
|
|
|
|
theme_contexts.erase(p_node);
|
|
_propagate_theme_context(p_node, context->parent);
|
|
|
|
memdelete(context);
|
|
}
|
|
|
|
void ThemeDB::_propagate_theme_context(Node *p_from_node, ThemeContext *p_context) {
|
|
Control *from_control = Object::cast_to<Control>(p_from_node);
|
|
Window *from_window = from_control ? nullptr : Object::cast_to<Window>(p_from_node);
|
|
|
|
if (from_control) {
|
|
from_control->set_theme_context(p_context);
|
|
} else if (from_window) {
|
|
from_window->set_theme_context(p_context);
|
|
}
|
|
|
|
for (int i = 0; i < p_from_node->get_child_count(); i++) {
|
|
Node *child_node = p_from_node->get_child(i);
|
|
|
|
// If the child is the root of another global context, stop the propagation
|
|
// in this branch.
|
|
if (theme_contexts.has(child_node)) {
|
|
theme_contexts[child_node]->parent = p_context;
|
|
continue;
|
|
}
|
|
|
|
_propagate_theme_context(child_node, p_context);
|
|
}
|
|
}
|
|
|
|
void ThemeDB::_init_default_theme_context() {
|
|
default_theme_context = memnew(ThemeContext);
|
|
|
|
List<Ref<Theme>> themes;
|
|
themes.push_back(project_theme);
|
|
themes.push_back(default_theme);
|
|
default_theme_context->set_themes(themes);
|
|
}
|
|
|
|
void ThemeDB::_finalize_theme_contexts() {
|
|
if (default_theme_context) {
|
|
memdelete(default_theme_context);
|
|
default_theme_context = nullptr;
|
|
}
|
|
while (theme_contexts.size()) {
|
|
HashMap<Node *, ThemeContext *>::Iterator E = theme_contexts.begin();
|
|
memdelete(E->value);
|
|
theme_contexts.remove(E);
|
|
}
|
|
}
|
|
|
|
ThemeContext *ThemeDB::get_default_theme_context() const {
|
|
return default_theme_context;
|
|
}
|
|
|
|
ThemeContext *ThemeDB::get_nearest_theme_context(Node *p_for_node) const {
|
|
ERR_FAIL_COND_V(!p_for_node->is_inside_tree(), nullptr);
|
|
|
|
Node *parent_node = p_for_node->get_parent();
|
|
while (parent_node) {
|
|
if (theme_contexts.has(parent_node)) {
|
|
return theme_contexts[parent_node];
|
|
}
|
|
|
|
parent_node = parent_node->get_parent();
|
|
}
|
|
|
|
return nullptr;
|
|
}
|
|
|
|
// Object methods.
|
|
|
|
void ThemeDB::_bind_methods() {
|
|
ClassDB::bind_method(D_METHOD("get_default_theme"), &ThemeDB::get_default_theme);
|
|
ClassDB::bind_method(D_METHOD("get_project_theme"), &ThemeDB::get_project_theme);
|
|
|
|
ClassDB::bind_method(D_METHOD("set_fallback_base_scale", "base_scale"), &ThemeDB::set_fallback_base_scale);
|
|
ClassDB::bind_method(D_METHOD("get_fallback_base_scale"), &ThemeDB::get_fallback_base_scale);
|
|
ClassDB::bind_method(D_METHOD("set_fallback_font", "font"), &ThemeDB::set_fallback_font);
|
|
ClassDB::bind_method(D_METHOD("get_fallback_font"), &ThemeDB::get_fallback_font);
|
|
ClassDB::bind_method(D_METHOD("set_fallback_font_size", "font_size"), &ThemeDB::set_fallback_font_size);
|
|
ClassDB::bind_method(D_METHOD("get_fallback_font_size"), &ThemeDB::get_fallback_font_size);
|
|
ClassDB::bind_method(D_METHOD("set_fallback_icon", "icon"), &ThemeDB::set_fallback_icon);
|
|
ClassDB::bind_method(D_METHOD("get_fallback_icon"), &ThemeDB::get_fallback_icon);
|
|
ClassDB::bind_method(D_METHOD("set_fallback_stylebox", "stylebox"), &ThemeDB::set_fallback_stylebox);
|
|
ClassDB::bind_method(D_METHOD("get_fallback_stylebox"), &ThemeDB::get_fallback_stylebox);
|
|
|
|
ADD_GROUP("Fallback values", "fallback_");
|
|
ADD_PROPERTY(PropertyInfo(Variant::FLOAT, "fallback_base_scale", PROPERTY_HINT_RANGE, "0.0,2.0,0.01,or_greater"), "set_fallback_base_scale", "get_fallback_base_scale");
|
|
ADD_PROPERTY(PropertyInfo(Variant::OBJECT, "fallback_font", PROPERTY_HINT_RESOURCE_TYPE, "Font", PROPERTY_USAGE_NONE), "set_fallback_font", "get_fallback_font");
|
|
ADD_PROPERTY(PropertyInfo(Variant::INT, "fallback_font_size", PROPERTY_HINT_RANGE, "0,256,1,or_greater,suffix:px"), "set_fallback_font_size", "get_fallback_font_size");
|
|
ADD_PROPERTY(PropertyInfo(Variant::OBJECT, "fallback_icon", PROPERTY_HINT_RESOURCE_TYPE, "Texture2D", PROPERTY_USAGE_NONE), "set_fallback_icon", "get_fallback_icon");
|
|
ADD_PROPERTY(PropertyInfo(Variant::OBJECT, "fallback_stylebox", PROPERTY_HINT_RESOURCE_TYPE, "StyleBox", PROPERTY_USAGE_NONE), "set_fallback_stylebox", "get_fallback_stylebox");
|
|
|
|
ADD_SIGNAL(MethodInfo("fallback_changed"));
|
|
}
|
|
|
|
// Memory management, reference, and initialization.
|
|
|
|
ThemeDB *ThemeDB::singleton = nullptr;
|
|
|
|
ThemeDB *ThemeDB::get_singleton() {
|
|
return singleton;
|
|
}
|
|
|
|
ThemeDB::ThemeDB() {
|
|
singleton = this;
|
|
}
|
|
|
|
ThemeDB::~ThemeDB() {
|
|
// For technical reasons unit tests recreate and destroy the default
|
|
// theme over and over again. Make sure that finalize_theme() also
|
|
// frees any objects that can be recreated by initialize_theme*().
|
|
|
|
_finalize_theme_contexts();
|
|
|
|
default_theme.unref();
|
|
project_theme.unref();
|
|
|
|
fallback_font.unref();
|
|
fallback_icon.unref();
|
|
fallback_stylebox.unref();
|
|
|
|
singleton = nullptr;
|
|
}
|
|
|
|
void ThemeContext::_emit_changed() {
|
|
emit_signal(SNAME("changed"));
|
|
}
|
|
|
|
void ThemeContext::set_themes(List<Ref<Theme>> &p_themes) {
|
|
for (const Ref<Theme> &theme : themes) {
|
|
theme->disconnect_changed(callable_mp(this, &ThemeContext::_emit_changed));
|
|
}
|
|
|
|
themes.clear();
|
|
|
|
for (const Ref<Theme> &theme : p_themes) {
|
|
if (theme.is_null()) {
|
|
continue;
|
|
}
|
|
|
|
themes.push_back(theme);
|
|
theme->connect_changed(callable_mp(this, &ThemeContext::_emit_changed));
|
|
}
|
|
|
|
_emit_changed();
|
|
}
|
|
|
|
List<Ref<Theme>> ThemeContext::get_themes() const {
|
|
return themes;
|
|
}
|
|
|
|
Ref<Theme> ThemeContext::get_fallback_theme() const {
|
|
// We expect all contexts to be valid and non-empty, but just in case...
|
|
if (themes.size() == 0) {
|
|
return ThemeDB::get_singleton()->get_default_theme();
|
|
}
|
|
|
|
return themes.back()->get();
|
|
}
|
|
|
|
void ThemeContext::_bind_methods() {
|
|
ADD_SIGNAL(MethodInfo("changed"));
|
|
}
|