Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,9 @@ and the project follows [Semantic Versioning](https://semver.org/spec/v2.0.0.htm

## [Unreleased]

### Changed
- `docs/keys.md`: the namespace `nwc:` is registered for `NwcIO.Scene`; its formats are fixed from the first release of the package, 0.12.0. The `nwc` source format names `NwcIO.Scene` as its producer.

## [0.1.1] - 2026-11-13

### Fixed
Expand Down
16 changes: 14 additions & 2 deletions docs/keys.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,8 +31,9 @@ This file is the registry of the namespaces, of their key formats and of the `Sc
|---|---|---|
| `revit:` | `RvtIO.Scene` | registered; the formats below are fixed from the first release of the package, 0.4.0 |
| `ifc:` | `IfcIO.Scene` | registered; the formats below are fixed from the first release of the package, 0.11.1 |
| `nwc:` | `NwcIO.Scene` | registered; the formats below are fixed from the first release of the package, 0.12.0 |

No other namespace is registered. Producers for NWC, DWG and other formats register theirs when they are written.
No other namespace is registered. Producers for DWG and other formats register theirs when they are written.

### `revit:`

Expand All @@ -55,6 +56,17 @@ registered when `RvtIO.Scene` first writes them; that is an addition.
The property sets of an IFC type object, when they are read, use the same `ifc:` key form and come after the
occurrence sets.

### `nwc:`

| Key | Used on | Meaning |
|---|---|---|
| `nwc:<TabInternalName>` | property set | A Navisworks property tab by its internal name, for tabs whose internal name the Revit exporter fixes: `nwc:LcRevitData_Element`, `nwc:LcRevitData_Type`, `nwc:LcRevitMaterialProperties`, and `nwc:LcRevitId` (the element id). |
| `nwc:<TabInternalName>.<InternalName>` | property | A property of such a tab by its internal name, for names that do not change with language or a renamed parameter: built-in Revit parameters `lcldrevit_parameter_-<id>` (`nwc:LcRevitData_Element.lcldrevit_parameter_-1001107`), the exporter's `LcRevitPropertyElement{Category,CategoryId,Family,Id,Name,Type}`, Revit material asset names `revit_<Identifier>` (letters, digits and underscore) except `revit_mat_cust_prop_*`, and `LcRevitId`. |

Other tabs and properties (references to other elements, rooms, and parameters whose internal name the exporter derives
from their display name, and custom material properties `revit_mat_cust_prop_*`) have no key. Keys for them are registered when `NwcIO.Scene` first writes them; that is an
addition.

## `SourceFormat` values

`SceneModel.SourceFormat` is the registered id of the format of the content, not of the container: `ifc` covers
Expand All @@ -64,7 +76,7 @@ occurrence sets.
|---|---|---|
| `rvt` | Revit project | `RvtIO.Scene` |
| `ifc` | IFC STEP file, also zipped (`.ifczip`) | `IfcIO.Scene` |
| `nwc` | Navisworks cache | `NwcIO.Scene` (later) |
| `nwc` | Navisworks cache | `NwcIO.Scene` |
| `dwg` | DWG drawing | `DwgIO.Scene` (later) |
| `glb` | binary glTF | `IOScene.Formats` (later) |
| `obj` | Wavefront OBJ | `IOScene.Formats` (later) |
Expand Down
Loading