Skip to main content

Module appearance

Module appearance 

Source
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§

AnnotationPlaneFrame
AnnotationPlanePlan
AnnotationPlaneRequest
AppearanceCatalog
AppearanceCatalogProduct
AppearanceCatalogRequest
AppearanceCatalogType
AppearanceConversion
AppearanceGeneratedImage
AppearanceItem
AppearanceItemImage
AppearancePlan
AppearanceRaster
Offset into the separately supplied top-down, straight-alpha RGBA8 payload.
AppearanceRequest
AppearanceSourceRaster
CalibratedPlane
CapturedMesh
Explicit segmented surface, not a point cloud or an inferred BIM class.
CapturedMeshPlan
CapturedMeshRequest
CorrespondenceResidual
CreatedEntity
Exclusion
MeshTransferPlan
MeshTransferRequest
MeshTransferSummary
PageAppearancePlan
PageAppearanceRequest
PdfFillAnnotationPlan
PdfFillAnnotationRequest
PdfFillRegion
PlaneCalibrationRequest
PositionalEdit
RegistrationFrame
RegistrationResiduals
RegistrationSpread
ScanCorrespondence
ScanRegistrationReport
ScanRegistrationRequest
TransferCoverage
TransferFrame
TransferItemCoverage
TransferSourceMesh

Enums§

Mapping
MappingFrame
RepresentationPolicy

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
schema must come from the host’s validated parser; nextExpressId is 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
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 complete opaque polygonal fill pages through canonical product authoring and geometry. Unsupported visible semantics refuse the whole page.
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.