Skip to content

openbim-ifc ​

Facade for the openBIM IFC crates: pick codecs and domains as features.

StatusImplemented
Latest release0.42.0 (2026-11-09)
Registriescrates.io openbim-ifc
API documentationrustdoc · docs.rs
Sourcecrates/openbim-ifc/

Overview ​

ifc — the facade. Pick your codecs and domains as cargo features.

Features ​

FeatureDefaultWhat it enables
alignmentifc-alignment: IFC4x3 linear positioning: alignments, referents, linear placement, spirals.
approvalifc-approval: Bounded IFC4 approval resource semantics.
authorSchema-checked authoring (authoring) with every bundled release (schema).
authoringSchema-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).
classificationifc-classification: Classification systems, document references, libraries, external references.
codecsBoth codecs: STEP and ifcXML.
colourThe 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.
constraintifc-constraint: Bounded IFC4 metric, objective, and constraint relationships.
controlifc-control: Bounded IFC control semantics: permits, project orders, action requests, and performance history.
costifc-cost: Cost semantics as a borrowed view over the IFC model.
domainsEvery domain view, plus authoring and spatial traversal.
element-typeifc-element-type: Element, resource, and process type definitions: the IfcTypeObject catalogue.
fullEverything: codecs and ifcZIP, schema tables, every domain, catalogues, geometry and meshes, georeferencing and alignment.
geometryRepresentation selection plus lowering into the neutral geometry DAG.
geometry-selectRepresentation selection only: contexts, plan/body choice, placements and units, with no geometry kernel.
geometry-wireEach 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.
georefifc-georef: Georeferencing: map conversion, coordinate reference systems, site placement.
ifc2x3The schema API with the bundled IFC2X3 TC1 table.
ifc4The schema API with the bundled IFC4 ADD2 TC1 table.
ifc4x1The schema API with the bundled IFC4X1 FINAL table.
ifc4x2The schema API with the bundled IFC4X2 FINAL table.
ifc4x3The schema API with the bundled IFC4X3 ADD2 table.
ifcxmlifc-xml: ifcXML (ISO 10303-28) codec for the IFC model.
js-randomRandom 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.
materialMaterial 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-templatesMaterial views together with the property template catalogue.
meshTriangle 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).
occurrenceifc-occurrence: Built element and distribution occurrence classes and their type pairing.
propertiesProperty 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-catalogThe PSD/QTO template catalogue (ifc-template-catalog), every edition embedded.
property-catalog-runtimeThe PSD/QTO template catalogue installed at runtime from pinned per-edition snapshot files; nothing embedded.
resourceifc-resource: Construction resources: labour, equipment, material, crew, subcontract.
scheduleifc-schedule: IFC scheduling: IfcTask/IfcWorkSchedule, sequencing, 4D linkage.
schemaThe schema API with every bundled release (IFC2X3, IFC4, IFC4X1, IFC4X2, IFC4X3).
schema-apiThe schema API without a bundled release; implied by each release feature.
selectorThe 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.
sheetTables 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-xlsxsheet with XLSX workbooks too, through the pure-Rust rust_xlsxwriter (write) and calamine (read) crates.
spatialifc-spatial: IFC spatial containment and objectified relationship traversal: project, site, building, storey, element.
stepyesifc-step: STEP physical file (ISO 10303-21) codec for the IFC model.
structuralifc-structural: Structural analysis model: members, connections, actions, reactions, loads.
styleifc-style: Presentation: styles, colours, textures, layers, annotation.
systemsifc-systems: Distribution systems, ports, and connectivity between elements.
tabularifc-tabular: Structured IFC value containers indexed by position or time.
validateifc-validate: Schema conformance: WHERE rules, cardinality, GUID and reference integrity.
validate-expressValidation (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).
zipifcZIP (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 ​

Changes ​

Latest release, 0.42.0 (2026-11-09):

Fixed (#610) ​

  • product_meshes triangle order is deterministic: axiolid-mesh-compile 0.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_bounds and material_layer_meshes accept a layered Body of several coaxial extrusions, such as a wall interrupted at a crossing (see ifc-geometry).

Changed (#706) ​

  • Breaking: MaterialLayerMeshes positions are now in the object frame bounds is stated in, whatever the representation context's WorldCoordinateSystem, and MaterialLayerMeshes::world is the Body's full frame (the context frame above the product's placement), so world applied 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 and world includes it.

Added (#709) ​

  • History::rollback (re-exported from ifc-model): undoes the newest entry and drops it, leaving nothing to redo.

Semver: minor (additive).

Changed (#603) ​

  • Breaking: ColourResolver reports the colour that all materials of a layer, profile or constituent set state as ColourSource::MaterialSet { definition, materials } naming the set (IfcMaterialLayerSet, IfcMaterialProfileSet, IfcMaterialConstituentSet or IfcMaterialList, or a usage of one (IfcMaterialLayerSetUsage, IfcMaterialProfileSetUsage and its Tapering)) and the materials of the set that colour the item: every one, or the constituents its shape aspects name (ascending id, distinct), instead of Material of the first. A set of one material keeps Material; differing styles stay ColourError::AmbiguousMaterial. ColourSource and SurfaceColour are no longer Copy (ifc-style).

Semver: minor (pre-1.0 breaking).

Fixed (#695) ​

  • georeferencing no 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 with GeorefError::RecordsIncomplete behind 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 with GeorefError::RecordDamaged. Clean models and damage elsewhere still resolve to an empty list.

Added (#636) ​

  • AuthorOp::ReassignClass reassigns type objects (IfcTypeObject to IfcTypeObject). 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 in ReassignReport::paired. Classes pair by rule owner (IfcWall.CorrectTypeAssigned with IfcWallType), checked against the normative EXPRESS. AuthoringFailure::TypeNotAccepted, PairNotReassigned. IFC2X3 declares no type rules; nothing is paired there.

Changed (#636) ​

  • TypeRuleChanged is 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::object names the object taken out of the relationship: the reassigned entity, or, for a type object reassigned with remove_relationships, the occurrence whose type assignment was detached.
  • A move_pairs occurrence whose class the schema does not declare, or that no type class pairs with, is refused with PairNotReassigned (cause UnsupportedReassignment).

Added (#635) ​

  • ReassignClassOptions::remove_relationships: a reassignment takes the entity out of the relationships the new class cannot hold (WrongReferenceType, RelationshipLost, TypeRuleChanged) as AuthorOp::Remove detaches. ReassignReport::removed_relationships lists each (RemovedRelationship, RelationshipConflict). Only IfcRelationships are touched; InverseCardinality is still refused; a removal that leaves another entity below a mandatory inverse (an opening's VoidsElements) is refused with AuthoringFailure::RelationshipRequired.

Added (#661) ​

  • With geometry-select: BodyItem::swept_disk and SweptDisk: radius, inner radius, fillet radius, directrix and authored StartParam/EndParam of IfcSweptDiskSolid and IfcSweptDiskSolidPolygonal, 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 refuses body_description.

Semver: minor.

Fixed (#670) ​

  • AuthorOp::ReassignClass no longer treats IfcEvent.CorrectTypeAssigned as a type rule: it checks EventTriggerType, not the type object, so a typed object reassigned to IfcEvent is not refused with TypeRuleChanged.

Semver: patch (refusals narrowed).

Full history: crates/openbim-ifc/CHANGELOG.md

Dual-licensed under AGPL-3.0-or-later or a commercial licence. ISO and CEN standards material is not redistributed.