95b27fe8c7
This change introduces a new EditorThemeManager class to abstract theme generatio and its subroutines. Logic related to EditorTheme, EditorColorMap, and editor icons has been extracted into their respective files with includes cleaned up. All related files have been moved to a separate folder to better scope them in the project. This includes relevant generated files as well.
368 lines
15 KiB
C++
368 lines
15 KiB
C++
/**************************************************************************/
|
|
/* editor_network_profiler.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_network_profiler.h"
|
|
|
|
#include "core/os/os.h"
|
|
#include "editor/editor_settings.h"
|
|
#include "editor/editor_string_names.h"
|
|
#include "editor/themes/editor_scale.h"
|
|
|
|
void EditorNetworkProfiler::_bind_methods() {
|
|
ADD_SIGNAL(MethodInfo("enable_profiling", PropertyInfo(Variant::BOOL, "enable")));
|
|
ADD_SIGNAL(MethodInfo("open_request", PropertyInfo(Variant::STRING, "path")));
|
|
}
|
|
|
|
void EditorNetworkProfiler::_notification(int p_what) {
|
|
switch (p_what) {
|
|
case NOTIFICATION_THEME_CHANGED: {
|
|
if (activate->is_pressed()) {
|
|
activate->set_icon(theme_cache.stop_icon);
|
|
} else {
|
|
activate->set_icon(theme_cache.play_icon);
|
|
}
|
|
clear_button->set_icon(theme_cache.clear_icon);
|
|
|
|
incoming_bandwidth_text->set_right_icon(theme_cache.incoming_bandwidth_icon);
|
|
outgoing_bandwidth_text->set_right_icon(theme_cache.outgoing_bandwidth_icon);
|
|
|
|
// This needs to be done here to set the faded color when the profiler is first opened
|
|
incoming_bandwidth_text->add_theme_color_override("font_uneditable_color", theme_cache.incoming_bandwidth_color * Color(1, 1, 1, 0.5));
|
|
outgoing_bandwidth_text->add_theme_color_override("font_uneditable_color", theme_cache.outgoing_bandwidth_color * Color(1, 1, 1, 0.5));
|
|
} break;
|
|
}
|
|
}
|
|
|
|
void EditorNetworkProfiler::_update_theme_item_cache() {
|
|
VBoxContainer::_update_theme_item_cache();
|
|
|
|
theme_cache.node_icon = get_theme_icon(SNAME("Node"), EditorStringName(EditorIcons));
|
|
theme_cache.stop_icon = get_theme_icon(SNAME("Stop"), EditorStringName(EditorIcons));
|
|
theme_cache.play_icon = get_theme_icon(SNAME("Play"), EditorStringName(EditorIcons));
|
|
theme_cache.clear_icon = get_theme_icon(SNAME("Clear"), EditorStringName(EditorIcons));
|
|
|
|
theme_cache.multiplayer_synchronizer_icon = get_theme_icon("MultiplayerSynchronizer", EditorStringName(EditorIcons));
|
|
theme_cache.instance_options_icon = get_theme_icon(SNAME("InstanceOptions"), EditorStringName(EditorIcons));
|
|
|
|
theme_cache.incoming_bandwidth_icon = get_theme_icon(SNAME("ArrowDown"), EditorStringName(EditorIcons));
|
|
theme_cache.outgoing_bandwidth_icon = get_theme_icon(SNAME("ArrowUp"), EditorStringName(EditorIcons));
|
|
|
|
theme_cache.incoming_bandwidth_color = get_theme_color(SNAME("font_color"), EditorStringName(Editor));
|
|
theme_cache.outgoing_bandwidth_color = get_theme_color(SNAME("font_color"), EditorStringName(Editor));
|
|
}
|
|
|
|
void EditorNetworkProfiler::_refresh() {
|
|
if (!dirty) {
|
|
return;
|
|
}
|
|
dirty = false;
|
|
refresh_rpc_data();
|
|
refresh_replication_data();
|
|
}
|
|
|
|
void EditorNetworkProfiler::refresh_rpc_data() {
|
|
counters_display->clear();
|
|
|
|
TreeItem *root = counters_display->create_item();
|
|
int cols = counters_display->get_columns();
|
|
|
|
for (const KeyValue<ObjectID, RPCNodeInfo> &E : rpc_data) {
|
|
TreeItem *node = counters_display->create_item(root);
|
|
|
|
for (int j = 0; j < cols; ++j) {
|
|
node->set_text_alignment(j, j > 0 ? HORIZONTAL_ALIGNMENT_RIGHT : HORIZONTAL_ALIGNMENT_LEFT);
|
|
}
|
|
|
|
node->set_text(0, E.value.node_path);
|
|
node->set_text(1, E.value.incoming_rpc == 0 ? "-" : vformat(TTR("%d (%s)"), E.value.incoming_rpc, String::humanize_size(E.value.incoming_size)));
|
|
node->set_text(2, E.value.outgoing_rpc == 0 ? "-" : vformat(TTR("%d (%s)"), E.value.outgoing_rpc, String::humanize_size(E.value.outgoing_size)));
|
|
}
|
|
}
|
|
|
|
void EditorNetworkProfiler::refresh_replication_data() {
|
|
replication_display->clear();
|
|
|
|
TreeItem *root = replication_display->create_item();
|
|
|
|
for (const KeyValue<ObjectID, SyncInfo> &E : sync_data) {
|
|
// Ensure the nodes have at least a temporary cache.
|
|
ObjectID ids[3] = { E.value.synchronizer, E.value.config, E.value.root_node };
|
|
for (uint32_t i = 0; i < 3; i++) {
|
|
const ObjectID &id = ids[i];
|
|
if (!node_data.has(id)) {
|
|
missing_node_data.insert(id);
|
|
node_data[id] = NodeInfo(id);
|
|
}
|
|
}
|
|
|
|
TreeItem *node = replication_display->create_item(root);
|
|
|
|
const NodeInfo &root_info = node_data[E.value.root_node];
|
|
const NodeInfo &sync_info = node_data[E.value.synchronizer];
|
|
const NodeInfo &cfg_info = node_data[E.value.config];
|
|
|
|
node->set_text(0, root_info.path.get_file());
|
|
node->set_icon(0, has_theme_icon(root_info.type, EditorStringName(EditorIcons)) ? get_theme_icon(root_info.type, EditorStringName(EditorIcons)) : theme_cache.node_icon);
|
|
node->set_tooltip_text(0, root_info.path);
|
|
|
|
node->set_text(1, sync_info.path.get_file());
|
|
node->set_icon(1, theme_cache.multiplayer_synchronizer_icon);
|
|
node->set_tooltip_text(1, sync_info.path);
|
|
|
|
int cfg_idx = cfg_info.path.find("::");
|
|
if (cfg_info.path.begins_with("res://") && ResourceLoader::exists(cfg_info.path) && cfg_idx > 0) {
|
|
String res_idstr = cfg_info.path.substr(cfg_idx + 2).replace("SceneReplicationConfig_", "");
|
|
String scene_path = cfg_info.path.substr(0, cfg_idx);
|
|
node->set_text(2, vformat("%s (%s)", res_idstr, scene_path.get_file()));
|
|
node->add_button(2, theme_cache.instance_options_icon);
|
|
node->set_tooltip_text(2, cfg_info.path);
|
|
node->set_metadata(2, scene_path);
|
|
} else {
|
|
node->set_text(2, cfg_info.path);
|
|
node->set_metadata(2, "");
|
|
}
|
|
|
|
node->set_text(3, vformat("%d - %d", E.value.incoming_syncs, E.value.outgoing_syncs));
|
|
node->set_text(4, vformat("%d - %d", E.value.incoming_size, E.value.outgoing_size));
|
|
}
|
|
}
|
|
|
|
Array EditorNetworkProfiler::pop_missing_node_data() {
|
|
Array out;
|
|
for (const ObjectID &id : missing_node_data) {
|
|
out.push_back(id);
|
|
}
|
|
missing_node_data.clear();
|
|
return out;
|
|
}
|
|
|
|
void EditorNetworkProfiler::add_node_data(const NodeInfo &p_info) {
|
|
ERR_FAIL_COND(!node_data.has(p_info.id));
|
|
node_data[p_info.id] = p_info;
|
|
dirty = true;
|
|
}
|
|
|
|
void EditorNetworkProfiler::_activate_pressed() {
|
|
if (activate->is_pressed()) {
|
|
refresh_timer->start();
|
|
activate->set_icon(theme_cache.stop_icon);
|
|
activate->set_text(TTR("Stop"));
|
|
} else {
|
|
refresh_timer->stop();
|
|
activate->set_icon(theme_cache.play_icon);
|
|
activate->set_text(TTR("Start"));
|
|
}
|
|
emit_signal(SNAME("enable_profiling"), activate->is_pressed());
|
|
}
|
|
|
|
void EditorNetworkProfiler::_clear_pressed() {
|
|
rpc_data.clear();
|
|
sync_data.clear();
|
|
node_data.clear();
|
|
missing_node_data.clear();
|
|
set_bandwidth(0, 0);
|
|
refresh_rpc_data();
|
|
refresh_replication_data();
|
|
}
|
|
|
|
void EditorNetworkProfiler::_replication_button_clicked(TreeItem *p_item, int p_column, int p_idx, MouseButton p_button) {
|
|
if (!p_item) {
|
|
return;
|
|
}
|
|
String meta = p_item->get_metadata(p_column);
|
|
if (meta.size() && ResourceLoader::exists(meta)) {
|
|
emit_signal("open_request", meta);
|
|
}
|
|
}
|
|
|
|
void EditorNetworkProfiler::add_rpc_frame_data(const RPCNodeInfo &p_frame) {
|
|
dirty = true;
|
|
if (!rpc_data.has(p_frame.node)) {
|
|
rpc_data.insert(p_frame.node, p_frame);
|
|
} else {
|
|
rpc_data[p_frame.node].incoming_rpc += p_frame.incoming_rpc;
|
|
rpc_data[p_frame.node].outgoing_rpc += p_frame.outgoing_rpc;
|
|
}
|
|
if (p_frame.incoming_rpc) {
|
|
rpc_data[p_frame.node].incoming_size = p_frame.incoming_size / p_frame.incoming_rpc;
|
|
}
|
|
if (p_frame.outgoing_rpc) {
|
|
rpc_data[p_frame.node].outgoing_size = p_frame.outgoing_size / p_frame.outgoing_rpc;
|
|
}
|
|
}
|
|
|
|
void EditorNetworkProfiler::add_sync_frame_data(const SyncInfo &p_frame) {
|
|
dirty = true;
|
|
if (!sync_data.has(p_frame.synchronizer)) {
|
|
sync_data[p_frame.synchronizer] = p_frame;
|
|
} else {
|
|
sync_data[p_frame.synchronizer].incoming_syncs += p_frame.incoming_syncs;
|
|
sync_data[p_frame.synchronizer].outgoing_syncs += p_frame.outgoing_syncs;
|
|
}
|
|
SyncInfo &info = sync_data[p_frame.synchronizer];
|
|
if (info.incoming_syncs) {
|
|
info.incoming_size = p_frame.incoming_size / p_frame.incoming_syncs;
|
|
}
|
|
if (info.outgoing_syncs) {
|
|
info.outgoing_size = p_frame.outgoing_size / p_frame.outgoing_syncs;
|
|
}
|
|
}
|
|
|
|
void EditorNetworkProfiler::set_bandwidth(int p_incoming, int p_outgoing) {
|
|
incoming_bandwidth_text->set_text(vformat(TTR("%s/s"), String::humanize_size(p_incoming)));
|
|
outgoing_bandwidth_text->set_text(vformat(TTR("%s/s"), String::humanize_size(p_outgoing)));
|
|
|
|
// Make labels more prominent when the bandwidth is greater than 0 to attract user attention
|
|
incoming_bandwidth_text->add_theme_color_override(
|
|
"font_uneditable_color",
|
|
theme_cache.incoming_bandwidth_color * Color(1, 1, 1, p_incoming > 0 ? 1 : 0.5));
|
|
outgoing_bandwidth_text->add_theme_color_override(
|
|
"font_uneditable_color",
|
|
theme_cache.outgoing_bandwidth_color * Color(1, 1, 1, p_outgoing > 0 ? 1 : 0.5));
|
|
}
|
|
|
|
bool EditorNetworkProfiler::is_profiling() {
|
|
return activate->is_pressed();
|
|
}
|
|
|
|
EditorNetworkProfiler::EditorNetworkProfiler() {
|
|
HBoxContainer *hb = memnew(HBoxContainer);
|
|
hb->add_theme_constant_override("separation", 8 * EDSCALE);
|
|
add_child(hb);
|
|
|
|
activate = memnew(Button);
|
|
activate->set_toggle_mode(true);
|
|
activate->set_text(TTR("Start"));
|
|
activate->connect("pressed", callable_mp(this, &EditorNetworkProfiler::_activate_pressed));
|
|
hb->add_child(activate);
|
|
|
|
clear_button = memnew(Button);
|
|
clear_button->set_text(TTR("Clear"));
|
|
clear_button->connect("pressed", callable_mp(this, &EditorNetworkProfiler::_clear_pressed));
|
|
hb->add_child(clear_button);
|
|
|
|
hb->add_spacer();
|
|
|
|
Label *lb = memnew(Label);
|
|
// TRANSLATORS: This is the label for the network profiler's incoming bandwidth.
|
|
lb->set_text(TTR("Down", "Network"));
|
|
hb->add_child(lb);
|
|
|
|
incoming_bandwidth_text = memnew(LineEdit);
|
|
incoming_bandwidth_text->set_editable(false);
|
|
incoming_bandwidth_text->set_custom_minimum_size(Size2(120, 0) * EDSCALE);
|
|
incoming_bandwidth_text->set_horizontal_alignment(HORIZONTAL_ALIGNMENT_RIGHT);
|
|
hb->add_child(incoming_bandwidth_text);
|
|
|
|
Control *down_up_spacer = memnew(Control);
|
|
down_up_spacer->set_custom_minimum_size(Size2(30, 0) * EDSCALE);
|
|
hb->add_child(down_up_spacer);
|
|
|
|
lb = memnew(Label);
|
|
// TRANSLATORS: This is the label for the network profiler's outgoing bandwidth.
|
|
lb->set_text(TTR("Up", "Network"));
|
|
hb->add_child(lb);
|
|
|
|
outgoing_bandwidth_text = memnew(LineEdit);
|
|
outgoing_bandwidth_text->set_editable(false);
|
|
outgoing_bandwidth_text->set_custom_minimum_size(Size2(120, 0) * EDSCALE);
|
|
outgoing_bandwidth_text->set_horizontal_alignment(HORIZONTAL_ALIGNMENT_RIGHT);
|
|
hb->add_child(outgoing_bandwidth_text);
|
|
|
|
// Set initial texts in the incoming/outgoing bandwidth labels
|
|
set_bandwidth(0, 0);
|
|
|
|
HSplitContainer *sc = memnew(HSplitContainer);
|
|
add_child(sc);
|
|
sc->set_v_size_flags(SIZE_EXPAND_FILL);
|
|
sc->set_h_size_flags(SIZE_EXPAND_FILL);
|
|
sc->set_split_offset(100 * EDSCALE);
|
|
|
|
// RPC
|
|
counters_display = memnew(Tree);
|
|
counters_display->set_custom_minimum_size(Size2(320, 0) * EDSCALE);
|
|
counters_display->set_v_size_flags(SIZE_EXPAND_FILL);
|
|
counters_display->set_h_size_flags(SIZE_EXPAND_FILL);
|
|
counters_display->set_hide_folding(true);
|
|
counters_display->set_hide_root(true);
|
|
counters_display->set_columns(3);
|
|
counters_display->set_column_titles_visible(true);
|
|
counters_display->set_column_title(0, TTR("Node"));
|
|
counters_display->set_column_expand(0, true);
|
|
counters_display->set_column_clip_content(0, true);
|
|
counters_display->set_column_custom_minimum_width(0, 60 * EDSCALE);
|
|
counters_display->set_column_title(1, TTR("Incoming RPC"));
|
|
counters_display->set_column_expand(1, false);
|
|
counters_display->set_column_clip_content(1, true);
|
|
counters_display->set_column_custom_minimum_width(1, 120 * EDSCALE);
|
|
counters_display->set_column_title(2, TTR("Outgoing RPC"));
|
|
counters_display->set_column_expand(2, false);
|
|
counters_display->set_column_clip_content(2, true);
|
|
counters_display->set_column_custom_minimum_width(2, 120 * EDSCALE);
|
|
sc->add_child(counters_display);
|
|
|
|
// Replication
|
|
replication_display = memnew(Tree);
|
|
replication_display->set_custom_minimum_size(Size2(320, 0) * EDSCALE);
|
|
replication_display->set_v_size_flags(SIZE_EXPAND_FILL);
|
|
replication_display->set_h_size_flags(SIZE_EXPAND_FILL);
|
|
replication_display->set_hide_folding(true);
|
|
replication_display->set_hide_root(true);
|
|
replication_display->set_columns(5);
|
|
replication_display->set_column_titles_visible(true);
|
|
replication_display->set_column_title(0, TTR("Root"));
|
|
replication_display->set_column_expand(0, true);
|
|
replication_display->set_column_clip_content(0, true);
|
|
replication_display->set_column_custom_minimum_width(0, 80 * EDSCALE);
|
|
replication_display->set_column_title(1, TTR("Synchronizer"));
|
|
replication_display->set_column_expand(1, true);
|
|
replication_display->set_column_clip_content(1, true);
|
|
replication_display->set_column_custom_minimum_width(1, 80 * EDSCALE);
|
|
replication_display->set_column_title(2, TTR("Config"));
|
|
replication_display->set_column_expand(2, true);
|
|
replication_display->set_column_clip_content(2, true);
|
|
replication_display->set_column_custom_minimum_width(2, 80 * EDSCALE);
|
|
replication_display->set_column_title(3, TTR("Count"));
|
|
replication_display->set_column_expand(3, false);
|
|
replication_display->set_column_clip_content(3, true);
|
|
replication_display->set_column_custom_minimum_width(3, 80 * EDSCALE);
|
|
replication_display->set_column_title(4, TTR("Size"));
|
|
replication_display->set_column_expand(4, false);
|
|
replication_display->set_column_clip_content(4, true);
|
|
replication_display->set_column_custom_minimum_width(4, 80 * EDSCALE);
|
|
replication_display->connect("button_clicked", callable_mp(this, &EditorNetworkProfiler::_replication_button_clicked));
|
|
sc->add_child(replication_display);
|
|
|
|
refresh_timer = memnew(Timer);
|
|
refresh_timer->set_wait_time(0.5);
|
|
refresh_timer->connect("timeout", callable_mp(this, &EditorNetworkProfiler::_refresh));
|
|
add_child(refresh_timer);
|
|
}
|