first commit

src/Overlay.NET/OverlayPlugin.cs

@@ -0,0 +1,54 @@
+using System;
+using Overlay.NET.Common;
+using Process.NET.Windows;
+
+namespace Overlay.NET {
+    /// <summary>
+    ///     Abstract class that defines basic overlay operations and values.
+    /// </summary>
+    /// <seealso cref="Overlay.NET.Common.PluginBase" />
+    /// <seealso cref="System.IDisposable" />
+    public abstract class OverlayPlugin : PluginBase, IDisposable {
+        /// <summary>
+        ///     Gets or sets the target window that the overlay is to 'attach' to.
+        /// </summary>
+        /// <value>
+        ///     The target window.
+        /// </value>
+        public IWindow TargetWindow { get; protected set; }
+
+        /// <summary>
+        ///     Gets or sets a value indicating whether this instance is enabled.
+        /// </summary>
+        /// <value>
+        ///     <c>true</c> if this instance is enabled; otherwise, <c>false</c>.
+        /// </value>
+        public bool IsEnabled { get; protected set; }
+
+        /// <summary>
+        ///     Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
+        /// </summary>
+        public virtual void Dispose() {}
+
+        /// <summary>
+        ///     Enables this instance.
+        /// </summary>
+        public virtual void Enable() => IsEnabled = true;
+
+        /// <summary>
+        ///     Disables this instance.
+        /// </summary>
+        public virtual void Disable() => IsEnabled = false;
+
+        /// <summary>
+        ///     Initializes the specified target window.
+        /// </summary>
+        /// <param name="targetWindow">The target window.</param>
+        public virtual void Initialize(IWindow targetWindow) => TargetWindow = targetWindow;
+
+        /// <summary>
+        ///     Updates this instance.
+        /// </summary>
+        public virtual void Update() {}
+    }
+}