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 models (Media3D namespace).

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

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

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

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

HelixToolkit.SharpDX.Core.Wpf: Wpf Wrapper Components based on HelixToolkit.SharpDX.Core for .NET Core Wpf.

HelixToolkit.WinUI: Custom 3D Engine and XAML/MVVM compatible Scene Graphs based on SharpDX(DirectX 11) for WinUI.

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

Project Build

Visual Studio 2019. Windows 10 SDK (Min Ver.10.0.18362.0).

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.

HelixToolkit Library Structure

WPF Internal 3D Engine (DirectX9)

graph TD
    wpf[WPF Framework] --> hxWpf[HelixToolkit.Wpf]
    wpf --> hxCoreWpf[HelixToolkit.Core.Wpf]

HelixToolkit DirectX11 Engine

graph TD
    hx[HelixToolkit] --> dx11[DirectX11 Engine]    
    dx11 --> hxSharpDX[HelixToolkit.Wpf.SharpDX]
    dx11 --> hxUWP[HelixToolkit.UWP]
    dx11 --> hxCore[HelixToolkit.SharpDX.Core]
    hxCore --> hxWinUI[HelixToolkit.SharpDX.Core.Wpf]
    hxCore --> hxSharpDXCoreWpf[HelixToolkit.WinUI]
    hxSharpDX --> hxAssimp[HelixToolkit.SharpDX.Assimp]
    hxUWP --> hxAssimp
    hxCore --> hxAssimp

Bug Report

Please use the following template to report bugs.

• Version: [Example: 2.20]
• Package: [Example: Helixtoolkit.Wpf]
• Issue:
• Reproduce Steps:
• Sample Code:

News

2024-02-27

v2.25.0 releases are available on nuget. Release Note

• WPF
• Core.WPF
• WPF.Input
• WPF.SharpDX
• UWP
• SharpDX.Core
• SharpDX.Core.Wpf
• WinUI
• SharpDX.Assimp

Changes (Please refer to Release Note for details)

2023-03-17

Nightly build myget feed link has been updated to: https://www.myget.org/F/helixtoolkit-nightly