bjorn/cnx-1105-add-dynamic-setselection-support-no-events-available (#522)

* refresh GetSelection and UI icon

- refreshing GetSelection based on RVT22 approach
- adding Speckle Beta icon to the UI

* feat: changing default plugin size

Author: bjoernsteinhagen

Connectors/CSi/Speckle.Connectors.CSiShared/Bindings/CsiSharedSelectionBinding.cs

@@ -3,14 +3,63 @@
 using Speckle.Connectors.DUI.Bindings;
 using Speckle.Connectors.DUI.Bridge;
 using Speckle.Converters.CSiShared.Utils;
+using Timer = System.Timers.Timer;
 
 namespace Speckle.Connectors.CSiShared.Bindings;
 
-public class CsiSharedSelectionBinding(IBrowserBridge parent, ICsiApplicationService csiApplicationService)
-  : ISelectionBinding
+public class CsiSharedSelectionBinding : ISelectionBinding, IDisposable
 {
+  private bool _disposed;
+  private readonly Timer _selectionTimer;
+  private readonly ICsiApplicationService _csiApplicationService;
+  private HashSet<string> _lastSelection = new();
+
+  public IBrowserBridge Parent { get; }
   public string Name => "selectionBinding";
-  public IBrowserBridge Parent { get; } = parent;
+
+  public CsiSharedSelectionBinding(
+    IBrowserBridge parent,
+    ICsiApplicationService csiApplicationService,
+    ITopLevelExceptionHandler topLevelExceptionHandler
+  )
+  {
+    Parent = parent;
+    _csiApplicationService = csiApplicationService;
+
+    _selectionTimer = new Timer(1000);
+    _selectionTimer.Elapsed += (_, _) => topLevelExceptionHandler.CatchUnhandled(CheckSelectionChanged);
+    _selectionTimer.Start();
+  }
+
+  private void CheckSelectionChanged()
+  {
+    var currentSelection = GetSelection();
+    var currentIds = new HashSet<string>(currentSelection.SelectedObjectIds);
+
+    if (!_lastSelection.SetEquals(currentIds))
+    {
+      _lastSelection = currentIds;
+      Parent.Send(SelectionBindingEvents.SET_SELECTION, currentSelection);
+    }
+  }
+
+  protected virtual void Dispose(bool disposing)
+  {
+    if (!_disposed)
+    {
+      if (disposing)
+      {
+        _selectionTimer?.Dispose();
+      }
+      _disposed = true;
+    }
+  }
+
+  public void Dispose()
+  {
+    Dispose(true);
+    GC.SuppressFinalize(this);
+  }
 
   /// <summary>
   /// Gets the selection and creates an encoded ID (objectType and objectName).
@@ -24,7 +73,7 @@ public SelectionInfo GetSelection()
     int[] objectType = [];
     string[] objectName = [];
 
-    csiApplicationService.SapModel.SelectObj.GetSelected(ref numberItems, ref objectType, ref objectName);
+    _csiApplicationService.SapModel.SelectObj.GetSelected(ref numberItems, ref objectType, ref objectName);
 
     var encodedIds = new List<string>(numberItems);
     var typeCounts = new Dictionary<string, int>();

Connectors/CSi/Speckle.Connectors.CSiShared/Plugin/CsiPluginBase.cs

@@ -3,6 +3,7 @@ namespace Speckle.Connectors.CSiShared;
 [System.Diagnostics.CodeAnalysis.SuppressMessage("Style", "IDE1006:Naming Styles", Justification = "<Pending>")]
 public abstract class CSiPluginBase : cPluginContract, IDisposable
 {
+  private const string s_modality = "Non-Modal";
   private SpeckleFormBase? _panel;
   private bool _disposed;
 
@@ -11,7 +12,15 @@ public void Main(ref cSapModel sapModel, ref cPluginCallback pluginCallback)
     _panel = CreateForm();
     _panel.Initialize(ref sapModel, ref pluginCallback);
     _panel.FormClosed += (_, _) => Dispose();
-    _panel.ShowDialog();
+
+    if (string.Equals(s_modality, "Non-Modal", StringComparison.OrdinalIgnoreCase))
+    {
+      _panel.Show();
+    }
+    else
+    {
+      _panel.ShowDialog();
+    }
   }
 
   protected abstract SpeckleFormBase CreateForm();

Connectors/CSi/Speckle.Connectors.CSiShared/Plugin/SpeckleFormBase.cs

@@ -1,4 +1,5 @@
 using System.ComponentModel;
+using System.Reflection;
 using System.Windows.Forms.Integration;
 using Microsoft.Extensions.DependencyInjection;
 using Speckle.Connectors.Common;
@@ -22,6 +23,7 @@ public abstract class SpeckleFormBase : Form, ICsiApplicationService
   protected SpeckleFormBase()
   {
     Text = "Speckle (Beta)";
+    Size = new System.Drawing.Size(400, 600);
   }
 
   public cSapModel SapModel { get; private set; }
@@ -39,16 +41,37 @@ protected virtual void ConfigureServices(IServiceCollection services)
 
   public void Initialize(ref cSapModel sapModel, ref cPluginCallback pluginCallback)
   {
+    // store app-specific model and callback references (callback if at all possible?)
     SapModel = sapModel;
     _pluginCallback = pluginCallback;
 
+    string assemblyName =
+      Assembly.GetExecutingAssembly().GetName().Name
+      ?? throw new InvalidOperationException("Could not determine executing assembly name");
+    string resourcePath = $"{assemblyName}.Resources.et_element_Speckle.bmp";
+
+    // load and set the speckle icon from embedded resources
+    using (var stream = System.Reflection.Assembly.GetExecutingAssembly().GetManifestResourceStream(resourcePath))
+    {
+      if (stream == null)
+      {
+        throw new InvalidOperationException($"Could not find resource: {resourcePath}");
+      }
+
+      using var bmp = new Bitmap(stream);
+      Icon = Icon.FromHandle(bmp.GetHicon());
+    }
+
+    // configure dependency injection services
     var services = new ServiceCollection();
     services.AddSingleton<ICsiApplicationService>(this);
     ConfigureServices(services);
 
+    // build service container and initialize ui framework
     _container = services.BuildServiceProvider();
     _container.UseDUI();
 
+    // setup webview control and form properties
     var webview = _container.GetRequiredService<DUI3ControlWebView>();
     Host = new() { Child = webview, Dock = DockStyle.Fill };
     Controls.Add(Host);

Connectors/CSi/Speckle.Connectors.CSiShared/Resources/et_element_Speckle.bmp

@@ -8,6 +8,11 @@
   <PropertyGroup Label="Configuration">
     <Import_RootNamespace>Speckle.Connectors.CSiShared</Import_RootNamespace>
   </PropertyGroup>
+  <ItemGroup>
+    <EmbeddedResource Include="$(MSBuildThisFileDirectory)Resources\et_element_Speckle.bmp">
+      <CopyToOutputDirectory>Always</CopyToOutputDirectory>
+    </EmbeddedResource>
+  </ItemGroup>
   <ItemGroup>
     <Compile Include="$(MSBuildThisFileDirectory)Bindings\CsiSharedBasicConnectorBinding.cs" />
     <Compile Include="$(MSBuildThisFileDirectory)Bindings\CsiSharedSelectionBinding.cs" />
@@ -30,4 +35,7 @@
     <Compile Include="$(MSBuildThisFileDirectory)ServiceRegistration.cs" />
     <Compile Include="$(MSBuildThisFileDirectory)Utils\ObjectIdentifiers.cs" />
   </ItemGroup>
+  <ItemGroup>
+    <Content Include="$(MSBuildThisFileDirectory)Resources\et_element_Speckle.bmp" />
+  </ItemGroup>
 </Project>