Hipped roof (#128)

Author: Beakerboy

.github/workflows/main.yml

@@ -10,15 +10,19 @@ jobs:
         mkdir ../pyramid
         mkdir ../ramp
         mkdir ../wedge
+        mkdir ../hipped
         wget -P ../pyramid https://beakerboy.github.io/Threejs-Geometries/src/PyramidGeometry.js
         wget -P ../ramp https://beakerboy.github.io/Threejs-Geometries/src/RampGeometry.js
         wget -P ../wedge https://beakerboy.github.io/Threejs-Geometries/src/WedgeGeometry.js
+        wget -P ../hipped https://beakerboy.github.io/Threejs-Geometries/src/HippedGeometry.js
         cd ../pyramid
         echo '{"name":"pyramid","type":"module","private":true,"scripts":{"test":"npx jest"}}' > "./package.json" && npm init -y
         cd ../ramp
         echo '{"name":"ramp","type":"module","private":true,"scripts":{"test":"npx jest"}}' > "./package.json" && npm init -y
         cd ../wedge
         echo '{"name":"wedge","type":"module","private":true,"scripts":{"test":"npx jest"}}' > "./package.json" && npm init -y
+        cd ../hipped
+        echo '{"name":"hipped","type":"module","private":true,"scripts":{"test":"npx jest"}}' > "./package.json" && npm init -y
         cd ../OSMBuilding
         yarn --prod=false
     - name: Lint

index.html

@@ -16,9 +16,11 @@
       {
         "imports": {
           "three": "https://unpkg.com/three/build/three.module.js",
+          "straight-skeleton": "https://cdn.skypack.dev/straight-skeleton@1.1.0",
           "pyramid": "https://beakerboy.github.io/Threejs-Geometries/src/PyramidGeometry.js",
           "ramp": "https://beakerboy.github.io/Threejs-Geometries/src/RampGeometry.js",
-          "wedge": "https://beakerboy.github.io/Threejs-Geometries/src/WedgeGeometry.js"
+          "wedge": "https://beakerboy.github.io/Threejs-Geometries/src/WedgeGeometry.js",
+          "hipped": "https://beakerboy.github.io/Threejs-Geometries/src/HippedGeometry.js"
         }
       }
     </script>

package.json

@@ -19,9 +19,11 @@
     "jest-fetch-mock": "*",
     "jest-matcher-deep-close-to": "*",
     "jsdom": "*",
+    "hipped": "file:../hipped",
     "pyramid": "file:../pyramid",
     "ramp": "file:../ramp",
-    "wedge": "file:../wedge"
+    "wedge": "file:../wedge",
+    "straight-skeleton": "1.1.0"
   },
   "scripts": {
     "test": "c8 jest"

src/buildingpart.js

@@ -11,6 +11,7 @@ import {
 import {PyramidGeometry} from 'pyramid';
 import {RampGeometry} from 'ramp';
 import {WedgeGeometry} from 'wedge';
+import {HippedGeometry} from 'hipped';
 import {BuildingShapeUtils} from './extras/BuildingShapeUtils.js';
 /**
  * An OSM Building Part
@@ -285,6 +286,15 @@ class BuildingPart {
       };
       const geometry = new PyramidGeometry(this.shape, options);
 
+      material = BuildingPart.getRoofMaterial(this.way);
+      roof = new Mesh( geometry, material );
+      roof.rotation.x = -Math.PI / 2;
+      roof.position.set( 0, this.options.building.height - this.options.roof.height, 0);
+    } else if (this.options.roof.shape === 'hipped') {
+      const options = {
+        depth: this.options.roof.height,
+      };
+      const geometry = new HippedGeometry(this.shape, options);
       material = BuildingPart.getRoofMaterial(this.way);
       roof = new Mesh( geometry, material );
       roof.rotation.x = -Math.PI / 2;

test/buildingpart.test.js

@@ -60,16 +60,7 @@ test('Constructor', () => {
   // Gabled with unspecified orientation shal be 'along'
   expect(part.options.roof.orientation).toBe('along');
 
-  // Troubleshoot Bug
-  const shape = part.shape.extractPoints().shape;
-  let value = [shape[0].x, shape[0].y];
-  expect(value).toStrictEqual([-4.332738077015795, -5.882209888874915]);
-  value = [shape[1].x, shape[1].y];
-  expect(value).toStrictEqual([-4.332738077015795, 5.88221335051411]);
-  value = [shape[2].x, shape[2].y];
-  expect(value).toStrictEqual([4.332747472106493, 5.88221335051411]);
-  expect(BuildingShapeUtils.edgeDirection(part.shape)).toStrictEqual([Math.PI / 2, 0, -Math.PI / 2, Math.PI]);
-  expect(BuildingShapeUtils.longestSideAngle(part.shape)).toBe(Math.PI / 2);
+  // toDo: Mock BuildingShapeUtils and test options
   expect(part.options.roof.direction).toBe(90);
   expect(errors.length).toBe(0);
 });

test/utils.test.js

@@ -124,6 +124,13 @@ rightTriangle2.lineTo(-1, 1);
 rightTriangle2.lineTo(1, -1);
 rightTriangle2.lineTo(1, 1);
 
+const rectangle = new Shape();
+rectangle.moveTo(-4.332738077015795, -5.882209888874915);
+rectangle.lineTo(-4.332738077015795, 5.88221335051411);
+rectangle.lineTo(4.332747472106493, 5.88221335051411);
+rectangle.lineTo(4.332747472106493, -5.882209888874915);
+rectangle.lineTo(-4.332738077015795, -5.882209888874915);
+
 test('Extents no Rotation', () => {
   expect(BuildingShapeUtils.extents(rightTriangle)).toStrictEqual([-1, -1, 1, 1]);
 });
@@ -152,9 +159,10 @@ test('Vertex Angles counterclockwise', () => {
 describe.each([
   [rightTriangle, [-Math.PI / 2, 3 * Math.PI / 4, 0], 'CW'],
   [rightTriangle2, [Math.PI, -Math.PI / 4, Math.PI / 2], 'CCW'],
+  [rectangle, [Math.PI / 2, 0, -Math.PI / 2, Math.PI], 'Rect'],
 ])('Edge Direction', (shape, expected, description) =>{
   test(`${description}`, () => {
-    expect(BuildingShapeUtils.edgeDirection(shape)).toBeDeepCloseTo(expected);
+    expect(BuildingShapeUtils.edgeDirection(shape)).toStrictEqual(expected);
   });
 });