Power monitoring console overhaul (#20927)
* Prototyping whole station wire map * More prototyping * Added icons for the different power distributors and toggleable cable displays * Power cable layouts are now only sent to the client when the power monitor is open * UI prototyping * Power monitors can now see the sprites of distant entities, long entity names are truncated * Updated how network devices are added to the player's PVS * More feature prototypes * Added source / load symbols * Final prototype! Time to actually code it properly... * Start of code clean up * Continuing code clean up * Fixed UI appearance * Code clean up complete * Removed unnecessary changes * Updated how power values are calculated, added UI warnings for power sinks and power net checks * Updated how power values are calculated again, added support for portable generators * Removed unnecessary files * Map beacons start toggled off, console map now works outside the station, fixed substation icon * Made some of Sloth's requested changes. Power distributors don't blink anymore, unless selected * Moved a number of static variables in PowerMonitoringHelper to sensible places in the main files. Added a NavMapTrackableComponent so that you can specify how individual entities appear on the navmap * Updated the colors/positions of HV cables and SMESes to improve contrast * Fixed SMES color in map legend * Partially fixed auto-scrolling on device selection, made sublists alphabetical * Changed how auto-scroll is handled * Changed the font color of the console warning messages * Reduced the font size of beacon labels * Added the station name to the console * Organized references * Removed unwanted changes to RobustToolbox * Fix merge conflict * Fix merge conflict, maybe * Fix merge conflict * Updated outdated reference * Fixed portable_generator.yml * Implemented a number of requested changes, move bit masks to a shared component * Navigate listings via the navmap * First attempt at improving efficiency * Second attempt at optimization, entity grouping added for solar panels * Finished solar panel entity joining * Finished major revisions, code clean up needed * Finializing optimizations * Made requested changes * Bug fix, removed obsolete code * Bug fixes * Bug fixes * STarted revisions * Further revisions * More revision * Finalizing revisions. Need to make RT PR * Code tidying * More code tidying * Trying to avoid merge conflicts * Trying to avoid merge conflicts * Removed use of PVS * Improving efficiency * Addressed a bunch of outstanding issues * Clear old data on console refresh * UI adjustments * Made node comparison more robust. More devices can be combined into one entry * Added missing component 'dirty'
This commit is contained in:
chromiumboy
490
Content.Client/Power/PowerMonitoringWindow.xaml.Widgets.cs
Normal file
490
Content.Client/Power/PowerMonitoringWindow.xaml.Widgets.cs
Normal file
@@ -0,0 +1,490 @@
|
||||
using Content.Client.Stylesheets;
|
||||
using Content.Shared.Power;
|
||||
using Robust.Client.Graphics;
|
||||
using Robust.Client.UserInterface.Controls;
|
||||
using Robust.Shared.Utility;
|
||||
using System.Diagnostics.CodeAnalysis;
|
||||
using System.Linq;
|
||||
using System.Numerics;
|
||||
|
||||
namespace Content.Client.Power;
|
||||
|
||||
public sealed partial class PowerMonitoringWindow
|
||||
{
|
||||
private SpriteSpecifier.Texture _sourceIcon = new SpriteSpecifier.Texture(new ResPath("/Textures/Interface/PowerMonitoring/source_arrow.png"));
|
||||
private SpriteSpecifier.Texture _loadIconPath = new SpriteSpecifier.Texture(new ResPath("/Textures/Interface/PowerMonitoring/load_arrow.png"));
|
||||
|
||||
private bool _autoScrollActive = false;
|
||||
private bool _autoScrollAwaitsUpdate = false;
|
||||
|
||||
private void UpdateWindowConsoleEntry
|
||||
(BoxContainer masterContainer,
|
||||
int index,
|
||||
PowerMonitoringConsoleEntry entry,
|
||||
PowerMonitoringConsoleEntry[] focusSources,
|
||||
PowerMonitoringConsoleEntry[] focusLoads)
|
||||
{
|
||||
UpdateWindowConsoleEntry(masterContainer, index, entry);
|
||||
|
||||
var windowEntry = masterContainer.GetChild(index) as PowerMonitoringWindowEntry;
|
||||
|
||||
// If we exit here, something was added to the container that shouldn't have been added
|
||||
if (windowEntry == null)
|
||||
return;
|
||||
|
||||
// Update sources and loads
|
||||
UpdateEntrySourcesOrLoads(masterContainer, windowEntry.SourcesContainer, focusSources, _sourceIcon);
|
||||
UpdateEntrySourcesOrLoads(masterContainer, windowEntry.LoadsContainer, focusLoads, _loadIconPath);
|
||||
|
||||
windowEntry.MainContainer.Visible = true;
|
||||
}
|
||||
|
||||
private void UpdateWindowConsoleEntry(BoxContainer masterContainer, int index, PowerMonitoringConsoleEntry entry)
|
||||
{
|
||||
PowerMonitoringWindowEntry? windowEntry;
|
||||
|
||||
// Add missing children
|
||||
if (index >= masterContainer.ChildCount)
|
||||
{
|
||||
// Add basic entry
|
||||
windowEntry = new PowerMonitoringWindowEntry(entry);
|
||||
masterContainer.AddChild(windowEntry);
|
||||
|
||||
// Selection action
|
||||
windowEntry.Button.OnButtonUp += args =>
|
||||
{
|
||||
windowEntry.SourcesContainer.DisposeAllChildren();
|
||||
windowEntry.LoadsContainer.DisposeAllChildren();
|
||||
ButtonAction(windowEntry, masterContainer);
|
||||
};
|
||||
}
|
||||
|
||||
else
|
||||
{
|
||||
windowEntry = masterContainer.GetChild(index) as PowerMonitoringWindowEntry;
|
||||
}
|
||||
|
||||
// If we exit here, something was added to the container that shouldn't have been added
|
||||
if (windowEntry == null)
|
||||
return;
|
||||
|
||||
windowEntry.NetEntity = entry.NetEntity;
|
||||
windowEntry.Entry = entry;
|
||||
windowEntry.MainContainer.Visible = false;
|
||||
|
||||
UpdateWindowEntryButton(entry.NetEntity, windowEntry.Button, entry);
|
||||
}
|
||||
|
||||
public void UpdateWindowEntryButton(NetEntity netEntity, PowerMonitoringButton button, PowerMonitoringConsoleEntry entry)
|
||||
{
|
||||
if (!netEntity.IsValid())
|
||||
return;
|
||||
|
||||
if (entry.MetaData == null)
|
||||
return;
|
||||
|
||||
// Update button style
|
||||
if (netEntity == _focusEntity)
|
||||
button.AddStyleClass(StyleNano.StyleClassButtonColorGreen);
|
||||
|
||||
else
|
||||
button.RemoveStyleClass(StyleNano.StyleClassButtonColorGreen);
|
||||
|
||||
// Update sprite
|
||||
if (entry.MetaData.Value.SpritePath != string.Empty && entry.MetaData.Value.SpriteState != string.Empty)
|
||||
button.TextureRect.Texture = _spriteSystem.Frame0(new SpriteSpecifier.Rsi(new ResPath(entry.MetaData.Value.SpritePath), entry.MetaData.Value.SpriteState));
|
||||
|
||||
// Update name
|
||||
var name = Loc.GetString(entry.MetaData.Value.EntityName);
|
||||
button.NameLocalized.Text = name;
|
||||
|
||||
// Update tool tip
|
||||
button.ToolTip = Loc.GetString(name);
|
||||
|
||||
// Update power value
|
||||
button.PowerValue.Text = Loc.GetString("power-monitoring-window-value", ("value", entry.PowerValue));
|
||||
}
|
||||
|
||||
private void UpdateEntrySourcesOrLoads(BoxContainer masterContainer, BoxContainer currentContainer, PowerMonitoringConsoleEntry[]? entries, SpriteSpecifier.Texture icon)
|
||||
{
|
||||
if (currentContainer == null)
|
||||
return;
|
||||
|
||||
if (entries == null || entries.Length == 0)
|
||||
{
|
||||
currentContainer.RemoveAllChildren();
|
||||
return;
|
||||
}
|
||||
|
||||
// Remove excess children
|
||||
while (currentContainer.ChildCount > entries.Length)
|
||||
{
|
||||
currentContainer.RemoveChild(currentContainer.GetChild(currentContainer.ChildCount - 1));
|
||||
}
|
||||
|
||||
// Add missing children
|
||||
while (currentContainer.ChildCount < entries.Length)
|
||||
{
|
||||
var entry = entries[currentContainer.ChildCount];
|
||||
var subEntry = new PowerMonitoringWindowSubEntry(entry);
|
||||
currentContainer.AddChild(subEntry);
|
||||
|
||||
// Selection action
|
||||
subEntry.Button.OnButtonUp += args => { ButtonAction(subEntry, masterContainer); };
|
||||
}
|
||||
|
||||
if (!_entManager.TryGetComponent<PowerMonitoringConsoleComponent>(_owner, out var console))
|
||||
return;
|
||||
|
||||
// Update all children
|
||||
foreach (var child in currentContainer.Children)
|
||||
{
|
||||
if (child is not PowerMonitoringWindowSubEntry)
|
||||
continue;
|
||||
|
||||
var castChild = (PowerMonitoringWindowSubEntry) child;
|
||||
|
||||
if (castChild == null)
|
||||
continue;
|
||||
|
||||
if (castChild.Icon != null)
|
||||
castChild.Icon.Texture = _spriteSystem.Frame0(icon);
|
||||
|
||||
var entry = entries[child.GetPositionInParent()];
|
||||
|
||||
castChild.NetEntity = entry.NetEntity;
|
||||
castChild.Entry = entry;
|
||||
|
||||
UpdateWindowEntryButton(entry.NetEntity, castChild.Button, entries.ElementAt(child.GetPositionInParent()));
|
||||
}
|
||||
}
|
||||
|
||||
private void ButtonAction(PowerMonitoringWindowBaseEntry entry, BoxContainer masterContainer)
|
||||
{
|
||||
// Toggle off button?
|
||||
if (entry.NetEntity == _focusEntity)
|
||||
{
|
||||
entry.Button.RemoveStyleClass(StyleNano.StyleClassButtonColorGreen);
|
||||
_focusEntity = null;
|
||||
|
||||
// Request an update from the power monitoring system
|
||||
SendPowerMonitoringConsoleMessageAction?.Invoke(null, entry.Entry.Group);
|
||||
|
||||
return;
|
||||
}
|
||||
|
||||
// Otherwise, toggle on
|
||||
entry.Button.AddStyleClass(StyleNano.StyleClassButtonColorGreen);
|
||||
|
||||
ActivateAutoScrollToFocus();
|
||||
|
||||
// Toggle off the old button (if applicable)
|
||||
if (_focusEntity != null)
|
||||
{
|
||||
foreach (PowerMonitoringWindowEntry sibling in masterContainer.Children)
|
||||
{
|
||||
if (sibling.NetEntity == _focusEntity)
|
||||
{
|
||||
sibling.Button.RemoveStyleClass(StyleNano.StyleClassButtonColorGreen);
|
||||
break;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// Center the nav map on selected entity
|
||||
_focusEntity = entry.NetEntity;
|
||||
|
||||
if (!NavMap.TrackedEntities.TryGetValue(entry.NetEntity, out var blip))
|
||||
return;
|
||||
|
||||
NavMap.CenterToCoordinates(blip.Coordinates);
|
||||
|
||||
// Switch tabs
|
||||
SwitchTabsBasedOnPowerMonitoringConsoleGroup(entry.Entry.Group);
|
||||
|
||||
// Send an update from the power monitoring system
|
||||
SendPowerMonitoringConsoleMessageAction?.Invoke(_focusEntity, entry.Entry.Group);
|
||||
}
|
||||
|
||||
private void ActivateAutoScrollToFocus()
|
||||
{
|
||||
_autoScrollActive = false;
|
||||
_autoScrollAwaitsUpdate = true;
|
||||
}
|
||||
|
||||
private bool TryGetNextScrollPosition([NotNullWhen(true)] out float? nextScrollPosition)
|
||||
{
|
||||
nextScrollPosition = null;
|
||||
|
||||
var scroll = MasterTabContainer.Children.ElementAt(MasterTabContainer.CurrentTab) as ScrollContainer;
|
||||
if (scroll == null)
|
||||
return false;
|
||||
|
||||
var container = scroll.Children.ElementAt(0) as BoxContainer;
|
||||
if (container == null || container.Children.Count() == 0)
|
||||
return false;
|
||||
|
||||
// Exit if the heights of the children haven't been initialized yet
|
||||
if (!container.Children.Any(x => x.Height > 0))
|
||||
return false;
|
||||
|
||||
nextScrollPosition = 0;
|
||||
|
||||
foreach (var control in container.Children)
|
||||
{
|
||||
if (control == null || control is not PowerMonitoringWindowEntry)
|
||||
continue;
|
||||
|
||||
if (((PowerMonitoringWindowEntry) control).NetEntity == _focusEntity)
|
||||
return true;
|
||||
|
||||
nextScrollPosition += control.Height;
|
||||
}
|
||||
|
||||
// Failed to find control
|
||||
nextScrollPosition = null;
|
||||
|
||||
return false;
|
||||
}
|
||||
|
||||
private bool TryGetVerticalScrollbar(ScrollContainer scroll, [NotNullWhen(true)] out VScrollBar? vScrollBar)
|
||||
{
|
||||
vScrollBar = null;
|
||||
|
||||
foreach (var child in scroll.Children)
|
||||
{
|
||||
if (child is not VScrollBar)
|
||||
continue;
|
||||
|
||||
var castChild = child as VScrollBar;
|
||||
|
||||
if (castChild != null)
|
||||
{
|
||||
vScrollBar = castChild;
|
||||
return true;
|
||||
}
|
||||
}
|
||||
|
||||
return false;
|
||||
}
|
||||
|
||||
private void AutoScrollToFocus()
|
||||
{
|
||||
if (!_autoScrollActive)
|
||||
return;
|
||||
|
||||
var scroll = MasterTabContainer.Children.ElementAt(MasterTabContainer.CurrentTab) as ScrollContainer;
|
||||
if (scroll == null)
|
||||
return;
|
||||
|
||||
if (!TryGetVerticalScrollbar(scroll, out var vScrollbar))
|
||||
return;
|
||||
|
||||
if (!TryGetNextScrollPosition(out float? nextScrollPosition))
|
||||
return;
|
||||
|
||||
vScrollbar.ValueTarget = nextScrollPosition.Value;
|
||||
|
||||
if (MathHelper.CloseToPercent(vScrollbar.Value, vScrollbar.ValueTarget))
|
||||
_autoScrollActive = false;
|
||||
}
|
||||
|
||||
private void UpdateWarningLabel(PowerMonitoringFlags flags)
|
||||
{
|
||||
if (flags == PowerMonitoringFlags.None)
|
||||
{
|
||||
SystemWarningPanel.Visible = false;
|
||||
return;
|
||||
}
|
||||
|
||||
var msg = new FormattedMessage();
|
||||
|
||||
if ((flags & PowerMonitoringFlags.RoguePowerConsumer) != 0)
|
||||
{
|
||||
SystemWarningPanel.PanelOverride = new StyleBoxFlat
|
||||
{
|
||||
BackgroundColor = Color.Red,
|
||||
BorderColor = Color.DarkRed,
|
||||
BorderThickness = new Thickness(2),
|
||||
};
|
||||
|
||||
msg.AddMarkup(Loc.GetString("power-monitoring-window-rogue-power-consumer"));
|
||||
SystemWarningPanel.Visible = true;
|
||||
}
|
||||
|
||||
else if ((flags & PowerMonitoringFlags.PowerNetAbnormalities) != 0)
|
||||
{
|
||||
SystemWarningPanel.PanelOverride = new StyleBoxFlat
|
||||
{
|
||||
BackgroundColor = Color.Orange,
|
||||
BorderColor = Color.DarkOrange,
|
||||
BorderThickness = new Thickness(2),
|
||||
};
|
||||
|
||||
msg.AddMarkup(Loc.GetString("power-monitoring-window-power-net-abnormalities"));
|
||||
SystemWarningPanel.Visible = true;
|
||||
}
|
||||
|
||||
SystemWarningLabel.SetMessage(msg);
|
||||
}
|
||||
|
||||
private void SwitchTabsBasedOnPowerMonitoringConsoleGroup(PowerMonitoringConsoleGroup group)
|
||||
{
|
||||
switch (group)
|
||||
{
|
||||
case PowerMonitoringConsoleGroup.Generator:
|
||||
MasterTabContainer.CurrentTab = 0; break;
|
||||
case PowerMonitoringConsoleGroup.SMES:
|
||||
MasterTabContainer.CurrentTab = 1; break;
|
||||
case PowerMonitoringConsoleGroup.Substation:
|
||||
MasterTabContainer.CurrentTab = 2; break;
|
||||
case PowerMonitoringConsoleGroup.APC:
|
||||
MasterTabContainer.CurrentTab = 3; break;
|
||||
}
|
||||
}
|
||||
|
||||
private PowerMonitoringConsoleGroup GetCurrentPowerMonitoringConsoleGroup()
|
||||
{
|
||||
return (PowerMonitoringConsoleGroup) MasterTabContainer.CurrentTab;
|
||||
}
|
||||
}
|
||||
|
||||
public sealed class PowerMonitoringWindowEntry : PowerMonitoringWindowBaseEntry
|
||||
{
|
||||
public BoxContainer MainContainer;
|
||||
public BoxContainer SourcesContainer;
|
||||
public BoxContainer LoadsContainer;
|
||||
|
||||
public PowerMonitoringWindowEntry(PowerMonitoringConsoleEntry entry) : base(entry)
|
||||
{
|
||||
Entry = entry;
|
||||
|
||||
// Alignment
|
||||
Orientation = LayoutOrientation.Vertical;
|
||||
HorizontalExpand = true;
|
||||
|
||||
// Update selection button
|
||||
Button.StyleClasses.Add("OpenLeft");
|
||||
AddChild(Button);
|
||||
|
||||
// Grid container to hold sub containers
|
||||
MainContainer = new BoxContainer()
|
||||
{
|
||||
Orientation = LayoutOrientation.Vertical,
|
||||
HorizontalExpand = true,
|
||||
Margin = new Thickness(8, 0, 0, 0),
|
||||
Visible = false,
|
||||
};
|
||||
|
||||
AddChild(MainContainer);
|
||||
|
||||
// Grid container to hold the list of sources when selected
|
||||
SourcesContainer = new BoxContainer()
|
||||
{
|
||||
Orientation = LayoutOrientation.Vertical,
|
||||
HorizontalExpand = true,
|
||||
};
|
||||
|
||||
MainContainer.AddChild(SourcesContainer);
|
||||
|
||||
// Grid container to hold the list of loads when selected
|
||||
LoadsContainer = new BoxContainer()
|
||||
{
|
||||
Orientation = LayoutOrientation.Vertical,
|
||||
HorizontalExpand = true,
|
||||
};
|
||||
|
||||
MainContainer.AddChild(LoadsContainer);
|
||||
}
|
||||
}
|
||||
|
||||
public sealed class PowerMonitoringWindowSubEntry : PowerMonitoringWindowBaseEntry
|
||||
{
|
||||
public TextureRect? Icon;
|
||||
|
||||
public PowerMonitoringWindowSubEntry(PowerMonitoringConsoleEntry entry) : base(entry)
|
||||
{
|
||||
Orientation = LayoutOrientation.Horizontal;
|
||||
HorizontalExpand = true;
|
||||
|
||||
// Source/load icon
|
||||
Icon = new TextureRect()
|
||||
{
|
||||
VerticalAlignment = VAlignment.Center,
|
||||
Margin = new Thickness(0, 0, 2, 0),
|
||||
};
|
||||
|
||||
AddChild(Icon);
|
||||
|
||||
// Selection button
|
||||
Button.StyleClasses.Add("OpenBoth");
|
||||
AddChild(Button);
|
||||
}
|
||||
}
|
||||
|
||||
public abstract class PowerMonitoringWindowBaseEntry : BoxContainer
|
||||
{
|
||||
public NetEntity NetEntity;
|
||||
public PowerMonitoringConsoleEntry Entry;
|
||||
public PowerMonitoringButton Button;
|
||||
|
||||
public PowerMonitoringWindowBaseEntry(PowerMonitoringConsoleEntry entry)
|
||||
{
|
||||
Entry = entry;
|
||||
|
||||
// Add selection button (properties set by derivative classes)
|
||||
Button = new PowerMonitoringButton();
|
||||
}
|
||||
}
|
||||
|
||||
public sealed class PowerMonitoringButton : Button
|
||||
{
|
||||
public BoxContainer MainContainer;
|
||||
public TextureRect TextureRect;
|
||||
public Label NameLocalized;
|
||||
public Label PowerValue;
|
||||
|
||||
public PowerMonitoringButton()
|
||||
{
|
||||
HorizontalExpand = true;
|
||||
VerticalExpand = true;
|
||||
Margin = new Thickness(0f, 1f, 0f, 1f);
|
||||
|
||||
MainContainer = new BoxContainer()
|
||||
{
|
||||
Orientation = BoxContainer.LayoutOrientation.Horizontal,
|
||||
HorizontalExpand = true,
|
||||
SetHeight = 32f,
|
||||
};
|
||||
|
||||
AddChild(MainContainer);
|
||||
|
||||
TextureRect = new TextureRect()
|
||||
{
|
||||
HorizontalAlignment = HAlignment.Center,
|
||||
VerticalAlignment = VAlignment.Center,
|
||||
SetSize = new Vector2(32f, 32f),
|
||||
Margin = new Thickness(0f, 0f, 5f, 0f),
|
||||
};
|
||||
|
||||
MainContainer.AddChild(TextureRect);
|
||||
|
||||
NameLocalized = new Label()
|
||||
{
|
||||
HorizontalExpand = true,
|
||||
ClipText = true,
|
||||
};
|
||||
|
||||
MainContainer.AddChild(NameLocalized);
|
||||
|
||||
PowerValue = new Label()
|
||||
{
|
||||
HorizontalAlignment = HAlignment.Right,
|
||||
SetWidth = 72f,
|
||||
Margin = new Thickness(10, 0, 0, 0),
|
||||
ClipText = true,
|
||||
};
|
||||
|
||||
MainContainer.AddChild(PowerValue);
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user