From 011a28df6a00f833c6bc079a7626ffd6f932b649 Mon Sep 17 00:00:00 2001 From: Dimitrie Stefanescu Date: Sun, 4 Oct 2020 23:01:30 +0100 Subject: [PATCH] feat(init): first commit! --- .gitignore | 350 ++++++++++++++++++ .../Base/GH_AsyncComponent.cs | 127 +++++++ .../Base/IAsyncComponentWorker.cs | 44 +++ .../GrasshopperAsyncComponent.csproj | 101 +++++ .../GrasshopperAsyncComponent.sln | 25 ++ .../Info/GrasshopperAsyncComponentInfo.cs | 57 +++ .../Properties/AssemblyInfo.cs | 36 ++ .../SampleAsyncComponent.cs | 77 ++++ GrasshopperAsyncComponent/packages.config | 6 + 9 files changed, 823 insertions(+) create mode 100644 .gitignore create mode 100644 GrasshopperAsyncComponent/Base/GH_AsyncComponent.cs create mode 100644 GrasshopperAsyncComponent/Base/IAsyncComponentWorker.cs create mode 100644 GrasshopperAsyncComponent/GrasshopperAsyncComponent.csproj create mode 100644 GrasshopperAsyncComponent/GrasshopperAsyncComponent.sln create mode 100644 GrasshopperAsyncComponent/Info/GrasshopperAsyncComponentInfo.cs create mode 100644 GrasshopperAsyncComponent/Properties/AssemblyInfo.cs create mode 100644 GrasshopperAsyncComponent/SampleImplementations/SampleAsyncComponent.cs create mode 100644 GrasshopperAsyncComponent/packages.config diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..dfcfd56 --- /dev/null +++ b/.gitignore @@ -0,0 +1,350 @@ +## Ignore Visual Studio temporary files, build results, and +## files generated by popular Visual Studio add-ons. +## +## Get latest from https://github.com/github/gitignore/blob/master/VisualStudio.gitignore + +# User-specific files +*.rsuser +*.suo +*.user +*.userosscache +*.sln.docstates + +# User-specific files (MonoDevelop/Xamarin Studio) +*.userprefs + +# Mono auto generated files +mono_crash.* + +# Build results +[Dd]ebug/ +[Dd]ebugPublic/ +[Rr]elease/ +[Rr]eleases/ +x64/ +x86/ +[Aa][Rr][Mm]/ +[Aa][Rr][Mm]64/ +bld/ +[Bb]in/ +[Oo]bj/ +[Ll]og/ +[Ll]ogs/ + +# Visual Studio 2015/2017 cache/options directory +.vs/ +# Uncomment if you have tasks that create the project's static files in wwwroot +#wwwroot/ + +# Visual Studio 2017 auto generated files +Generated\ Files/ + +# MSTest test Results +[Tt]est[Rr]esult*/ +[Bb]uild[Ll]og.* + +# NUnit +*.VisualState.xml +TestResult.xml +nunit-*.xml + +# Build Results of an ATL Project +[Dd]ebugPS/ +[Rr]eleasePS/ +dlldata.c + +# Benchmark Results +BenchmarkDotNet.Artifacts/ + +# .NET Core +project.lock.json +project.fragment.lock.json +artifacts/ + +# StyleCop +StyleCopReport.xml + +# Files built by Visual Studio +*_i.c +*_p.c +*_h.h +*.ilk +*.meta +*.obj +*.iobj +*.pch +*.pdb +*.ipdb +*.pgc +*.pgd +*.rsp +*.sbr +*.tlb +*.tli +*.tlh +*.tmp +*.tmp_proj +*_wpftmp.csproj +*.log +*.vspscc +*.vssscc +.builds +*.pidb +*.svclog +*.scc + +# Chutzpah Test files +_Chutzpah* + +# Visual C++ cache files +ipch/ +*.aps +*.ncb +*.opendb +*.opensdf +*.sdf +*.cachefile +*.VC.db +*.VC.VC.opendb + +# Visual Studio profiler +*.psess +*.vsp +*.vspx +*.sap + +# Visual Studio Trace Files +*.e2e + +# TFS 2012 Local Workspace +$tf/ + +# Guidance Automation Toolkit +*.gpState + +# ReSharper is a .NET coding add-in +_ReSharper*/ +*.[Rr]e[Ss]harper +*.DotSettings.user + +# TeamCity is a build add-in +_TeamCity* + +# DotCover is a Code Coverage Tool +*.dotCover + +# AxoCover is a Code Coverage Tool +.axoCover/* +!.axoCover/settings.json + +# Visual Studio code coverage results +*.coverage +*.coveragexml + +# NCrunch +_NCrunch_* +.*crunch*.local.xml +nCrunchTemp_* + +# MightyMoose +*.mm.* +AutoTest.Net/ + +# Web workbench (sass) +.sass-cache/ + +# Installshield output folder +[Ee]xpress/ + +# DocProject is a documentation generator add-in +DocProject/buildhelp/ +DocProject/Help/*.HxT +DocProject/Help/*.HxC +DocProject/Help/*.hhc +DocProject/Help/*.hhk +DocProject/Help/*.hhp +DocProject/Help/Html2 +DocProject/Help/html + +# Click-Once directory +publish/ + +# Publish Web Output +*.[Pp]ublish.xml +*.azurePubxml +# Note: Comment the next line if you want to checkin your web deploy settings, +# but database connection strings (with potential passwords) will be unencrypted +*.pubxml +*.publishproj + +# Microsoft Azure Web App publish settings. Comment the next line if you want to +# checkin your Azure Web App publish settings, but sensitive information contained +# in these scripts will be unencrypted +PublishScripts/ + +# NuGet Packages +*.nupkg +# NuGet Symbol Packages +*.snupkg +# The packages folder can be ignored because of Package Restore +**/[Pp]ackages/* +# except build/, which is used as an MSBuild target. +!**/[Pp]ackages/build/ +# Uncomment if necessary however generally it will be regenerated when needed +#!**/[Pp]ackages/repositories.config +# NuGet v3's project.json files produces more ignorable files +*.nuget.props +*.nuget.targets + +# Microsoft Azure Build Output +csx/ +*.build.csdef + +# Microsoft Azure Emulator +ecf/ +rcf/ + +# Windows Store app package directories and files +AppPackages/ +BundleArtifacts/ +Package.StoreAssociation.xml +_pkginfo.txt +*.appx +*.appxbundle +*.appxupload + +# Visual Studio cache files +# files ending in .cache can be ignored +*.[Cc]ache +# but keep track of directories ending in .cache +!?*.[Cc]ache/ + +# Others +ClientBin/ +~$* +*~ +*.dbmdl +*.dbproj.schemaview +*.jfm +*.pfx +*.publishsettings +orleans.codegen.cs + +# Including strong name files can present a security risk +# (https://github.com/github/gitignore/pull/2483#issue-259490424) +#*.snk + +# Since there are multiple workflows, uncomment next line to ignore bower_components +# (https://github.com/github/gitignore/pull/1529#issuecomment-104372622) +#bower_components/ + +# RIA/Silverlight projects +Generated_Code/ + +# Backup & report files from converting an old project file +# to a newer Visual Studio version. Backup files are not needed, +# because we have git ;-) +_UpgradeReport_Files/ +Backup*/ +UpgradeLog*.XML +UpgradeLog*.htm +ServiceFabricBackup/ +*.rptproj.bak + +# SQL Server files +*.mdf +*.ldf +*.ndf + +# Business Intelligence projects +*.rdl.data +*.bim.layout +*.bim_*.settings +*.rptproj.rsuser +*- [Bb]ackup.rdl +*- [Bb]ackup ([0-9]).rdl +*- [Bb]ackup ([0-9][0-9]).rdl + +# Microsoft Fakes +FakesAssemblies/ + +# GhostDoc plugin setting file +*.GhostDoc.xml + +# Node.js Tools for Visual Studio +.ntvs_analysis.dat +node_modules/ + +# Visual Studio 6 build log +*.plg + +# Visual Studio 6 workspace options file +*.opt + +# Visual Studio 6 auto-generated workspace file (contains which files were open etc.) +*.vbw + +# Visual Studio LightSwitch build output +**/*.HTMLClient/GeneratedArtifacts +**/*.DesktopClient/GeneratedArtifacts +**/*.DesktopClient/ModelManifest.xml +**/*.Server/GeneratedArtifacts +**/*.Server/ModelManifest.xml +_Pvt_Extensions + +# Paket dependency manager +.paket/paket.exe +paket-files/ + +# FAKE - F# Make +.fake/ + +# CodeRush personal settings +.cr/personal + +# Python Tools for Visual Studio (PTVS) +__pycache__/ +*.pyc + +# Cake - Uncomment if you are using it +# tools/** +# !tools/packages.config + +# Tabs Studio +*.tss + +# Telerik's JustMock configuration file +*.jmconfig + +# BizTalk build output +*.btp.cs +*.btm.cs +*.odx.cs +*.xsd.cs + +# OpenCover UI analysis results +OpenCover/ + +# Azure Stream Analytics local run output +ASALocalRun/ + +# MSBuild Binary and Structured Log +*.binlog + +# NVidia Nsight GPU debugger configuration file +*.nvuser + +# MFractors (Xamarin productivity tool) working folder +.mfractor/ + +# Local History for Visual Studio +.localhistory/ + +# BeatPulse healthcheck temp database +healthchecksdb + +# Backup folder for Package Reference Convert tool in Visual Studio 2017 +MigrationBackup/ + +# Ionide (cross platform F# VS Code tools) working folder +.ionide/ diff --git a/GrasshopperAsyncComponent/Base/GH_AsyncComponent.cs b/GrasshopperAsyncComponent/Base/GH_AsyncComponent.cs new file mode 100644 index 0000000..92c9e6b --- /dev/null +++ b/GrasshopperAsyncComponent/Base/GH_AsyncComponent.cs @@ -0,0 +1,127 @@ +using System; +using System.Collections.Concurrent; +using System.Collections.Generic; +using System.Threading; +using System.Threading.Tasks; +using Grasshopper.Kernel; +using Timer = System.Timers.Timer; + +namespace GrasshopperAsyncComponent +{ + public abstract class GH_AsyncComponent : GH_Component + { + public override Guid ComponentGuid { get => new Guid("5DBBD498-0326-4E25-83A5-424D8DC493D4"); } + + protected override System.Drawing.Bitmap Icon { get => null; } + + public override GH_Exposure Exposure => GH_Exposure.hidden; + + public IAsyncComponentWorker Worker; + + IAsyncComponentWorker CurrentWorker; + + Task CurrentRun; + + ConcurrentBag TokenSources = new ConcurrentBag(); + + Action ReportProgress; + + Action ReportError; + + List<(string, GH_RuntimeMessageLevel)> Errors; + + Action Done; + + int State = 0; + + Timer DisplayProgressTimer; + + protected GH_AsyncComponent(string name, string nickname, string description, string category, string subCategory) : base(name, nickname, description, category, subCategory) + { + + DisplayProgressTimer = new Timer(333) { AutoReset = false }; + DisplayProgressTimer.Elapsed += (s, e) => + { + Rhino.RhinoApp.InvokeOnUiThread((Action)delegate + { + OnDisplayExpired(true); + }); + }; + + ReportProgress = (progress) => + { + Rhino.RhinoApp.InvokeOnUiThread((Action)delegate + { + Message = progress; + if (!DisplayProgressTimer.Enabled) DisplayProgressTimer.Start(); + }); + }; + + ReportError = (error, type) => Errors?.Add((error, type)); + + Done = () => + { + Rhino.RhinoApp.InvokeOnUiThread((Action)delegate + { + State = 1; + ExpireSolution(true); + }); + }; + + Errors = new List<(string, GH_RuntimeMessageLevel)>(); + } + + protected override void SolveInstance(IGH_DataAccess DA) + { + if (State == 0) + { + if (Worker == null) + { + AddRuntimeMessage(GH_RuntimeMessageLevel.Error, "Worker class not provided."); + return; + } + + CurrentWorker = Worker.GetNewInstance(); + if (CurrentWorker == null) + { + AddRuntimeMessage(GH_RuntimeMessageLevel.Error, "Could not get a worker instance."); + return; + } + + Errors = new List<(string, GH_RuntimeMessageLevel)>(); + + // Request the cancellation of any old tasks. + CancellationTokenSource oldTokenSource; + while (TokenSources.TryTake(out oldTokenSource)) + { + oldTokenSource?.Cancel(); + } + + // Let the worker collect data. + CurrentWorker.CollectData(DA, Params); + + // Create the task + var tokenSource = new CancellationTokenSource(); + CurrentRun = new Task(() => CurrentWorker.DoWork(tokenSource.Token, ReportProgress, ReportError, Done), tokenSource.Token); + + // Add cancelation source to our bag + TokenSources.Add(tokenSource); + CurrentRun.Start(); + return; + } + + foreach (var (message, type) in Errors) + { + AddRuntimeMessage(type, message); + } + + OnDisplayExpired(true); + CurrentWorker.SetData(DA); + + Message = "Done"; + + Errors.Clear(); + State = 0; + } + } +} diff --git a/GrasshopperAsyncComponent/Base/IAsyncComponentWorker.cs b/GrasshopperAsyncComponent/Base/IAsyncComponentWorker.cs new file mode 100644 index 0000000..8c5ac07 --- /dev/null +++ b/GrasshopperAsyncComponent/Base/IAsyncComponentWorker.cs @@ -0,0 +1,44 @@ +using Grasshopper.Kernel; +using System; +using System.Collections.Generic; +using System.Linq; +using System.Text; +using System.Threading; +using System.Threading.Tasks; + +namespace GrasshopperAsyncComponent +{ + // TODO: Would an an abstract class be better here? + public interface IAsyncComponentWorker + { + + /// + /// This function should return a duplicate instance of your class. Make sure any state is duplicated (or not) properly. + /// + /// + IAsyncComponentWorker GetNewInstance(); + + /// + /// Here you can safely set the data of your component, just like you would normally. Important: do not call this method directly! When you are ready, call the provided "Done" action from the DoWork function. + /// + /// + void SetData(IGH_DataAccess DA); + + /// + /// Here you can safely collect the data from your component, just like you would normally. Important: do not call this method directly. It will be invoked by the parent component. + /// + /// The magic Data Access class. + /// The parameters list, in case you need it. + void CollectData(IGH_DataAccess DA, GH_ComponentParamServer Params); + + /// + /// This where the computation happens. Make sure to check and return if the token is cancelled! + /// + /// The cancellation token. + /// Call this action to report progress. It will be displayed in the component's message bar. + /// Call this to report a warning or an error. + /// When you are done computing, call this function to have the parent component invoke the SetData function. + void DoWork(CancellationToken token, Action ReportProgress, Action ReportError, Action Done); + + } +} diff --git a/GrasshopperAsyncComponent/GrasshopperAsyncComponent.csproj b/GrasshopperAsyncComponent/GrasshopperAsyncComponent.csproj new file mode 100644 index 0000000..a981acc --- /dev/null +++ b/GrasshopperAsyncComponent/GrasshopperAsyncComponent.csproj @@ -0,0 +1,101 @@ + + + + Debug + AnyCPU + 8.0.30703 + 2.0 + {695D2B91-DDB6-416E-8A99-DDE6253DA7AA} + Library + Properties + GrasshopperAsyncComponent + GrasshopperAsyncComponent + v4.7.2 + 512 + false + + + + + + true + full + false + bin\ + DEBUG;TRACE + prompt + false + + + pdbonly + true + bin\ + TRACE + prompt + 4 + + + + packages\RhinoCommon.6.29.20238.11501\lib\net45\Eto.dll + + + packages\Grasshopper.6.29.20238.11501\lib\net45\GH_IO.dll + + + packages\Grasshopper.6.29.20238.11501\lib\net45\Grasshopper.dll + + + packages\RhinoCommon.6.29.20238.11501\lib\net45\Rhino.UI.dll + + + packages\RhinoCommon.6.29.20238.11501\lib\net45\RhinoCommon.dll + + + + + + + + + + + + + + + + + + + + + + + Copy "$(TargetPath)" "$(TargetDir)$(ProjectName).gha" +Erase "$(TargetPath)" + + + en-US + + + C:\Program Files\Rhino 6\System\Rhino.exe + + + Program + + + + + This project references NuGet package(s) that are missing on this computer. Use NuGet Package Restore to download them. For more information, see http://go.microsoft.com/fwlink/?LinkID=322105. The missing file is {0}. + + + + + + \ No newline at end of file diff --git a/GrasshopperAsyncComponent/GrasshopperAsyncComponent.sln b/GrasshopperAsyncComponent/GrasshopperAsyncComponent.sln new file mode 100644 index 0000000..16c4f9b --- /dev/null +++ b/GrasshopperAsyncComponent/GrasshopperAsyncComponent.sln @@ -0,0 +1,25 @@ + +Microsoft Visual Studio Solution File, Format Version 12.00 +# Visual Studio Version 16 +VisualStudioVersion = 16.0.30517.126 +MinimumVisualStudioVersion = 10.0.40219.1 +Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "GrasshopperAsyncComponent", "GrasshopperAsyncComponent.csproj", "{695D2B91-DDB6-416E-8A99-DDE6253DA7AA}" +EndProject +Global + GlobalSection(SolutionConfigurationPlatforms) = preSolution + Debug|Any CPU = Debug|Any CPU + Release|Any CPU = Release|Any CPU + EndGlobalSection + GlobalSection(ProjectConfigurationPlatforms) = postSolution + {695D2B91-DDB6-416E-8A99-DDE6253DA7AA}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {695D2B91-DDB6-416E-8A99-DDE6253DA7AA}.Debug|Any CPU.Build.0 = Debug|Any CPU + {695D2B91-DDB6-416E-8A99-DDE6253DA7AA}.Release|Any CPU.ActiveCfg = Release|Any CPU + {695D2B91-DDB6-416E-8A99-DDE6253DA7AA}.Release|Any CPU.Build.0 = Release|Any CPU + EndGlobalSection + GlobalSection(SolutionProperties) = preSolution + HideSolutionNode = FALSE + EndGlobalSection + GlobalSection(ExtensibilityGlobals) = postSolution + SolutionGuid = {08DDC5B3-E975-48EF-B33D-23F77FE55433} + EndGlobalSection +EndGlobal diff --git a/GrasshopperAsyncComponent/Info/GrasshopperAsyncComponentInfo.cs b/GrasshopperAsyncComponent/Info/GrasshopperAsyncComponentInfo.cs new file mode 100644 index 0000000..7d7aa1b --- /dev/null +++ b/GrasshopperAsyncComponent/Info/GrasshopperAsyncComponentInfo.cs @@ -0,0 +1,57 @@ +using System; +using System.Drawing; +using Grasshopper.Kernel; + +namespace GrasshopperAsyncComponent +{ + public class GrasshopperAsyncComponentInfo : GH_AssemblyInfo + { + public override string Name + { + get + { + return "GrasshopperAsyncComponent"; + } + } + public override Bitmap Icon + { + get + { + //Return a 24x24 pixel bitmap to represent this GHA library. + return null; + } + } + public override string Description + { + get + { + //Return a short string describing the purpose of this GHA library. + return "A base for async & less janky grasshopper components."; + } + } + public override Guid Id + { + get + { + return new Guid("9c8808bc-ddee-45ca-8c66-05ca3cf4d394"); + } + } + + public override string AuthorName + { + get + { + //Return a string identifying you or your company. + return ""; + } + } + public override string AuthorContact + { + get + { + //Return a string representing your preferred contact details. + return ""; + } + } + } +} diff --git a/GrasshopperAsyncComponent/Properties/AssemblyInfo.cs b/GrasshopperAsyncComponent/Properties/AssemblyInfo.cs new file mode 100644 index 0000000..3764cb5 --- /dev/null +++ b/GrasshopperAsyncComponent/Properties/AssemblyInfo.cs @@ -0,0 +1,36 @@ +using System.Reflection; +using System.Runtime.CompilerServices; +using System.Runtime.InteropServices; + +// General Information about an assembly is controlled through the following +// set of attributes. Change these attribute values to modify the information +// associated with an assembly. +[assembly: AssemblyTitle("GrasshopperAsyncComponent")] +[assembly: AssemblyDescription("")] +[assembly: AssemblyConfiguration("")] +[assembly: AssemblyCompany("")] +[assembly: AssemblyProduct("GrasshopperAsyncComponent")] +[assembly: AssemblyCopyright("Copyright © 2020")] +[assembly: AssemblyTrademark("")] +[assembly: AssemblyCulture("")] + +// Setting ComVisible to false makes the types in this assembly not visible +// to COM components. If you need to access a type in this assembly from +// COM, set the ComVisible attribute to true on that type. +[assembly: ComVisible(false)] + +// The following GUID is for the ID of the typelib if this project is exposed to COM +[assembly: Guid("695d2b91-ddb6-416e-8a99-dde6253da7aa")] + +// Version information for an assembly consists of the following four values: +// +// Major Version +// Minor Version +// Build Number +// Revision +// +// You can specify all the values or you can default the Build and Revision Numbers +// by using the '*' as shown below: +// [assembly: AssemblyVersion("1.0.*")] +[assembly: AssemblyVersion("1.0.0.0")] +[assembly: AssemblyFileVersion("1.0.0.0")] diff --git a/GrasshopperAsyncComponent/SampleImplementations/SampleAsyncComponent.cs b/GrasshopperAsyncComponent/SampleImplementations/SampleAsyncComponent.cs new file mode 100644 index 0000000..ec4ab0a --- /dev/null +++ b/GrasshopperAsyncComponent/SampleImplementations/SampleAsyncComponent.cs @@ -0,0 +1,77 @@ +using Grasshopper.Kernel; +using System; +using System.Collections.Generic; +using System.Linq; +using System.Text; +using System.Threading; +using System.Threading.Tasks; + +namespace GrasshopperAsyncComponent.SampleImplementations +{ + public class SampleAsyncComponent : GH_AsyncComponent + { + public override Guid ComponentGuid { get => new Guid("DF2B93E2-052D-4BE4-BC62-90DC1F169BF6"); } + + protected override System.Drawing.Bitmap Icon { get => null; } + + public override GH_Exposure Exposure => GH_Exposure.primary; + + public SampleAsyncComponent() : base("Sample Async Component", "ASYNC", "Meaningless labour.", "Samples", "Async") + { + Worker = new SampleAsyncComponentWorker(); + } + + protected override void RegisterInputParams(GH_InputParamManager pManager) + { + pManager.AddIntegerParameter("Max iterations", "M", "How many useless cycles should we spin. Minimum 10, maximum 1000.", GH_ParamAccess.item); + } + + protected override void RegisterOutputParams(GH_OutputParamManager pManager) + { + pManager.AddTextParameter("Output", "O", "Will just say hello world after spinning.", GH_ParamAccess.item); + } + } + + public class SampleAsyncComponentWorker : IAsyncComponentWorker + { + int MaxIterations { get; set; } = 100; + + public void CollectData(IGH_DataAccess DA, GH_ComponentParamServer Params) + { + int _maxIterations = 100; + DA.GetData(0, ref _maxIterations); + if (_maxIterations > 1000) MaxIterations = 1000; + if (_maxIterations < 10) MaxIterations = 10; + + MaxIterations = _maxIterations; + } + + public void DoWork(CancellationToken token, Action ReportProgress, Action ReportError, Action Done) + { + if (token.IsCancellationRequested) return; + + for (int i = 0; i <= MaxIterations; i++) + { + var sw = new SpinWait(); + for (int j = 0; j <= 100; j++) + sw.SpinOnce(); + + ReportProgress(((double)(i + 1) / (double)MaxIterations).ToString("0.00%")); + + if (token.IsCancellationRequested) return; + } + + Done(); + } + + public IAsyncComponentWorker GetNewInstance() + { + return new SampleAsyncComponentWorker(); + } + + public void SetData(IGH_DataAccess DA) + { + DA.SetData(0, "Hello world. I'm done spinning."); + } + } +} diff --git a/GrasshopperAsyncComponent/packages.config b/GrasshopperAsyncComponent/packages.config new file mode 100644 index 0000000..f0d29eb --- /dev/null +++ b/GrasshopperAsyncComponent/packages.config @@ -0,0 +1,6 @@ + + + + + + \ No newline at end of file