tbd 3.0.0

data/lib/measures/tbd/resources/tbd.rb

@@ -0,0 +1,55 @@
+# MIT License
+#
+# Copyright (c) 2020-2022 Denis Bourgeois & Dan Macumber
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+
+require "openstudio"
+
+# Topolys gem files.
+require_relative "model"
+require_relative "geometry"
+require_relative "transformation"
+require_relative "version"
+
+# OSlg gem file.
+require_relative "oslog"
+
+# OSut gem file.
+require_relative "utils"
+
+# TBD gem files.
+require_relative "psi"
+require_relative "geo"
+require_relative "ua"
+
+module TBD
+  extend OSut         #                                     OpenStudio utilities
+
+  TOL  = OSut::TOL
+  TOL2 = OSut::TOL2
+  DBG  = OSut::DEBUG  #   mainly to flag invalid arguments for devs (buggy code)
+  INF  = OSut::INFO   #           informs TBD user of measure success or failure
+  WRN  = OSut::WARN   # e.g. WARN users of 'iffy' .osm inputs (yet not critical)
+  ERR  = OSut::ERR    #                            e.g. flag invalid .osm inputs
+  FTL  = OSut::FATAL  #                     e.g. invalid TBD JSON format/entries
+  NS   = "nameString" #                   OpenStudio IdfObject nameString method
+
+  extend TBD
+end

data/lib/measures/tbd/resources/transformation.rb

@@ -0,0 +1,121 @@
+require 'matrix'
+
+class Matrix
+  def []=(i, j, x)
+    @rows[i][j] = x
+  end
+end
+
+module Topolys
+
+  # Transformations can be applied to Geometry. Ported from OpenStudio Transformation library.
+
+  class Transformation
+  
+    # @return [Matrix] internal 4x4 matrix
+    attr_reader :matrix
+    
+    ##
+    # Initializes an Transformation object
+    #
+    # @param [Matrix] matrix A 4x4 matrix, defaults to identity
+    def initialize(matrix=Matrix.identity(4))
+      raise "Incorrect argument for Transformation, expected Matrix but got #{matrix.class}" unless matrix.is_a?(Matrix)
+      @matrix = matrix
+    end
+    
+    # translation along vector
+    def Transformation.translation(translation)
+      return nil if !translation.is_a?(Vector3D)
+      
+      matrix = Matrix.identity(4)
+      matrix[0,3] = translation.x
+      matrix[1,3] = translation.y
+      matrix[2,3] = translation.z      
+      
+      return Transformation.new(matrix)
+    end
+  
+    ##
+    # Initializes a rotation about origin defined by axis and angle (radians)
+    #
+    def Transformation.rotation(axis, radians)
+      return nil if !axis.is_a?(Vector3D)
+      return nil if !radians.is_a?(Numeric)
+      return nil if (axis.magnitude < Float::EPSILON)
+      normal = axis
+      normal.normalize!
+      
+      # Rodrigues' rotation formula / Rotation matrix from Euler axis/angle
+      # I*cos(radians) + I*(1-cos(radians))*axis*axis^T + Q*sin(radians)
+      # Q = [0, -axis[2], axis[1]; axis[2], 0, -axis[0]; -axis[1], axis[0], 0]
+      p = normal.outer_product(normal)
+      i = Matrix.identity(3)
+      q = Matrix.zero(3)
+      q[0,1] = -normal.z
+      q[0,2] =  normal.y
+      q[1,0] =  normal.z
+      q[1,2] = -normal.x
+      q[2,0] = -normal.y
+      q[2,1] =  normal.x
+
+      # rotation matrix
+      r = i*Math.cos(radians) + (1-Math.cos(radians))*p + q*Math.sin(radians)
+
+      matrix = Matrix.identity(4)
+      matrix[0,0] = r[0,0]
+      matrix[0,1] = r[0,1]
+      matrix[0,2] = r[0,2]
+      matrix[1,0] = r[1,0]
+      matrix[1,1] = r[1,1]
+      matrix[1,2] = r[1,2]
+      matrix[2,0] = r[2,0]
+      matrix[2,1] = r[2,1]
+      matrix[2,2] = r[2,2]
+      
+      return Transformation.new(matrix)
+    end
+
+    ##
+    # Multiplies a Transformation by geometry class
+    #
+    # @param [Obj] obj A geometry object
+    #
+    # @return [Obj] Returns a new, transformed object - nil if not a geometry object
+    def *(obj)
+      if obj.is_a?(Point3D)
+        return mult_point(obj)
+      elsif obj.is_a?(Vector3D)
+        return mult_vector(obj)
+      elsif obj.is_a?(Array)
+        return mult_array(obj)
+      elsif obj.is_a?(Transformation)
+        return mult_transformation(obj)
+      end
+      return nil
+    end
+    
+    private
+    
+    def mult_point(point)
+      temp = Matrix.column_vector([point.x, point.y, point.z, 1])
+      temp = @matrix*temp
+      return Point3D.new(temp[0,0],temp[1,0],temp[2,0])
+    end
+    
+    def mult_vector(vector)
+      temp = Matrix.column_vector([vector.x, vector.y, vector.z, 1])
+      temp = @matrix*temp
+      return Vector3D.new(temp[0,0],temp[1,0],temp[2,0])
+    end
+    
+    def mult_array(array)
+      array.map {|obj| self*obj}
+    end
+    
+    def mult_transformation(obj)
+      Transformation.new(@matrix * obj.matrix)
+    end
+
+  end
+end