The smallest useful BIM.
|Name|Description| |----|----| |Elements|The core elements library containing base geometric types.| |Elements.CodeGeneration|Methods for converting JSON schema of Element types to C#.| |Elements.Serialization.IFC|Methods for serializing a
In a .net core project: ```
dotnet add package Hypar.ElementsIn Visual Studio:PM> Install-Package Hypar.Elements ```
Find the documentation here.
The best examples are those provided in the tests, where we demonstrate usage of almost every function in the library.
Elements is a cross-platform library for creating building elements. It's meant to be used by architects, engineers, and other building professionals who want to write code that generates buildings.
When we started Hypar we needed a library that would generate building elements and run at the core of each function on the platform. Because we don't like rebuilding the wheel, we looked around for existing libraries that fulfilled the following requirements: - The library must be small and fast. Elements is currently ~300kb and we're working every day to make it smaller. - The library must run in micro-services on Linux. - The library must have great visual documentation. If we're going to pass this library on as a recommendation to developers on Hypar, we want great docs. - The library must be free of dependencies on host applications like Rhino or Revit or geometry kernels like Open Cascade which, while really cool, become a black box in your system. - The library must be able to serialize data to formats like JSON, IFC,and glTF, that are useful to architects, engineers, contractors, and people building real-time visualization applications for AEC. - The library must be written in a language that supports developer productivity through things like type safety, and which supports code re-use in other popular AEC applications like Dynamo, Grasshopper, Revit, and Unity. - Serialization and deserialization of types that extend
Elementshould be possible provided that those types are made up of primitives defined in this library.
We couldn't find anything quite right. So we started building this.
/Schemasdirectory. These schemas are provided as JSON schema.
hypar generate-typescommand. For users of Visual Studio Code, the "CLI Generate Elements" task can be used.
partial. You can add constructors using a separate partial class, but remember that those constructors will not be available to other developers unless you share them in a library (ex: a NuGet package).
CSharpClassStyle.POCOusing NJsonSchema. This results in class definitions without constructors.
JsonInheritanceAttributepointing to their derived types.
Elementmust be decorated with the
UserElementattribute. This is required because a type author doesn't have access to the base types, and must therefore signify to the serializer that it needs to load a specific type.
Elements contains a very simple BREP geometry kernel, and a small set of geometric types like vectors, lines, and polygons. Elements uses a right-handed coordinate system with +Z "up". Elements is unitless except as indicated when calling a geometric method (ex: arcs requires angles in degrees).
We are often asked whether the Elements library supports the ____ geometry kernel. It does not. Yet. The geometry kernel that we've created for Elements is a very simple BREP kernel which does "flat stuff with holes in it" really well. We think Nurbs are sexy, and we'll definitely support more curvy stuff in the future, it's just that the effort required to support ____ geometry kernel for micro-services running in the cloud is not small. Good geometry kernels are also usually large, expensive, and not open source, so they introduce a lot of concerns which are orthogonal to why we built this library in the first place. If you are interested in using Elements with another geometry library, we love pull requests.
Hypar Elements is open source and will remain so forever. Your donation will directly support the development of the Hypar Elements. Hypar Elements has been demonstrated to work in Revit add-ins, Unity projects, and as Lambdas running on AWS. Send us a donation and open a feature request telling us what you'd like it to do.
You'll only need to do this if you want to contribute to the library, otherwise you can use the NuGet package that is published regularly.
cd Elements.Benchmarks dotnet run -c Release
cd doc docfx -f --serve
git log --pretty=oneline v0.3.6...v0.3.7, where the tags are changed appropriately.