Merge pull request #14 from InventorCode/feat/interfacemembers

Add IPlugin interface members

Author: jordanrobot

GitVersion.yml

@@ -1,7 +1,8 @@
+next-version: 0.5.1
+major-version-bump-message: ^(build|chore|ci|docs|feat|fix|perf|refactor|revert|style|test)(\([\w\s]*\))?(!:|:.*\n\n((.+\n)+\n)?BREAKING CHANGE:\s.+)
+minor-version-bump-message: '^(feat)(\([\w\s]*\))?:'
+patch-version-bump-message: '^(build|chore|ci|docs|fix|perf|refactor|revert|style|test)(\([\w\s]*\))?:'
 branches: {}
 ignore:
   sha: []
 merge-message-formats: {}
-major-version-bump-message: "^(build|chore|ci|docs|feat|fix|perf|refactor|revert|style|test)(\\([\\w\\s]*\\))?(!:|:.*\\n\\n((.+\\n)+\\n)?BREAKING CHANGE:\\s.+)"
-minor-version-bump-message: "^(feat)(\\([\\w\\s]*\\))?:"
-patch-version-bump-message: "^(build|chore|ci|docs|fix|perf|refactor|revert|style|test)(\\([\\w\\s]*\\))?:"

README.md

@@ -37,6 +37,9 @@ To help remedy this, we can decouple the tools/plugins from each other entirely.
     - `Execute()`: Executes whatever you want; accessible from the calling assembly.
     - `Activate(Inventor.Application inventorApplication, string ClientId, bool firstTime = true)`
     - `Deactivate()`: Deactivates the plugin
+    - `Name`: Name of the plugin, as a string. Read-only.
+    - `Version`: Version of the assembly, as a string. Read-only.
+    - `ExecuteSettings`: an `Inventor.CommandControl` object that lets you activate settings from the HostPlugin.
 
 
 In the demo project below, when the addin is started:
@@ -66,114 +69,15 @@ This project contains a [Demo solution](https://github.com/InventorCode/Plugin/t
 
 ### AddinDemo
 
-This is the addin class that implements the `Inventor.ApplicationAddInServer`.  
-
-```C#
-using Inventor;
-using Microsoft.Win32;
-using System;
-using System.Runtime.InteropServices;
-using System.Windows.Forms;
-using InventorCode.Plugin;
-using System.Collections.Generic;
-
-namespace PluginHostDemo
-{
-    [ProgId("PluginHostDemo.StandardAddinServer")]
-    [GuidAttribute("7F39964A-C0DC-4BC7-948E-4B0A060256D1")]
-    public class StandardAddInServer : Inventor.ApplicationAddInServer
-    {
-        private Inventor.Application m_inventorApplication;
-
-        // Create an instance of the PluginHost class in the package.  This contains
-        // the code to wire up the plugins dynamically.
-        private PluginHost pluginHost = new PluginHost();
-        
-        public StandardAddInServer()
-        {
-            // Here we will actually wire up the plugins by collecting classes with advertised
-            // Plugin interfaces into our PluginHost object.  If you need granular control, you
-            // can manually compose these using MEF. See the IPluginHost class to get you started.
-            pluginHost.ComposePlugins();
-        }
-
-
-        public void Activate(Inventor.ApplicationAddInSite addInSiteObject, bool firstTime)
-        {
-            m_inventorApplication = addInSiteObject.Application;
-
-            // Here we'll activate the individual plugins...
-            pluginHost.ActivateAll(m_inventorApplication, "7F39964A-C0DC-4BC7-948E-4B0A060256D1");
-        }
-
-        public void Deactivate()
-        {
-            // And here we'll deactivate the individual plugins...
-            pluginHost.DeactivateAll();
-
-            // Release objects.
-            m_inventorApplication = null;
-
-            GC.Collect();
-            GC.WaitForPendingFinalizers();
-        }
-
-        public void ExecuteCommand(int commandID) { }
-
-        public object Automation { get => null; }
-    }
-}
-```
-
----
+This is the addin class that implements the `Inventor.ApplicationAddInServer`.  It acts as the puppet master that loads the plugins via the PluginHost class.  Please find the code [here](https://github.com/InventorCode/Plugin/blob/master/demo/PluginHostDemo/PluginHostDemo.csproj).
 
 ### PluginExample
 
-As for the individual tools/plugins... the demo code for a single plugin is included below.  Think of this as a mini-addin; you can do just about anything here that you would in a full fledged addin: add event handlers, buttons, commands, ribbon interfaces, etc.
-
-1. For this to work wou will need to add an assembly reference `System.ComponentModel.Composition`, and
-1. install the `InventorCode.Plugin` nuget package
-
-```C#
-using Inventor;
-using Microsoft.Win32;
-using System;
-using System.Runtime.Interop;
-using System.Windows.Forms;
-using InventorCode.Plugin;
-using System.ComponentModel.Composition;
-
-namespace PluginDemo
-{
-    //This attribute is required!  It is what PluginHost uses to find this plugin.
-    [Export(typeof(IPlugin))]
-    // Implement the Plugin Interface
-    public class Main : IPlugin
-    {
-
-        private Inventor.Application _inventorApplication;
-        private string _clientId;
-
-        private DockableWindow dockableWindow;
-        public void Activate(Inventor.Application InventorApplication, string ClientId, bool firstTime = true)
-        {
-            _inventorApplication = InventorApplication;
-            _clientId = ClientId;
-
-            //Create dockable window
-            dockableWindow = _inventorApplication.UserInterfaceManager.DockableWindows.Add(ClientId,
-                "dockable_window.StandardAddInServer.dockableWindow", "PluginDemo");
-            dockableWindow.ShowVisibilityCheckBox = true;
-        }
-
-        public void Deactivate()
-        {
-            _inventorApplication = null;
-        }
-
-        public void Execute()
-        {
-        }
-    }
-}
-```
+As for the individual tools/plugins... the demo code for a single plugin is included below.  Think of this as a mini-addin; you can do just about anything here that you would in a full fledged addin: add event handlers, buttons, commands, ribbon interfaces, etc.  Please find the demo code [here](https://github.com/InventorCode/Plugin/blob/master/demo/PluginDemo/main.cs).
+
+## Plugin and PluginHost templates
+
+You can find templates for the Plugin and HostPlugin implementations in the following `dotnet new` [template pack](https://github.com/InventorCode/inventor-addin-templates).
+
+- `inv-pluginhost` template creates a bare-bones addin implementation that utilizes the InventorCode.Plugin package.
+- `inv-plugin` template creates a minimal IPlugin implementation as a new project.

demo/PluginDemo/PluginDemo.csproj

@@ -9,9 +9,10 @@
     <AssemblyName>PluginDemo</AssemblyName>
     <GeneratePackageOnBuild>false</GeneratePackageOnBuild>
     <Authors>Matthew D. Jordan</Authors>
+	<Version>0.1.0</Version>
     <Company></Company>
     <Product></Product>
-    <Description></Description>
+    <Description>This is a description.</Description>
     <Copyright></Copyright>
   </PropertyGroup>
 
@@ -29,14 +30,16 @@
 	</PropertyGroup>
 
 	<ItemGroup>
-	  <PackageReference Include="InventorCode.Plugin" Version="0.4.2" />
+	  <PackageReference Include="InventorCode.Plugin" Version="0.6.0" />
 	</ItemGroup>
 
   <ItemGroup>
     <Reference Include="Autodesk.Inventor.Interop">
       <HintPath>..\..\..\..\..\..\..\..\Program Files\Autodesk\Inventor 2021\Bin\Public Assemblies\Autodesk.Inventor.Interop.dll</HintPath>
     </Reference>
-    <Reference Include="System.ComponentModel.Composition" />
+    <Reference Include="System.ComponentModel.Composition">
+      <Private>true</Private>
+    </Reference>
     <Reference Include="System.Windows.Forms" />
   </ItemGroup>
 

demo/PluginDemo/main.cs

@@ -1,10 +1,9 @@
 using Inventor;
-using Microsoft.Win32;
-using System;
-using System.Runtime.InteropServices;
-using System.Windows.Forms;
 using InventorCode.Plugin;
+using System;
 using System.ComponentModel.Composition;
+using System.Reflection;
+using System.Windows.Forms;
 
 namespace PluginDemo
 {
@@ -28,7 +27,7 @@ public void Activate(Inventor.Application InventorApplication, string ClientId,
         {
             _inventorApplication = InventorApplication;
             _clientId = ClientId;
-            MessageBox.Show("PluginDemo Loaded.");
+            MessageBox.Show("External PluginDemo Loaded, with " + Name + " ver: " + Version);
         }
 
         public void Deactivate()
@@ -39,5 +38,20 @@ public void Deactivate()
         public void Execute()
         {
         }
+
+        #region Properties
+
+        //Provides a place to implement a settings command from the PluginHost
+        public CommandControl ExecuteSettings { get; set; }
+
+        // Provides the name of your plugin.  Typically this would be set to return the
+        // assembly name as shown below...
+        public string Name { get => Assembly.GetExecutingAssembly().GetName().Name; }
+
+        // Provides the version of your plugin.  Typically this would be set to return the
+        // assembly version as shown below...
+        public string Version { get => Assembly.GetExecutingAssembly().GetName().Version.ToString(); }
+
+        #endregion Properties
     }
-}
+}

demo/PluginHostDemo/EmbeddedPluginDemo.cs

@@ -1,5 +1,6 @@
 using InventorCode.Plugin;
 using System.ComponentModel.Composition;
+using System.Reflection;
 using System.Windows.Forms;
 
 namespace PluginHostDemo
@@ -14,7 +15,7 @@ public void Activate(Inventor.Application InventorApplication, string ClientId,
         {
             _inventorApplication = InventorApplication;
             _clientId = ClientId;
-            MessageBox.Show("EmbeddedPluginDemo Loaded.");
+            MessageBox.Show("EmbeddedPluginDemo Loaded with " + Name + " ver: " + Version);
         }
 
         public void Deactivate()
@@ -25,5 +26,11 @@ public void Deactivate()
         public void Execute()
         {
         }
+
+        public Inventor.CommandControl ExecuteSettings { get; set; }
+
+        public string Name { get => Assembly.GetExecutingAssembly().GetName().Name; }
+
+        public string Version { get => Assembly.GetExecutingAssembly().GetName().Version.ToString(); }
     }
 }

demo/PluginHostDemo/PluginHostDemo.csproj

@@ -31,7 +31,7 @@
 	</PropertyGroup>
 
   <ItemGroup>
-    <PackageReference Include="InventorCode.Plugin" Version="0.4.2" />
+    <PackageReference Include="InventorCode.Plugin" Version="0.6.0" />
   </ItemGroup>
 
   <ItemGroup>

nuget-build-script.sample

@@ -1,2 +1,2 @@
 nuget pack
-nuget push InventorCode.Plugin.0.4.1.nupkg -Source https://api.nuget.org/v3/index.json
+nuget push InventorCode.Plugin.0.6.0.nupkg -Source https://api.nuget.org/v3/index.json

src/IPlugin.cs

@@ -2,10 +2,39 @@
 {
     public interface IPlugin
     {
+        /// <summary>
+        /// Executes code that the user chooses.
+        /// </summary>
         void Execute();
 
+        /// <summary>
+        /// Activates the plugin, acts as the plugin's entry point.  Synonymous with the
+        /// Inventor.StandardAddinServer.Activate() method.
+        /// </summary>
+        /// <param name="inventorApplication">Inventor.Application object</param>
+        /// <param name="ClientId">The addin's string GUID.</param>
+        /// <param name="firstTime">Optional boolean value. Not currently used.</param>
         void Activate(Inventor.Application inventorApplication, string ClientId, bool firstTime = true);
 
+        /// <summary>
+        /// Deactivates the plugin, acts as the plugin's finalize/cleanup method.
+        /// Synonymous with the Inventor.StandardAddinServer.Activate() method.
+        /// </summary>
         void Deactivate();
+
+        /// <summary>
+        /// Provides the ability to add a settings ui accessible from the PluginHost.
+        /// </summary>
+        Inventor.CommandControl ExecuteSettings { get; set; }
+
+        /// <summary>
+        /// Provides the name of the plugin.
+        /// </summary>
+        string Name { get;}
+
+        /// <summary>
+        /// Provides the version number of the plugin.
+        /// </summary>
+        string Version { get; }
     }
-}
+} 

src/Plugin.csproj

@@ -28,11 +28,12 @@
   <PropertyGroup>
     <AppendTargetFrameworkToOutputPath>false</AppendTargetFrameworkToOutputPath>
     <AppendRuntimeIdentifierToOutputPath>false</AppendRuntimeIdentifierToOutputPath>
-    <Version>0.4.2</Version>
+    <Version>0.6.0</Version>
+	  <PackageVersion>0.6.0</PackageVersion>
     <PackageProjectUrl></PackageProjectUrl>
 	<PackageIcon>icon.png</PackageIcon>
     <RepositoryUrl>https://github.com/InventorCode/Plugin</RepositoryUrl>
-    <AssemblyVersion>0.4.2.0</AssemblyVersion>
+    <AssemblyVersion>0.6.0.0</AssemblyVersion>
     <PackageLicenseFile>LICENSE</PackageLicenseFile>
   </PropertyGroup>