Helix Toolkit is a collection of 3D components for .NET.
Branch: develop
Clone or download
Latest commit f6d8c2f Feb 17, 2019

README.md

Helix Toolkit

Helix Toolkit is a collection of 3D components for .NET Framework.

HelixToolkit.WPF: Adds variety of functionalities/models on the top of internal WPF 3D model (Media3D namespace).

HelixToolkit.SharpDX.WPF: 3D Components and XAML/MVVM compatible Scene Graphs based on SharpDX(DirectX 11) for high performance usage.

HelixToolkit.UWP: 3D Components and XAML/MVVM compatible Scene Graphs based on SharpDX(DirectX 11) for Universal Windows App.

HelixToolkit.SharpDX.Core: 3D Components and Scene Graphs based on SharpDX(DirectX 11) for netstandard and .NET Core.

HelixToolkit.SharpDX.Assimp: Assimp.Net 3D model importer/expoter support for HelixToolkit.SharpDX Components.

Examples: Please download full source code to run examples. Or download compiled version

License: MIT Build status Release Chat

Description Value
Web page http://helix-toolkit.org/
Wiki https://github.com/helix-toolkit/helix-toolkit/wiki
Documentation http://docs.helix-toolkit.org/
Chat https://gitter.im/helix-toolkit/helix-toolkit
Source repository http://github.com/helix-toolkit/helix-toolkit
Latest build http://ci.appveyor.com/project/objorke/helix-toolkit
Issue tracker http://github.com/helix-toolkit/helix-toolkit/issues
NuGet packages http://www.nuget.org/packages?q=HelixToolkit
MyGet feed https://www.myget.org/F/helix-toolkit
StackOverflow http://stackoverflow.com/questions/tagged/helix-3d-toolkit
Twitter https://twitter.com/hashtag/Helix3DToolkit

Project Build

Visual Studio 2017. Windows 10 SDK (Min Ver.10.0.10586.0).

Missing .cso error during the build? Windows 10 SDK Ver.10.0.10586.0 can be selected and installed using Visual Studio 2017 installer. If you already installed the higher SDK version, please change the target version in HelixToolkit.Native.ShaderBuilder property to the version installed on your machine.

Notes

1. Right-handed Cartesian coordinate system and row major matrix by default

HelixToolkit default is using right-handed Cartesian coordinate system, including Meshbuilder etc. To use left-handed Cartesian coordinate system (Camera.CreateLeftHandedSystem = true), user must manually correct the triangle winding order or IsFrontCounterClockwise in raster state description if using SharpDX. Matrices are row major by default.

2. Performance Topics for WPF.SharpDX and UWP.

3. Following features are not supported currently on FeatureLevel 10 graphics card:

FXAA, Order Independant Transparent Rendering, Particle system, Tessellation.

4. Wiki and useful External Resources on Computer Graphics.

News

2019-02-16

v2.6.1 releases are available on nuget. Release Note

2019-01-04

v2.6.0 releases are available on nuget. Release Note

Two new packages have been released on version 2.6.0.

  • SharpDX.Core is the base implementation for all HelixToolkit.SharpDX versions(WPF.SharpDX and UWP). It is implemented based on netstandard and can be used on other platforms such as WinForms and DotNetCore.
  • SharpDX.Assimp ports Assimp.Net into HelixToolkit to support 3D model import/export for HelixToolkit.SharpDX versions. Currently import/export supports SceneNode only. For more details, please refer to FileLoadDemo or CoreTest.

2018-10-19

V2.5.1 releases are available on nuget. Release Note

Hotfix: Wrong type cast causes null reference exception when uses custom ViewBox texture. (SharpDX Version Only)

Changes (Please refer to Release Note for details)

Note: 2.0 Breaking changes from version 1.x.x. (HelixToolkit.SharpDX only) see ChangeLog