Caching of preview meshes to improve performance

[IsakNaslundBh]

Issues addressed by this PR

Closes #655

Changes the way geometry is rendered from rendering Surface geometry via the specific render method accepting Breps, to instead extract PreviewMeshes that are cached at first preview and then reused to preview.

Also storing preview material rather than only preview colour, as creating those for each frame also slows things down.

This will increase the demand on RAM slightly, but from initial testing with a quite significant amount of obejcts this has not yet proven to be a massive problem.

If it is, we could have a look to instead remove the cached BHoM geometry and Rhino geometry, for them to be extracted on the fly instead, and directly turned to the preview meshes.

Test files

Two testfiles in the folder, first testing that all of our surface types are still visible, second testing the speed. The speed testfile is able to relatively decently handle 100 000 panels with the code on this PR, while it can not handle a fraction of that on main.

https://burohappold.sharepoint.com/:f:/r/sites/BHoM/02_Current/12_Scripts/02_Pull%20Request/BHoM/Grasshopper_Toolkit/%23656-CachingOfPreviewMeshesToImprovePerformance?csf=1&web=1&e=OV1WJr

Changelog

Additional comments

[FraserGreenroyd]

Some minor spelling/formatting changes requested from code review (functionality review not yet performed).

Tagging @alelom as well to take a glance through just to check if this causes any concern for him with the remote compute work he's working on following our nuget discussion this morning @alelom ?

Happy for conversations to be marked resolved if an answer is given @IsakNaslundBh 👍

[michaelhoehn]

I've compared the code on main and the PR code against the sample scripts and am very happy with the performance improvements. I didn't notice any adverse side effects on memory usage when upping the panel counts quite significantly. The only real difference was noticed when orbiting/panning around the models which provided a significant framerate performance boost. Happy to see this merged 🐛

[IsakNaslundBh]

@BHoMBot check compliance
@BHoMBot check required

[bhombot-ci]

@IsakNaslundBh to confirm, the following checks are now queued:

• code-compliance
• documentation-compliance
• project-compliance
• branch-compliance
• dataset-compliance
• copyright-compliance
• code-compliance
• documentation-compliance
• project-compliance
• core
• null-handling
• serialisation
• versioning
• installer

There are 344 requests in the queue ahead of you.

[FraserGreenroyd]

Changes are good, happy with the discussion, great work, thanks @IsakNaslundBh

@alelom unless you desperately need this for your remote computing work, I won't plan to make a nuget out of this until the next beta - but if you do need it desperately then let me know!

[bhombot-ci]

The check code-compliance has already been run previously and recorded as a successful check. This check has not been run again at this time.

[bhombot-ci]

The check documentation-compliance has already been run previously and recorded as a successful check. This check has not been run again at this time.

[bhombot-ci]

The check project-compliance has already been run previously and recorded as a successful check. This check has not been run again at this time.

[IsakNaslundBh]

@BHoMBot check ready-to-merge

[bhombot-ci]

@IsakNaslundBh to confirm, the following checks are now queued:

• ready-to-merge

There are 359 requests in the queue ahead of you.