Skip to content

nic-burgers-arup/SpeckleCore

This branch is 72 commits behind speckleworks/SpeckleCore:master.

Folders and files

NameName
Last commit message
Last commit date

Latest commit

666014c · Aug 24, 2019
Jul 9, 2019
Jul 9, 2019
Jul 9, 2019
Aug 9, 2019
Jul 9, 2019
Jul 9, 2019
Jul 12, 2017
Jul 12, 2019
Jul 9, 2019
Apr 11, 2018
Apr 10, 2018
Apr 11, 2018
Aug 15, 2017
Jul 9, 2019
May 17, 2019
Jul 16, 2019
Jul 9, 2019
Jul 9, 2019
Aug 24, 2019

Repository files navigation

SpeckleCore

Build status DOI

Overview

This is the core .NET client lib of Speckle. It provides:

  • async methods for calling the speckle api
  • methods for interacting with the speckle's websocket api
  • the core conversion methods (Serialise and Deserialise) & other helper methods
  • a base SpeckleObject from which you can inherit to create your own speckle kits

Pretty much all of speckle's connectors are using this library, including:

  • Rhino
  • Grasshopper
  • Revit
  • Dynamo
  • Unity (with flavours)

Example usage

// TODO

Note: Newtonsoft.Json Aliasing

Because of quite a few conflicts with other libraries, we are aliasing newtonsoftjson. Consequently, to preserve expected behaviour, if referencing speckle core in your libraries, do use the bundled "SpeckleNewtonsoft" (original v.12). To do so, add a reference to the dll from inside the SpeckleCore solution folder in your project, and then you can use it by doing

extern alias SpeckleNewtonsoft;
using SNJ = SpeckleNewtonsoft.Newtonsoft.Json; // for convenience

// thereafter, in your code, you can use it like this:

SNJ.JsonConvert.SerializeObject( e.EventData, Interop.camelCaseSettings )

License

MIT

About

.NET base for the speckle api

Resources

License

Code of conduct

Stars

Watchers

Forks

Packages

No packages published

Languages

  • C# 100.0%