# *******************************************************************************
# Honeybee OpenStudio Gem, Copyright (c) 2020, Alliance for Sustainable
# Energy, LLC, Ladybug Tools LLC and other contributors. All rights reserved.
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
#
# (1) Redistributions of source code must retain the above copyright notice,
# this list of conditions and the following disclaimer.
#
# (2) Redistributions in binary form must reproduce the above copyright notice,
# this list of conditions and the following disclaimer in the documentation
# and/or other materials provided with the distribution.
#
# (3) Neither the name of the copyright holder nor the names of any contributors
# may be used to endorse or promote products derived from this software without
# specific prior written permission from the respective party.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDER(S) AND ANY CONTRIBUTORS
# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
# THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER(S), ANY CONTRIBUTORS, THE
# UNITED STATES GOVERNMENT, OR THE UNITED STATES DEPARTMENT OF ENERGY, NOR ANY OF
# THEIR EMPLOYEES, BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
# EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
# OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
# STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
# OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
# *******************************************************************************

require 'honeybee/geometry/door'

require 'to_openstudio/model_object'

module Honeybee
  class Door

  def self.from_sub_surface(sub_surface, site_transformation)
      hash = {}
      hash[:type] = 'Door'
      hash[:identifier] = clean_identifier(sub_surface.nameString)
      unless sub_surface.displayName.empty?
        hash[:display_name] = (sub_surface.displayName.get).force_encoding("UTF-8")
      end
      hash[:user_data] = {handle: sub_surface.handle.to_s}
      hash[:properties] = properties_from_sub_surface(sub_surface)
      hash[:geometry] = geometry_from_sub_surface(sub_surface, site_transformation)
      hash[:boundary_condition] = boundary_condition_from_sub_surface(sub_surface)

      sub_surface_type = sub_surface.subSurfaceType
      hash[:is_glass] = (sub_surface_type == 'GlassDoor')

      indoor_shades = indoor_shades_from_sub_surface(sub_surface)
      hash[:indoor_shades] = indoor_shades if !indoor_shades.empty?

      outdoor_shades = outdoor_shades_from_sub_surface(sub_surface)
      hash[:outdoor_shades] = outdoor_shades if !outdoor_shades.empty?

      hash
    end

    def self.properties_from_sub_surface(sub_surface)
      hash = {}
      hash[:type] = 'DoorPropertiesAbridged'
      hash[:energy] = energy_properties_from_sub_surface(sub_surface)
      hash
    end

    def self.energy_properties_from_sub_surface(sub_surface)
      hash = {}
      hash[:type] = 'DoorEnergyPropertiesAbridged'

      unless sub_surface.isConstructionDefaulted
        construction = sub_surface.construction
        if !construction.empty?
          constr_id = clean_name(construction.get.nameString)
          if hash[:is_glass] && !$window_constructions[constr_id].nil?
            hash[:construction] = constr_id
          elsif !hash[:is_glass] && !$opaque_constructions[constr_id].nil?
            hash[:construction] = constr_id
          end
        end
      end
      
      hash
    end

    def self.geometry_from_sub_surface(sub_surface, site_transformation)
      result = {}
      result[:type] = 'Face3D'
      result[:boundary] = []
      vertices = site_transformation * sub_surface.vertices
      vertices.each do |v|
        result[:boundary] << [v.x, v.y, v.z]
      end
      result
    end

    def self.boundary_condition_from_sub_surface(sub_surface)
      result = {}
      surface = sub_surface.surface.get
      surface_type = surface.surfaceType
      adjacent_sub_surface = sub_surface.adjacentSubSurface
      if !adjacent_sub_surface.empty?
        adjacent_space = clean_identifier(adjacent_sub_surface.get.space.get.nameString)
        adjacent_surface = clean_identifier(adjacent_sub_surface.get.surface.get.nameString)
        adjacent_sub_surface = clean_identifier(adjacent_sub_surface.get.nameString)
        result = {type: 'Surface', boundary_condition_objects: [adjacent_sub_surface, adjacent_surface, adjacent_space]}
      elsif surface.isGroundSurface
        result = {type: 'Ground'}
      elsif surface_type == 'Adiabatic'
        result = {type: 'Adiabatic'}
      else
        sun_exposure = (surface.sunExposure == 'SunExposed')
        wind_exposure = (surface.windExposure == 'WindExposed')
        view_factor = sub_surface.viewFactortoGround
        if view_factor.empty?
          view_factor = {type: 'Autocalculate'}
        else
          view_factor = view_factor.get
        end
        result = {type: 'Outdoors', sun_exposure: sun_exposure,
                  wind_exposure: wind_exposure, view_factor: view_factor}
      end
      result
    end

    def self.indoor_shades_from_sub_surface(sub_surface)
      []
    end

    def self.outdoor_shades_from_sub_surface(sub_surface)
      result = []
      sub_surface.shadingSurfaceGroups.each do |shading_surface_group|
        site_transformation = shading_surface_group.siteTransformation
        shading_surface_group.shadingSurfaces.each do |shading_surface|
          result << Shade.from_shading_surface(shading_surface, site_transformation)
        end
      end
      result
    end

  end # Door
end # Honeybee