DarthAffe/Artemis
1
0
Fork 0
mirror of https://github.com/Artemis-RGB/Artemis synced 2025-12-13 05:48:35 +00:00
Code Issues Releases Wiki Activity

Nodes - Show errors in node editor when a node fails to evaluate

Browse Source
This commit is contained in:
Robert 2022-09-01 20:33:55 +02:00
parent cd537051ca
commit eca8985fc4
9 changed files with 89 additions and 48 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
src/Artemis.Core/Models/BreakableModel.cs
View File

@ -69,11 +69,16 @@ public abstract class BreakableModel : CorePropertyChanged, IBreakableModel
/// <inheritdoc />
public void ClearBrokenState(string state)
{
if (state == null) throw new ArgumentNullException(nameof(state));
if (state == null)
throw new ArgumentNullException(nameof(state));
// If there was no broken state to begin with, done!
if (BrokenState == null)
return;
if (BrokenState != state) return;
// Only clear similar broken states
if (BrokenState != state)
return;
BrokenState = null;
BrokenStateException = null;
OnBrokenStateChanged();

2
src/Artemis.Core/Services/NodeService.cs
View File

@ -115,7 +115,7 @@ internal class NodeService : INodeService
}
}
node.Initialize(script);
node.TryInitialize(script);
return node;
}

10
src/Artemis.Core/VisualScripting/Interfaces/INode.cs
View File

@ -8,7 +8,7 @@ namespace Artemis.Core;
/// <summary>
/// Represents a kind of node inside a <see cref="INodeScript" />
/// </summary>
public interface INode : INotifyPropertyChanged
public interface INode : INotifyPropertyChanged, IBreakableModel
{
/// <summary>
/// Gets or sets the ID of the node.
@ -81,15 +81,15 @@ public interface INode : INotifyPropertyChanged
event EventHandler<SingleValueEventArgs<IPinCollection>> PinCollectionRemoved;
/// <summary>
/// Called when the node was loaded from storage or newly created
/// Attempts to initialize the node.
/// </summary>
/// <param name="script">The script the node is contained in</param>
void Initialize(INodeScript script);
void TryInitialize(INodeScript script);
/// <summary>
/// Evaluates the value of the output pins of this node
/// Attempts to evaluate the value of the output pins of this node
/// </summary>
void Evaluate();
void TryEvaluate();
/// <summary>
/// Resets the node causing all pins to re-evaluate the next time <see cref="Evaluate" /> is called

26
src/Artemis.Core/VisualScripting/Node.cs
View File

@ -12,7 +12,7 @@ namespace Artemis.Core;
/// <summary>
/// Represents a kind of node inside a <see cref="NodeScript" />
/// </summary>
public abstract class Node : CorePropertyChanged, INode
public abstract class Node : BreakableModel, INode
{
/// <inheritdoc />
public event EventHandler? Resetting;
@ -95,6 +95,9 @@ public abstract class Node : CorePropertyChanged, INode
/// <inheritdoc />
public IReadOnlyCollection<IPinCollection> PinCollections => new ReadOnlyCollection<IPinCollection>(_pinCollections);
/// <inheritdoc />
public override string BrokenDisplayName => Name;
#endregion
#region Construtors
@ -335,12 +338,17 @@ public abstract class Node : CorePropertyChanged, INode
return isRemoved;
}
/// <inheritdoc />
/// <summary>
/// Called when the node was loaded from storage or newly created
/// </summary>
/// <param name="script">The script the node is contained in</param>
public virtual void Initialize(INodeScript script)
{
}
/// <inheritdoc />
/// <summary>
/// Evaluates the value of the output pins of this node
/// </summary>
public abstract void Evaluate();
/// <inheritdoc />
@ -354,6 +362,18 @@ public abstract class Node : CorePropertyChanged, INode
Resetting?.Invoke(this, EventArgs.Empty);
}
/// <inheritdoc />
public void TryInitialize(INodeScript script)
{
TryOrBreak(() => Initialize(script), "Failed to initialize");
}
/// <inheritdoc />
public void TryEvaluate()
{
TryOrBreak(Evaluate, "Failed to evaluate");
}
/// <summary>
/// Called whenever the node must show it's custom view model, if <see langword="null" />, no custom view model is used
/// </summary>

2
src/Artemis.Core/VisualScripting/NodeScript.cs
View File

@ -101,7 +101,7 @@ public abstract class NodeScript : CorePropertyChanged, INodeScript
node.Reset();
}
ExitNode.Evaluate();
ExitNode.TryEvaluate();
}
/// <inheritdoc />

4
src/Artemis.Core/VisualScripting/OutputPin.cs
View File

@ -43,7 +43,7 @@ public sealed class OutputPin<T> : Pin
get
{
if (!IsEvaluated)
Node?.Evaluate();
Node?.TryEvaluate();
return _value;
}
@ -115,7 +115,7 @@ public sealed class OutputPin : Pin
get
{
if (!IsEvaluated)
Node?.Evaluate();
Node?.TryEvaluate();
return _value;
}

33
src/Artemis.UI/Screens/VisualScripting/NodeView.axaml
View File

@ -37,35 +37,38 @@
ClipToBounds="True"
Background="{DynamicResource ContentDialogBackground}">
<Border Background="{DynamicResource TaskDialogHeaderBackground}">
<Grid Classes="node-header"
VerticalAlignment="Top"
ColumnDefinitions="*,Auto">
<TextBlock VerticalAlignment="Center"
Margin="10 0 0 0"
Text="{CompiledBinding Node.Name}"
ToolTip.Tip="{CompiledBinding Node.Description}">
</TextBlock>
<Button VerticalAlignment="Center"
<Grid Classes="node-header" VerticalAlignment="Top" ColumnDefinitions="Auto,*,Auto">
<Button Grid.Column="0"
VerticalAlignment="Center"
IsVisible="{CompiledBinding Node.BrokenState, Converter={x:Static ObjectConverters.IsNotNull}}"
Classes="icon-button icon-button-small"
Grid.Column="1"
Margin="5"
Command="{CompiledBinding DeleteNode}">
Foreground="White"
Background="#E74C4C"
BorderBrush="#E74C4C"
Margin="5 0 0 0"
ToolTip.Tip="{CompiledBinding Node.BrokenState}"
Command="{CompiledBinding ShowBrokenState}">
<avalonia:MaterialIcon Kind="AlertCircle"></avalonia:MaterialIcon>
</Button>
<TextBlock Grid.Column="1" VerticalAlignment="Center" Margin="10 0 0 0" Text="{CompiledBinding Node.Name}" ToolTip.Tip="{CompiledBinding Node.Description}"/>
<Button Grid.Column="2" VerticalAlignment="Center" Classes="icon-button icon-button-small" Margin="5" Command="{CompiledBinding DeleteNode}">
<avalonia:MaterialIcon Kind="Close"></avalonia:MaterialIcon>
</Button>
</Grid>
</Border>
</Border>
<Grid Grid.Row="1" ColumnDefinitions="Auto,*,Auto" Margin="4">
<StackPanel Grid.Column="0" IsVisible="{CompiledBinding HasInputPins}">
<ItemsControl Items="{CompiledBinding InputPinViewModels}" Margin="4 0" />
<ItemsControl Items="{CompiledBinding InputPinCollectionViewModels}" />
</StackPanel>
<ContentControl Grid.Column="1"
<ContentControl Grid.Column="1"
Name="CustomViewModelContainer"
Content="{CompiledBinding CustomNodeViewModel}"
Content="{CompiledBinding CustomNodeViewModel}"
IsVisible="{CompiledBinding CustomNodeViewModel, Converter={x:Static ObjectConverters.IsNotNull}}" />
<StackPanel Grid.Column="2" IsVisible="{CompiledBinding HasOutputPins}">

28
src/Artemis.UI/Screens/VisualScripting/NodeViewModel.cs
View File

@ -8,6 +8,7 @@ using Artemis.Core.Events;
using Artemis.UI.Ninject.Factories;
using Artemis.UI.Screens.VisualScripting.Pins;
using Artemis.UI.Shared;
using Artemis.UI.Shared.Services;
using Artemis.UI.Shared.Services.NodeEditor;
using Artemis.UI.Shared.Services.NodeEditor.Commands;
using Avalonia;
@ -21,9 +22,9 @@ namespace Artemis.UI.Screens.VisualScripting;
public class NodeViewModel : ActivatableViewModelBase
{
private readonly INodeEditorService _nodeEditorService;
private readonly IWindowService _windowService;
private ICustomNodeViewModel? _customNodeViewModel;
private ReactiveCommand<Unit, Unit>? _deleteNode;
private double _dragOffsetX;
private double _dragOffsetY;
private ObservableAsPropertyHelper<bool>? _hasInputPins;
@ -34,14 +35,13 @@ public class NodeViewModel : ActivatableViewModelBase
private double _startX;
private double _startY;
public NodeViewModel(NodeScriptViewModel nodeScriptViewModel, INode node, INodeVmFactory nodeVmFactory, INodeEditorService nodeEditorService)
public NodeViewModel(NodeScriptViewModel nodeScriptViewModel, INode node, INodeVmFactory nodeVmFactory, INodeEditorService nodeEditorService, IWindowService windowService)
{
_nodeEditorService = nodeEditorService;
_windowService = windowService;
NodeScriptViewModel = nodeScriptViewModel;
Node = node;
DeleteNode = ReactiveCommand.Create(ExecuteDeleteNode, this.WhenAnyValue(vm => vm.IsStaticNode).Select(v => !v));
SourceList<PinViewModel> nodePins = new();
SourceList<PinCollectionViewModel> nodePinCollections = new();
@ -61,7 +61,10 @@ public class NodeViewModel : ActivatableViewModelBase
nodePins.Connect().Merge(nodePinCollections.Connect().TransformMany(c => c.PinViewModels)).Bind(out ReadOnlyObservableCollection<PinViewModel> pins).Subscribe();
PinViewModels = pins;
DeleteNode = ReactiveCommand.Create(ExecuteDeleteNode, this.WhenAnyValue(vm => vm.IsStaticNode).Select(v => !v));
ShowBrokenState = ReactiveCommand.Create(ExecuteShowBrokenState);
this.WhenActivated(d =>
{
_isStaticNode = Node.WhenAnyValue(n => n.IsDefaultNode, n => n.IsExitNode)
@ -152,17 +155,14 @@ public class NodeViewModel : ActivatableViewModelBase
set => RaiseAndSetIfChanged(ref _customNodeViewModel, value);
}
public ReactiveCommand<Unit, Unit>? DeleteNode
{
get => _deleteNode;
set => RaiseAndSetIfChanged(ref _deleteNode, value);
}
public bool IsSelected
{
get => _isSelected;
set => RaiseAndSetIfChanged(ref _isSelected, value);
}
public ReactiveCommand<Unit,Unit> ShowBrokenState { get; }
public ReactiveCommand<Unit, Unit> DeleteNode { get; }
public void StartDrag(Point mouseStartPosition)
{
@ -195,4 +195,10 @@ public class NodeViewModel : ActivatableViewModelBase
{
_nodeEditorService.ExecuteCommand(NodeScriptViewModel.NodeScript, new DeleteNode(NodeScriptViewModel.NodeScript, Node));
}
private void ExecuteShowBrokenState()
{
if (Node.BrokenState != null && Node.BrokenStateException != null)
_windowService.ShowExceptionDialog(Node.BrokenState, Node.BrokenStateException);
}
}

21
src/Artemis.VisualScripting/Nodes/Text/StringRegexMatchNode.cs
View File

@ -8,7 +8,7 @@ public class StringRegexMatchNode : Node
{
private string? _lastPattern;
private Regex? _regex;
private bool _broken;
private Exception? _exception;
public StringRegexMatchNode() : base("Regex Match", "Checks provided regex pattern matches the input.")
{
@ -25,20 +25,27 @@ public class StringRegexMatchNode : Node
{
if (Input.Value == null || Pattern.Value == null)
return;
if (_broken && _lastPattern == Pattern.Value)
return;
// If the regex was invalid output false and rethrow the exception
if (_lastPattern == Pattern.Value && _exception != null)
{
Result.Value = false;
throw _exception;
}
// If there is no regex yet or the regex changed, recompile
if (_regex == null || _lastPattern != Pattern.Value)
{
try
{
_regex = new Regex(Pattern.Value, RegexOptions.Compiled);
_broken = false;
_exception = null;
}
catch (Exception)
catch (Exception e)
{
_broken = true;
return;
// If there is an exception, save it to keep rethrowing until the regex is fixed
_exception = e;
throw;
}
finally
{