@jfk-solutions/demo3d-file-format 1.5.0 → 1.7.0

package/dist/three/index.js

@@ -1,5 +1,6 @@
-import { Demo3DConveyorSideProperties, Demo3DDimensionAspect, Demo3DDimensionPoint, Demo3DExtrusionPolygon, Demo3DExtrusionProfile, Demo3DMaterial, Demo3DMesh, Demo3DPackage, Demo3DProject, Demo3DPhotoEye, Demo3DResource, Demo3DSupportStand, Demo3DVisual } from "../model.js";
+import { Demo3DConveyorSideProperties, Demo3DDimensionAspect, Demo3DDimensionPoint, Demo3DExtrusionPolygon, Demo3DExtrusionProfile, Demo3DMaterial, Demo3DMesh, Demo3DPackage, Demo3DPointCloud, Demo3DProject, Demo3DPhotoEye, Demo3DResource, Demo3DSupportStand, Demo3DVisual } from "../model.js";
 import { Demo3DBinaryBlock, Demo3DXmlElement } from "../xml.js";
+export { createRaw3DThreeGroup, createRaw3DThreeScene, decodeRaw3DThreeGeometry } from "./raw3d.js";
 export { createDemo3DThreeRenderer } from "./renderer.js";
 export async function createDemo3DThreeScene(parsed, options = {}) {
     const three = await resolveThree(options);
@@ -88,6 +89,7 @@ export function decodeDemo3DThreeGeometry(mesh, three) {
     if (mesh.indices) {
         geometry.setIndex(new three.BufferAttribute(readIndexBuffer(mesh.indices, mesh.indexFormat), 1));
     }
+    addMeshSubsetGroups(geometry, mesh);
     convertTriangleGeometryToThreeCoordinates(geometry);
     if (!normals) {
         geometry.computeVertexNormals();
@@ -96,6 +98,25 @@ export function decodeDemo3DThreeGeometry(mesh, three) {
     geometry.computeBoundingSphere();
     return geometry;
 }
+function addMeshSubsetGroups(geometry, mesh) {
+    const subsets = mesh.auxiliary?.toUint8Array();
+    const drawCount = geometry.getIndex()?.count ?? geometry.getAttribute("position").count;
+    const faceCount = Math.floor(drawCount / 3);
+    if (!subsets || subsets.length !== faceCount || faceCount === 0) {
+        return;
+    }
+    let runStart = 0;
+    let materialIndex = subsets[0] ?? 0;
+    for (let face = 1; face <= faceCount; face += 1) {
+        const nextMaterialIndex = face < faceCount ? subsets[face] : undefined;
+        if (face < faceCount && nextMaterialIndex === materialIndex) {
+            continue;
+        }
+        geometry.addGroup(runStart * 3, (face - runStart) * 3, materialIndex);
+        runStart = face;
+        materialIndex = nextMaterialIndex ?? 0;
+    }
+}
 export function createDemo3DThreeMaterial(material, three) {
     const diffuse = material?.diffuse;
     const color = diffuse === undefined ? 0x9aa0a6 : demo3dColorToHex(diffuse);
@@ -126,6 +147,7 @@ function createState(three, project, options, buffers) {
         options,
         warnings: [],
         meshById: new Map(project.meshes.flatMap((mesh) => (mesh.id ? [[mesh.id, mesh]] : []))),
+        pointCloudById: new Map(project.pointClouds.flatMap((pointCloud) => pointCloud.id ? [[pointCloud.id, pointCloud]] : [])),
         serializedObjectById: indexSerializedObjects(project),
         textureImageById: indexTextureImages(project),
         drawingBlockById: indexDrawingBlocks(project),
@@ -161,6 +183,7 @@ function createState(three, project, options, buffers) {
             unreconstructedProceduralVisuals: 0,
             imageVisuals: 0,
             lights: 0,
+            pointClouds: 0,
             missingGeometryPlaceholders: 0,
             serializedRenderables: 0,
             unsupported: 0
@@ -192,7 +215,7 @@ function createVisualObject(visual, state, inheritedLayer, parentVisual) {
         meshes.push(directVisualObject);
     }
     for (const ref of refs) {
-        const mesh = createMeshObject(ref, visual, visual.materials[0], state);
+        const mesh = createMeshObject(ref, visual, visual.materials, state);
         if (mesh) {
             if (mesh.userData.demo3d?.kind === "missing-geometry-placeholder") {
                 placeholderObjects.push(mesh);
@@ -281,11 +304,13 @@ function createAspectRenderableObjects(visual, state) {
         for (const renderable of renderables.children) {
             const meshIds = findMeshReferenceIds(renderable);
             for (const meshId of meshIds) {
-                const material = firstMaterial(renderable) ?? visual.materials[0];
+                const serializedMaterials = renderableMaterials(renderable);
+                const materials = serializedMaterials.length > 0 ? serializedMaterials : visual.materials;
+                const primaryMaterial = materials[0];
                 const mesh = state.meshById.has(meshId)
-                    ? createMeshObject(meshId, renderable, material, state)
-                    : createPrimitiveRenderableObject(aspect, renderable, meshId, material, state) ??
-                        createMeshObject(meshId, renderable, material, state);
+                    ? createMeshObject(meshId, renderable, materials, state)
+                    : createPrimitiveRenderableObject(aspect, renderable, meshId, primaryMaterial, state) ??
+                        createMeshObject(meshId, renderable, materials, state);
                 if (!mesh) {
                     continue;
                 }
@@ -381,6 +406,9 @@ function createDirectVisualObject(visual, state, parentVisual) {
     if (visual.typeName === "e3d:ImportedImageVisual") {
         return createImportedImageObject(visual, state);
     }
+    if (visual.typeName === "e3d:PointCloudVisual") {
+        return createPointCloudObject(visual, state);
+    }
     if (visual.typeName === "e3d:StraightBeltConveyor" ||
         visual.typeName === "e3d:CurveBeltConveyor" ||
         visual.typeName === "e3d:InjectorBeltConveyor") {
@@ -423,6 +451,89 @@ function createDirectVisualObject(visual, state, parentVisual) {
     state.stats.directVisuals += 1;
     return object;
 }
+function createPointCloudObject(visual, state) {
+    const referenceId = visual.properties?.textOf("PointCloudRef");
+    const pointCloud = referenceId ? state.pointCloudById.get(referenceId) : undefined;
+    if (!pointCloud) {
+        warn(state, {
+            code: "DEMO3D_THREE_MISSING_POINT_CLOUD",
+            message: `Point cloud reference ${referenceId ?? "<missing>"} could not be resolved.`,
+            sourceId: visual.id,
+            sourceType: visual.typeName,
+            xmlPath: visual.xml.path
+        });
+        return undefined;
+    }
+    const group = new state.three.Group();
+    group.name = visual.displayName ?? pointCloud.name ?? referenceId ?? visual.typeName;
+    const fallbackColor = primaryMaterial(visual)?.diffuse;
+    const pointSize = Math.min(128, Math.max(1, numberChild(visual.properties, "PointSize", 1)));
+    for (const [primitiveIndex, primitive] of pointCloud.primitives.entries()) {
+        const bufferName = primitive.pointsBufferName;
+        const buffer = bufferName ? state.bufferByName.get(bufferName.toLowerCase()) : undefined;
+        if (!buffer) {
+            warn(state, {
+                code: "DEMO3D_THREE_MISSING_POINT_CLOUD_BUFFER",
+                message: `Point cloud buffer ${bufferName ?? "<missing>"} could not be resolved.`,
+                sourceId: visual.id,
+                sourceType: visual.typeName,
+                xmlPath: primitive.xml.path
+            });
+            continue;
+        }
+        if (buffer.byteLength % 12 !== 0) {
+            warn(state, {
+                code: "DEMO3D_THREE_INVALID_POINT_CLOUD_BUFFER",
+                message: `Point cloud buffer ${bufferName} has ${buffer.byteLength} bytes; expected packed Float32 XYZ triples.`,
+                sourceId: visual.id,
+                sourceType: visual.typeName,
+                xmlPath: primitive.xml.path
+            });
+            continue;
+        }
+        const positions = new Float32Array(buffer.byteLength / 4);
+        const view = new DataView(buffer.buffer, buffer.byteOffset, buffer.byteLength);
+        for (let index = 0; index < positions.length; index += 3) {
+            positions[index] = view.getFloat32(index * 4, true);
+            positions[index + 1] = view.getFloat32((index + 1) * 4, true);
+            positions[index + 2] = -view.getFloat32((index + 2) * 4, true);
+        }
+        const geometry = new state.three.BufferGeometry();
+        geometry.setAttribute("position", new state.three.BufferAttribute(positions, 3));
+        geometry.computeBoundingBox();
+        geometry.computeBoundingSphere();
+        const material = new state.three.PointsMaterial({
+            color: demo3dColorToHex(primitive.color ?? fallbackColor ?? -1),
+            size: pointSize,
+            sizeAttenuation: false
+        });
+        const points = new state.three.Points(geometry, material);
+        points.name = pointCloud.primitives.length > 1 ? `${group.name} ${primitiveIndex + 1}` : group.name;
+        points.userData.demo3d = {
+            kind: "point-cloud-primitive",
+            pointCloudId: pointCloud.id,
+            bufferName,
+            pointCount: positions.length / 3
+        };
+        group.add(points);
+        state.stats.geometries += 1;
+        state.stats.materials += 1;
+    }
+    if (group.children.length === 0) {
+        return undefined;
+    }
+    group.userData.demo3d = {
+        kind: "point-cloud",
+        id: visual.id,
+        pointCloudId: pointCloud.id,
+        typeName: visual.typeName,
+        xmlPath: visual.xml.path
+    };
+    state.stats.groups += 1;
+    state.stats.directVisuals += 1;
+    state.stats.pointClouds += 1;
+    return group;
+}
 function createBeltConveyorObject(visual, state) {
     if (visual.typeName === "e3d:CurveBeltConveyor") {
         return createCurveBeltConveyorObject(visual, state);
@@ -606,17 +717,10 @@ function readProceduralBelt(visual, state) {
     if (!properties || isFalse(properties.textOf("CenterVisible"))) {
         return undefined;
     }
-    const centerProfile = properties.child("CenterProfile");
-    if (centerProfile && (centerProfile.children.length > 0 || centerProfile.text.length > 0)) {
-        warn(state, {
-            code: "DEMO3D_THREE_UNSUPPORTED_BELT_PROFILE",
-            message: "Straight belt conveyors with a custom CenterProfile are not supported.",
-            sourceId: visual.id,
-            sourceType: visual.typeName,
-            xmlPath: visual.xml.path
-        });
-        return undefined;
-    }
+    const centerProfileElement = properties.child("CenterProfile");
+    const centerProfile = centerProfileElement && centerProfileElement.children.length > 0
+        ? new Demo3DExtrusionProfile(centerProfileElement)
+        : undefined;
     const startPadding = numberChild(properties, "StartPadding", 0);
     const endPadding = numberChild(properties, "EndPadding", 0);
     const leftPadding = numberChild(properties, "LeftPadding", 0);
@@ -659,6 +763,7 @@ function readProceduralBelt(visual, state) {
         zOffset: (rightPadding - leftPadding) / 2,
         startCap,
         endCap,
+        centerProfile,
         surfaceMaterial,
         sideMaterial
     };
@@ -680,21 +785,55 @@ function beltCap(value, visual, state) {
     return "Box";
 }
 function getProceduralBeltGeometry(belt, state) {
-    const key = `belt:${belt.length}:${belt.width}:${belt.thickness}:${belt.endRadius}:${belt.xOffset}:${belt.zOffset}:${belt.startCap}:${belt.endCap}`;
+    const profileKey = belt.centerProfile?.polygons
+        .map((polygon) => polygon.points.map((point) => `${point.x},${point.y}`).join(";"))
+        .join("/") ?? "";
+    const key = `belt:${belt.length}:${belt.width}:${belt.thickness}:${belt.endRadius}:${belt.xOffset}:${belt.zOffset}:${belt.startCap}:${belt.endCap}:${profileKey}`;
     const cached = state.primitiveGeometryCache.get(key);
     if (cached) {
         return cached;
     }
-    const geometry = belt.startCap === "Box" && belt.endCap === "Box"
-        ? createRectangularBeltGeometry(belt, state)
-        : createRoundedBeltGeometry(belt, state);
-    convertTriangleGeometryToThreeCoordinates(geometry);
+    const profilePolygon = belt.centerProfile?.polygons.find((polygon) => polygon.points.length >= 3);
+    const geometry = belt.centerProfile && profilePolygon
+        ? createProfileBeltGeometry(belt, belt.centerProfile, profilePolygon, state)
+        : belt.startCap === "Box" && belt.endCap === "Box"
+            ? createRectangularBeltGeometry(belt, state)
+            : createRoundedBeltGeometry(belt, state);
+    if (!profilePolygon) {
+        convertTriangleGeometryToThreeCoordinates(geometry);
+    }
     geometry.computeBoundingBox();
     geometry.computeBoundingSphere();
     state.primitiveGeometryCache.set(key, geometry);
     state.stats.geometries += 1;
     return geometry;
 }
+function createProfileBeltGeometry(belt, profile, polygon, state) {
+    const shape = new state.three.Shape();
+    polygon.points.forEach((point, index) => {
+        const lateral = -(point.x - profile.anchor.x);
+        const vertical = point.y - profile.anchor.y;
+        if (index === 0) {
+            shape.moveTo(lateral, vertical);
+        }
+        else {
+            shape.lineTo(lateral, vertical);
+        }
+    });
+    shape.closePath();
+    const geometry = new state.three.ExtrudeGeometry(shape, {
+        bevelEnabled: false,
+        curveSegments: 1,
+        depth: belt.length,
+        steps: 1
+    });
+    geometry.rotateY(Math.PI / 2);
+    geometry.translate(belt.xOffset, 0, belt.zOffset);
+    for (const group of geometry.groups) {
+        group.materialIndex = group.materialIndex === 0 ? 1 : 0;
+    }
+    return geometry;
+}
 function createCurveBeltConveyorObject(visual, state) {
     const belt = readProceduralCurveBelt(visual, state);
     if (!belt) {
@@ -871,7 +1010,8 @@ function createRackObject(visual, state) {
     }
     const frameHeight = numberChild(properties, "FrameHeight", 0);
     const uprightWidth = numberChild(properties, "UprightWidth", 0.05);
-    const uprightDepth = numberChild(properties, "UprightDepth", 0.05);
+    const serializedUprightDepth = numberChild(properties, "UprightDepth", 0.05);
+    const uprightDepth = serializedUprightDepth > 0 ? serializedUprightDepth : uprightWidth;
     const frameDepth = numberChildOptional(properties, "FrameDepth") ?? numberChild(properties, "BayDepth", 0);
     const strutWidth = numberChild(properties, "StrutWidth", 0.05);
     if (frameHeight <= 0 || frameDepth <= 0 || uprightWidth <= 0 || uprightDepth <= 0 || strutWidth <= 0) {
@@ -1604,6 +1744,7 @@ function getDirectVisualGeometry(visual, state) {
         properties.textOf("Length") ?? "",
         properties.textOf("Radius") ?? "",
         properties.textOf("StartAngle") ?? "",
+        properties.textOf("Thickness") ?? "",
         properties.textOf("Width") ?? ""
     ].join("|")}`;
     const cached = state.primitiveGeometryCache.get(key);
@@ -1611,25 +1752,70 @@ function getDirectVisualGeometry(visual, state) {
         return cached;
     }
     let geometry;
-    if (visual.typeName === "e3d:BoxVisual" || visual.typeName === "e3d:BoxTubeVisual") {
+    if (visual.typeName === "e3d:BoxVisual") {
         geometry = new state.three.BoxGeometry(numberChild(properties, "Width", 1), numberChild(properties, "Height", 1), numberChild(properties, "Depth", 1));
     }
+    else if (visual.typeName === "e3d:BoxTubeVisual") {
+        geometry = createBoxTubeGeometry(numberChild(properties, "Width", 0.25), numberChild(properties, "Height", 1), numberChild(properties, "Depth", 0.25), numberChild(properties, "Thickness", 0.015), state);
+    }
     else if (visual.typeName === "e3d:CylinderVisual") {
         geometry = new state.three.CylinderGeometry(numberChild(properties, "Radius", 0.5), numberChild(properties, "Radius", 0.5), numberChild(properties, "Length", 1), 32, 1, false, degreesToRadians(numberChild(properties, "StartAngle", 0)), degreesToRadians(numberChild(properties, "Angle", 360)));
     }
+    else if (visual.typeName === "e3d:SphereVisual") {
+        geometry = new state.three.SphereGeometry(numberChild(properties, "Radius", 0.5), 32, 16);
+    }
     else if (visual.typeName === "e3d:WedgeVisual") {
         geometry = createWedgeGeometry(numberChild(properties, "Width", 1), numberChild(properties, "Height", 1), numberChild(properties, "Length", 1), state);
     }
     if (!geometry) {
         return undefined;
     }
-    convertTriangleGeometryToThreeCoordinates(geometry);
+    // BoxGeometry and the box-tube extrusion are already created in Three's
+    // coordinate system. Reflecting these symmetric, Three-native geometries
+    // swaps their front/back UV layouts even though their bounds do not change.
+    // Other direct primitives still need the Demo3D-to-Three Z reflection.
+    if (visual.typeName !== "e3d:BoxVisual" &&
+        visual.typeName !== "e3d:BoxTubeVisual" &&
+        visual.typeName !== "e3d:SphereVisual") {
+        convertTriangleGeometryToThreeCoordinates(geometry);
+    }
     geometry.computeBoundingBox();
     geometry.computeBoundingSphere();
     state.primitiveGeometryCache.set(key, geometry);
     state.stats.geometries += 1;
     return geometry;
 }
+function createBoxTubeGeometry(width, height, depth, thickness, state) {
+    const halfWidth = Math.max(width, 0) / 2;
+    const halfDepth = Math.max(depth, 0) / 2;
+    const edge = clamp(thickness, 0, Math.min(halfWidth, halfDepth));
+    const shape = new state.three.Shape();
+    shape.moveTo(-halfWidth, -halfDepth);
+    shape.lineTo(-halfWidth, halfDepth);
+    shape.lineTo(halfWidth, halfDepth);
+    shape.lineTo(halfWidth, -halfDepth);
+    shape.closePath();
+    const innerHalfWidth = halfWidth - edge;
+    const innerHalfDepth = halfDepth - edge;
+    if (innerHalfWidth > 0 && innerHalfDepth > 0) {
+        const hole = new state.three.Path();
+        hole.moveTo(-innerHalfWidth, -innerHalfDepth);
+        hole.lineTo(innerHalfWidth, -innerHalfDepth);
+        hole.lineTo(innerHalfWidth, innerHalfDepth);
+        hole.lineTo(-innerHalfWidth, innerHalfDepth);
+        hole.closePath();
+        shape.holes.push(hole);
+    }
+    const geometry = new state.three.ExtrudeGeometry(shape, {
+        depth: Math.max(height, 0),
+        steps: 1,
+        bevelEnabled: false
+    });
+    // ExtrudeGeometry uses Z for its extrusion. Demo3D box tubes extrude along Y.
+    geometry.rotateX(-Math.PI / 2);
+    geometry.translate(0, -Math.max(height, 0) / 2, 0);
+    return geometry;
+}
 function createWedgeGeometry(width, height, length, state) {
     const x = width / 2;
     const y = height / 2;
@@ -1696,8 +1882,12 @@ function getDrawingBlockGeometry(blockId, state) {
     state.stats.geometries += 1;
     return geometry;
 }
-function createMeshObject(meshId, source, material, state) {
+function createMeshObject(meshId, source, materialSelection, state) {
     const mesh = state.meshById.get(meshId);
+    const materials = Array.isArray(materialSelection)
+        ? materialSelection
+        : materialSelection ? [materialSelection] : [];
+    const primaryMaterial = materials[0];
     const sourceId = source instanceof Demo3DVisual ? source.id : source.textOf("Id");
     const sourceType = source instanceof Demo3DVisual ? source.typeName : source.xsiType ?? source.localName;
     const xmlPath = source instanceof Demo3DVisual ? source.xml.path : source.path;
@@ -1710,20 +1900,24 @@ function createMeshObject(meshId, source, material, state) {
             xmlPath
         });
         return state.options.showPlaceholders === true
-            ? createPlaceholderMesh(sourceId ?? meshId, meshId, material, state)
+            ? createPlaceholderMesh(sourceId ?? meshId, meshId, primaryMaterial, state)
             : undefined;
     }
     const geometry = getGeometry(mesh, state);
     if (!geometry) {
         return state.options.showPlaceholders === true
-            ? createPlaceholderMesh(sourceId ?? meshId, meshId, material, state)
+            ? createPlaceholderMesh(sourceId ?? meshId, meshId, primaryMaterial, state)
             : undefined;
     }
-    const object = new state.three.Mesh(geometry, getMaterial(material, state));
+    const threeMaterial = materials.length > 1
+        ? materials.map((material) => getMaterial(material, state))
+        : getMaterial(primaryMaterial, state);
+    const object = new state.three.Mesh(geometry, threeMaterial);
     object.name = source instanceof Demo3DVisual ? source.displayName ?? meshId : meshId;
     object.userData.demo3d = {
         kind: "mesh",
         meshId,
+        materialSlots: materials.length,
         sourceId,
         sourceType,
         xmlPath
@@ -1801,7 +1995,9 @@ function getPrimitiveGeometry(aspect, renderable, state) {
     if (!geometry) {
         return undefined;
     }
-    convertTriangleGeometryToThreeCoordinates(geometry);
+    if (type !== "e3d:BoxRendererAspect" && type !== "e3d:ContainerRendererAspect") {
+        convertTriangleGeometryToThreeCoordinates(geometry);
+    }
     geometry.computeBoundingBox();
     geometry.computeBoundingSphere();
     state.primitiveGeometryCache.set(key, geometry);
@@ -1982,7 +2178,9 @@ function getTexture(textureReference, state) {
         texture.colorSpace = state.three.SRGBColorSpace;
     }
     texture.name = image.name ?? image.id;
-    texture.flipY = false;
+    // Demo3D's generated primitive UVs use the conventional bottom-left texture
+    // origin expected by Three's TextureLoader.
+    texture.flipY = true;
     state.textureCache.set(textureReference, texture);
     state.stats.textures += 1;
     return texture;
@@ -2217,8 +2415,7 @@ function createSerializedRenderableGroup(state) {
             }
             const meshIds = findMeshReferenceIds(renderable);
             for (const meshId of meshIds) {
-                const material = firstMaterial(renderable);
-                const mesh = createMeshObject(meshId, renderable, material, state);
+                const mesh = createMeshObject(meshId, renderable, renderableMaterials(renderable), state);
                 if (!mesh) {
                     continue;
                 }
@@ -2418,6 +2615,23 @@ function findVisualMeshReferenceIds(root) {
     }
     return [...ids];
 }
+function renderableMaterials(renderable) {
+    const materials = [];
+    const materialProperties = renderable.child("MaterialProperties");
+    for (const entry of materialProperties?.children ?? []) {
+        const material = firstMaterial(entry);
+        if (material) {
+            materials.push(material);
+        }
+    }
+    if (materials.length === 0) {
+        const material = firstMaterial(renderable);
+        if (material) {
+            materials.push(material);
+        }
+    }
+    return materials;
+}
 function firstMaterial(root) {
     let found;
     visit(root, (node) => {
@@ -2501,7 +2715,9 @@ function applyDemo3DTransform(object, transformText) {
         return;
     }
     object.position.set(values[0] ?? 0, values[1] ?? 0, -(values[2] ?? 0));
-    object.rotation.set(-(values[3] ?? 0), -(values[4] ?? 0), values[5] ?? 0);
+    // Demo3D rotation triples are pitch (X), yaw (Y), and roll (Z). Its
+    // RotationYawPitchRoll matrix corresponds to Three's intrinsic YXZ order.
+    object.rotation.set(-(values[3] ?? 0), -(values[4] ?? 0), values[5] ?? 0, "YXZ");
 }
 function convertTriangleGeometryToThreeCoordinates(geometry) {
     geometry.scale(1, 1, -1);