HiAPI Packages and Sample Code

HiAPI is a C# software development kit for machining simulation. It provides libraries for NC motion simulation, collision detection, geometry removal simulation, milling force simulation, optimization, and more.

Nuget Packages

The HiAPI is applied by the form of Nuget Packages. You have to apply HiNc nuget package and its dependencies. They include all the functionality of the HiNC software, but do not include the GUI components.

The packages can be downloaded and installed from the HiAPI NuGet Server. The server URL is:

https://superhightech-gitea.webredirect.org/api/packages/HiAPI/nuget/index.json

Note

• Authentication is required to access the server. Register the feed and the account together with the single dotnet nuget add source command in Getting Started — the feed rejects anonymous requests, so a source declared without credentials gets a restore no further.
• Direct browser access to the URL will not show meaningful content. Since the server is designed for Visual Studio NuGet package management. For more information about NuGet, visit NuGet.org

Package Dependencies

The HiNc package has the following dependency chain:

graph LR
    HiGeom --> HiDisp
    HiDisp --> HiCbtr
    HiCbtr --> HiMech
    HiMech --> HiUniNc
    HiUniNc --> HiNc

    HiDisp --> Hi.WinForm
    HiDisp --> Hi.WpfPlus
        
    style HiNc fill:#d3d,stroke:#333,stroke-width:2px

UI Framework Support

If you need to develop Windows desktop applications:

• For Windows Forms applications, use the Hi.WinForm package.
• For WPF applications, use the Hi.WpfPlus package.

Note

See Building Your Own Rendering Canvas to build the rendering canvas cross-platform.

HiAPI Sample Code

Download the sample repositories below to get the samples. They demonstrate various aspects of using HiAPI for machining simulation:

• HiNC-2025-webservice
  • https://superhightech-gitea.webredirect.org/HiAPI/HiNC-2025-webservice.git
  • The source of the shipped HiNC application itself — a Quasar SPA served by ASP.NET Core. It is the production-scale example: every screen you see in the product is built from the public API documented here, and each component is dissected in HiNC App Anatomy.
• Hi.Sample
  • https://superhightech-gitea.webredirect.org/HiNC-Deploy/Hi.Sample.git
  • The repository generally contains the sample codes without using rendering canvas.
• Hi.Sample.Wpf
  • https://superhightech-gitea.webredirect.org/HiNC-Deploy/Hi.Sample.Wpf.git
  • The repository generally contains the sample code that requires rendering canvas.

See Also

• Getting Started with HiAPI — wiring this feed into a project and writing the first program against it
• Rendering — what the Hi.WinForm and Hi.WpfPlus packages above are for