Skip to content

ColumnType: CustomVariable #27

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
wooferzfg merged 10 commits into from
May 17, 2025
Merged

ColumnType: CustomVariable #27

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
f45c480
ColumnType: CustomVariable
AlexKnauth Sep 12, 2024
3a74fc9
Use CustomVariableValues
AlexKnauth Apr 26, 2025
0d7a49d
Clean up skipped segment entries
AlexKnauth Apr 28, 2025
8536972
Adjust width
AlexKnauth May 3, 2025
0197b05
Fix CustomVariable ForeColor
AlexKnauth May 5, 2025
8535237
Dynamically adjust width
AlexKnauth May 6, 2025
9593e4e
SplitsComponent: CalculateColumnWidths
AlexKnauth May 7, 2025
2e1032b
Draw: CalculateColumnWidths
AlexKnauth May 7, 2025
fa01e28
Cache invalidation
AlexKnauth May 13, 2025
d46bb6f
Revert "Draw: CalculateColumnWidths"
AlexKnauth May 13, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion src/LiveSplit.Splits/UI/ColumnType.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,5 @@

public enum ColumnType
{
Delta, SplitTime, DeltaorSplitTime, SegmentDelta, SegmentTime, SegmentDeltaorSegmentTime
Delta, SplitTime, DeltaorSplitTime, SegmentDelta, SegmentTime, SegmentDeltaorSegmentTime, CustomVariable
}
5 changes: 3 additions & 2 deletions src/LiveSplit.Splits/UI/Components/ColumnSettings.Designer.cs
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

10 changes: 9 additions & 1 deletion src/LiveSplit.Splits/UI/Components/ColumnSettings.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -131,10 +131,18 @@ private static string GetColumnType(ColumnType type)
{
return "Segment Delta";
}
else
else if (type == ColumnType.SegmentDeltaorSegmentTime)
{
return "Segment Delta or Segment Time";
}
else if (type == ColumnType.CustomVariable)
{
return "Custom Variable";
}
else
{
return "Unknown";
}
}

private static ColumnType ParseColumnType(string columnType)
Expand Down
65 changes: 9 additions & 56 deletions src/LiveSplit.Splits/UI/Components/LabelsComponent.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,30 +6,20 @@

using LiveSplit.Model;
using LiveSplit.Model.Comparisons;
using LiveSplit.TimeFormatters;

namespace LiveSplit.UI.Components;

public class LabelsComponent : IComponent
{
public SplitsSettings Settings { get; set; }

protected SimpleLabel MeasureTimeLabel { get; set; }
protected SimpleLabel MeasureDeltaLabel { get; set; }

protected ITimeFormatter TimeFormatter { get; set; }
protected ITimeFormatter DeltaTimeFormatter { get; set; }

protected TimeAccuracy CurrentAccuracy { get; set; }
protected TimeAccuracy CurrentDeltaAccuracy { get; set; }
protected bool CurrentDropDecimals { get; set; }

protected int FrameCount { get; set; }

public GraphicsCache Cache { get; set; }

public IEnumerable<ColumnData> ColumnsList { get; set; }
public IList<SimpleLabel> LabelsList { get; set; }
protected List<float> ColumnWidths { get; }

public float PaddingTop => 0f;
public float PaddingLeft => 0f;
Expand All @@ -45,19 +35,15 @@ public class LabelsComponent : IComponent
public float MinimumHeight { get; set; }

public IDictionary<string, Action> ContextMenuControls => null;
public LabelsComponent(SplitsSettings settings, IEnumerable<ColumnData> columns)
public LabelsComponent(SplitsSettings settings, IEnumerable<ColumnData> columns, List<float> columnWidths)
{
Settings = settings;
MinimumHeight = 31;

MeasureTimeLabel = new SimpleLabel();
MeasureDeltaLabel = new SimpleLabel();
TimeFormatter = new SplitTimeFormatter(Settings.SplitTimesAccuracy);
DeltaTimeFormatter = new DeltaSplitTimeFormatter(Settings.DeltasAccuracy, Settings.DropDecimals);

Cache = new GraphicsCache();
LabelsList = [];
ColumnsList = columns;
ColumnWidths = columnWidths;
}

private void DrawGeneral(Graphics g, LiveSplitState state, float width, float height, LayoutMode mode)
Expand All @@ -69,30 +55,6 @@ private void DrawGeneral(Graphics g, LiveSplitState state, float width, float he
), 0, 0, width, height);
}

MeasureTimeLabel.Text = TimeFormatter.Format(new TimeSpan(24, 0, 0));
MeasureDeltaLabel.Text = DeltaTimeFormatter.Format(new TimeSpan(0, 9, 0, 0));

MeasureTimeLabel.Font = state.LayoutSettings.TimesFont;
MeasureTimeLabel.IsMonospaced = true;
MeasureDeltaLabel.Font = state.LayoutSettings.TimesFont;
MeasureDeltaLabel.IsMonospaced = true;

MeasureTimeLabel.SetActualWidth(g);
MeasureDeltaLabel.SetActualWidth(g);

if (Settings.SplitTimesAccuracy != CurrentAccuracy)
{
TimeFormatter = new SplitTimeFormatter(Settings.SplitTimesAccuracy);
CurrentAccuracy = Settings.SplitTimesAccuracy;
}

if (Settings.DeltasAccuracy != CurrentDeltaAccuracy || Settings.DropDecimals != CurrentDropDecimals)
{
DeltaTimeFormatter = new DeltaSplitTimeFormatter(Settings.DeltasAccuracy, Settings.DropDecimals);
CurrentDeltaAccuracy = Settings.DeltasAccuracy;
CurrentDropDecimals = Settings.DropDecimals;
}

foreach (SimpleLabel label in LabelsList)
{
label.ShadowColor = state.LayoutSettings.ShadowsColor;
Expand All @@ -105,24 +67,15 @@ private void DrawGeneral(Graphics g, LiveSplitState state, float width, float he

if (ColumnsList.Count() == LabelsList.Count)
{
while (ColumnWidths.Count < LabelsList.Count)
{
ColumnWidths.Add(0f);
}

float curX = width - 7;
foreach (SimpleLabel label in LabelsList.Reverse())
{
ColumnData column = ColumnsList.ElementAt(LabelsList.IndexOf(label));

float labelWidth = 0f;
if (column.Type is ColumnType.DeltaorSplitTime or ColumnType.SegmentDeltaorSegmentTime)
{
labelWidth = Math.Max(MeasureDeltaLabel.ActualWidth, MeasureTimeLabel.ActualWidth);
}
else if (column.Type is ColumnType.Delta or ColumnType.SegmentDelta)
{
labelWidth = MeasureDeltaLabel.ActualWidth;
}
else
{
labelWidth = MeasureTimeLabel.ActualWidth;
}
float labelWidth = ColumnWidths[LabelsList.IndexOf(label)];

curX -= labelWidth + 5;
label.Width = labelWidth;
Expand Down
84 changes: 39 additions & 45 deletions src/LiveSplit.Splits/UI/Components/SplitComponent.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,6 @@ public class SplitComponent : IComponent
public ISegment Split { get; set; }

protected SimpleLabel NameLabel { get; set; }
protected SimpleLabel MeasureTimeLabel { get; set; }
protected SimpleLabel MeasureDeltaLabel { get; set; }
public SplitsSettings Settings { get; set; }

protected int FrameCount { get; set; }
Expand Down Expand Up @@ -47,6 +45,7 @@ public class SplitComponent : IComponent

public IEnumerable<ColumnData> ColumnsList { get; set; }
public IList<SimpleLabel> LabelsList { get; set; }
protected List<float> ColumnWidths { get; }
Copy link
Member

@wooferzfg wooferzfg May 7, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why is this being added?

Copy link
Contributor Author

@AlexKnauth AlexKnauth May 7, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

To store the list of column widths that comes from SplitsComponent, and is meant to be a shared mutable object: when a column gets larger in one SplitComponent, it should get larger on all SplitComponents. Right now it looks a bit janky to me... there's probably a better way to do this

Copy link
Member

@wooferzfg wooferzfg May 7, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this fixing a bug that existed before? Or is it fixing an issue that was introduced with custom variable columns?

Copy link
Contributor Author

@AlexKnauth AlexKnauth May 7, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

To my knowledge, it isn't fixing a bug that existed before. Unless it was possible to make split times or deltas be so big that they overrun the set column widths for those based on MeasureDeltaLabel.ActualWidth... but I'm not aware of such an issue before Custom Variables.

Custom Variables can be much longer than split times or deltas, so this is a new issue with those.

The "jank" I'm referring to is a slight delay from when the variable gets longer to when the next column over shifts to accommodate it. For that short period of time, there can be some overrun.

Also, sometimes it updates the current split first, and past splits a slight bit later. For that moment, the next column over looks crooked.

Copy link
Member

@wooferzfg wooferzfg May 7, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The "jank" I'm referring to is a slight delay from when the variable gets longer to when the next column over shifts to accommodate it. For that short period of time, there can be some overrun.

Ideally, the custom variable text would temporarily be cut off instead of the columns not being aligned. And all the columns would shift at the same time

Copy link
Member

@wooferzfg wooferzfg May 7, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What if a custom variable gets longer and then shorter again? Do the columns shrink?

Copy link
Contributor Author

@AlexKnauth AlexKnauth May 7, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The columns do not currently shrink. I can implement that if you want, I just hadn't thought of it because in my use-cases, the values wouldn't shrink so the columns would never need to.

Copy link
Member

@wooferzfg wooferzfg May 7, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What if you have a large variable value and then undo a split? Doesn't that cause the issue even with your use case?

Copy link
Contributor Author

@AlexKnauth AlexKnauth May 7, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

After SplitsComponent: CalculateColumnWidths, it can shrink the columns when the values shrink. It is also less precise, not accounting for characters with different widths, such as Fullwidth Unicode CJK characters.

I was hoping it would also get rid of the jank, but some of the jank I referred to above is still there.


public float VerticalHeight { get; set; }

Expand All @@ -60,17 +59,16 @@ public float HorizontalWidth

public IDictionary<string, Action> ContextMenuControls => null;

public SplitComponent(SplitsSettings settings, IEnumerable<ColumnData> columnsList)
public SplitComponent(SplitsSettings settings, IEnumerable<ColumnData> columnsList, List<float> columnWidths)
{
NameLabel = new SimpleLabel()
{
HorizontalAlignment = StringAlignment.Near,
X = 8,
};
MeasureTimeLabel = new SimpleLabel();
MeasureDeltaLabel = new SimpleLabel();
Settings = settings;
ColumnsList = columnsList;
ColumnWidths = columnWidths;
TimeFormatter = new SplitTimeFormatter(Settings.SplitTimesAccuracy);
DeltaTimeFormatter = new DeltaSplitTimeFormatter(Settings.DeltasAccuracy, Settings.DropDecimals);
MinimumHeight = 25;
Expand Down Expand Up @@ -99,17 +97,6 @@ private void DrawGeneral(Graphics g, LiveSplitState state, float width, float he
), 0, 0, width, height);
}

MeasureTimeLabel.Text = TimeFormatter.Format(new TimeSpan(24, 0, 0));
MeasureDeltaLabel.Text = DeltaTimeFormatter.Format(new TimeSpan(0, 9, 0, 0));

MeasureTimeLabel.Font = state.LayoutSettings.TimesFont;
MeasureTimeLabel.IsMonospaced = true;
MeasureDeltaLabel.Font = state.LayoutSettings.TimesFont;
MeasureDeltaLabel.IsMonospaced = true;

MeasureTimeLabel.SetActualWidth(g);
MeasureDeltaLabel.SetActualWidth(g);

NameLabel.ShadowColor = state.LayoutSettings.ShadowsColor;
NameLabel.OutlineColor = state.LayoutSettings.TextOutlineColor;
foreach (SimpleLabel label in LabelsList)
Expand Down Expand Up @@ -229,25 +216,16 @@ private void DrawGeneral(Graphics g, LiveSplitState state, float width, float he

if (ColumnsList.Count() == LabelsList.Count)
{
while (ColumnWidths.Count < LabelsList.Count)
{
ColumnWidths.Add(0f);
}

float curX = width - 7;
float nameX = width - 7;
foreach (SimpleLabel label in LabelsList.Reverse())
{
ColumnData column = ColumnsList.ElementAt(LabelsList.IndexOf(label));

float labelWidth = 0f;
if (column.Type is ColumnType.DeltaorSplitTime or ColumnType.SegmentDeltaorSegmentTime)
{
labelWidth = Math.Max(MeasureDeltaLabel.ActualWidth, MeasureTimeLabel.ActualWidth);
}
else if (column.Type is ColumnType.Delta or ColumnType.SegmentDelta)
{
labelWidth = MeasureDeltaLabel.ActualWidth;
}
else
{
labelWidth = MeasureTimeLabel.ActualWidth;
}
float labelWidth = ColumnWidths[LabelsList.IndexOf(label)];

label.Width = labelWidth + 20;
curX -= labelWidth + 5;
Expand Down Expand Up @@ -387,19 +365,24 @@ protected void UpdateColumn(LiveSplitState state, SimpleLabel label, ColumnData
int splitIndex = state.Run.IndexOf(Split);
if (splitIndex < state.CurrentSplitIndex)
{
if (type is ColumnType.SplitTime or ColumnType.SegmentTime)
if (type is ColumnType.SplitTime or ColumnType.SegmentTime or ColumnType.CustomVariable)
{
label.ForeColor = Settings.OverrideTimesColor ? Settings.BeforeTimesColor : state.LayoutSettings.TextColor;

if (type == ColumnType.SplitTime)
{
label.Text = TimeFormatter.Format(Split.SplitTime[timingMethod]);
}
else //SegmentTime
else if (type == ColumnType.SegmentTime)
{
TimeSpan? segmentTime = LiveSplitStateHelper.GetPreviousSegmentTime(state, splitIndex, timingMethod);
label.Text = TimeFormatter.Format(segmentTime);
}
else if (type == ColumnType.CustomVariable)
{
Split.CustomVariableValues.TryGetValue(data.Name, out string text);
label.Text = text ?? "";
}
}

if (type is ColumnType.DeltaorSplitTime or ColumnType.Delta)
Expand Down Expand Up @@ -461,7 +444,7 @@ protected void UpdateColumn(LiveSplitState state, SimpleLabel label, ColumnData
}
else
{
if (type is ColumnType.SplitTime or ColumnType.SegmentTime or ColumnType.DeltaorSplitTime or ColumnType.SegmentDeltaorSegmentTime)
if (type is ColumnType.SplitTime or ColumnType.SegmentTime or ColumnType.DeltaorSplitTime or ColumnType.SegmentDeltaorSegmentTime or ColumnType.CustomVariable)
{
if (Split == state.CurrentSplit)
{
Expand All @@ -476,7 +459,7 @@ protected void UpdateColumn(LiveSplitState state, SimpleLabel label, ColumnData
{
label.Text = TimeFormatter.Format(Split.Comparisons[comparison][timingMethod]);
}
else //SegmentTime or SegmentTimeorSegmentDeltaTime
else if (type is ColumnType.SegmentTime or ColumnType.SegmentDeltaorSegmentTime)
{
TimeSpan previousTime = TimeSpan.Zero;
for (int index = splitIndex - 1; index >= 0; index--)
Expand All @@ -491,6 +474,17 @@ protected void UpdateColumn(LiveSplitState state, SimpleLabel label, ColumnData

label.Text = TimeFormatter.Format(Split.Comparisons[comparison][timingMethod] - previousTime);
}
else if (type is ColumnType.CustomVariable)
{
if (splitIndex == state.CurrentSplitIndex)
{
label.Text = state.Run.Metadata.CustomVariableValue(data.Name) ?? "";
}
else if (splitIndex > state.CurrentSplitIndex)
{
label.Text = "";
}
}
}

//Live Delta
Expand All @@ -511,14 +505,9 @@ protected void UpdateColumn(LiveSplitState state, SimpleLabel label, ColumnData

protected float CalculateLabelsWidth()
{
if (ColumnsList != null)
if (ColumnWidths != null)
{
int mixedCount = ColumnsList.Count(x => x.Type is ColumnType.DeltaorSplitTime or ColumnType.SegmentDeltaorSegmentTime);
int deltaCount = ColumnsList.Count(x => x.Type is ColumnType.Delta or ColumnType.SegmentDelta);
int timeCount = ColumnsList.Count(x => x.Type is ColumnType.SplitTime or ColumnType.SegmentTime);
return (mixedCount * (Math.Max(MeasureDeltaLabel.ActualWidth, MeasureTimeLabel.ActualWidth) + 5))
+ (deltaCount * (MeasureDeltaLabel.ActualWidth + 5))
+ (timeCount * (MeasureTimeLabel.ActualWidth + 5));
return ColumnWidths.Sum() + (5 * ColumnWidths.Count());
}

return 0f;
Expand Down Expand Up @@ -569,10 +558,15 @@ public void Update(IInvalidator invalidator, LiveSplitState state, float width,
Cache["IsActive"] = IsActive;
Cache["NameColor"] = NameLabel.ForeColor.ToArgb();
Cache["ColumnsCount"] = ColumnsList.Count();
foreach (SimpleLabel label in LabelsList)
for (int index = 0; index < LabelsList.Count; index++)
{
Cache["Columns" + LabelsList.IndexOf(label) + "Text"] = label.Text;
Cache["Columns" + LabelsList.IndexOf(label) + "Color"] = label.ForeColor.ToArgb();
SimpleLabel label = LabelsList[index];
Cache["Columns" + index + "Text"] = label.Text;
Cache["Columns" + index + "Color"] = label.ForeColor.ToArgb();
if (index < ColumnWidths.Count)
{
Cache["Columns" + index + "Width"] = ColumnWidths[index];
}
}

if (invalidator != null && (Cache.HasChanged || FrameCount > 1))
Expand Down
Loading