Skip to content

Commit 48f8d6a

Browse files
didimitriedidimitrie
committed
feat(sample & readme): added a small sample file and added extra info in the readme file
1 parent 011a28d commit 48f8d6a

File tree

2 files changed

+301
-1
lines changed

2 files changed

+301
-1
lines changed

‎README.md

Lines changed: 42 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,43 @@
11
# GrasshopperAsyncComponent
2-
Jankless Grasshopper Components
2+
3+
[![Twitter Follow](https://img.shields.io/twitter/follow/SpeckleSystems?style=social)](https://twitter.com/SpeckleSystems) [![Discourse users](https://img.shields.io/discourse/users?server=https%3A%2F%2Fdiscourse.speckle.works&style=flat-square)](https://discourse.speckle.works)
4+
[![Slack Invite](https://img.shields.io/badge/-slack-grey?style=flat-square&logo=slack)](https://speckle-works.slack.com/join/shared_invite/enQtNjY5Mzk2NTYxNTA4LTU4MWI5ZjdhMjFmMTIxZDIzOTAzMzRmMTZhY2QxMmM1ZjVmNzJmZGMzMDVlZmJjYWQxYWU0MWJkYmY3N2JjNGI) [![website](https://img.shields.io/badge/www-speckle.systems-royalblue?style=flat-square)](https://speckle.systems)
5+
6+
## Less Janky Grasshopper Components
7+
8+
See the companion blog post about the rationale behind this approach. This repo demonstrates how to create an eager and responsive async component that does not block the Grasshopper UI thread while doing heavy work in the background, reports on progress and - theoretically - makes your life easier.
9+
10+
We're not so sure about the last part! We've put this repo out in the hope that others will find something useful inside - even just inspiration for the approach.
11+
12+
INSERT GIF HERE
13+
14+
15+
16+
### Approach
17+
18+
Provides an abstract `GH_AsyncComponent` which you can inherit from to scaffold your own async component. There's more info in the blogpost on how to go about it.
19+
20+
Even better, there's a sample component that shows how an implementation could look like! TODO: link to code!
21+
22+
### Current limitations
23+
24+
Main current limitation is around data matching. If the component needs to run more than once - e.g., in the case of `Item` input parameters receiving a `List` of objects, it gets stuck. Currently, the safest bet - albeit not the easiest one - is to make sure your input parameters are set to `Tree` and you can do your own data matching inside. Not ideal, I know. I'm sure this can be improved, but it's late on a Sunday evening.
25+
26+
### Debugging
27+
28+
Quite easy:
29+
- Clone this repository and open up the solution in Visual Studio.
30+
- Once you've built it, add the `bin` folder to the Grasshopper Developer Settings (type `GrasshopperDeveloperSettings` in the Rhino command line) and open up Grasshopper.
31+
- You should see a new component popping up under "Samples > Async" in the ribbon.
32+
- A simple
33+
34+
## Contributing
35+
36+
Before embarking on submitting a patch, please make sure you read:
37+
38+
- [Contribution Guidelines](CONTRIBUTING.md),
39+
- [Code of Conduct](CODE_OF_CONDUCT.md)
40+
41+
## License
42+
43+
Unless otherwise described, the code in this repository is licensed under the Apache-2.0 license.

‎SampleGhFile.ghx

Lines changed: 259 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,259 @@
1+
<?xml version="1.0" encoding="utf-8" standalone="yes"?>
2+
<Archive name="Root">
3+
<!--Grasshopper archive-->
4+
<!--Grasshopper and GH_IO.dll are copyrighted by Robert McNeel & Associates-->
5+
<!--Archive generated by GH_IO.dll file utility library {0.2.0002}-->
6+
<items count="1">
7+
<item name="ArchiveVersion" type_name="gh_version" type_code="80">
8+
<Major>0</Major>
9+
<Minor>2</Minor>
10+
<Revision>2</Revision>
11+
</item>
12+
</items>
13+
<chunks count="2">
14+
<chunk name="Definition">
15+
<items count="1">
16+
<item name="plugin_version" type_name="gh_version" type_code="80">
17+
<Major>1</Major>
18+
<Minor>0</Minor>
19+
<Revision>7</Revision>
20+
</item>
21+
</items>
22+
<chunks count="5">
23+
<chunk name="DocumentHeader">
24+
<items count="5">
25+
<item name="DocumentID" type_name="gh_guid" type_code="9">7b7a4534-415e-40d2-85bf-2e969bf8cbda</item>
26+
<item name="Preview" type_name="gh_string" type_code="10">Shaded</item>
27+
<item name="PreviewMeshType" type_name="gh_int32" type_code="3">1</item>
28+
<item name="PreviewNormal" type_name="gh_drawing_color" type_code="36">
29+
<ARGB>100;150;0;0</ARGB>
30+
</item>
31+
<item name="PreviewSelected" type_name="gh_drawing_color" type_code="36">
32+
<ARGB>100;0;150;0</ARGB>
33+
</item>
34+
</items>
35+
</chunk>
36+
<chunk name="DefinitionProperties">
37+
<items count="3">
38+
<item name="Date" type_name="gh_date" type_code="8">637374490990396611</item>
39+
<item name="Description" type_name="gh_string" type_code="10"></item>
40+
<item name="Name" type_name="gh_string" type_code="10">SampleGhFile.ghx</item>
41+
</items>
42+
<chunks count="3">
43+
<chunk name="Revisions">
44+
<items count="1">
45+
<item name="RevisionCount" type_name="gh_int32" type_code="3">0</item>
46+
</items>
47+
</chunk>
48+
<chunk name="Projection">
49+
<items count="2">
50+
<item name="Target" type_name="gh_drawing_point" type_code="30">
51+
<X>-16</X>
52+
<Y>-11</Y>
53+
</item>
54+
<item name="Zoom" type_name="gh_single" type_code="5">1.38408291</item>
55+
</items>
56+
</chunk>
57+
<chunk name="Views">
58+
<items count="1">
59+
<item name="ViewCount" type_name="gh_int32" type_code="3">0</item>
60+
</items>
61+
</chunk>
62+
</chunks>
63+
</chunk>
64+
<chunk name="RcpLayout">
65+
<items count="1">
66+
<item name="GroupCount" type_name="gh_int32" type_code="3">0</item>
67+
</items>
68+
</chunk>
69+
<chunk name="GHALibraries">
70+
<items count="1">
71+
<item name="Count" type_name="gh_int32" type_code="3">1</item>
72+
</items>
73+
<chunks count="1">
74+
<chunk name="Library" index="0">
75+
<items count="6">
76+
<item name="AssemblyFullName" type_name="gh_string" type_code="10">GrasshopperAsyncComponent, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null</item>
77+
<item name="AssemblyVersion" type_name="gh_string" type_code="10">1.0.0.0</item>
78+
<item name="Author" type_name="gh_string" type_code="10"></item>
79+
<item name="Id" type_name="gh_guid" type_code="9">9c8808bc-ddee-45ca-8c66-05ca3cf4d394</item>
80+
<item name="Name" type_name="gh_string" type_code="10">GrasshopperAsyncComponent</item>
81+
<item name="Version" type_name="gh_string" type_code="10"></item>
82+
</items>
83+
</chunk>
84+
</chunks>
85+
</chunk>
86+
<chunk name="DefinitionObjects">
87+
<items count="1">
88+
<item name="ObjectCount" type_name="gh_int32" type_code="3">3</item>
89+
</items>
90+
<chunks count="3">
91+
<chunk name="Object" index="0">
92+
<items count="2">
93+
<item name="GUID" type_name="gh_guid" type_code="9">c552a431-af5b-46a9-a8a4-0fcbc27ef596</item>
94+
<item name="Name" type_name="gh_string" type_code="10">Group</item>
95+
</items>
96+
<chunks count="1">
97+
<chunk name="Container">
98+
<items count="8">
99+
<item name="Border" type_name="gh_int32" type_code="3">1</item>
100+
<item name="Colour" type_name="gh_drawing_color" type_code="36">
101+
<ARGB>150;170;135;255</ARGB>
102+
</item>
103+
<item name="Description" type_name="gh_string" type_code="10">A group of Grasshopper objects</item>
104+
<item name="ID" index="0" type_name="gh_guid" type_code="9">218540d4-f247-46f0-9a31-102d00304a2e</item>
105+
<item name="ID_Count" type_name="gh_int32" type_code="3">1</item>
106+
<item name="InstanceGuid" type_name="gh_guid" type_code="9">76fc2096-4cf4-4832-b9b8-65b28695b903</item>
107+
<item name="Name" type_name="gh_string" type_code="10">Group</item>
108+
<item name="NickName" type_name="gh_string" type_code="10">Does meaningless labour. Spins some cycles!</item>
109+
</items>
110+
<chunks count="1">
111+
<chunk name="Attributes" />
112+
</chunks>
113+
</chunk>
114+
</chunks>
115+
</chunk>
116+
<chunk name="Object" index="1">
117+
<items count="2">
118+
<item name="GUID" type_name="gh_guid" type_code="9">57da07bd-ecab-415d-9d86-af36d7073abc</item>
119+
<item name="Name" type_name="gh_string" type_code="10">Number Slider</item>
120+
</items>
121+
<chunks count="1">
122+
<chunk name="Container">
123+
<items count="6">
124+
<item name="Description" type_name="gh_string" type_code="10">Numeric slider for single values</item>
125+
<item name="InstanceGuid" type_name="gh_guid" type_code="9">fadc4348-0eb2-42b5-b744-04478b2a90ae</item>
126+
<item name="Name" type_name="gh_string" type_code="10">Number Slider</item>
127+
<item name="NickName" type_name="gh_string" type_code="10"></item>
128+
<item name="Optional" type_name="gh_bool" type_code="1">false</item>
129+
<item name="SourceCount" type_name="gh_int32" type_code="3">0</item>
130+
</items>
131+
<chunks count="2">
132+
<chunk name="Attributes">
133+
<items count="2">
134+
<item name="Bounds" type_name="gh_drawing_rectanglef" type_code="35">
135+
<X>98</X>
136+
<Y>191</Y>
137+
<W>202</W>
138+
<H>20</H>
139+
</item>
140+
<item name="Pivot" type_name="gh_drawing_pointf" type_code="31">
141+
<X>98.71039</X>
142+
<Y>191.433</Y>
143+
</item>
144+
</items>
145+
</chunk>
146+
<chunk name="Slider">
147+
<items count="7">
148+
<item name="Digits" type_name="gh_int32" type_code="3">3</item>
149+
<item name="GripDisplay" type_name="gh_int32" type_code="3">1</item>
150+
<item name="Interval" type_name="gh_int32" type_code="3">1</item>
151+
<item name="Max" type_name="gh_double" type_code="6">1000</item>
152+
<item name="Min" type_name="gh_double" type_code="6">0</item>
153+
<item name="SnapCount" type_name="gh_int32" type_code="3">0</item>
154+
<item name="Value" type_name="gh_double" type_code="6">769</item>
155+
</items>
156+
</chunk>
157+
</chunks>
158+
</chunk>
159+
</chunks>
160+
</chunk>
161+
<chunk name="Object" index="2">
162+
<items count="3">
163+
<item name="GUID" type_name="gh_guid" type_code="9">df2b93e2-052d-4be4-bc62-90dc1f169bf6</item>
164+
<item name="Lib" type_name="gh_guid" type_code="9">9c8808bc-ddee-45ca-8c66-05ca3cf4d394</item>
165+
<item name="Name" type_name="gh_string" type_code="10">Sample Async Component</item>
166+
</items>
167+
<chunks count="1">
168+
<chunk name="Container">
169+
<items count="4">
170+
<item name="Description" type_name="gh_string" type_code="10">Meaningless labour.</item>
171+
<item name="InstanceGuid" type_name="gh_guid" type_code="9">218540d4-f247-46f0-9a31-102d00304a2e</item>
172+
<item name="Name" type_name="gh_string" type_code="10">Sample Async Component</item>
173+
<item name="NickName" type_name="gh_string" type_code="10">ASYNC</item>
174+
</items>
175+
<chunks count="3">
176+
<chunk name="Attributes">
177+
<items count="2">
178+
<item name="Bounds" type_name="gh_drawing_rectanglef" type_code="35">
179+
<X>410</X>
180+
<Y>172</Y>
181+
<W>69</W>
182+
<H>59</H>
183+
</item>
184+
<item name="Pivot" type_name="gh_drawing_pointf" type_code="31">
185+
<X>444</X>
186+
<Y>202</Y>
187+
</item>
188+
</items>
189+
</chunk>
190+
<chunk name="param_input" index="0">
191+
<items count="7">
192+
<item name="Description" type_name="gh_string" type_code="10">How many useless cycles should we spin. Minimum 10, maximum 1000.</item>
193+
<item name="InstanceGuid" type_name="gh_guid" type_code="9">d89ad114-fb4c-4bbc-9a0c-d0a430acdbe9</item>
194+
<item name="Name" type_name="gh_string" type_code="10">Max iterations</item>
195+
<item name="NickName" type_name="gh_string" type_code="10">M</item>
196+
<item name="Optional" type_name="gh_bool" type_code="1">false</item>
197+
<item name="Source" index="0" type_name="gh_guid" type_code="9">fadc4348-0eb2-42b5-b744-04478b2a90ae</item>
198+
<item name="SourceCount" type_name="gh_int32" type_code="3">1</item>
199+
</items>
200+
<chunks count="1">
201+
<chunk name="Attributes">
202+
<items count="2">
203+
<item name="Bounds" type_name="gh_drawing_rectanglef" type_code="35">
204+
<X>412</X>
205+
<Y>174</Y>
206+
<W>17</W>
207+
<H>55</H>
208+
</item>
209+
<item name="Pivot" type_name="gh_drawing_pointf" type_code="31">
210+
<X>422</X>
211+
<Y>201.5</Y>
212+
</item>
213+
</items>
214+
</chunk>
215+
</chunks>
216+
</chunk>
217+
<chunk name="param_output" index="0">
218+
<items count="6">
219+
<item name="Description" type_name="gh_string" type_code="10">Will just say hello world after spinning.</item>
220+
<item name="InstanceGuid" type_name="gh_guid" type_code="9">95cec75f-9dc0-49c5-a502-c2445299cb1b</item>
221+
<item name="Name" type_name="gh_string" type_code="10">Output</item>
222+
<item name="NickName" type_name="gh_string" type_code="10">O</item>
223+
<item name="Optional" type_name="gh_bool" type_code="1">false</item>
224+
<item name="SourceCount" type_name="gh_int32" type_code="3">0</item>
225+
</items>
226+
<chunks count="1">
227+
<chunk name="Attributes">
228+
<items count="2">
229+
<item name="Bounds" type_name="gh_drawing_rectanglef" type_code="35">
230+
<X>459</X>
231+
<Y>174</Y>
232+
<W>18</W>
233+
<H>55</H>
234+
</item>
235+
<item name="Pivot" type_name="gh_drawing_pointf" type_code="31">
236+
<X>468</X>
237+
<Y>201.5</Y>
238+
</item>
239+
</items>
240+
</chunk>
241+
</chunks>
242+
</chunk>
243+
</chunks>
244+
</chunk>
245+
</chunks>
246+
</chunk>
247+
</chunks>
248+
</chunk>
249+
</chunks>
250+
</chunk>
251+
<chunk name="Thumbnail">
252+
<items count="1">
253+
<item name="Thumbnail" type_name="gh_drawing_bitmap" type_code="37">
254+
<bitmap length="1690">iVBORw0KGgoAAAANSUhEUgAAAJYAAABkCAIAAADrOV6nAAAAAXNSR0IArs4c6QAAAARnQU1BAACxjwv8YQUAAAAJcEhZcwAADsMAAA7DAcdvqGQAAAYvSURBVHhe7djdT1N3GMBx/4Ilc4Mr47yYF1544dSRgQRNFjMZOAcki0u8MjGSEITgUHlXBjK0trQU2tKWQmkptNAXqMA6xNIyxLdKteVd+g5svMjY3J3uoafilm2ueLHwtM8nv5ycnnNKyfn6+3HqNhIJXhK0Xif0EoQoIXqUED1KiB4lRI8SokcJ0aOE6FFC9CghepQQPUqIHiVEjxKiRwnRo4ToUUL0KCF6lBA9SogeJUSPEqJHCdGjhOhFTkKfb3MjYkROQtfmuENvwy8SEvoD3ulJ123t/KB2yaJbeTWeWfWvx8ZB2Jo7lyzdAbfbHRlzMUISTk24BtpXB1RrPQpfr9Lbq/D2tfq7m13MuNnigZdwMDgCA6rnZu0izERKuFUwCW+r13pU049G7Q7HxNjYtNls7QjS6XR6vf7Bg1Gnc9LpnLh719Yj91n0K9GY0Pe/CH3YZjAJzepfDXJHl9HUbTT39Q3z+eKSkqJafu111rW8vDy1pqe312o0mvUGk7HZbTU8i66EcGc9Hvfs7KzLFc5wPX1bMzMzwTu7uVvLJBzs+E0reyyVtctkWoXCeOXK9dTUzyUSycWLF1JSUkUilVxugFONjZqoS+j3+6enp0dG7j169Nhms8P24cNRGKOjT2CfGcxx5pTFYh0fH58Impyc/PMOs4Wz8AOh1tTUFGSDx4rgJevgArvdDjd3cXFxIWw/Ly64ZwMjXS+0Mqe0sa2lpVul6isr+y41NQVW0bKyUiahUmlsatJJJG03m/3D3b9EUcK5uTm7/bFCoauu5rPZIqGwpbm5UyRS8nhSoVABg8uVNDS0CgRyGApFV09Pv9/vgxvkgZnrdjPbjR34BwGR4M4aDAaLxXLnzh3YgYPMNTD/oCKXy+3v74ezg+GxWgdv/TAoqLpdUcpvELeWlFTfuCEuKqrMyEiTy+WnT59OTT0ORyoquPX1SmhcUdTQ3z4Hv0+0JJyfn4MZx+FIc3JKsrMLz5zJLSysKim5npn5TV5eaVbWxXPninJyimFkZxeUl3OVys6xMSd0+jv4OQ6HY2RkRK1WS6XSvr4+2GGxWE5n6HrYgWuKi4ubmprgSQTOhqOjU93W2lmaKyu8VC4Wt2VlXbh8mVVQ8G1y8md1dXWnTp06diz56tXagoJKLlcGCS/lVfYoXF5PhHzBD2cWBuDOcjiimhpJTY0UthwODHHwZWjAEeYUiyWqqxMPDprfIDhv1sE8g+3Q0BAc2TjV29trs9lWV1dhLQ3T8sqiz7Nwz/hSxh3i1cLaoJJKtTk5l2AhZbPZmZlnDx8+wmZLBIJWgbAVftX2euewcS2KFlLArG8QEqbX2Dpm559H8LK3BO+FDwoEAqEPDg/zOGPtfN7eYOPUiPn8FrFYk519ITHxEI/HO3/+fELCoWvXhAKBqpYvh+WkS+Ya6lqNroQAbitMx/8UzjVvBn8XQx8Zto2ErYL7rBtCLrdJKGw7ezY3Pv4TrVabn5+/b99HVVV1fL6Cx2uCdUInmfkxChNuZaGE2t+ba4erqrkw2xobdbm5RXv37o2Pjz969GhiYhKbLRWJ1LCWVl6t6WiYpIRby6vvhWvfK+eL8jnHv0hPT/86Pf3kkSOfHjgQt3//xwkJSfAyLe3kl2lfVV+R31KtWvXLlHALgYST4y6Tcvmu4SW//Na729957/3tBw8eyMhIT05OTklJOXHixK5dH8TEbN+xY4emfsaqeTGg+YkSbiFQwjXrsd93TzuW2lqMsbExsbGxe/bsiYuLg4UUtklJSTt37oyJidn94W6zyTY+uvDk4fr31ND7kYuEhAAqBua98ws+t+ep0WjU6/XwIMP8NzfQaDTMEZPJFJjzzs17YRsxIiThBnigXV5eXvkXS0tLoesiSKQljEKUED1KiB4lRI8SokcJ0aOE6FFC9CghepQQPUqIHiVEjxKiRwnRo4ToUUL0KCF6lBA9SogeJUSPEqJHCdGjhOhRQvQoIXqUED1KiB4lRI8SokcJ0aOE6FFC9CghepQQPUqIHiVEjxKiRwnRo4ToUUL0KCF6lBA9SogeJUSPEqJHCdGjhOhRQvQoIXqUED1KiB4lRI8SoveXhASpUEKC2LZtfwAeYSU/QiLztAAAAABJRU5ErkJggg==</bitmap>
255+
</item>
256+
</items>
257+
</chunk>
258+
</chunks>
259+
</Archive>

0 commit comments

Comments
 (0)