openstudio-common-measures 0.5.0 → 0.6.0

data/lib/measures/view_data/resources/report.html.in

@@ -1845,7 +1845,7 @@ var os_data;
 var os_data_const = <%=os_data %>;
 // END_REMOVE
 
-var renderer, scene, light, scene_objects, scene_edges, object_edges, coincident_objects, back_objects;
+var renderer, scene, light, scene_objects, scene_edges, object_edges, coincident_objects, back_objects, dot_points;
 var perspectiveCamera, orthographicCamera, perspectiveControls, orthographicControls;
 var project, materials, variable;
 var dataFolder, dateTimeControl;
@@ -1857,7 +1857,7 @@ var raycaster;
 var mouse;
 var headsUp;
 var intersected = [];
-var selected_material, unknown_material;
+var selected_material, unknown_material, dot_material;
 
 var getStringFromLocalStorage = function (key, defaultValue) {
   try {
@@ -1908,6 +1908,9 @@ var setLocalStorage = function (key, value) {
 var settings = {
   renderBy: 'Surface Type',
   showStory: 'All Stories',
+  showAirLoop: 'All Loops',
+  findAdjacencyIssues: false,
+  findAdjacencyThreshold: 1,
   searchType: getStringFromLocalStorage('searchType', 'Surfaces'),
   searchName: getStringFromLocalStorage('searchName', ''),
   showFloors: getBoolFromLocalStorage('showFloors', true),
@@ -2295,11 +2298,13 @@ function init(os_data_in) {
   orthographicControls.minDistance = 10;
   orthographicControls.maxDistance = 1000;
   orthographicControls.enabled = true;
+  orthographicControls.addEventListener('change', requestRenderIfNotRequested);
 
   perspectiveControls = new THREE.OrbitControls(perspectiveCamera, renderer.domElement);
   perspectiveControls.minDistance = 10;
   perspectiveControls.maxDistance = 1000;
   perspectiveControls.enabled = true;
+  perspectiveControls.addEventListener('change', requestRenderIfNotRequested);
 
   // initialize camera and controls
   setAllCameraAngles(-30, 30, 0);
@@ -2406,6 +2411,8 @@ function init(os_data_in) {
     shininess: 50,
     side: THREE.DoubleSide
   });
+
+  dot_material = new THREE.PointsMaterial( { size: 10, sizeAttenuation: false, color: 0xff0000 } );
   
   materials = parseMaterials(os_data.materials);
 
@@ -2543,6 +2550,7 @@ function onDocumentMouseClick(event) {
     } else {
       removeSelection();
     }
+    requestRenderIfNotRequested();
   }
 }
 
@@ -2622,8 +2630,10 @@ function displaySelectedObjectDetails() {
       document.body.style.cursor = 'pointer';
 }
 
-function animate(timestamp) {
-  requestAnimationFrame(animate);
+let renderRequested = false;
+
+function animate() {
+  renderRequested = undefined;
   orthographicControls.update();
   perspectiveControls.update();
   if (settings.orthographic){
@@ -2633,6 +2643,13 @@ function animate(timestamp) {
   }
 }
 
+function requestRenderIfNotRequested() {
+  if (!renderRequested) {
+    renderRequested = true;
+    requestAnimationFrame(animate);
+  }
+}
+
 function erf(x) {
   // constants
   var a1 =  0.254829592;
@@ -2683,6 +2700,100 @@ function cycleHour() {
   }
 }
 
+var adjacencyIssueIds = new Set();
+var adjacencyIssueVertices = new Set();
+var updateAdjacencyIssues = function(value) {
+  Array.groupBy = function(arr, prop) {
+      return arr.reduce(function(groups, item) {
+          const val = prop.split('.')
+              .reduce((obj, key) => (obj && obj[key] !== 'undefined') ? obj[key] : undefined, item);
+          groups[val] = groups[val] || [];
+          groups[val].push(item);
+          return groups;
+      }, {});
+  }
+
+  function combinations(a, b) {
+      if (b === undefined) {
+          return a.flatMap((v, i) => a.slice(i).map(w => [v, w]));
+      } else {
+          return a.flatMap((v, i) => b.map(w => [v, w]));
+      }
+  }
+
+  // As of now Three.js revision 71
+  class Box3 extends THREE.Box3 {
+
+      // Added in revision 84
+      expandByObject(object) {
+          const box = new THREE.Box3();
+          box.setFromObject(object);
+          this.expandByPoint(box.min);
+          this.expandByPoint(box.max);
+      }
+
+      // Added in revision 74
+      intersectsBox(box) {
+          // using 6 splitting planes to rule out intersections.
+          return box.max.x < this.min.x || box.min.x > this.max.x ||
+              box.max.y < this.min.y || box.min.y > this.max.y ||
+              box.max.z < this.min.z || box.min.z > this.max.z ? false : true;
+      }
+  }
+
+  const detectable = scene_objects.filter(o =>
+      ["Wall", "RoofCeiling", "Floor"].includes(o.userData.surfaceTypeMaterialName))
+  const per_space = Array.groupBy(detectable, 'userData.spaceName')
+  const space_boxes = Object.entries(per_space).map(([space, objects]) => {
+      const box = new Box3();
+      box.space = space;
+      box.surfaces = objects;
+      objects.forEach(o => box.expandByObject(o));
+      box.expandByScalar(0.5);
+      return box;
+  });
+
+  /*
+    * Implements part of Honeybee's SolveAdj tool licensed under the AGPL 3.0. See:
+    * - https://github.com/ladybug-tools/honeybee-grasshopper-core/blob/27773fe0097188d4be0e160c71a0cda2c54c6f73/honeybee_grasshopper_core/src/HB%20Solve%20Adjacency.py#L190
+    * - https://github.com/ladybug-tools/honeybee-core/blob/ae4e905a78635a7448291ff8dbe94aa2f627a1ae/honeybee/room.py#L925
+    * - https://github.com/ladybug-tools/honeybee-core/blob/ae4e905a78635a7448291ff8dbe94aa2f627a1ae/honeybee/room.py#L867
+    * - https://github.com/ladybug-tools/ladybug-geometry/blob/da34f3397c59bc311004cb6319d534953c8ee9ab/ladybug_geometry/geometry3d/polyface.py#L689
+    */
+  const almost_equal = 1e-6;
+  const thresh = (parseFloat(settings.findAdjacencyThreshold)**2)/10000;
+  adjacencyIssueIds.clear();
+  adjacencyIssueVertices.clear();
+
+  // issues within space
+  space_boxes.forEach(a => {
+    for (var [p, q] of combinations(a.surfaces)) {
+      for (var [x, y] of combinations(p.geometry.vertices, q.geometry.vertices)) {
+        const dist = x.distanceToSquared(y);
+        if (almost_equal < dist && dist < thresh) {
+          adjacencyIssueIds.add(p.id).add(q.id);
+          adjacencyIssueVertices.add(x).add(y);
+        }
+      }
+    }
+  })
+
+  // issues between spaces
+  for (var [a, b] of combinations(space_boxes)) {
+    if (a.intersectsBox(b)) {
+      for (var [p, q] of combinations(a.surfaces, b.surfaces)) {
+        for (var [x, y] of combinations(p.geometry.vertices, q.geometry.vertices)) {
+          const dist = x.distanceToSquared(y);
+          if (almost_equal < dist && dist < thresh) {
+            adjacencyIssueIds.add(p.id).add(q.id);
+            adjacencyIssueVertices.add(x).add(y);
+          }
+        }
+      }
+    }
+  }
+}
+
 var gui = null;
 var dataFolder = null;
 var update = function (value) {
@@ -2770,9 +2881,16 @@ var update = function (value) {
 
     object.visible = true;
 
-    if (settings.showStory == 'All Stories' || settings.showStory == object.userData.buildingStoryName){
-      // no-op
-    }else{
+    if (settings.findAdjacencyIssues) {
+      object.visible = adjacencyIssueIds.has(object.id);
+    }
+
+    if (settings.showStory !== 'All Stories' && settings.showStory !== object.userData.buildingStoryName) {
+      object.visible = false;
+    }
+    if ((settings.showAirLoop !== 'All Loops' && !object.userData.airLoopHVACNames.includes(settings.showAirLoop))
+        &&
+        (settings.showAirLoop !== 'No Loop' || object.userData.airLoopHVACNames.length !== 0)) {
       object.visible = false;
     }
 
@@ -2863,7 +2981,7 @@ var update = function (value) {
             keyName = object_variable.keyName;
           }
         }
-       
+
         if (value !== null) {
           object.userData.variableName = settings.variableName;
           object.userData.variableDate = date;
@@ -2875,7 +2993,7 @@ var update = function (value) {
           object.userData.variableName = settings.variableName;
           object.userData.variableDate = date;
           object.userData.variableTime = time;
-          object.userData.variableKeyName = keyName;          
+          object.userData.variableKeyName = keyName;
           object.userData.variableValue = '';
           object.userData.variableUnits = units;
         }
@@ -2884,7 +3002,7 @@ var update = function (value) {
         material.color.set(getColor(value, variable.valueMin, variable.valueMax, settings.colorScheme));
         break;
     }
-    
+
     if (!material) {
       material = unknown_material;
     }
@@ -2926,7 +3044,7 @@ var update = function (value) {
             // coincident object is visible, hide back object
             back_object.visible = false;
           }else{
-            
+
             if (back_object.material){
 			  // coincident object is not visible, show back object
               back_object.visible = true;
@@ -2942,6 +3060,27 @@ var update = function (value) {
       }
     }
   });
+
+  if (dot_points instanceof THREE.Points){
+    scene.remove(dot_points);
+    dot_points = null;
+  }
+
+  if (settings.findAdjacencyIssues) {
+    var dot_geometry = new THREE.Geometry();
+    dot_points = new THREE.Points(dot_geometry, dot_material);
+
+    adjacencyIssueVertices.forEach(function(p) {
+      dot_geometry.vertices.push(p);
+    });
+
+    dot_geometry.verticesNeedUpdate = true;
+    dot_geometry.elementsNeedUpdate = true;
+    dot_geometry.computeVertexNormals();
+    scene.add(dot_points);
+  }
+
+  requestRenderIfNotRequested();
 };
 
 var updateVariable = function (variableName) {
@@ -2973,13 +3112,27 @@ var initDatGui = function () {
     update(value);
   });
 
-  building_story_names = os_data.metadata.buildingStoryNames;
+  var building_story_names = os_data.metadata.buildingStoryNames;
   building_story_names.unshift('All Stories');
   gui.add(settings, 'showStory', building_story_names).name('Show Story').onChange(function(value) {
     removeSelection();
     update(value);
   });
 
+  var air_loop_names = os_data.metadata
+    .modelObjectMetadata
+    .filter(objMetaData => objMetaData.iddObjectType === "OS:AirLoopHVAC")
+    .map(objMetaData => objMetaData.name)
+    .sort();
+  if (air_loop_names && air_loop_names.length > 0) {
+    air_loop_names.unshift("All Loops");
+    air_loop_names.unshift("No Loop");
+    gui.add(settings, 'showAirLoop', air_loop_names).name('Show Air Loop').onChange(function (value) {
+      removeSelection();
+      update(value);
+    });
+  }
+
   var s1 = gui.addFolder('Search');
   search_types = ['Surfaces', 'Spaces and Groups']
   s1.add(settings, 'searchType', search_types).name('Search Type').onChange(function (value) {
@@ -3037,16 +3190,33 @@ var initDatGui = function () {
   });
   f1.open();
 
-  var f2 = gui.addFolder('Camera');
-  f2.add(settings, 'orthographic').name('Orthographic').onChange(function(value) {
-    setLocalStorage('orthographic', value);
+  var f2 = gui.addFolder('Potential Adjacency Issues');
+  f2.add(settings, 'findAdjacencyIssues').name('Enable').onChange(value => {
+      removeSelection();
+      setLocalStorage('findAdjacencyThreshold', value);
+      updateAdjacencyIssues();
+      update(value);
+  });
+  f2.add(settings, 'findAdjacencyThreshold', 0.1, 10, 0.5).name('Threshold').onFinishChange(function (value) {
+      if (settings.findAdjacencyIssues) {
+          removeSelection();
+          setLocalStorage('findAdjacencyThreshold', value);
+          updateAdjacencyIssues();
+          update(value);
+      }
   });
-  f2.add(settings, 'xView').name('X View');
-  f2.add(settings, 'yView').name('Y View');
-  f2.add(settings, 'zView').name('Z View');
-  f2.add(settings, 'reset').name('Reset');
   f2.open();
 
+  var f3 = gui.addFolder('Camera');
+  f3.add(settings, 'orthographic').name('Orthographic').onChange(function (value) {
+      setLocalStorage('orthographic', value);
+  });
+  f3.add(settings, 'xView').name('X View');
+  f3.add(settings, 'yView').name('Y View');
+  f3.add(settings, 'zView').name('Z View');
+  f3.add(settings, 'reset').name('Reset');
+  f3.open();
+
   /*var f2 = gui.addFolder('Section Cut');
   f2.add(settings, 'xSection', 0, 360).name('X Section').onChange(function (value) {
     console.log('X cut: ' + value);

data/lib/measures/view_data/resources/va3c.rb

@@ -228,6 +228,7 @@ class VA3C
     materials << make_material('Boundary_Outdoors_Wind', format_color(9, 159, 162), 1, THREE::DoubleSide)
     materials << make_material('Boundary_Outdoors_SunWind', format_color(68, 119, 161), 1, THREE::DoubleSide)
     materials << make_material('Boundary_Ground', format_color(204, 183, 122), 1, THREE::DoubleSide)
+    materials << make_material('Boundary_Foundation', format_color(117, 30, 122), 1, THREE::DoubleSide)
     materials << make_material('Boundary_Groundfcfactormethod', format_color(153, 122, 30), 1, THREE::DoubleSide)
     materials << make_material('Boundary_Groundslabpreprocessoraverage', format_color(255, 191, 0), 1, THREE::DoubleSide)
     materials << make_material('Boundary_Groundslabpreprocessorcore', format_color(255, 182, 50), 1, THREE::DoubleSide)

data/lib/measures/view_model/measure.xml

@@ -3,8 +3,8 @@
   <schema_version>3.0</schema_version>
   <name>view_model</name>
   <uid>f4669f10-fda5-489d-8e1c-7ca3c2d40378</uid>
-  <version_id>8e4cf2b6-75ec-406e-8bd6-e1f4367e81f5</version_id>
-  <version_modified>20210801T054201Z</version_modified>
+  <version_id>53a5f6c1-15cc-4df4-973c-62f725cd268e</version_id>
+  <version_modified>20220505T194724Z</version_modified>
   <xml_checksum>1E1F8B97</xml_checksum>
   <class_name>ViewModel</class_name>
   <display_name>ViewModel</display_name>
@@ -53,12 +53,6 @@
       <usage_type>test</usage_type>
       <checksum>AC094EF8</checksum>
     </file>
-    <file>
-      <filename>va3c.rb</filename>
-      <filetype>rb</filetype>
-      <usage_type>resource</usage_type>
-      <checksum>1FD61D41</checksum>
-    </file>
     <file>
       <version>
         <software_program>OpenStudio</software_program>
@@ -88,11 +82,17 @@
       <usage_type>readmeerb</usage_type>
       <checksum>703C9964</checksum>
     </file>
+    <file>
+      <filename>va3c.rb</filename>
+      <filetype>rb</filetype>
+      <usage_type>resource</usage_type>
+      <checksum>78ACC264</checksum>
+    </file>
     <file>
       <filename>report.html.in</filename>
       <filetype>in</filetype>
       <usage_type>resource</usage_type>
-      <checksum>E7E95149</checksum>
+      <checksum>A57477D9</checksum>
     </file>
   </files>
 </measure>