openbim-ifc
Facade for the openBIM IFC crates: pick codecs and domains as features.
| Status | Implemented |
| Latest release | 0.42.0 (2026-11-09) |
| Registries | crates.io openbim-ifc |
| API documentation | rustdoc · docs.rs |
| Source | crates/openbim-ifc/ |
Overview
ifc — the facade. Pick your codecs and domains as cargo features.
Features
| Feature | Default | What it enables |
|---|---|---|
alignment | ifc-alignment: IFC4x3 linear positioning: alignments, referents, linear placement, spirals. | |
approval | ifc-approval: Bounded IFC4 approval resource semantics. | |
author | Schema-checked authoring (authoring) with every bundled release (schema). | |
authoring | Schema-checked authoring (ifc-author) and the checked authoring batch (apply_authoring), against the releases the build names; with properties, numbers read in SI (apply_authoring_with). | |
classification | ifc-classification: Classification systems, document references, libraries, external references. | |
codecs | Both codecs: STEP and ifcXML. | |
colour | The surface colour of each product's Body (product_colours): the item's styled item, its styled presentation layer, else its material's styled representation (layer, profile and constituent sets resolved per item), with the source and a typed refusal; and what decides it, a material also while unstyled (ColourResolver::product_decider). Kernel-free. | |
constraint | ifc-constraint: Bounded IFC4 metric, objective, and constraint relationships. | |
control | ifc-control: Bounded IFC control semantics: permits, project orders, action requests, and performance history. | |
cost | ifc-cost: Cost semantics as a borrowed view over the IFC model. | |
domains | Every domain view, plus authoring and spatial traversal. | |
element-type | ifc-element-type: Element, resource, and process type definitions: the IfcTypeObject catalogue. | |
full | Everything: codecs and ifcZIP, schema tables, every domain, catalogues, geometry and meshes, georeferencing and alignment. | |
geometry | Representation selection plus lowering into the neutral geometry DAG. | |
geometry-select | Representation selection only: contexts, plan/body choice, placements and units, with no geometry kernel. | |
geometry-wire | Each product's Body as Axiolid's neutral geometry graph (product_graphs), exact and in world metres, encodable in Axiolid's versioned wire format (1.0; 1.1 where a station carries a seam-snapping window, 1.2 where a run's sections do, 1.3 where an offset run continues to a basis end the kernel measures, 1.4 where a polygonal bounded half-space clips) as JSON or CBOR (ifc::geometry::wire); a typed refusal per product. Computes nothing; adds the lowering and serde. | |
georef | ifc-georef: Georeferencing: map conversion, coordinate reference systems, site placement. | |
ifc2x3 | The schema API with the bundled IFC2X3 TC1 table. | |
ifc4 | The schema API with the bundled IFC4 ADD2 TC1 table. | |
ifc4x1 | The schema API with the bundled IFC4X1 FINAL table. | |
ifc4x2 | The schema API with the bundled IFC4X2 FINAL table. | |
ifc4x3 | The schema API with the bundled IFC4X3 ADD2 table. | |
ifcxml | ifc-xml: ifcXML (ISO 10303-28) codec for the IFC model. | |
js-random | Random GlobalIds (new_guid) and batch seeds (fresh_seed) on wasm32-unknown-unknown from the JavaScript host's crypto.getRandomValues; without it both refuse there; native targets always have them. | |
material | Material views (ifc-material): layer sets, profile sets, constituents, usage; together with geometry-select, each layered wall's, slab's or plate's material layer bounds in its object frame (material_layer_bounds), and with mesh its Body split into one mesh per layer (material_layer_meshes). | |
material-templates | Material views together with the property template catalogue. | |
mesh | Triangle meshes per product (product_meshes, product_meshes_for a representation purpose, with solid or surface closure) and polylines of curve representations (product_curves: Axis, FootPrint, annotation curves, each with a certified chord bound) through ifc-geometry's reference compile backend: positions relative to each product's world placement, its surface colour (colour), a typed refusal per product. Opt-in; links an execution provider (ADR 0004, ADR 0012). | |
occurrence | ifc-occurrence: Built element and distribution occurrence classes and their type pairing. | |
properties | Property sets, quantities and unit resolution (ifc-properties); together with geometry-select, door and window operation geometry; together with spatial, element properties by spatial container; together with style, a material's cut fill as hatch line families in metres and radians (material_fill, material_fills, material_fills_by_context, material_fill_for_view, fill_area_style, FillResolver). | |
property-catalog | The PSD/QTO template catalogue (ifc-template-catalog), every edition embedded. | |
property-catalog-runtime | The PSD/QTO template catalogue installed at runtime from pinned per-edition snapshot files; nothing embedded. | |
resource | ifc-resource: Construction resources: labour, equipment, material, crew, subcontract. | |
schedule | ifc-schedule: IFC scheduling: IfcTask/IfcWorkSchedule, sequencing, 4D linkage. | |
schema | The schema API with every bundled release (IFC2X3, IFC4, IFC4X1, IFC4X2, IFC4X3). | |
schema-api | The schema API without a bundled release; implied by each release feature. | |
selector | The selector query language (ifc::selector, grammar 1.0): filter elements by class, GlobalId, attribute, property, type, material, classification, location and group, with typed parse errors carrying byte spans; read and write values by path (type.Name, Pset_WallCommon.FireRating) through a checked transaction. Property facets need properties too. | |
sheet | Tables of values by path (ifc::sheet, #474): export selected entities by attribute, property, quantity and relation paths as CSV or TSV, and import a table back by GlobalId or id as one checked transaction, with a planned diff and typed refusals by row and column. | |
sheet-xlsx | sheet with XLSX workbooks too, through the pure-Rust rust_xlsxwriter (write) and calamine (read) crates. | |
spatial | ifc-spatial: IFC spatial containment and objectified relationship traversal: project, site, building, storey, element. | |
step | yes | ifc-step: STEP physical file (ISO 10303-21) codec for the IFC model. |
structural | ifc-structural: Structural analysis model: members, connections, actions, reactions, loads. | |
style | ifc-style: Presentation: styles, colours, textures, layers, annotation. | |
systems | ifc-systems: Distribution systems, ports, and connectivity between elements. | |
tabular | ifc-tabular: Structured IFC value containers indexed by position or time. | |
validate | ifc-validate: Schema conformance: WHERE rules, cardinality, GUID and reference integrity. | |
validate-express | Validation (validate) with the EXPRESS rule evaluator (ifc::validate::express): every WHERE rule, type rule and global rule of a release, evaluated from the .exp text the caller supplies (#461). | |
zip | ifcZIP (ifc::ifczip, ifc::ifczip::IfcZipCodec): read an archive holding one STEP or ifcXML model within a decompression budget, and write one; Stored and Deflate only, through the pure-Rust zip and flate2 (miniz_oxide) crates. |
Depends on
ifc-alignmentifc-approvalifc-authorifc-classificationifc-constraintifc-controlifc-costifc-element-typeifc-geometryifc-georefifc-materialifc-modelifc-occurrenceifc-propertiesifc-resourceifc-scheduleifc-schemaifc-spatialifc-stepifc-structuralifc-styleifc-systemsifc-tabularifc-template-catalogifc-validateifc-xml
Changes
Latest release, 0.42.0 (2026-11-09):
Fixed (#610)
product_meshestriangle order is deterministic:axiolid-mesh-compile0.3.44 flips Delaunay edges deterministically (axiolid/kernel#425), so a product's mesh no longer differs from call to call or between a subset and the whole model. Floor raised to 0.3.44.
Changed (#705)
material_layer_boundsandmaterial_layer_meshesaccept a layered Body of several coaxial extrusions, such as a wall interrupted at a crossing (seeifc-geometry).
Changed (#706)
- Breaking:
MaterialLayerMeshespositions are now in the object frameboundsis stated in, whatever the representation context'sWorldCoordinateSystem, andMaterialLayerMeshes::worldis the Body's full frame (the context frame above the product's placement), soworldapplied to a position is still its world position. Results for an identity context frame are unchanged; with another one, positions no longer carry the context frame andworldincludes it.
Added (#709)
History::rollback(re-exported fromifc-model): undoes the newest entry and drops it, leaving nothing to redo.
Semver: minor (additive).
Changed (#603)
- Breaking:
ColourResolverreports the colour that all materials of a layer, profile or constituent set state asColourSource::MaterialSet { definition, materials }naming the set (IfcMaterialLayerSet,IfcMaterialProfileSet,IfcMaterialConstituentSetorIfcMaterialList, or a usage of one (IfcMaterialLayerSetUsage,IfcMaterialProfileSetUsageand itsTapering)) and the materials of the set that colour the item: every one, or the constituents its shape aspects name (ascending id, distinct), instead ofMaterialof the first. A set of one material keepsMaterial; differing styles stayColourError::AmbiguousMaterial.ColourSourceandSurfaceColourare no longerCopy(ifc-style).
Semver: minor (pre-1.0 breaking).
Fixed (#695)
georeferencingno longer answers an empty list when the reader's damage may have hidden what its presence gate scans. After a lenient read, a skipped record or a diagnostic the reader's classification cannot place refuses withGeorefError::RecordsIncompletebehind either gate (the IFC2X3 property-set test and the IFC4 operation scan), and a reported duplicate of a property set the IFC2X3 gate reads refuses withGeorefError::RecordDamaged. Clean models and damage elsewhere still resolve to an empty list.
Added (#636)
AuthorOp::ReassignClassreassigns type objects (IfcTypeObjecttoIfcTypeObject).ReassignClassOptions::move_pairs: where the new class's type rule does not accept the other end of a type assignment, that end is reassigned too (an occurrence's type to the class its rule names, a type's unsatisfied occurrences to the class that type pairs with), each inReassignReport::paired. Classes pair by rule owner (IfcWall.CorrectTypeAssignedwithIfcWallType), checked against the normative EXPRESS.AuthoringFailure::TypeNotAccepted,PairNotReassigned. IFC2X3 declares no type rules; nothing is paired there.
Changed (#636)
TypeRuleChangedis raised only when the new class's type rule differs from the old class's and the type object's class is not the type class the new rule requires.RemovedRelationship::objectnames the object taken out of the relationship: the reassigned entity, or, for a type object reassigned withremove_relationships, the occurrence whose type assignment was detached.- A
move_pairsoccurrence whose class the schema does not declare, or that no type class pairs with, is refused withPairNotReassigned(causeUnsupportedReassignment).
Added (#635)
ReassignClassOptions::remove_relationships: a reassignment takes the entity out of the relationships the new class cannot hold (WrongReferenceType,RelationshipLost,TypeRuleChanged) asAuthorOp::Removedetaches.ReassignReport::removed_relationshipslists each (RemovedRelationship,RelationshipConflict). OnlyIfcRelationships are touched;InverseCardinalityis still refused; a removal that leaves another entity below a mandatory inverse (an opening'sVoidsElements) is refused withAuthoringFailure::RelationshipRequired.
Added (#661)
- With
geometry-select:BodyItem::swept_diskandSweptDisk: radius, inner radius, fillet radius, directrix and authoredStartParam/EndParamofIfcSweptDiskSolidandIfcSweptDiskSolidPolygonal, in the item frame.
Changed (#661)
- With
geometry-select: a swept disk with a non-positive radius, a bore at least its radius, a half-open range or a non-positive fillet now refusesbody_description.
Semver: minor.
Fixed (#670)
AuthorOp::ReassignClassno longer treatsIfcEvent.CorrectTypeAssignedas a type rule: it checksEventTriggerType, not the type object, so a typed object reassigned toIfcEventis not refused withTypeRuleChanged.
Semver: patch (refusals narrowed).
Full history: crates/openbim-ifc/CHANGELOG.md