Artemis/src/Artemis.Core/VisualScripting/Interfaces/INode.cs

using System;
using System.Collections.Generic;
using System.ComponentModel;
using Artemis.Core.Events;

namespace Artemis.Core;

/// <summary>
///     Represents a kind of node inside a <see cref="INodeScript" />
/// </summary>
public interface INode : INotifyPropertyChanged, IBreakableModel, IPluginFeatureDependent
{
    /// <summary>
    ///     Gets or sets the ID of the node.
    /// </summary>
    Guid Id { get; set; }
    
    /// <summary>
    ///     Gets or sets the node data with information about this node
    /// </summary>
    NodeData? NodeData { get; set; }

    /// <summary>
    ///     Gets the name of the node
    /// </summary>
    string Name { get; set; }

    /// <summary>
    ///     Gets the description of the node
    /// </summary>
    string Description { get; set; }

    /// <summary>
    ///     Gets a boolean indicating whether the node is the exit node of the script
    /// </summary>
    bool IsExitNode { get; }

    /// <summary>
    ///     Gets a boolean indicating whether the node is a default node that connot be removed
    /// </summary>
    bool IsDefaultNode { get; }

    /// <summary>
    ///     Gets or sets the X-position of the node
    /// </summary>
    public double X { get; set; }

    /// <summary>
    ///     Gets or sets the Y-position of the node
    /// </summary>
    public double Y { get; set; }
    
    /// <summary>
    ///     Gets or sets the help URL of the node
    /// </summary>
    string HelpUrl { get; set; }

    /// <summary>
    ///     Gets a read-only collection of the pins on this node
    /// </summary>
    public IReadOnlyCollection<IPin> Pins { get; }

    /// <summary>
    ///     Gets a read-only collection of the pin collections on this node
    /// </summary>
    public IReadOnlyCollection<IPinCollection> PinCollections { get; }

    /// <summary>
    ///     Called when the node resets
    /// </summary>
    event EventHandler Resetting;

    /// <summary>
    ///     Occurs when a pin was added to the node
    /// </summary>
    event EventHandler<SingleValueEventArgs<IPin>> PinAdded;

    /// <summary>
    ///     Occurs when a pin was removed from the node
    /// </summary>
    event EventHandler<SingleValueEventArgs<IPin>> PinRemoved;

    /// <summary>
    ///     Occurs when a pin collection was added to the node
    /// </summary>
    event EventHandler<SingleValueEventArgs<IPinCollection>> PinCollectionAdded;

    /// <summary>
    ///     Occurs when a pin was removed from the node
    /// </summary>
    event EventHandler<SingleValueEventArgs<IPinCollection>> PinCollectionRemoved;

    /// <summary>
    ///     Attempts to initialize the node.
    /// </summary>
    /// <param name="script">The script the node is contained in</param>
    void TryInitialize(INodeScript script);

    /// <summary>
    ///     Attempts to evaluate the value of the output pins of this node
    /// </summary>
    void TryEvaluate();

    /// <summary>
    ///     Resets the node causing all pins to re-evaluate the next time <see cref="TryEvaluate" /> is called
    /// </summary>
    void Reset();
}