Expand description
Opt-in appearance authoring over an effective IFC snapshot. No load-time geometry changes. Plans are applied atomically by the host mutation editor.
Structs§
- Annotation
Plane Frame - Annotation
Plane Plan - Annotation
Plane Request - Appearance
Catalog - Appearance
Catalog Product - Appearance
Catalog Request - Appearance
Catalog Type - Appearance
Conversion - Appearance
Generated Image - Appearance
Item - Appearance
Item Image - Appearance
Plan - Appearance
Raster - Offset into the separately supplied top-down, straight-alpha RGBA8 payload.
- Appearance
Request - Appearance
Source Raster - Calibrated
Plane - Captured
Mesh - Explicit segmented surface, not a point cloud or an inferred BIM class.
- Captured
Mesh Plan - Captured
Mesh Request - Correspondence
Residual - Created
Entity - Exclusion
- Face
Mask - Ascending or unordered source triangle ordinals of one product’s evaluated surface. A stale fingerprint is an explicit exclusion, never a silent reuse.
- Mesh
Transfer Plan - Mesh
Transfer Request - Mesh
Transfer Summary - Page
Appearance Plan - Page
Appearance Request - PdfFill
Annotation Plan - PdfFill
Annotation Request - PdfFill
Region - Plane
Calibration Request - Positional
Edit - Registration
Frame - Registration
Residuals - Registration
Spread - Scan
Correspondence - Scan
Registration Report - Scan
Registration Request - Transfer
Budget Report - Work actually charged against the fixed transfer budget, so a plan’s cost is auditable next to its coverage (#4381).
- Transfer
Coverage - Transfer
Frame - Transfer
Item Coverage - Transfer
Point Payload - Binary point payload accompanying a
TransferSource::Pointsrequest. Positions are source-frame metres; colors are RGB8;normals(3n f32, oriented) andstations(n indices intoviewpoints) are empty when absent. - Transfer
Source Mesh - Transfer
Source Points - Transfer
Source Summary - Which capture kind and orientation source produced a plan (#4381).
Enums§
- Mapping
- Mapping
Frame - Point
Orientation - Which side a point-cloud sample faces. Every plan records the source it used so the “no nearest-Gaussian shortcut” rule stays auditable (#4381).
- Representation
Policy - Transfer
Source - One registered capture: a textured mesh or an RGB point cloud.
Functions§
- calibrate_
appearance_ plane - Establish one measured similarity transform for the whole source, then derive the current raster’s world rectangle. A crop/rotation/DPI change only changes raster_to_source and raster_size; it never recalibrates the measured span. This computes placement only, not clipped projection or IFC mutations.
- catalog_
appearance - Build class/type selectors without geometry or a TypeScript overlay policy. Input must already contain effective host edits. All IDs are model-local. A refusal returns no partial catalogue; caller validates sourceRevision.
- plan_
annotation_ plane - Create one bounded textured annotation through the shared native product planner.
- plan_
appearance schemamust come from the host’s validated parser;nextExpressIdis its reserved allocator watermark, strictly greater than every effective-source id. Images must already have a model-owned, collision-free relative filename. Returned UVs describe an UNSPLIT canonical item; fragment consumers must remap source corners or refuse a mismatched vertex count, never truncate UV arrays.- plan_
captured_ mesh - Author a bounded existing captured surface as IfcBuildingElementProxy. Decoding, reconstruction, classification and image ownership stay with callers.
- plan_
mesh_ transfer - Textured mesh source.
rgbacarries the source image and the target’s existing rasters; a point source is refused here. - plan_
page_ appearance - Finite page composition shares target appearance preservation, charts and canonical IFC image/material planning with other surface samplers.
- plan_
pdf_ fill_ annotation - Create opaque polygonal fill pages through canonical product authoring and geometry. An exact page converts as is; a page with visible unsupported content converts only when the request quotes its fidelity report digest, and the omissions are recorded with the annotation. Raster-only pages and geometric qualification failures refuse the whole page.
- plan_
pdf_ fill_ annotation_ with_ clip - Plan an annotation from an optional registered rectangle in native PDF space without changing the source-compatible request struct.
- plan_
point_ transfer - RGB point-cloud source (#4381).
rgbacarries only the target’s existing rasters; positions, colours and optional normals/stations arrive inpoints. - register_
scan_ correspondences - Pure fit in declared metre frames. The host must verify source bytes/frame revisions before using this report and must not promote it to an accuracy verdict without independently selected and spatially distributed checks.