HiAPI Documentation

Warning

🚧 Documentation Under Construction 🚧

The API Documentation is available and can be accessed via the "API Documentation" link in the navigation bar above. Other documentation sections are currently being updated. We appreciate your patience.

Welcome to the HiAPI documentation. This documentation provides comprehensive information about the HiAPI software development kit.

Introduction to HiAPI

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.

System Requirements

• Operating System:
  • Windows 10 or later
  • Ubuntu 22.04 LTS
• CPU Architecture: x64 (ARM not yet supported)
• Runtime: .NET 9.0 or later
• Memory (RAM):
  • Minimum: 8GB RAM (suitable for low-resolution models)
  • Recommended: 128GB RAM or higher (for large and detailed models)
• Graphics:
  • OpenGL 4.4 compatible graphics card or integrated graphics
  • Most computers manufactured within the last 15 years meet this requirement

Core Components

HiGeom - Geometric Computation

Provides fundamental 3D/2D geometric types and operations:

• Basic Types:

  • Vec2d - 2D vector/point
  • Vec3d - 3D vector/point
  • Box2d - 2D bounding box
  • Box3d - 3D bounding box
  • Tri3d - 3D triangle
  • DVec3d - Dual vector (point and normal)
  • Polar3d - 3D polar coordinates

• Utilities:

  • GeomUtil - Geometric computation utilities
  • Tri3dUtil - Triangle mesh generation utilities

HiDisp - Display System

OpenGL-based display and visualization management:

• Core Components:

  • DispEngine - Main display engine managing rendering thread and context
  • Drawing - Efficient elemental 3D rendering unit
  • Bind - Runtime data for rendering transformation and picking
  • Pickable - UI event management for rendered objects

• Display Types:

  • StringDrawing - Text rendering in 3D space
  • Various rendering primitives (points, lines, faces)

HiCbtr - High-Performance Geometry

High-performance geometry computation module based on CubeTree data structure:

• Core Components:

  • CubeTree - Main data structure for efficient geometry manipulation
  • NativeStl - Native STL format support
  • CachedTris - Feature-cached triangles for computation

• Features:

  • Real-time boolean operations (union, intersection, difference)
  • Volume removal and addition
  • Collision detection
  • Memory-efficient caching system

• Applications:

  • Machining simulation
  • Tool path verification
  • Real-time geometric modeling

HiMech - Mechanical Control

Mechanical control and motion planning:

• Core Components:
  • MillingCutter - Milling tool definition and management
  • SpanContourPos4d - Tool flute geometry
  • ISolidMachiningChain - Machining process interface

HiUniNc - Universal NC Control

Universal NC control interface:

• Core Components:
  • NcEnv - NC environment settings
  • NcLine - NC code line parsing
  • NcFlag - NC command flag definitions
  • NcProc - NC code processor

HiNc - NC Programming

NC programming and execution system.

License

HiAPI packages are provided 'as-is', without any express or implied warranty. Users must accept license agreements during installation. License files are shown during the installation process and are placed in the package folder.

Getting Started

To start using HiAPI, please refer to our Getting Started guide for installation instructions and next steps.

Support

For technical support, please visit Tech Coordinate or contact our support team.