@jfk-solutions/demo3d-file-format 1.6.0 → 1.8.0

package/dist/three/index.js

@@ -1,7 +1,8 @@
-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 { applyDemo3DThreeRenderMode } from "./presentation.js";
 export async function createDemo3DThreeScene(parsed, options = {}) {
     const three = await resolveThree(options);
     const group = await createDemo3DThreeGroup(parsed, { ...options, three });
@@ -45,6 +46,38 @@ export async function createDemo3DThreeGroup(parsed, options = {}) {
     };
     return root;
 }
+/** Dispose geometries, materials, and textures owned by a generated Demo3D or RAW3D group. */
+export function disposeDemo3DThreeGroup(root) {
+    const geometries = new Set();
+    const materials = new Set();
+    const textures = new Set();
+    root.traverse((object) => {
+        const renderable = object;
+        if (renderable.geometry) {
+            geometries.add(renderable.geometry);
+        }
+        const objectMaterials = Array.isArray(renderable.material)
+            ? renderable.material
+            : renderable.material ? [renderable.material] : [];
+        for (const material of objectMaterials) {
+            materials.add(material);
+            for (const value of Object.values(material)) {
+                if (value?.isTexture) {
+                    textures.add(value);
+                }
+            }
+        }
+    });
+    for (const geometry of geometries) {
+        geometry.dispose();
+    }
+    for (const material of materials) {
+        material.dispose();
+    }
+    for (const texture of textures) {
+        texture.dispose();
+    }
+}
 export function decodeDemo3DThreeGeometry(mesh, three) {
     if (mesh.meshFormat !== "TriangleList") {
         throw new Error(`Unsupported Demo3D mesh format: ${mesh.meshFormat ?? "unknown"}`);
@@ -147,6 +180,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),
@@ -182,6 +216,7 @@ function createState(three, project, options, buffers) {
             unreconstructedProceduralVisuals: 0,
             imageVisuals: 0,
             lights: 0,
+            pointClouds: 0,
             missingGeometryPlaceholders: 0,
             serializedRenderables: 0,
             unsupported: 0
@@ -404,6 +439,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") {
@@ -446,6 +484,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);
@@ -629,17 +750,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);
@@ -682,6 +796,7 @@ function readProceduralBelt(visual, state) {
         zOffset: (rightPadding - leftPadding) / 2,
         startCap,
         endCap,
+        centerProfile,
         surfaceMaterial,
         sideMaterial
     };
@@ -703,21 +818,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) {
@@ -894,7 +1043,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) {
@@ -1644,13 +1794,24 @@ function getDirectVisualGeometry(visual, 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);
@@ -1867,7 +2028,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);
@@ -2048,7 +2211,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;