BCF Workflows in Bonsai

Version: Bonsai v0.8.x | Blender 4.2.0+ | Python 3.11 Module path: bonsai.bim.module.bcf — NEVER blenderbim.bim.module.bcf BCF versions: v2.1 and v3.0 (via bcf.bcfxml library bundled with IfcOpenShell) Dependencies: bonsai-core-architecture, bonsai-syntax-elements

Critical Warnings

1. ALWAYS set scene.BCFProperties.author to a valid email BEFORE creating topics or comments. Default "john@doe.com" is a placeholder — replace it.
2. ALWAYS use BcfStore.get_bcfxml() to access BCF data. NEVER access BcfStore.bcfxml directly — get_bcfxml() handles lazy initialization and path resolution.
3. ALWAYS call bpy.ops.bim.save_bcf_project() to persist changes. BCF modifications are in-memory only until saved.
4. NEVER mix BCF v2.1 and v3.0 operations on the same project. The version is set at creation/load time and MUST remain consistent.
5. ALWAYS ensure an active camera exists before calling bpy.ops.bim.add_bcf_viewpoint(). The operator polls for an active scene camera.
6. NEVER assume viewpoint coordinates match the loaded IFC model coordinates. Viewpoint activation applies georeference offset corrections.
7. ALWAYS use bonsai.* imports. NEVER use blenderbim.* — renamed in 2024 (v0.8.0+).
8. BCF v3.0 REQUIRES non-empty status and type fields on topics. These are optional in v2.1 but mandatory in v3.0.