Meeting takeaways

This is the basic outline of what we’re proposing to change:

• Create a global Doc property somewhere in the Converters, and use that instead of the ActiveDoc when calling SetContextDocument() in the converter.
  • This will ensure we use the same Document instance across all components in GH.
  • But also follows the Rhinocommon docs recommendation linked above.
• Create a new static method GetHeadlessDoc() that will:
  • Check if a template file exists on a pre-defined path (i.e. %appdata%/speckle/kits/objects/rhinoTemplate.3dm)
  • Create a headless document with Rhino.CreateHeadlessDoc()
    • Using template path if it exists; instead of packaging a 3dm file in our installer. Seems cleaner.
• To prevent this new Doc property from being null, either set or return the GetHeadlessDoc() if the ActiveDoc is null.
• Things to check:
  • Ability to swap the global Doc for a custom one at runtime using a script in GH.
  • Ensure CreateHeadlessDoc behaviour when no path is provided
• Documentation:
  • Add Rhino.Compute+Speckle section in the docs
  • Add proper explanation of the headless doc template behaviour in code

Pre-meeting notes

For reference, this stems from conversations in the forum:

Not able to disable conversion on the Synchronous Sender

Running Speckle on Rhino Compute

The problem

We depend on the ActiveDoc to be set as the Converter document using SetContextDocument

This seemed to be harmless until we started playing around with Rhino.Compute, which does not actually have an ActiveDoc set.

There is also the fact that was raised on the forum about this new warning in the Rhino Docs: https://developer.rhino3d.com/api/RhinoCommon/html/P_Rhino_RhinoDoc_ActiveDoc.htm

WARNING!! Do not use the ActiveDoc if you don't have to. 
Under Mac Rhino the ActiveDoc can change while a command is running. 
Use the doc that is passed to you in your RunCommand function 
or continue to use the same doc after the first call to ActiveDoc.

Chris welch did suggest one of my initial ideas, which is to write a wrapper class to hold all Converter settings, see: