Helix Toolkit

https://docs.helix-toolkit.org/en/latest/
Admin
Helix Toolkit is a 3D library for .NET, providing tools for WPF and WPF + SharpDX applications.
Tokens:4,303
Snippets:5
Trust Score:7
Update:1 year ago
Show doc for...
Tokens:
Raw
### Add HelixViewport3D Control with Content

Source: https://docs.helix-toolkit.org/en/latest/wpf/getting-started

This snippet demonstrates adding a `HelixViewport3D` control to your XAML, including essential elements like lighting and a sample `GeometryModel3D`. It configures the viewport to zoom to extents when loaded.

```XAML
<HelixToolkit:HelixViewport3D ZoomExtentsWhenLoaded="True">
    <!-- Remember to add light to the scene -->
    <HelixToolkit:SunLight/>
    <ModelVisual3D>
        <ModelVisual3D.Content>
            <GeometryModel3D>
                <GeometryModel3D.Geometry>
                    <MeshGeometry3D x:Name="meshMain"
                        Positions="0 0 0  1 0 0  0 1 0  1 1 0  0 0 1  1 0 1  0 1 1  1 1 1"
                        TriangleIndices="2 3 1  2 1 0  7 1 3  7 5 1  6 5 7  6 4 5  6 2 0  2 0 4  2 7 3  2 6 7  0 1 5  0 5 4">
                    </MeshGeometry3D>
                </GeometryModel3D.Geometry>
                <GeometryModel3D.Material>
                    <DiffuseMaterial x:Name="matDiffuseMain">
                        <DiffuseMaterial.Brush>
                            <SolidColorBrush Color="Gray"/>
                        </DiffuseMaterial.Brush>
                    </DiffuseMaterial>
                </GeometryModel3D.Material>
            </GeometryModel3D>
        </ModelVisual3D.Content>
    </ModelVisual3D>
    <HelixToolkit:GridLinesVisual3D Width="8" Length="8" MinorDistance="1" MajorDistance="1" Thickness="0.01"/>
</HelixToolkit:HelixViewport3D>

```

--------------------------------

### Add Helix Toolkit Namespace to XAML

Source: https://docs.helix-toolkit.org/en/latest/wpf/getting-started

This snippet shows how to declare the Helix Toolkit namespace in your XAML window. This is a prerequisite for using Helix Toolkit controls in your WPF application.

```XAML
<Window x:Class="YourNamespace.MainWindow"
        xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
        xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
        xmlns:d="http://schemas.microsoft.com/expression/blend/2008"
        xmlns:mc="http://schemas.openxmlformats.org/markup-compatibility/2006"
        xmlns:HelixToolkit="clr-namespace:HelixToolkit.Wpf;assembly=HelixToolkit.Wpf"
        xmlns:local="clr-namespace:YourNamespace"
        mc:Ignorable="d"
        Title="MainWindow" Height="350" Width="525">


```

--------------------------------

### Clone Helix Toolkit Repository using Git

Source: https://docs.helix-toolkit.org/en/latest/contribute/build

This command clones the Helix Toolkit source code repository from GitHub. It requires Git to be installed on your system. The output is the complete source code of the project.

```git
git clone https://github.com/helix-toolkit/helix-toolkit.git
```

--------------------------------

### Helix Toolkit Git Workflow

Source: https://docs.helix-toolkit.org/en/latest/contribute/contributions

This section details the essential Git commands and workflow for contributing to the Helix Toolkit project. It covers forking the repository, cloning it locally, creating feature branches, making changes, committing them, rebasing against the main development branch, and pushing the changes to create a pull request.

```git
git clone https://github.com/yourusername/helix-toolkit.git
```

```git
git branch bugfix-some-error
```

```git
git checkout bugfix-some-error
```

```git
git commit -m <msg>
```

```git
git push
```

--------------------------------

### MIT License Text

Source: https://docs.helix-toolkit.org/en/latest/introduction/license

The complete text of the MIT License as applied to the Helix Toolkit project. This license grants broad permissions for use, modification, and distribution, requiring only the preservation of copyright and license notices.

```text
The MIT License (MIT)

Copyright (c) 2012 Helix TOolkit contributors

Permission is hereby granted, free of charge, to any person obtaining a
copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so, subject to
the following conditions:

The above copyright notice and this permission notice shall be included
in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

```
Tokens:
Raw