IOViewer 0.2.0

<p align="center"> <img src="docs/images/ioviewer-banner.png" alt="IOViewer" width="640"> </p>

IOViewer

IOViewer is a fast, 100% managed .NET library and command line tool that generates standalone interactive 3D WebGL / HTML BIM & CAD model viewers from code, glTF/GLB, Wavefront OBJ, or JSON. Geometry read by sibling libraries (RvtIO, IfcIO, and NwcIO) can be passed in by building a ViewerDocument in code; IOViewer has no direct dependency on them.

The generated HTML is a single file with no external dependencies that works offline: it opens from disk (file://) in a current browser with WebGL 2 and makes no network requests. The viewer is built on three.js, which is embedded in the file (see THIRD-PARTY-NOTICES.md).

Built clean-room under the IOExtend organization.

What it does

• Writes one self-contained HTML file per model; the viewer, its styles and the model data are all inlined.
• Stores geometry once per shape: meshes can share a ViewerGeometry placed by a Transform3d, and the exporter also finds meshes that are exact translated copies of each other.
• Packs geometry compactly: positions quantized to 16-bit steps of 2⁻¹⁰ m (error at most 0.49 mm, 0.85 mm for rotated shared geometry; geometry larger than about 64 m, or shared geometry that an instance scales up, stays 32-bit float), octahedral 16-bit normals, 16- or 32-bit indices, all in one base64 block.
• Shifts coordinates relative to the model centre (RTC), so georeferenced models with coordinates around 10⁶ m do not jitter.
• Draws large models with few draw calls: geometry is merged into spatial chunks per material (very large models draw their repeated shapes as instanced copies instead), and hiding, selection and colouring are per-object data, so they never rebuild geometry.
• Viewer interface in Russian or English, chosen from the browser language:
  • model tree by category with search, a properties panel and a selected/total counter;
  • toolbar with labelled groups: navigation, sections, measure, display and view;
  • context menu: properties, hide, isolate, show all, zoom to object, section box around the object, copy Id;
  • view cube that follows the camera exactly, with face clicks, 90° arrows and a home button;
  • section planes (up to six, moved and rotated with an in-scene gizmo) or a section box (keep inside or cut inside, face handles, move by the centre, box around the selection);
  • point-to-point distance measurement, display modes (materials, textures, white, wireframe), grid lines and a global opacity slider;
  • saved viewpoints with a viewpoint tour, clash results, a 4D schedule player and linked-file visibility, each shown only when the document has that data.
• Imports binary glTF 2.0 (.glb), Wavefront OBJ (.obj), and JSON snapshots.

Mouse and keyboard

The model's up axis is +Z.

Install

Install the command line tool:

dotnet tool install --global IOViewer.Cli

Add the library to a .NET project:

dotnet add package IOViewer

The library targets .NET 8 and .NET 10. It uses managed code without native dependencies or Windows-only APIs and supports Windows, Linux, and macOS.

Command line

Generate standalone 3D HTML viewers from 3D models:

# Convert binary glTF 2.0 (GLB) to interactive HTML viewer
ioviewer model.glb -o viewer.html

# Convert Wavefront OBJ model to interactive HTML viewer
ioviewer model.obj -o viewer.html

# Convert and immediately preview in default web browser via built-in HTTP server
ioviewer model.glb --serve

Export structured JSON snapshots:

# Export model snapshot to structured JSON
ioviewer model.glb -o model.json

Diagnostics and progress go to standard error. Run ioviewer --help for the full list of options.

Library

Create a viewer document programmatically and export to HTML:

using IOViewer;
using IOViewer.Model;
using IOViewer.Exporters;

// Create viewer document
var doc = new ViewerDocument
{
    Title = "Commercial Building 3D Showcase",
    Author = "IOExtend"
};

// Add mesh geometry
var mesh = new ViewerMesh
{
    Id = 1,
    Name = "Curtain Wall Panel",
    Vertices = [new(0, 0, 0), new(3, 0, 0), new(3, 3, 0), new(0, 3, 0)],
    Indices = [0, 1, 2, 0, 2, 3],
    Color = new RgbaColor(100, 149, 237, 200),
    Opacity = 0.8
};
doc.Meshes.Add(mesh);

// Export to self-contained HTML
HtmlViewerExporter.Save(doc, "showcase.html", new HtmlViewerOptions
{
    Title = "Commercial Building 3D Showcase",
    IncludeProperties = true,
    IncludeViewpoints = true
});

Import a glTF / GLB model and convert to HTML viewer:

using IOViewer.Importers;
using IOViewer.Exporters;

// Load binary glTF 2.0 model
var doc = GlbViewerImporter.Load("complex_building.glb");

// Export to self-contained single-file HTML viewer
HtmlViewerExporter.Save(doc, "complex_building.html");

See the public API for the supported surface and getting started guide for detailed workflows.

Documentation

The documentation site with API references and guides is at https://ioextend.github.io/IOViewer/. offers an automatically generated overview of the repository.

Limitations

• The API can evolve before 1.0.
• Standalone HTML export generates self-contained files with all geometry inlined. IOViewer does not simplify meshes, so models with millions of triangles produce large files; reduce them before export.
• The binary geometry block is assembled in memory before it is written, so it must stay below 2 GB.
• HtmlViewerOptions.MaxMeshVertices is unlimited by default. When a lower limit cuts the model, the viewer shows a banner with the number of meshes written.
• The viewer needs WebGL 2; without it the page says so. If the browser drops the graphics context, the page shows a message asking to reload it.
• Transparent objects are sorted per chunk of merged geometry (or per cell of instanced copies), not per object, so overlapping transparent objects in the same chunk can blend in the wrong order.
• Section planes and section boxes stored in ViewerDocument are kept in JSON snapshots but are not applied by the HTML viewer when it opens.
• The OBJ importer reads geometry only; .mtl material files are not read.

Build from source and tests

Use the .NET SDK selected by global.json, which specifies 10.0.100 with latestFeature roll-forward and excludes prerelease SDKs.

From the repository root:

dotnet build IOViewer.slnx -c Release
dotnet test

The viewer page is built from src/IOViewer/Viewer with Node.js 24; see CONTRIBUTING.md. The built script dist/viewer.js is committed, so building the .NET solution does not need Node.js.

Contributing

See CONTRIBUTING.md and the Code of Conduct. Release changes are recorded in CHANGELOG.md.

Security

Report vulnerabilities through GitHub private vulnerability reporting in the repository's Security tab. Do not open public issues for security vulnerabilities. See SECURITY.md.

License and trademarks

IOViewer is licensed under the MIT License. Copyright holder: mahach666. The generated viewer embeds three.js (MIT); see THIRD-PARTY-NOTICES.md.

IOViewer is not affiliated with, endorsed by or sponsored by Autodesk. Autodesk, Revit, Navisworks, ViewCube and TimeLiner are trademarks of Autodesk, Inc. They are used here only to describe compatibility and familiar features. The viewer is written from scratch and includes no Autodesk code or binaries.