IOScene 0.1.0

There is a newer version of this package available.
See the version list below for details.
dotnet add package IOScene --version 0.1.0
                    
NuGet\Install-Package IOScene -Version 0.1.0
                    
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="IOScene" Version="0.1.0" />
                    
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="IOScene" Version="0.1.0" />
                    
Directory.Packages.props
<PackageReference Include="IOScene" />
                    
Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.
paket add IOScene --version 0.1.0
                    
#r "nuget: IOScene, 0.1.0"
                    
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
#:package IOScene@0.1.0
                    
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package.
#addin nuget:?package=IOScene&version=0.1.0
                    
Install as a Cake Addin
#tool nuget:?package=IOScene&version=0.1.0
                    
Install as a Cake Tool

IOScene

IOScene

NuGet Release License: MIT Platform

IOScene is a neutral scene model for tessellated BIM and CAD data, with a JSON file format and a structural validator. It is the shared contract between the readers of source formats and the tools that show or check a model: a reader turns its own model into a SceneDocument, and a viewer, a clash tool or a writer of another format takes it from there. The package is pure managed .NET (8 and 10) and has no dependencies.

Built clean-room under the IOExtend organization.

Status: stable (0.1). The model is specified in docs/contract.md and changes only as its section 5 describes: a 0.1.x patch adds or fixes, and a breaking change waits for 0.2.0. Packages outside IOExtend are supported from IOScene 1.0; until then the supported route is a scene file.

What is in a scene

  • Elements in a flat list with a parent link, a source id and an optional IFC GlobalId; an element may have no geometry.
  • Geometry stored once and placed by instances with an affine transform; triangles, lines and points, indexed or not.
  • Materials with colour, roughness, metalness and an optional texture.
  • Typed property values with a display string, a number in SI units and a stable key; property sets are shared by id.
  • Models (source files and links), levels, grids, saved viewpoints, 4D schedules and clash results.
  • SceneJson reads and writes the file ("Kind": "ioscene", "Format": 1), and Validate() checks the structure.

Everything is in metres, right-handed, Z up, in one coordinate space per document.

A scene holds what a viewer or a coordination tool shows, filters, measures or tests. It is not an authoring model: parametric geometry, B-rep and type objects stay in the source formats' own libraries, and no source file is rebuilt from a scene.

Install

dotnet add package IOScene

A package that depends on IOScene references one 0.x line, because a 0.x minor release may break the API and a patch release never does. For the line 0.N the range is [0.N.0, 0.N+1.0-0); the -0 keeps out the previews of the next line:

<PackageReference Include="IOScene" Version="[0.1.0, 0.2.0-0)" />

dotnet pack of a stable package reports NU5104 for this range, because its upper bound 0.2.0-0 is a prerelease version; add <NoWarn>$(NoWarn);NU5104</NoWarn> to the referencing project.

Quick start

One mesh into a scene file:

using IOScene;

var scene = new SceneDocument { Title = "Quad" };
scene.AddMesh(
    "Quad",
    [new(0, 0, 0), new(1, 0, 0), new(1, 1, 0), new(0, 1, 0)],
    [0, 1, 2, 0, 2, 3],
    new RgbaColor(200, 80, 80));

foreach (var issue in scene.Validate())
    Console.WriteLine($"{issue.Severity} {issue.Code}: {issue.Message}");

SceneJson.Save(scene, "quad.json");

AddMesh creates the model, the geometry, the element and the instance that links them. A reader of a real format fills the same lists directly: Models, Geometries, Elements, Instances, PropertySets and the rest. SceneJson.Load brings the file back. SceneJson.Write and SceneJson.Read work on streams and on JSON text.

Documentation

License

MIT, see LICENSE.

Product Compatible and additional computed target framework versions.
.NET net8.0 is compatible.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed.  net9.0 was computed.  net9.0-android was computed.  net9.0-browser was computed.  net9.0-ios was computed.  net9.0-maccatalyst was computed.  net9.0-macos was computed.  net9.0-tvos was computed.  net9.0-windows was computed.  net10.0 is compatible.  net10.0-android was computed.  net10.0-browser was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-macos was computed.  net10.0-tvos was computed.  net10.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.
  • net10.0

    • No dependencies.
  • net8.0

    • No dependencies.

NuGet packages (7)

Showing the top 5 NuGet packages that depend on IOScene:

Package Downloads
RvtIO.Scene

Turns a Revit project read by RvtIO into an IOScene scene document.

NwcIO.Scene

Turns a Navisworks model read by NwcIO into an IOScene scene document in metres: the selection tree, element GUIDs and IFC GlobalIds, property tabs, geometry with instancing, file colours and Revit levels and grids.

IOViewer

Fast, pure managed .NET library and CLI tool for generating standalone interactive 3D WebGL/HTML BIM & CAD model viewers with no external dependencies that work offline.

IfcIO.Scene

Converts IFC models read by IfcIO into IOScene documents in metres with Z up, keeping GlobalIds, storeys, property sets, quantities and 4D schedules.

IOScene.Formats

GLB and OBJ import and export for IOScene models.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last Updated
0.1.2 439 11/19/2026
0.1.1 626 11/13/2026
0.1.0 2,247 11/13/2026
0.1.0-preview.2 94 11/12/2026