Feat (GIS): support line element

speckle_connector/src/actions/receive_objects.rb

@@ -27,10 +27,12 @@ module SpeckleConnector
         converter = Converters::ToNative.new(state, @stream_id, @stream_name, @branch_name, @source_app)
         # Have side effects on the sketchup model. It effects directly on the entities by adding new objects.
         start_time = Time.now.to_f
+        state.sketchup_state.sketchup_model.start_operation('Receive Speckle Objects', true)
         state = converter.receive_commit_object(@base)
         if state.user_state.model_preferences[:merge_coplanar_faces]
           Converters::CleanUp.merge_coplanar_faces(converter.converted_faces)
         end
+        state.sketchup_state.sketchup_model.commit_operation
         elapsed_time = (Time.now.to_f - start_time).round(3)
         puts "==== Converting to Native executed in #{elapsed_time} sec ===="
         puts "==== Source application is #{@source_app}. ===="

speckle_connector/src/constants/type_constants.rb

@@ -4,6 +4,7 @@ module SpeckleConnector
   BASE_OBJECT = 'Base'
 
   OBJECTS_GIS_POLYGONELEMENT = 'Objects.GIS.PolygonElement'
+  OBJECTS_GIS_LINEELEMENT = 'Objects.GIS.LineElement'
 
   OBJECTS_BUILTELEMENTS_VIEW3D = 'Objects.BuiltElements.View:Objects.BuiltElements.View3D'
   OBJECTS_BUILTELEMENTS_NETWORK = 'Objects.BuiltElements.Network'
@@ -33,4 +34,6 @@ module SpeckleConnector
   OBJECTS_OTHER_DISPLAYSTYLE = 'Objects.Other.DisplayStyle'
 
   SPECKLE_CORE_MODELS_COLLECTION = 'Speckle.Core.Models.Collection'
+  SPECKLE_CORE_MODELS_COLLECTION_RASTER_LAYER = 'Speckle.Core.Models.Collection:Objects.GIS.RasterLayer'
+  SPECKLE_CORE_MODELS_COLLECTION_VECTOR_LAYER = 'Speckle.Core.Models.Collection:Objects.GIS.VectorLayer'
 end

speckle_connector/src/convertors/clean_up.rb

@@ -25,40 +25,18 @@ module SpeckleConnector
 
       def self.merge_coplanar_faces(faces)
         edges = []
-        start_time = Time.now.to_f
-        puts "number of faces before reject deleted: #{faces.length}"
         faces = faces.reject(&:deleted?)
-        puts "number of faces #{faces.length}"
-        elapsed_time = (Time.now.to_f - start_time).round(3)
-        puts "==== 1- Rejecting deleted faces executed in #{elapsed_time} sec ===="
 
-        start_time = Time.now.to_f
         faces.each { |face| face.edges.each { |edge| edges << edge } }
-        elapsed_time = (Time.now.to_f - start_time).round(3)
-        puts "==== 2- Collecting edges executed in #{elapsed_time} sec ===="
 
-        start_time = Time.now.to_f
-        puts "number of edges before uniq!: #{edges.length}"
         edges.uniq!
-        puts "number of edges #{edges.length}"
-        elapsed_time = (Time.now.to_f - start_time).round(3)
-        puts "==== 3- Making edges uniq! in #{elapsed_time} sec ===="
 
-        start_time = Time.now.to_f
         edges.each { |edge| remove_edge_have_coplanar_faces(edge) }
-        elapsed_time = (Time.now.to_f - start_time).round(3)
-        puts "==== 4- Clean up edges executed in #{elapsed_time} sec ===="
 
-        start_time = Time.now.to_f
         # Remove remaining orphan edges
-        edges.reject(&:deleted?).select { |edge| edge.faces.empty? }.each(&:erase!)
-        elapsed_time = (Time.now.to_f - start_time).round(3)
-        puts "==== 5- Removing orphan edges edges executed in #{elapsed_time} sec ===="
+        # edges.reject(&:deleted?).select { |edge| edge.faces.empty? }.each(&:erase!)
 
-        start_time = Time.now.to_f
         merged_faces(faces)
-        elapsed_time = (Time.now.to_f - start_time).round(3)
-        puts "==== 6- Rejecting deleted faces executed in #{elapsed_time} sec ===="
       end
 
       def self.merged_faces(faces)
@@ -83,19 +61,24 @@ module SpeckleConnector
 
         face_1, face_2 = edge.faces
 
-        return false unless face_1.normal.samedirection?(face_2.normal)
+        begin
+          return false unless face_1.normal.samedirection?(face_2.normal)
 
-        return false if face_duplicate?(face_1, face_2)
-        # Check for troublesome faces which might lead to missing geometry if merged.
-        return false unless edge_safe_to_merge?(edge)
+          return false if face_duplicate?(face_1, face_2)
+          # Check for troublesome faces which might lead to missing geometry if merged.
+          return false unless edge_safe_to_merge?(edge)
 
-        return false unless (face_1.material == face_2.material) && (face_1.back_material == face_2.back_material)
+          return false unless (face_1.material == face_2.material) && (face_1.back_material == face_2.back_material)
 
-        # Check faces are coplanar or not.
-        return false unless faces_coplanar?(face_1, face_2)
+          # Check faces are coplanar or not.
+          return false unless faces_coplanar?(face_1, face_2)
 
-        edge.erase!
-        true
+          edge.erase!
+          true
+        rescue StandardError => e
+          puts "Failed to merge coplanar faces by removing edge with error: #{e}"
+          false
+        end
       end
 
       # Determines if two faces are overlapped.

speckle_connector/src/convertors/to_native.rb

@@ -4,6 +4,7 @@ require_relative 'converter'
 require_relative '../constants/type_constants'
 require_relative '../speckle_entities/speckle_entity'
 require_relative '../speckle_objects/gis/polygon_element'
+require_relative '../speckle_objects/gis/line_element'
 require_relative '../speckle_objects/other/transform'
 require_relative '../speckle_objects/other/render_material'
 require_relative '../speckle_objects/other/block_definition'
@@ -19,6 +20,7 @@ require_relative '../speckle_objects/geometry/mesh'
 require_relative '../speckle_objects/built_elements/view3d'
 require_relative '../speckle_objects/built_elements/network'
 require_relative '../speckle_objects/speckle/core/models/collection'
+require_relative '../speckle_objects/speckle/core/models/gis_layer_collection'
 require_relative '../sketchup_model/dictionary/speckle_entity_dictionary_handler'
 
 module SpeckleConnector
@@ -64,7 +66,9 @@ module SpeckleConnector
       DISPLAY_VALUE = OTHER::DisplayValue
       VIEW3D = BUILTELEMENTS::View3d
       POLYGON_ELEMENT = GIS::PolygonElement
+      LINE_ELEMENT = GIS::LineElement
       COLLECTION = SpeckleObjects::Speckle::Core::Models::Collection
+      GIS_LAYER_COLLECTION = SpeckleObjects::Speckle::Core::Models::GisLayerCollection
 
       BASE_OBJECT_PROPS = %w[applicationId id speckle_type totalChildrenCount].freeze
       CONVERTABLE_SPECKLE_TYPES = %w[
@@ -84,7 +88,10 @@ module SpeckleConnector
         Objects.BuiltElements.Wall:Objects.BuiltElements.Revit.RevitWall
         Objects.BuiltElements.Network
         Objects.GIS.PolygonElement
+        Objects.GIS.LineElement
         Speckle.Core.Models.Collection
+        Speckle.Core.Models.Collection:Objects.GIS.RasterLayer
+        Speckle.Core.Models.Collection:Objects.GIS.VectorLayer
       ].freeze
 
       def from_revit
@@ -303,7 +310,10 @@ module SpeckleConnector
         OBJECTS_BUILTELEMENTS_REVIT_DIRECTSHAPE => BUILTELEMENTS::Revit::DirectShape.method(:to_native),
         OBJECTS_BUILTELEMENTS_NETWORK => BUILTELEMENTS::Network.method(:to_native),
         OBJECTS_GIS_POLYGONELEMENT => POLYGON_ELEMENT.method(:to_native),
-        SPECKLE_CORE_MODELS_COLLECTION => COLLECTION.method(:to_native)
+        OBJECTS_GIS_LINEELEMENT => LINE_ELEMENT.method(:to_native),
+        SPECKLE_CORE_MODELS_COLLECTION => COLLECTION.method(:to_native),
+        SPECKLE_CORE_MODELS_COLLECTION_RASTER_LAYER => GIS_LAYER_COLLECTION.method(:to_native),
+        SPECKLE_CORE_MODELS_COLLECTION_VECTOR_LAYER => GIS_LAYER_COLLECTION.method(:to_native)
       }.freeze
 
       # @param state [States::State] state of the speckle application

speckle_connector/src/preferences/preferences.rb

@@ -12,7 +12,7 @@ module SpeckleConnector
     include Immutable::ImmutableUtils
     DICT_HANDLER = SketchupModel::Dictionary::SpeckleModelDictionaryHandler
     # rubocop:disable Layout/LineLength
-    DEFAULT_CONFIG = "('configSketchup', '{\"dark_theme\":false, \"diffing\":false, \"register_speckle_entity\":false}, \"fe2\":false');"
+    DEFAULT_CONFIG = "('configSketchup', '{\"dark_theme\":false, \"diffing\":false, \"register_speckle_entity\":false, \"fe2\":false}');"
     # rubocop:enable Layout/LineLength
     DEFAULT_PREFERENCES = '{"dark_theme":false, "diffing":false, "register_speckle_entity": false, "fe2": false}'
 
@@ -34,12 +34,16 @@ module SpeckleConnector
     def self.data_complete?(row_data)
       return false if row_data.empty?
 
-      data = JSON.parse(row_data.first.first)
-      if data['dark_theme'].nil? || data['fe2'].nil? || data['diffing'].nil? || data['register_speckle_entity'].nil?
-        return false
-      end
+      begin
+        data = JSON.parse(row_data.first.first)
+        if data['dark_theme'].nil? || data['fe2'].nil? || data['diffing'].nil? || data['register_speckle_entity'].nil?
+          return false
+        end
 
-      true
+        true
+      rescue StandardError
+        false
+      end
     end
 
     # Validates current preferences. If there are incomplete data then this method resets it with default preferences.

speckle_connector/src/speckle_entities/speckle_entity.rb

@@ -136,6 +136,15 @@ module SpeckleConnector
           next if (entity.is_a?(Sketchup::Face) || entity.is_a?(Sketchup::Edge)) &&
                   !state.user_state.user_preferences[:register_speckle_entity]
 
+          if entity.is_a?(Sketchup::ComponentDefinition)
+            definition = speckle_object['definition'] || speckle_object['@block_definition'] ||
+              speckle_object['block_definition']
+            if definition
+              speckle_id = definition['id']
+              speckle_type = definition['speckle_type']
+            end
+          end
+
           ent = SpeckleEntity.new(entity, speckle_id, application_id, speckle_type, children, [stream_id])
           ent.write_initial_base_data
           speckle_state = speckle_state.with_speckle_entity(ent)

speckle_connector/src/speckle_objects/geometry/length.rb

@@ -11,6 +11,10 @@ module SpeckleConnector
       end
 
       def self.length_to_native(length, units)
+        if units == 'none'
+          units = SpeckleConnector::Converters::
+              SKETCHUP_UNITS[Sketchup.active_model.options['UnitsOptions']['LengthUnit']]
+        end
         length.__send__(SpeckleConnector::Converters::SKETCHUP_UNIT_STRINGS[units])
       end
     end

speckle_connector/src/speckle_objects/geometry/units.rb

@@ -0,0 +1,207 @@
+# frozen_string_literal: true
+
+module SpeckleConnector
+  module SpeckleObjects
+    module Geometry
+      module Units
+        MILLIMETERS = 'mm'
+        CENTIMETERS = 'cm'
+        METERS = 'm'
+        KILOMETERS = 'km'
+        INCHES = 'in'
+        FEET = 'ft'
+        YARDS = 'yd'
+        MILES = 'mi'
+        NONE = 'none'
+
+        # USInches = "us_in" the smelliest ones, can add later if people scream "USA #1"
+        USFEET = 'us_ft' # it happened, absolutely gross
+
+        SUPPORTED_UNITS = [MILLIMETERS, CENTIMETERS, METERS, KILOMETERS,
+                           INCHES, FEET, USFEET, YARDS, MILES, NONE].freeze
+
+        CONVERSION_TABLE = {
+          MILLIMETERS => {
+            CENTIMETERS => 0.1,
+            METERS => 0.001,
+            KILOMETERS => 1e-6,
+            INCHES => 0.0393701,
+            FEET => 0.00328084,
+            USFEET => 0.0032808333,
+            YARDS => 0.00109361,
+            MILES => 6.21371e-7
+          },
+          CENTIMETERS => {
+            MILLIMETERS => 10,
+            METERS => 0.01,
+            KILOMETERS => 1e-5,
+            INCHES => 0.393701,
+            FEET => 0.0328084,
+            USFEET => 0.0328083333,
+            YARDS => 0.0109361,
+            MILES => 6.21371e-6
+          },
+          METERS => {
+            MILLIMETERS => 1000,
+            CENTIMETERS => 100,
+            KILOMETERS => 0.001,
+            INCHES => 39.3701,
+            FEET => 3.28084,
+            USFEET => 3.28083333,
+            YARDS => 1.09361,
+            MILES => 0.000621371
+          },
+          KILOMETERS => {
+            MILLIMETERS => 1e6,
+            CENTIMETERS => 100000,
+            METERS => 1000,
+            INCHES => 39370.1,
+            FEET => 3280.84,
+            USFEET => 3280.83333,
+            YARDS => 1093.61,
+            MILES => 0.621371
+          },
+          INCHES => {
+            MILLIMETERS => 25.4,
+            CENTIMETERS => 2.54,
+            METERS => 0.0254,
+            KILOMETERS => 2.54e-5,
+            FEET => 0.0833333,
+            USFEET => 0.0833331667,
+            YARDS => 0.027777694,
+            MILES => 1.57828e-5
+          },
+          FEET => {
+            MILLIMETERS => 304.8,
+            CENTIMETERS => 30.48,
+            METERS => 0.3048,
+            KILOMETERS => 0.0003048,
+            INCHES => 12,
+            USFEET => 0.999998,
+            YARDS => 0.333332328,
+            MILES => 0.000189394
+          },
+          USFEET => {
+            MILLIMETERS => 120000.0 / 3937.0,
+            CENTIMETERS => 12000.0 / 3937.0,
+            METERS => 1200.0 / 3937.0,
+            KILOMETERS => 1.2 / 3937.0,
+            INCHES => 12.000024,
+            FEET => 1.000002,
+            YARDS => 1.000002 / 3.0,
+            MILES => 1.000002 / 5280.0
+          },
+          YARDS => {
+            MILLIMETERS => 914.4,
+            CENTIMETERS => 91.44,
+            METERS => 0.9144,
+            KILOMETERS => 0.0009144,
+            INCHES => 36,
+            FEET => 3,
+            USFEET => 2.999994,
+            MILES => 1.0 / 1760.0
+          },
+          MILES => {
+            MILLIMETERS => 1.609e6,
+            CENTIMETERS => 160934,
+            METERS => 1609.34,
+            KILOMETERS => 1.60934,
+            INCHES => 63360,
+            FEET => 5280,
+            USFEET => 5279.98944002112,
+            YARDS => 1759.99469184
+          },
+          NONE => { NONE => 1 }
+        }.freeze
+
+        def self.unit_supported?(unit)
+          SUPPORTED_UNITS.include?(unit)
+        end
+
+        # USYards = "us_yd" the smelliest ones, can add later if people scream "USA #1"
+        # USMiles = "us_mi" the smelliest ones, can add later if people scream "USA #1"
+
+        def self.get_conversion_factor(from, to)
+          from = get_units_from_string(from)
+          to = get_units_from_string(to)
+          CONVERSION_TABLE[from][to] || 1
+        end
+
+        def self.get_units_from_string(unit)
+          return nil if unit.nil?
+
+          case unit.downcase
+          when 'mm', 'mil', 'millimeter', 'millimeters', 'millimetres'
+            MILLIMETERS
+          when 'cm', 'centimetre', 'centimeter', 'centimetres', 'centimeters'
+            CENTIMETERS
+          when 'm', 'meter', 'metre', 'meters', 'metres'
+            METERS
+          when 'inches', 'inch', 'in'
+            INCHES
+          when 'feet', 'foot', 'ft'
+            FEET
+          when 'ussurveyfeet'
+            USFEET
+          when 'yard', 'yards', 'yd'
+            YARDS
+          when 'miles', 'mile', 'mi'
+            MILES
+          when 'kilometers', 'kilometer', 'km'
+            KILOMETERS
+          when 'none'
+            NONE
+          else
+            raise "Cannot understand what unit #{unit} is."
+          end
+        end
+
+        def self.get_encoding_from_unit(unit)
+          case unit
+          when MILLIMETERS
+            1
+          when CENTIMETERS
+            2
+          when METERS
+            3
+          when KILOMETERS
+            4
+          when INCHES
+            5
+          when FEET
+            6
+          when YARDS
+            7
+          when MILES
+            8
+          else
+            0
+          end
+        end
+
+        def self.get_unit_from_encoding(unit)
+          case unit
+          when 1
+            MILLIMETERS
+          when 2
+            CENTIMETERS
+          when 3
+            METERS
+          when 4
+            KILOMETERS
+          when 5
+            INCHES
+          when 6
+            FEET
+          when 7
+            YARDS
+          when 8
+            MILES
+          else
+            NONE
+          end
+        end
+      end
+    end
+  end
+end

speckle_connector/src/speckle_objects/gis/line_element.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+require_relative 'utils'
+require_relative '../base'
+require_relative '../other/transform'
+require_relative '../other/block_definition'
+require_relative '../other/block_instance'
+require_relative '../../constants/type_constants'
+require_relative '../../sketchup_model/dictionary/dictionary_handler'
+
+module SpeckleConnector
+  module SpeckleObjects
+    module GIS
+      # Line element in GIS tools.
+      class LineElement < Base
+        SPECKLE_TYPE = OBJECTS_GIS_LINEELEMENT
+
+        # Handles polygon element differently from display value.
+        def self.to_native(state, obj, layer, entities, &convert_to_native)
+          attributes = GIS.get_qgis_attributes(obj)
+          obj = collect_definition_geometries(obj)
+          obj['name'] = GIS.get_definition_name(obj, attributes)
+
+          state, _definitions = Other::BlockDefinition.to_native(
+            state, obj, layer, entities, &convert_to_native
+          )
+
+          definition = state.sketchup_state.sketchup_model
+                            .definitions[Other::BlockDefinition.get_definition_name(obj)]
+
+          Other::BlockInstance.find_and_erase_existing_instance(definition, obj['id'], obj['applicationId'])
+          t_arr = obj['transform']
+          transform = t_arr.nil? ? Geom::Transformation.new : Other::Transform.to_native(t_arr, obj['units'])
+          instance = entities.add_instance(definition, transform)
+          instance.name = obj['name'] unless obj['name'].nil?
+          SketchupModel::Dictionary::DictionaryHandler.set_hash(instance, attributes, 'qgis')
+          SketchupModel::Dictionary::DictionaryHandler.set_hash(definition, attributes, 'qgis')
+          # Align instance axes that created from display value. (without any transform)
+          Other::BlockInstance.align_instance_axes(instance)
+          return state, [instance, definition]
+        end
+
+        def self.collect_definition_geometries(obj)
+          geometries = []
+
+          # FIXME: This type check needed because of QGIS. It can send geometries both way, object or array..
+          #  This is something need to be fixed by QGIS.
+          if obj['geometry'].is_a?(Array)
+            obj['geometry'].each do |geometry|
+              geometries << geometry
+            end
+          else
+            geometries += obj['geometry']
+          end
+
+          geometries.each do |geo|
+            if geo['speckle_type'] && geo['speckle_type'] == OBJECTS_GEOMETRY_MESH
+              geo['sketchup_attributes'] = { 'is_soften' => false }
+            end
+          end
+
+          obj['geometry'] = geometries
+          obj
+        end
+      end
+    end
+  end
+end

speckle_connector/src/speckle_objects/gis/polygon_element.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require_relative 'utils'
 require_relative '../base'
 require_relative '../other/transform'
 require_relative '../other/block_definition'
@@ -14,26 +15,11 @@ module SpeckleConnector
       class PolygonElement < Base
         SPECKLE_TYPE = OBJECTS_GIS_POLYGONELEMENT
 
-        def self.get_definition_name(obj, attributes)
-          return obj['name'] unless obj['name'].nil?
-
-          return attributes['name'] unless attributes['name'].nil?
-
-          return "def::#{obj['id']}"
-        end
-
-        def self.get_qgis_attributes(obj)
-          attributes = obj['attributes'].to_h
-          speckle_properties = %w[id speckle_type totalChildrenCount units applicationId]
-          speckle_properties.each { |key| attributes.delete(key) }
-          attributes
-        end
-
         # Handles polygon element differently from display value.
         def self.to_native(state, obj, layer, entities, &convert_to_native)
-          attributes = get_qgis_attributes(obj)
+          attributes = GIS.get_qgis_attributes(obj)
           obj = collect_definition_geometries(obj)
-          obj['name'] = get_definition_name(obj, attributes)
+          obj['name'] = GIS.get_definition_name(obj, attributes)
 
           state, _definitions = Other::BlockDefinition.to_native(
             state, obj, layer, entities, &convert_to_native

speckle_connector/src/speckle_objects/gis/utils.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require_relative '../base'
+require_relative '../other/transform'
+require_relative '../other/block_definition'
+require_relative '../other/block_instance'
+require_relative '../../constants/type_constants'
+require_relative '../../sketchup_model/dictionary/dictionary_handler'
+
+module SpeckleConnector
+  module SpeckleObjects
+    module GIS
+      def self.get_definition_name(obj, attributes)
+        return obj['name'] unless obj['name'].nil?
+
+        return attributes['name'] unless attributes['name'].nil?
+
+        return "def::#{obj['id']}"
+      end
+
+      def self.get_qgis_attributes(obj)
+        attributes = obj['attributes'].to_h
+        speckle_properties = %w[id speckle_type totalChildrenCount units applicationId]
+        speckle_properties.each { |key| attributes.delete(key) }
+        attributes
+      end
+    end
+  end
+end

speckle_connector/src/speckle_objects/speckle/core/models/gis_layer_collection.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require_relative 'collection'
+
+module SpeckleConnector
+  module SpeckleObjects
+    module Speckle
+      module Core
+        module Models
+          # VectorLayerCollection object that collect GIS vector elements under it's elements.
+          class GisLayerCollection < Collection
+            # @param state [States::State] state of the Speckle application.
+            def self.to_native(state, vector_layer_collection, layer_or_folder, entities, &convert_to_native)
+              elements = vector_layer_collection['elements']
+
+              elements.each do |element|
+                new_state, _converted_entities = convert_to_native.call(state, element, layer_or_folder, entities)
+                state = new_state
+              end
+
+              return state, []
+            end
+          end
+        end
+      end
+    end
+  end
+end