Input actions description helpers

KinectToVR · Oct 13, 2024 · e5c7edd · e5c7edd
1 parent e0e6006
commit e5c7edd
Show file tree

Hide file tree

Showing 2 changed files with 46 additions and 32 deletions.
diff --git a/Amethyst.Plugins.Contract/Amethyst.Plugins.Contract.csproj b/Amethyst.Plugins.Contract/Amethyst.Plugins.Contract.csproj
@@ -1,37 +1,36 @@
 <Project Sdk="Microsoft.NET.Sdk">
 
-  <PropertyGroup>
-    <TargetFramework>net7.0</TargetFramework>
-    <ImplicitUsings>enable</ImplicitUsings>
-    <Nullable>enable</Nullable>
-    <GeneratePackageOnBuild>True</GeneratePackageOnBuild>
-    <Title>Amethyst Device Plugin API (Contract)</Title>
-    <FileVersion></FileVersion>
-    <Version>0.3.25</Version>
-    <Platforms>x64</Platforms>
-  </PropertyGroup>
+	<PropertyGroup>
+		<TargetFramework>net7.0</TargetFramework>
+		<ImplicitUsings>enable</ImplicitUsings>
+		<Nullable>enable</Nullable>
+		<GeneratePackageOnBuild>True</GeneratePackageOnBuild>
+		<Title>Amethyst Device Plugin API (Contract)</Title>
+		<FileVersion></FileVersion>
+		<Version>0.3.26-alpha</Version>
+		<Platforms>x64</Platforms>
+	</PropertyGroup>
 
-  <PropertyGroup>
-    <PackageId>Amethyst.Plugins.Contract</PackageId>
-    <Version>0.3.25</Version>
-    <Authors>K2VR</Authors>
-    <Company>K2VR</Company>
-    <PackageTags>Amethyst;K2VR;KinectToVR;VR;OpenVR;Fullbody Tracking</PackageTags>
-    <Description>
-      This client class library lets you export your plugin library for Amethyst with MEF.
-      Compatible with C# (with XAML via WinUI/WinRT), C++/CLI, and custom WinRT projections.
-      Contains additional functions and helper classes to make plugin developmnet easier.
-    </Description>
-    <PackageIcon>ktvr.png</PackageIcon>
-    <PackageLicenseExpression>MIT</PackageLicenseExpression>
-    <RequireLicenseAcceptance>true</RequireLicenseAcceptance>
-    <SupportedOSPlatformVersion>10.0.19041.0</SupportedOSPlatformVersion>
-    <PlatformTarget>AnyCPU</PlatformTarget>
-    <AllowUnsafeBlocks>False</AllowUnsafeBlocks>
-  </PropertyGroup>
+	<PropertyGroup>
+		<PackageId>Amethyst.Plugins.Contract</PackageId>
+		<Authors>K2VR</Authors>
+		<Company>K2VR</Company>
+		<PackageTags>Amethyst;K2VR;KinectToVR;VR;OpenVR;Fullbody Tracking</PackageTags>
+		<Description>
+			This client class library lets you export your plugin library for Amethyst with MEF.
+			Compatible with C# (with XAML via WinUI/WinRT), C++/CLI, and custom WinRT projections.
+			Contains additional functions and helper classes to make plugin developmnet easier.
+		</Description>
+		<PackageIcon>ktvr.png</PackageIcon>
+		<PackageLicenseExpression>MIT</PackageLicenseExpression>
+		<RequireLicenseAcceptance>true</RequireLicenseAcceptance>
+		<SupportedOSPlatformVersion>10.0.19041.0</SupportedOSPlatformVersion>
+		<PlatformTarget>AnyCPU</PlatformTarget>
+		<AllowUnsafeBlocks>False</AllowUnsafeBlocks>
+	</PropertyGroup>
 
-  <ItemGroup>
-    <None Include="Assets\ktvr.png" Pack="true" PackagePath="\" />
-  </ItemGroup>
+	<ItemGroup>
+		<None Include="Assets\ktvr.png" Pack="true" PackagePath="\" />
+	</ItemGroup>
 
-</Project>
+</Project>
diff --git a/Amethyst.Plugins.Contract/Classes.cs b/Amethyst.Plugins.Contract/Classes.cs
@@ -281,6 +281,21 @@ public KeyInputAction()
     /// </summary>
     public IAmethystHost? Host { get; set; }
 
+    /// <summary>
+    ///     Action description for binding UI
+    /// </summary>
+    public string Description { get; set; } = string.Empty;
+
+    /// <summary>
+    ///     Action image for binding UI to be shown in info
+    ///     MUST BE OF TYPE Microsoft.UI.Xaml.Controls.Image
+    /// </summary>
+    /// <remarks>
+    ///     Make this a getter and return an Image constructed
+    ///     during OnLoad, expect COM-related crashes otherwise
+    /// </remarks>
+    public object? Image { get; set; } = null;
+
     /// <summary>
     ///     Invoke the action (shortcut)
     /// </summary>