@pascal-app/viewer 1.0.6 → 1.1.0

package/dist/systems/roof/roof-materials.js

@@ -1,9 +1,9 @@
-import { findLevelBelowId, getEffectiveRoofSurfaceMaterial, getLevelElevations, parseMaterialRef, wallAssemblyFinishRef, } from '@pascal-app/core';
+import { findLevelBelowId, getEffectiveRoofSurfaceMaterial, getLevelElevations, getRoofWallBandMaterial, parseMaterialRef, wallAssemblyFinishRef, } from '@pascal-app/core';
 import { createMaterial, createSurfaceRoleMaterial, resolveMaterialRef, resolveSlotDefaultMaterial, } from '../../lib/materials';
 // Declared catalog defaults for an unpainted roof, per the 4-slot layout
 // (0 wall/trim · 1 deck · 2 interior soffit · 3 shingle top). The wall/trim
-// band mirrors the wall kind's default (WALL_SLOT_DEFAULT = concrete-drywall)
-// so a roof reads as continuous with the walls below it.
+// band is bare drywall, the wall faces' default before they took the interior
+// paint; over walls with a cladding it takes theirs (`levelWallCladdingRef`).
 const ROOF_DEFAULT_REFS = [
     'library:concrete-drywall',
     'library:preset-softwhite',
@@ -32,30 +32,12 @@ function createResolvedMaterial(material, materialPreset, sceneMaterials, shadin
     }
     return null;
 }
-/**
- * The cladding the walls under a roof declare through their ASSEMBLIES
- * (`wall.assembly.exterior.finish` → catalog ref), so the roof's gable band —
- * the triangle of wall above the plate that the roof kind builds — is skinned
- * like the walls it sits on instead of the bare drywall default. The walls are
- * the roof's level's, or for a roof on a level of its own (a building's roof
- * level), the storey's directly below. The most common ref among them wins;
- * null when none declares one.
- */
-export function levelWallCladdingRef(nodes, roof) {
-    const levelId = roof.parentId;
-    if (!levelId)
-        return null;
-    const wallsOn = (id) => Object.values(nodes).filter((node) => node?.type === 'wall' && node.parentId === id);
-    const own = wallsOn(levelId);
-    const walls = own.length
-        ? own
-        : wallsOn(findLevelBelowId(levelId, getLevelElevations(nodes)));
+/** The most common ref, the first seen winning a tie; null when there is none. */
+function mostCommonRef(refs) {
     const counts = new Map();
-    for (const wall of walls) {
-        const ref = wallAssemblyFinishRef(wall);
+    for (const ref of refs)
         if (ref)
             counts.set(ref, (counts.get(ref) ?? 0) + 1);
-    }
     let best = null;
     let bestCount = 0;
     for (const [ref, count] of counts) {
@@ -66,18 +48,77 @@ export function levelWallCladdingRef(nodes, roof) {
     }
     return best;
 }
+// Every roof and segment renderer reads these on each store change: one scan per
+// level per nodes snapshot, shared by all of them.
+const levelWallRefsCache = new WeakMap();
+function levelWallRefs(nodes, levelId) {
+    let byLevel = levelWallRefsCache.get(nodes);
+    if (!byLevel) {
+        byLevel = new Map();
+        levelWallRefsCache.set(nodes, byLevel);
+    }
+    const cached = byLevel.get(levelId);
+    if (cached)
+        return cached;
+    const wallsOn = (id) => Object.values(nodes).filter((node) => node?.type === 'wall' && node.parentId === id);
+    const own = wallsOn(levelId);
+    const walls = own.length
+        ? own
+        : wallsOn(findLevelBelowId(levelId, getLevelElevations(nodes)));
+    const refs = {
+        cladding: mostCommonRef(walls.map((wall) => wallAssemblyFinishRef(wall))),
+        face: mostCommonRef(walls.map((wall) => {
+            // Face a is the front (+normal) side; an unresolved wall's exterior is face b.
+            const exterior = wall.frontSide === 'exterior' && wall.backSide !== 'exterior' ? 'a' : 'b';
+            const painted = wall.slots?.[exterior];
+            return typeof painted === 'string' ? painted : wallAssemblyFinishRef(wall);
+        })),
+    };
+    byLevel.set(levelId, refs);
+    return refs;
+}
+/**
+ * The cladding the walls under a roof declare through their ASSEMBLIES
+ * (`wall.assembly.exterior.finish` → catalog ref), so the roof's gable band —
+ * the triangle of wall above the plate that the roof kind builds — is skinned
+ * like the walls it sits on instead of the bare drywall default. The walls are
+ * the roof's level's, or for a roof on a level of its own (a building's roof
+ * level), the storey's directly below. The most common ref among them wins;
+ * null when none declares one.
+ */
+export function levelWallCladdingRef(nodes, roof) {
+    return roof.parentId ? levelWallRefs(nodes, roof.parentId).cladding : null;
+}
+/**
+ * What the walls under a roof show outside, for the heel band — the strip of
+ * wall between their top plate and the eaves, which is wall, not trim: their
+ * exterior face's paint, else the cladding their assembly declares
+ * (`levelWallCladdingRef`'s walls). The most common wins; null when none has
+ * either.
+ */
+export function levelWallFaceRef(nodes, roof) {
+    return roof.parentId ? levelWallRefs(nodes, roof.parentId).face : null;
+}
 export function getRoofMaterialArray(node, shading = 'rendered', textures = true, colorPreset = 'clay', sceneTheme, 
 /** Catalog ref for the gable/trim band when unpainted — see `levelWallCladdingRef`. */
-wallCladdingRef = null, sceneMaterials) {
+wallCladdingRef = null, sceneMaterials, 
+/** Catalog ref for the heel band when unpainted — see `levelWallFaceRef`. */
+wallFaceRef = null) {
     const top = getEffectiveRoofSurfaceMaterial(node, 'top');
     const edge = getEffectiveRoofSurfaceMaterial(node, 'edge');
     const wall = getEffectiveRoofSurfaceMaterial(node, 'wall');
+    const heel = getRoofWallBandMaterial(node, 'heel') ?? {
+        material: undefined,
+        materialPreset: undefined,
+    };
     const cacheKey = JSON.stringify({
         shading,
         textures,
         colorPreset,
         sceneTheme,
         wallCladdingRef,
+        wallFaceRef,
+        heel: getSurfaceMaterialSignature(heel, sceneMaterials),
         top: getSurfaceMaterialSignature(top, sceneMaterials),
         edge: getSurfaceMaterialSignature(edge, sceneMaterials),
         wall: getSurfaceMaterialSignature(wall, sceneMaterials),
@@ -95,6 +136,10 @@ wallCladdingRef = null, sceneMaterials) {
         ceilingMaterial,
         ceilingMaterial,
         roofMaterial,
+        // The bands drew in the wall/trim slot before they had slots of their own.
+        roofMaterial,
+        roofMaterial,
+        roofMaterial,
     ];
     // Textures-off (monochrome) is the guaranteed escape hatch: themed role
     // colours, no catalog finishes.
@@ -106,6 +151,7 @@ wallCladdingRef = null, sceneMaterials) {
     const topMaterial = resolve(top);
     const edgeMaterial = resolve(edge);
     const wallMaterial = resolve(wall);
+    const heelMaterial = resolve(heel);
     // Each slot resolves to its own role only, then the declared default — never
     // another role. Cross-role fallback here used to splatter a single painted
     // surface (e.g. the edge) across the shingle and soffit slots. The legacy
@@ -113,11 +159,24 @@ wallCladdingRef = null, sceneMaterials) {
     // returns it for top/edge/wall alike.
     // Resolve an unpainted slot's catalog default lazily: painted roofs must
     // not load unused finish assets (or make capture readiness depend on them).
+    const trimDefaultRef = wallCladdingRef ?? ROOF_DEFAULT_REFS[0];
+    const trim = edgeMaterial ?? resolveSlotDefaultMaterial(trimDefaultRef, shading);
+    // The heel band is wall: unpainted, it follows the walls below, never the gable / fascia
+    // trim. A roof with no edge paint over walls with no face paint draws it exactly as it did
+    // when the band was part of the wall/trim slot — the very same material.
+    const heelDefaultRef = wallFaceRef ?? trimDefaultRef;
+    const heelSlot = heelMaterial ??
+        (!edgeMaterial && heelDefaultRef === trimDefaultRef
+            ? trim
+            : resolveSlotDefaultMaterial(heelDefaultRef, shading));
     const materialArray = [
-        edgeMaterial ?? resolveSlotDefaultMaterial(wallCladdingRef ?? ROOF_DEFAULT_REFS[0], shading),
+        trim,
         wallMaterial ?? resolveSlotDefaultMaterial(ROOF_DEFAULT_REFS[1], shading),
         wallMaterial ?? resolveSlotDefaultMaterial(ROOF_DEFAULT_REFS[2], shading),
         topMaterial ?? resolveSlotDefaultMaterial(ROOF_DEFAULT_REFS[3], shading),
+        heelSlot,
+        trim,
+        trim,
     ];
     roofMaterialArrayCache.set(cacheKey, materialArray);
     return materialArray;

package/dist/systems/roof/roof-system.d.ts

@@ -49,15 +49,48 @@ export declare function mapRoofGroupMaterialIndex(groupMaterialIndex: number | u
  * same trim, in the same segment-local frame.
  */
 export declare function clipGeometryBySegmentTrim(geometry: THREE.BufferGeometry | null, segment: RoofSegmentNode): THREE.BufferGeometry | null;
+/**
+ * How deep a roof plane's deck opens under its sheathing while the viewer shows the frame
+ * (`useViewer.framingShown`), square to the slope: the structure its layers name
+ * (`roofStructureDepth`: its rafters, or its trusses' top chords on their heel), else Bones' default
+ * 2x6. A deck no deeper keeps its top 7/16 in; a plane finished underneath (a cathedral ceiling)
+ * stays closed, the frame hidden behind its finish, and so does a form `FRAMING_OPEN_ROOF_TYPES`
+ * leaves out. 0 when nothing opens.
+ */
+export declare function roofFramingDepth(node: RoofSegmentNode): number;
 /**
  * `fascia`: build the segment's fascia boards into its deck. Only the roof
  * renderer asks; a dormer, a chimney or a sibling's clip takes the bare shell.
+ * `framing`: the structure band to open (`roofFramingDepth`), the roof
+ * renderer's while the frame is shown. Inside the walls the deck keeps only the
+ * band over it, so the rafters show from the attic; over the walls and in the
+ * overhangs it stays whole, closing the band at the walls' inner faces.
  */
 export declare function getRoofSegmentBrushes(node: RoofSegmentNode, options?: {
     fascia?: boolean;
+    framing?: number;
 }): RoofSegmentBrushSet | null;
-export declare function generateRoofSegmentGeometry(node: RoofSegmentNode, nodes?: Record<string, AnyNode>): THREE.BufferGeometry;
+/**
+ * `framing`: the frame is shown (`useViewer.framingShown`), so the deck opens its structure band
+ * (`roofFramingDepth`). Only the roof system asks; a picture of the plan or a section takes the
+ * closed deck.
+ */
+export declare function generateRoofSegmentGeometry(node: RoofSegmentNode, nodes?: Record<string, AnyNode>, options?: {
+    framing?: boolean;
+}): THREE.BufferGeometry;
 export declare function clipDirectRoofGeometryAgainstSiblings(geometry: THREE.BufferGeometry, node: RoofSegmentNode, nodes: Record<string, AnyNode>, space: 'roof' | 'segment'): THREE.BufferGeometry;
+type WallBandSegment = {
+    node: RoofSegmentNode;
+    /** Geometry space → segment-local (identity for a segment's own mesh). */
+    inverse: THREE.Matrix4 | null;
+};
+/**
+ * Split the wall bands off slot 0 (see `ROOF_HEEL_MATERIAL_INDEX`): the heel
+ * band always, each gable end when `gables` (a segment's own mesh, where they
+ * paint apart; on the merged shell they stay the edge role's). Runs on the
+ * finished shell, after every slot remap that folds indices back into 0–3.
+ */
+export declare function splitRoofWallBandFaces(geometry: THREE.BufferGeometry, segments: readonly WallBandSegment[], gables: boolean): void;
 export declare function remapRoofShellFaces(geometry: THREE.BufferGeometry, node: RoofSegmentNode): void;
 export type SurfaceFrame = {
     point: THREE.Vector3;

package/dist/systems/roof/roof-system.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"roof-system.d.ts","sourceRoot":"","sources":["../../../src/systems/roof/roof-system.tsx"],"names":[],"mappings":"AAAA,OAAO,EACL,KAAK,OAAO,EA6BZ,KAAK,eAAe,EAQrB,MAAM,kBAAkB,CAAA;AAEzB,OAAO,KAAK,KAAK,MAAM,OAAO,CAAA;AAE9B,OAAO,EAAY,KAAK,EAA0B,MAAM,eAAe,CAAA;AA4JvE;;;;;GAKG;AACH,wBAAgB,wBAAwB,IAAI,MAAM,CAIjD;AAED,wBAAgB,sBAAsB,CACpC,OAAO,EAAE,QAAQ,CAAC,MAAM,CAAC,EACzB,OAAO,EAAE,CAAC,EAAE,EAAE,MAAM,KAAK,KAAK,CAAC,QAAQ,GAAG,SAAS,GAClD,MAAM,CAIR;AAiFD,0EAA0E;AAC1E,MAAM,MAAM,mBAAmB,GAAG;IAChC,YAAY,EAAE,CAAC,IAAI,EAAE,eAAe,EAAE,IAAI,EAAE,KAAK,CAAC,IAAI,KAAK,IAAI,CAAA;CAChE,CAAA;AAED,eAAO,MAAM,UAAU,yBAAyB;IAAE,eAAe,CAAC,EAAE,mBAAmB,CAAA;CAAE,SA0JxF,CAAA;AAqbD;;;;;;;GAOG;AACH,eAAO,MAAM,gBAAgB,EAAE;IAC7B,KAAK,CAAC,iBAAiB;IACvB,KAAK,CAAC,iBAAiB;IACvB,KAAK,CAAC,iBAAiB;IACvB,KAAK,CAAC,iBAAiB;CAMxB,CAAA;AAID,eAAO,MAAM,wBAAwB,IAAI,CAAA;AAEzC,KAAK,mBAAmB,GAAG;IACzB,QAAQ,EAAE,KAAK,CAAA;IACf,QAAQ,EAAE,KAAK,CAAA;IACf,SAAS,EAAE,KAAK,CAAA;IAChB,UAAU,EAAE,KAAK,CAAA;IACjB,UAAU,EAAE,KAAK,CAAC,cAAc,GAAG,IAAI,CAAA;CACxC,CAAA;AA4FD,wBAAgB,yBAAyB,CACvC,kBAAkB,EAAE,MAAM,GAAG,SAAS,EACtC,YAAY,EAAE,KAAK,CAAC,QAAQ,EAAE,EAC9B,UAAU,EAAE,GAAG,CAAC,KAAK,CAAC,QAAQ,EAAE,MAAM,CAAC,GACtC,MAAM,CAuBR;AA4XD;;;;;;;;GAQG;AACH,wBAAgB,yBAAyB,CACvC,QAAQ,EAAE,KAAK,CAAC,cAAc,GAAG,IAAI,EACrC,OAAO,EAAE,eAAe,GACvB,KAAK,CAAC,cAAc,GAAG,IAAI,CAgC7B;AAuHD;;;GAGG;AACH,wBAAgB,qBAAqB,CACnC,IAAI,EAAE,eAAe,EACrB,OAAO,GAAE;IAAE,MAAM,CAAC,EAAE,OAAO,CAAA;CAAO,GACjC,mBAAmB,GAAG,IAAI,CA4V5B;AAkFD,wBAAgB,2BAA2B,CACzC,IAAI,EAAE,eAAe,EACrB,KAAK,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAC9B,KAAK,CAAC,cAAc,CA8GtB;AAED,wBAAgB,qCAAqC,CACnD,QAAQ,EAAE,KAAK,CAAC,cAAc,EAC9B,IAAI,EAAE,eAAe,EACrB,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAC9B,KAAK,EAAE,MAAM,GAAG,SAAS,GACxB,KAAK,CAAC,cAAc,CAiCtB;AA+vCD,wBAAgB,mBAAmB,CAAC,QAAQ,EAAE,KAAK,CAAC,cAAc,EAAE,IAAI,EAAE,eAAe,QA0ExF;AAirBD,MAAM,MAAM,YAAY,GAAG;IACzB,KAAK,EAAE,KAAK,CAAC,OAAO,CAAA;IACpB,MAAM,EAAE,KAAK,CAAC,OAAO,CAAA;CACtB,CAAA;AAED;;;;GAIG;AACH,wBAAgB,+BAA+B,CAC7C,OAAO,EAAE,eAAe,EACxB,EAAE,EAAE,MAAM,EACV,EAAE,EAAE,MAAM,GACT,YAAY,CA+Ld"}
+{"version":3,"file":"roof-system.d.ts","sourceRoot":"","sources":["../../../src/systems/roof/roof-system.tsx"],"names":[],"mappings":"AAAA,OAAO,EACL,KAAK,OAAO,EAgCZ,KAAK,eAAe,EAUrB,MAAM,kBAAkB,CAAA;AAGzB,OAAO,KAAK,KAAK,MAAM,OAAO,CAAA;AAE9B,OAAO,EAAY,KAAK,EAA0B,MAAM,eAAe,CAAA;AAmKvE;;;;;GAKG;AACH,wBAAgB,wBAAwB,IAAI,MAAM,CAIjD;AAED,wBAAgB,sBAAsB,CACpC,OAAO,EAAE,QAAQ,CAAC,MAAM,CAAC,EACzB,OAAO,EAAE,CAAC,EAAE,EAAE,MAAM,KAAK,KAAK,CAAC,QAAQ,GAAG,SAAS,GAClD,MAAM,CAIR;AAiFD,0EAA0E;AAC1E,MAAM,MAAM,mBAAmB,GAAG;IAChC,YAAY,EAAE,CAAC,IAAI,EAAE,eAAe,EAAE,IAAI,EAAE,KAAK,CAAC,IAAI,KAAK,IAAI,CAAA;CAChE,CAAA;AAED,eAAO,MAAM,UAAU,yBAAyB;IAAE,eAAe,CAAC,EAAE,mBAAmB,CAAA;CAAE,SA6KxF,CAAA;AAmeD;;;;;;;GAOG;AACH,eAAO,MAAM,gBAAgB,EAAE;IAC7B,KAAK,CAAC,iBAAiB;IACvB,KAAK,CAAC,iBAAiB;IACvB,KAAK,CAAC,iBAAiB;IACvB,KAAK,CAAC,iBAAiB;CAMxB,CAAA;AAID,eAAO,MAAM,wBAAwB,IAAI,CAAA;AAEzC,KAAK,mBAAmB,GAAG;IACzB,QAAQ,EAAE,KAAK,CAAA;IACf,QAAQ,EAAE,KAAK,CAAA;IACf,SAAS,EAAE,KAAK,CAAA;IAChB,UAAU,EAAE,KAAK,CAAA;IACjB,UAAU,EAAE,KAAK,CAAC,cAAc,GAAG,IAAI,CAAA;CACxC,CAAA;AA8FD,wBAAgB,yBAAyB,CACvC,kBAAkB,EAAE,MAAM,GAAG,SAAS,EACtC,YAAY,EAAE,KAAK,CAAC,QAAQ,EAAE,EAC9B,UAAU,EAAE,GAAG,CAAC,KAAK,CAAC,QAAQ,EAAE,MAAM,CAAC,GACtC,MAAM,CAuBR;AA4XD;;;;;;;;GAQG;AACH,wBAAgB,yBAAyB,CACvC,QAAQ,EAAE,KAAK,CAAC,cAAc,GAAG,IAAI,EACrC,OAAO,EAAE,eAAe,GACvB,KAAK,CAAC,cAAc,GAAG,IAAI,CAgC7B;AAiUD;;;;;;;GAOG;AACH,wBAAgB,gBAAgB,CAAC,IAAI,EAAE,eAAe,GAAG,MAAM,CAO9D;AAED;;;;;;;GAOG;AACH,wBAAgB,qBAAqB,CACnC,IAAI,EAAE,eAAe,EACrB,OAAO,GAAE;IAAE,MAAM,CAAC,EAAE,OAAO,CAAC;IAAC,OAAO,CAAC,EAAE,MAAM,CAAA;CAAO,GACnD,mBAAmB,GAAG,IAAI,CA8b5B;AAkFD;;;;GAIG;AACH,wBAAgB,2BAA2B,CACzC,IAAI,EAAE,eAAe,EACrB,KAAK,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAC/B,OAAO,GAAE;IAAE,OAAO,CAAC,EAAE,OAAO,CAAA;CAAO,GAClC,KAAK,CAAC,cAAc,CA0HtB;AAED,wBAAgB,qCAAqC,CACnD,QAAQ,EAAE,KAAK,CAAC,cAAc,EAC9B,IAAI,EAAE,eAAe,EACrB,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAC9B,KAAK,EAAE,MAAM,GAAG,SAAS,GACxB,KAAK,CAAC,cAAc,CAiCtB;AAkwCD,KAAK,eAAe,GAAG;IACrB,IAAI,EAAE,eAAe,CAAA;IACrB,0EAA0E;IAC1E,OAAO,EAAE,KAAK,CAAC,OAAO,GAAG,IAAI,CAAA;CAC9B,CAAA;AA+CD;;;;;GAKG;AACH,wBAAgB,sBAAsB,CACpC,QAAQ,EAAE,KAAK,CAAC,cAAc,EAC9B,QAAQ,EAAE,SAAS,eAAe,EAAE,EACpC,MAAM,EAAE,OAAO,QA8DhB;AAED,wBAAgB,mBAAmB,CAAC,QAAQ,EAAE,KAAK,CAAC,cAAc,EAAE,IAAI,EAAE,eAAe,QA0ExF;AAirBD,MAAM,MAAM,YAAY,GAAG;IACzB,KAAK,EAAE,KAAK,CAAC,OAAO,CAAA;IACpB,MAAM,EAAE,KAAK,CAAC,OAAO,CAAA;CACtB,CAAA;AAED;;;;GAIG;AACH,wBAAgB,+BAA+B,CAC7C,OAAO,EAAE,eAAe,EACxB,EAAE,EAAE,MAAM,EACV,EAAE,EAAE,MAAM,GACT,YAAY,CA+Ld"}