IGESLoader is a modern TypeScript-native IGES file loader for Three.js.

[!WARNING] This package is currently in active development and may not be stable. Use with caution.

[!NOTE] Currently, only a limited number of 'entity' types are parsed (mainly to be able to display points/lines/curves).

Features

✨ TypeScript Native - Written in TypeScript with full type definitions
📦 Modern ESM/CJS - Dual package format with tree-shaking support
🔧 Fully Typed - Complete type safety for all IGES entities
⚡ Fast - Optimized build with tsup and modern tooling
🧪 Well Tested - Comprehensive test suite with Vitest

Install

pnpm add three-iges-loader three

Or using npm:

npm install three-iges-loader three

Or using yarn:

yarn add three-iges-loader three

Usage

JavaScript

import * as THREE from "three";
import { IGESLoader } from "three-iges-loader";

const loader = new IGESLoader();

const iges_file_path = "/file.iges";

loader.load(
  // resource URL
  iges_file_path,
  // called when load is complete
  function (object) {
    sceneGeometry.add(object);
  },
  // called when loading is in progress
  function (xhr) {
    console.log((xhr.loaded / xhr.total) * 100 + "% loaded");
  },
  // called when loading has errors
  function (error) {
    console.log("Error: " + error);
  }
);

TypeScript

import * as THREE from "three";
import { IGESLoader } from "three-iges-loader";

const scene = new THREE.Scene();
const loader = new IGESLoader();

loader.load(
  "/path/to/file.iges",
  (geometry: THREE.Group) => {
    scene.add(geometry);
  },
  (xhr: ProgressEvent) => {
    console.log(`${(xhr.loaded / xhr.total) * 100}% loaded`);
  },
  (error: Error | ErrorEvent) => {
    console.error("Error loading IGES file:", error);
  }
);

Advanced Usage

import { IGESLoader, type IGESData } from "three-iges-loader";
import * as THREE from "three";

// With loading manager
const manager = new THREE.LoadingManager();
const loader = new IGESLoader(manager);

// Parse from string
const igesContent = "..."; // IGES file content as string
const geometry = loader.parse(igesContent);
scene.add(geometry);

Development

Prerequisites

• Node.js >= 18.0.0
• pnpm (recommended) or npm

Setup

# Install dependencies
pnpm install

# Build the library
pnpm build

# Run tests
pnpm test

# Run tests in watch mode
pnpm test:watch

# Type check
pnpm type-check

# Lint and format
pnpm lint
pnpm format

Running the Example

The package includes a modern Vite-based example:

# Start the development server
pnpm dev:example

# Build the example
pnpm build:example

Then open http://localhost:3000 in your browser.

API Reference

IGESLoader

Constructor

new IGESLoader(manager?: THREE.LoadingManager)

Methods

load(url, onLoad, onProgress?, onError?)

Load an IGES file from a URL.

• url: string - The URL or path to the IGES file
• onLoad: (geometry: THREE.Group) => void - Callback when loading is complete
• onProgress?: (event: ProgressEvent) => void - Callback for loading progress
• onError?: (event: ErrorEvent | Error) => void - Callback when an error occurs

parse(data)

Parse IGES file content.

• data: string - The IGES file content as string
• Returns: THREE.Group - A Three.js Group containing the parsed geometry

Type Exports

import type { EntityAttribute, EntityParam, IGESData } from "three-iges-loader";

Supported IGES Entities

Currently supported entity types:

• ✅ 100 - Circular Arc
• ✅ 106 - Copious Data / Linear Path / Witness Line / Simple Closed Planar Curve
• ✅ 110 - Line
• ✅ 116 - Point
• ✅ 126 - Rational B-Spline Curve
• 🚧 102 - Composite Curve (TODO)
• 🚧 108 - Plane (TODO)
• 🚧 120 - Surface of Revolution (TODO)
• 🚧 122 - Tabulated Cylinder (TODO)
• 🚧 124 - Transformation Matrix (TODO)
• 🚧 128 - Rational B-Spline Surface (TODO)
• 🚧 142 - Curve on Parametric Surface (TODO)
• 🚧 144 - Trimmed Parametric Surface (TODO)

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

1. Fork the repository
2. Create your feature branch (git checkout -b feature/amazing-feature)
3. Commit your changes (git commit -m 'Add some amazing feature')
4. Push to the branch (git push origin feature/amazing-feature)
5. Open a Pull Request

License

MIT © Alex Marinov

Acknowledgments

• Based on the original work by Alex Marinov
• Maintained by Konsept Design
• Built with Three.js

Resources

• IGES File Specification
• IGES Version 5.3 Specification
• IGES Version 6.0 Specification
• IGES on Wikipedia

Author

Alex Marinov - Konsept Design Limited