diff options
Diffstat (limited to 'Software/Visual_Studio/SideChains/RealTimeGraphX/IGraphInputComponent.cs')
| -rw-r--r-- | Software/Visual_Studio/SideChains/RealTimeGraphX/IGraphInputComponent.cs | 40 |
1 files changed, 40 insertions, 0 deletions
diff --git a/Software/Visual_Studio/SideChains/RealTimeGraphX/IGraphInputComponent.cs b/Software/Visual_Studio/SideChains/RealTimeGraphX/IGraphInputComponent.cs new file mode 100644 index 000000000..96ee4ede9 --- /dev/null +++ b/Software/Visual_Studio/SideChains/RealTimeGraphX/IGraphInputComponent.cs @@ -0,0 +1,40 @@ +using RealTimeGraphX.EventArguments; +using System; +using System.Collections.Generic; +using System.Linq; +using System.Text; +using System.Threading.Tasks; + +namespace RealTimeGraphX +{ + /// <summary> + /// Represents a graph component which can receive data from another type of component. + /// </summary> + /// <typeparam name="TIn">The type of the in.</typeparam> + /// <seealso cref="RealTimeGraphX.IGraphComponent" /> + public interface IGraphInputComponent<TIn> : IGraphComponent where TIn : IGraphComponent + { + /// <summary> + /// Occurs when the <see cref="Input"/> property has changed. + /// </summary> + event EventHandler<InputChangedEventArgs<TIn>> InputChanged; + + /// <summary> + /// Gets the connected input <see cref="IGraphComponent"/>. + /// </summary> + TIn Input { get; } + + /// <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> + void ConnectInput(TIn component, bool fromInput = false); + + /// <summary> + /// Disconnects this component input from the current connected <see cref="Input"/> <see cref="IGraphComponent"/>. + /// </summary> + /// <param name="fromInput">Specifies whether this call was made from a <see cref="TIn"/> component.</param> + void DisconnectInput(bool fromInput = false); + } +} |
