aboutsummaryrefslogtreecommitdiffstats
path: root/Software/Visual_Studio/SideChains/RealTimeGraphX/GraphInputComponentBase.cs
blob: 4f1c52f127c22c8554091b9a9c87a41ba7bb5eff (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;
using RealTimeGraphX.EventArguments;

namespace RealTimeGraphX
{
    /// <summary>
    /// Represents an <see cref="IGraphInputComponent{TIn}"/> base class.
    /// </summary>
    /// <typeparam name="TIn">The type of the in.</typeparam>
    /// <seealso cref="RealTimeGraphX.IGraphInputComponent{TIn}" />
    public abstract class GraphInputComponentBase<TIn> : GraphObject, IGraphInputComponent<TIn> where TIn : IGraphComponent
    {
        /// <summary>
        /// Occurs when the <see cref="P:RealTimeGraphX.IGraphInputComponent`1.Input" /> property has changed.
        /// </summary>
        public event EventHandler<InputChangedEventArgs<TIn>> InputChanged;

        private TIn _input;
        /// <summary>
        /// Gets the connected input <see cref="T:RealTimeGraphX.IGraphComponent" />.
        /// </summary>
        public TIn Input
        {
            get { return _input; }
            private set
            {
                _input = value;
                RaisePropertyChangedAuto();
                OnInputChanged(_input);
            }
        }

        /// <summary>
        /// Raises the <see cref="InputChanged"/> event.
        /// </summary>
        /// <param name="input">The input.</param>
        protected virtual void OnInputChanged(TIn input)
        {
            InputChanged?.Invoke(this, new InputChangedEventArgs<TIn>(input));
        }

        /// <summary>
        /// Connects the specified component output to this component input.
        /// </summary>
        /// <param name="component">The component.</param>
        /// <param name="fromInput">Specifies whether this call was made from a <see cref="TIn" /> component.</param>
        public abstract void ConnectInput(TIn component, bool fromInput = false);

        /// <summary>
        /// Disconnects this component input from the current connected <see cref="P:RealTimeGraphX.IGraphInputComponent`1.Input" /><see cref="T:RealTimeGraphX.IGraphComponent" />.
        /// </summary>
        /// <param name="fromInput">Specifies whether this call was made from a <see cref="TIn" /> component.</param>
        public abstract void DisconnectInput(bool fromInput = false);
    }
}