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://gitea.superhightech.com.tw/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

    style HiNc fill:#d3d,stroke:#333,stroke-width:2px

UI Framework Support

There is no UI package. The packages above are framework-independent, and the on-screen component that hosts DispEngine belongs to your application — on any toolkit, Windows Forms and WPF included.

Releases up to HiNc 3.2.31 offered two ready-made canvases, Hi.WinForm and Hi.WpfPlus. Both were retired and are no longer published. A project still referencing one has to keep the rest of the package set at 3.2.31 as well: the canvases are not rebuilt against newer packages, 3.2.35 removed and reshaped HiGeom members they were compiled against, and they cannot load beside a HiGeom in which vec3d_t replaces the class vector.

Note

Building Your Own Rendering Canvas walks through the whole implementation and keeps a frozen copy of both retired canvases as a worked reference. The shipped HiNC application's own canvas — the production-scale example — is in the HiNC-2025-webservice repository listed below.

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://gitea.superhightech.com.tw/HiAPI/HiNC-2025-webservice.git
  • The source of the HiNC web service, the application at the heart of HiNC — a Quasar SPA served by ASP.NET Core. It is the production-scale example: every screen of it is built from the public API documented here, and each component is dissected in HiNC App Anatomy. The installed HiNC on Windows is this application hosted by a product host of its own, which adds the installation's data folder and its self-update (Hosting from another project).
• Hi.Sample
  • https://gitea.superhightech.com.tw/HiNC-Deploy/Hi.Sample.git
  • The repository generally contains the sample codes without using rendering canvas.

See Also

• Getting Started with HiAPI — wiring this feed into a project and writing the first program against it
• Rendering — putting what these packages produce on screen, in a canvas your application owns