Calculate rotation of family instance

- Previously we were using definition mappings only for direct shape conversions but now they can live in instances

speckle_connector/src/actions/mapper_initialized.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require_relative 'action'
+require_relative '../mapper/category/revit_category'
+require_relative '../mapper/category/revit_family_category'
+
+module SpeckleConnector
+  module Actions
+    # Collects mapper selection info.
+    class MapperInitialized < Action
+      # @param state [States::State] the current state of the {App::SpeckleConnectorApp}
+      # @return [States::State] the new updated state object
+      def self.update_state(state, _data)
+        init_parameters = {
+          categories: Mapper::Category::RevitCategory.to_a,
+          familyCategories: Mapper::Category::RevitFamilyCategory.to_a
+        }.freeze
+        state.with_mapper_init_queue(init_parameters)
+      end
+    end
+  end
+end

speckle_connector/src/actions/mapper_selection_changed.rb

@@ -2,6 +2,7 @@
 
 require_relative 'action'
 require_relative '../mapper/category/revit_category'
+require_relative '../mapper/category/revit_family_category'
 require_relative '../sketchup_model/reader/mapper_reader'
 require_relative '../sketchup_model/reader/speckle_entities_reader'
 require_relative '../sketchup_model/dictionary/speckle_entity_dictionary_handler'
@@ -35,6 +36,7 @@ module SpeckleConnector
       end
 
       def get_mapping_info(state, selection)
+        source_exist = !state.speckle_state.speckle_mapper_state.mapper_source.nil?
         selection = filter_out_levels(selection)
         grouped_by_type = group_by_type(selection)
 
@@ -45,10 +47,23 @@ module SpeckleConnector
 
         # Return Direct Shape itself if multiple kinds of element are selected like Edge and Face.
         # OR single type is equal to only direct shape supports.
+        return multiple_supported_selection_info(selection) if supported_entity_count > 1
+
+        # FIXME: Distinguish selection info according to selection elegantly!!!
+        if grouped_by_type.keys.first == Sketchup::ComponentInstance
+          return component_selection_info(selection, source_exist)
+        end
+
+        return group_selection_info(selection) if grouped_by_type.keys.first == Sketchup::Group
+
         if supported_entity_count > 1 ||
            (supported_entity_count == 1 &&
              MAPPER_DIRECT_SHAPE_SUPPORTED_ENTITY_TYPES.include?(grouped_by_type.keys.first))
-          return direct_shape_selection_info(selection)
+          if source_exist
+            return direct_shape_selection_info_with_source(selection, [])
+          else
+            return direct_shape_selection_info(selection, source_exist)
+          end
         end
 
         # Only single type selections remained after this point.
@@ -73,29 +88,54 @@ module SpeckleConnector
 
       EMPTY_SELECTION = {
         selection: [],
-        mappingMethods: [],
-        categories: []
+        mappingMethods: []
       }.freeze
 
-      def direct_shape_selection_info(selection)
+      def multiple_supported_selection_info(selection)
         {
           selection: SketchupModel::Reader::MapperReader.entities_schema_details(selection),
-          mappingMethods: ['Direct Shape'],
-          categories: Mapper::Category::RevitCategory.to_a
+          mappingMethods: ['Direct Shape']
+        }.freeze
+      end
+
+      def component_selection_info(selection, source_exist)
+        if source_exist
+          {
+            selection: SketchupModel::Reader::MapperReader.entities_schema_details(selection),
+            mappingMethods: ['Direct Shape', 'New Revit Family', 'Family Instance']
+          }.freeze
+        else
+          {
+            selection: SketchupModel::Reader::MapperReader.entities_schema_details(selection),
+            mappingMethods: ['Direct Shape', 'New Revit Family']
+          }.freeze
+        end
+      end
+
+      def group_selection_info(selection)
+        {
+          selection: SketchupModel::Reader::MapperReader.entities_schema_details(selection),
+          mappingMethods: ['Direct Shape']
+        }.freeze
+      end
+
+      def direct_shape_selection_info(selection, source_exist)
+        methods = ['Direct Shape', 'New Revit Family']
+        methods.append('Family Instance') if source_exist
+        {
+          selection: SketchupModel::Reader::MapperReader.entities_schema_details(selection),
+          mappingMethods: methods
         }.freeze
       end
 
       def direct_shape_selection_info_with_default(selection, methods)
         {
           selection: SketchupModel::Reader::MapperReader.entities_schema_details(selection),
-          mappingMethods: ['Direct Shape'] + methods,
-          categories: Mapper::Category::RevitCategory.to_a
+          mappingMethods: ['Direct Shape'] + methods
         }.freeze
       end
 
-      def direct_shape_selection_info_with_source(state, filtered_selection, methods)
-        types = state.speckle_state.speckle_mapper_state.mapper_source.types
-        levels = state.speckle_state.speckle_mapper_state.mapper_source.levels
+      def direct_shape_selection_info_with_source(filtered_selection, methods)
         instances = @selection.grep(Sketchup::ComponentInstance)
         selected_level = instances.find do |i|
           DICTIONARY::SpeckleEntityDictionaryHandler
@@ -109,8 +149,6 @@ module SpeckleConnector
           selection: READER::MapperReader.entities_schema_details(filtered_selection),
           mappingMethods: ['Direct Shape'] + methods,
           categories: Mapper::Category::RevitCategory.to_a,
-          types: types,
-          levels: levels,
           selectedLevelName: selected_level_name
         }.freeze
       end
@@ -119,13 +157,13 @@ module SpeckleConnector
       def face_selection_info(state, faces)
         source_exist = !state.speckle_state.speckle_mapper_state.mapper_source.nil?
         grouped_by_verticality = faces.group_by { |face| face.normal.perpendicular?(VECTOR_Z) }
-        return direct_shape_selection_info(faces) if grouped_by_verticality.length == 2
+        return direct_shape_selection_info(faces, source_exist) if grouped_by_verticality.length == 2
 
         if source_exist
           if grouped_by_verticality.keys.first
-            direct_shape_selection_info_with_source(state, faces, ['Wall'])
+            direct_shape_selection_info_with_source(faces, ['Wall'])
           else
-            direct_shape_selection_info_with_source(state, faces, ['Floor'])
+            direct_shape_selection_info_with_source(faces, ['Floor'])
           end
         else
           if grouped_by_verticality.keys.first
@@ -141,7 +179,7 @@ module SpeckleConnector
 
         if source_exist
           methods = ['Column', 'Beam', 'Pipe', 'Duct']
-          direct_shape_selection_info_with_source(state, edges, methods)
+          direct_shape_selection_info_with_source(edges, methods)
         else
           default_methods = ['Default Column', 'Default Beam', 'Default Pipe', 'Default Duct']
           direct_shape_selection_info_with_default(edges, default_methods)

speckle_connector/src/actions/mapper_source_updated.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require_relative 'action'
+require_relative '../constants/type_constants'
 require_relative '../mapper/mapper_source'
 require_relative '../speckle_objects/built_elements/revit/revit_element_type'
 
@@ -20,13 +21,15 @@ module SpeckleConnector
       def update_state(state)
         levels = convert_levels(state, @base['@Levels'])
         types = convert_types(@base['@Types'])
+        family_instances = convert_family_instance_types(@base['@Types'])
         mapper_source = Mapper::MapperSource.new(@stream_id, @commit_id, levels, types)
         new_speckle_state = state.speckle_state.with_mapper_source(mapper_source)
         state = state.with_speckle_state(new_speckle_state)
 
         state.with_add_queue('mapperSourceUpdated', @stream_id, [
                                { is_string: false, val: levels.to_json },
-                               { is_string: false, val: types.to_json }
+                               { is_string: false, val: types.to_json },
+                               { is_string: false, val: family_instances.to_json }
                              ])
       end
 
@@ -43,6 +46,27 @@ module SpeckleConnector
         end.compact.to_h
       end
 
+      def convert_family_instance_types(types)
+        family_instance_types = {}
+        types.each do |type, type_elements|
+          next if type_elements.nil? || !type_elements.is_a?(Array) || type == '__closure'
+
+          # skip type if there is no any revit symbol element type
+          symbol_element_types = type_elements.select do |t|
+            t['speckle_type'] == OBJECTS_BUILTELEMENTS_REVIT_REVITSYMBOLELEMENTTYPE &&
+              t['placementType'] == 'OneLevelBased'
+          end
+          next if symbol_element_types.empty?
+
+          elements = type_elements.map do |type_element|
+            SpeckleObjects::BuiltElements::Revit::RevitElementType.to_native(type_element)
+          end
+          elements = elements.group_by { |e| e[:family] }
+          family_instance_types.merge!(elements)
+        end
+        family_instance_types
+      end
+
       def convert_levels(state, levels)
         levels.collect do |level|
           SpeckleObjects::BuiltElements::Level.to_native(state, level, @stream_id)

speckle_connector/src/constants/type_constants.rb

@@ -14,8 +14,10 @@ module SpeckleConnector
   OBJECTS_BUILTELEMENTS_DEFAULT_WALL = 'Objects.BuiltElements.Wall'
   OBJECTS_BUILTELEMENTS_REVIT_WALL = 'Objects.BuiltElements.Wall:Objects.BuiltElements.Revit.RevitWall'
   OBJECTS_BUILTELEMENTS_REVIT_DIRECTSHAPE = 'Objects.BuiltElements.Revit.DirectShape'
+  OBJECTS_BUILTELEMENTS_REVIT_FAMILY_INSTANCE = 'Objects.BuiltElements.Revit.FamilyInstance'
   OBJECTS_BUILTELEMENTS_REVIT_PARAMETER = 'Objects.BuiltElements.Revit.Parameter'
   OBJECTS_BUILTELEMENTS_REVIT_REVITELEMENTTYPE = 'Objects.BuiltElements.Revit.RevitElementType'
+  OBJECTS_BUILTELEMENTS_REVIT_REVITSYMBOLELEMENTTYPE = 'Objects.BuiltElements.Revit.RevitElementType:Objects.BuiltElements.Revit.RevitSymbolElementType'
 
   OBJECTS_GEOMETRY_LINE = 'Objects.Geometry.Line'
   OBJECTS_GEOMETRY_POLYLINE = 'Objects.Geometry.Polyline'

speckle_connector/src/convertors/to_speckle.rb

@@ -64,19 +64,14 @@ module SpeckleConnector
       def convert(entity, preferences, speckle_state, parent = :base)
         convert = method(:convert)
 
-        unless SketchupModel::Reader::MapperReader.mapped_with_schema?(entity)
+        unless SketchupModel::Reader::MapperReader.mapped_with_schema?(entity) &&
+               !entity.is_a?(Sketchup::ComponentDefinition)
           return from_native_to_speckle(entity, preferences, speckle_state, parent, &convert)
         end
 
         return speckle_state, nil
       end
 
-      def from_mapped_to_speckle(entity, path, preferences)
-        direct_shape = SpeckleObjects::BuiltElements::Revit::DirectShape
-                       .from_entity(speckle_state, entity, path, @units, preferences)
-        return [direct_shape, [entity]]
-      end
-
       # rubocop:disable Metrics/MethodLength
       def from_native_to_speckle(entity, preferences, speckle_state, parent, &convert)
         if entity.is_a?(Sketchup::Edge)

speckle_connector/src/mapper/category/revit_category.rb

@@ -118,7 +118,8 @@ module SpeckleConnector
               VibrationManagement: 106,
               Walls: 107,
               StructConnectionWelds: 108,
-              Windows: 109
+              Windows: 109,
+              Railings: 110
             }.freeze
           end
           # rubocop:enable Metrics/MethodLength

speckle_connector/src/mapper/category/revit_family_category.rb

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+module SpeckleConnector
+  module Mapper
+    module Category
+      # Revit categories for families.
+      class RevitFamilyCategory < Hash
+        class << self
+          # rubocop:disable Metrics/MethodLength
+          def dictionary
+            {
+              AudioVisualDevices: 9,
+              CableTrayFitting: 16,
+              Casework: 19,
+              Columns: 21,
+              CommunicationDevices: 22,
+              ConduitFitting: 23,
+              DataDevices: 30,
+              Doors: 32,
+              DuctAccessory: 33,
+              ElectricalEquipment: 38,
+              ElectricalFixtures: 39,
+              Entourage: 40,
+              FireAlarmDevices: 42,
+              FireProtection: 43,
+              FoodServiceEquipment: 45,
+              Furniture: 46,
+              FurnitureSystems: 47,
+              GenericAnnotation: 48,
+              GenericModel: 49,
+              Hardscape: 51,
+              LightingDevices: 52,
+              LightingFixtures: 53,
+              Lines: 54,
+              Mass: 55,
+              MechanicalEquipment: 56,
+              MedicalEquipment: 57,
+              NurseCallDevices: 58,
+              Parking: 59,
+              PipeAccessory: 68,
+              PipeFitting: 69,
+              Planting: 74,
+              PlumbingFixtures: 76,
+              Roads: 80,
+              SecurityDevices: 82,
+              Signage: 84,
+              Site: 85,
+              SpecialityEquipment: 86,
+              Sprinklers: 87,
+              StructuralFramingSystem: 89,
+              StructuralColumns: 90,
+              StructConnections: 91,
+              StructuralFoundation: 93,
+              StructuralFraming: 94,
+              StructuralStiffener: 97,
+              TemporaryStructure: 100,
+              VerticalCirculation: 103,
+              Windows: 109,
+              Railings: 110
+            }.freeze
+          end
+          # rubocop:enable Metrics/MethodLength
+
+          def reverse_dictionary
+            dictionary.collect { |k, v| [v, k] }.to_h
+          end
+
+          def to_a
+            dictionary.collect { |k, v| { key: k, value: v } }.to_a
+          end
+
+          def reverse_to_a
+            dictionary.collect { |k, v| { key: v, value: k } }.to_a
+          end
+        end
+      end
+    end
+  end
+end

speckle_connector/src/mapper/mapper.rb

@@ -4,6 +4,7 @@ require_relative '../speckle_objects/built_elements/revit/revit_floor'
 require_relative '../speckle_objects/built_elements/revit/revit_wall'
 require_relative '../speckle_objects/built_elements/default_floor'
 require_relative '../speckle_objects/built_elements/default_wall'
+require_relative '../speckle_objects/other/mapped_block_wrapper'
 require_relative '../sketchup_model/query/entity'
 require_relative '../sketchup_model/reader/mapper_reader'
 require_relative '../sketchup_model/dictionary/speckle_schema_dictionary_handler'
@@ -31,7 +32,7 @@ module SpeckleConnector
       mapped_selection
     end
 
-    def self.to_speckle(speckle_state, entity, units, global_transformation: nil)
+    def self.to_speckle(speckle_state, entity, units, model_preferences, global_transformation: nil, path: nil)
       speckle_schema = SketchupModel::Dictionary::SpeckleSchemaDictionaryHandler.speckle_schema_to_speckle(entity)
       return speckle_schema if speckle_schema.nil?
 

speckle_connector/src/speckle_objects/built_elements/revit/direct_shape.rb

@@ -89,7 +89,7 @@ module SpeckleConnector
             mapped_selection
           end
 
-          def self.from_entity(speckle_state, entity, path, units, preferences)
+          def self.from_entity(speckle_state, entity, path, units, model_preferences)
             schema = DICTIONARY::SpeckleSchemaDictionaryHandler.attribute_dictionary(entity)
             if schema.nil? && entity.respond_to?(:definition)
               schema = DICTIONARY::SpeckleSchemaDictionaryHandler.attribute_dictionary(entity.definition)
@@ -103,7 +103,7 @@ module SpeckleConnector
                                       entity.definition.entities, [Sketchup::Face], path.append(entity)
                                     )
             end
-            base_geometries = group_faces_under_mesh_by_material(speckle_state, entities_with_path, units, preferences)
+            base_geometries = group_faces_under_mesh_by_material(speckle_state, entities_with_path, units, model_preferences)
             DirectShape.new(
               name: schema[:name], category: schema[:category], units: units,
               base_geometries: base_geometries, application_id: entity.persistent_id
@@ -111,13 +111,13 @@ module SpeckleConnector
           end
 
           # rubocop:disable Metrics/MethodLength
-          def self.group_faces_under_mesh_by_material(speckle_state, faces_with_path, units, preferences)
+          def self.group_faces_under_mesh_by_material(speckle_state, faces_with_path, units, model_preferences)
             mesh_groups = {}
             faces_with_path.each do |face_with_path|
               face = face_with_path[0]
               entity_path = face_with_path[1..-1]
               parent_material = QUERY::Entity.parent_material(entity_path)
-              mesh_group_id = Geometry::Mesh.get_mesh_group_id(face, preferences[:model], parent_material)
+              mesh_group_id = Geometry::Mesh.get_mesh_group_id(face, model_preferences, parent_material)
 
               if mesh_groups.key?(mesh_group_id)
                 mesh_group = mesh_groups[mesh_group_id]
@@ -126,7 +126,7 @@ module SpeckleConnector
               else
                 mesh = Geometry::Mesh.from_face(
                   speckle_state: speckle_state,
-                  face: face, units: units, model_preferences: preferences[:model],
+                  face: face, units: units, model_preferences: model_preferences,
                   global_transform: QUERY::Entity.global_transformation(face, entity_path),
                   parent_material: parent_material
                 )

speckle_connector/src/speckle_objects/built_elements/revit/family_instance.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require_relative '../../base'
+require_relative '../../../constants/type_constants'
+
+module SpeckleConnector
+  module SpeckleObjects
+    module BuiltElements
+      module Revit
+        # Family instance for Revit mappings.
+        class FamilyInstance < Base
+          SPECKLE_TYPE = OBJECTS_BUILTELEMENTS_REVIT_FAMILY_INSTANCE
+          READER = SketchupModel::Reader
+          QUERY = SketchupModel::Query
+          DICTIONARY = SketchupModel::Dictionary
+
+          # rubocop:disable Metrics/ParameterLists
+          def initialize(family:, type:, level:, units:, base_point:, rotation:, application_id: nil)
+            super(
+              speckle_type: SPECKLE_TYPE,
+              total_children_count: 0,
+              application_id: application_id,
+              id: nil
+            )
+            self[:family] = family
+            self[:type] = type
+            self[:level] = level
+            self[:units] = units
+            self[:basePoint] = base_point
+            self[:rotation] = rotation
+          end
+          # rubocop:enable Metrics/ParameterLists
+        end
+      end
+    end
+  end
+end

speckle_connector/src/speckle_objects/geometry/mesh.rb

@@ -154,7 +154,7 @@ module SpeckleConnector
           has_any_soften_edge = face.edges.any?(&:soft?)
           att = dictionaries.any? ? { is_soften: has_any_soften_edge, dictionaries: dictionaries }
                   : { is_soften: has_any_soften_edge }
-          speckle_schema = Mapper.to_speckle(speckle_state, face, units, global_transformation: global_transform)
+          speckle_schema = Mapper.to_speckle(speckle_state, face, units, model_preferences, global_transformation: global_transform)
           material = face.material || face.back_material || parent_material
           speckle_mesh = Mesh.new(
             units: units,

speckle_connector/src/speckle_objects/other/block_instance.rb

@@ -5,6 +5,8 @@ require_relative 'transform'
 require_relative 'block_definition'
 require_relative '../base'
 require_relative '../geometry/bounding_box'
+require_relative '../other/mapped_block_wrapper'
+require_relative '../built_elements/revit/family_instance'
 require_relative '../../sketchup_model/dictionary/base_dictionary_handler'
 require_relative '../../sketchup_model/dictionary/speckle_schema_dictionary_handler'
 require_relative '../../sketchup_model/query/layer'
@@ -40,7 +42,7 @@ module SpeckleConnector
           self[:renderMaterial] = render_material
           self[:transform] = transform
           self[:sketchup_attributes] = sketchup_attributes if sketchup_attributes.any?
-          self[:SpeckleSchema] = speckle_schema if speckle_schema.any?
+          self[:speckle_schema] = speckle_schema if speckle_schema.any?
           # FIXME: Since blockDefinition sends with @ as detached, block basePlane renders on viewer.
           self['@@definition'] = block_definition
         end
@@ -72,7 +74,7 @@ module SpeckleConnector
 
         # @param component_instance [Sketchup::ComponentInstance] component instance to convert Speckle BlockInstance
         # rubocop:disable Metrics/MethodLength
-        def self.from_component_instance(component_instance, units, preferences, speckle_state, &convert)
+        def self.from_component_instance(component_instance, units, preferences, speckle_state, path: nil, &convert)
           new_speckle_state, block_definition = convert.call(
             component_instance.definition,
             preferences,
@@ -82,11 +84,20 @@ module SpeckleConnector
           speckle_state = new_speckle_state
 
           dictionaries = SketchupModel::Dictionary::BaseDictionaryHandler
-                         .attribute_dictionaries_to_speckle(component_instance, preferences[:model])
+                         .attribute_dictionaries_to_speckle(component_instance, preferences)
           att = dictionaries.any? ? { dictionaries: dictionaries } : {}
           speckle_schema = SketchupModel::Dictionary::SpeckleSchemaDictionaryHandler
                            .speckle_schema_to_speckle(component_instance)
 
+          if speckle_schema.empty?
+            speckle_schema = SketchupModel::Dictionary::SpeckleSchemaDictionaryHandler
+                             .speckle_schema_to_speckle(component_instance.definition)
+          end
+
+          # transform into global if any path provided
+          transformation = component_instance.transformation
+          transformation = SketchupModel::Query::Entity.global_transformation(component_instance, path) if path
+
           block_instance = BlockInstance.new(
             units: units,
             is_sketchup_group: false,
@@ -96,13 +107,43 @@ module SpeckleConnector
                              else
                                RenderMaterial.from_material(component_instance.material)
                              end,
-            transform: Other::Transform.from_transformation(component_instance.transformation, units),
+            transform: Other::Transform.from_transformation(transformation, units),
             block_definition: block_definition,
             layer: SketchupModel::Query::Layer.entity_path(component_instance),
             sketchup_attributes: att,
             speckle_schema: speckle_schema,
             application_id: component_instance.persistent_id.to_s
           )
+
+          if speckle_schema
+            case speckle_schema['method']
+            when 'New Revit Family'
+              # duplicate already converted one to attach without speckle schema into mapped block wrapper
+              copy_block_instance = block_instance.clone(freeze: true)
+              block_instance['@SpeckleSchema'] = SpeckleObjects::Other::MappedBlockWrapper.new(
+                category: speckle_schema['category'],
+                units: units,
+                instance: copy_block_instance,
+                application_id: component_instance.persistent_id.to_s
+              )
+            when 'Family Instance'
+              level = speckle_state.speckle_mapper_state.mapper_source
+                                   .levels.find { |l| l[:name] == speckle_schema['level'] }
+              family = speckle_schema['family']
+              type = speckle_schema['family_type']
+              block_instance['@SpeckleSchema'] = SpeckleObjects::BuiltElements::Revit::FamilyInstance.new(
+                family: family,
+                type: type,
+                level: level,
+                units: units,
+                base_point: SpeckleObjects::Geometry::Point
+                              .from_vertex(component_instance.bounds.min.transform(transformation), units),
+                rotation: calculate_rotation(transformation.to_a),
+                application_id: component_instance.persistent_id.to_s
+              )
+            end
+          end
+
           return speckle_state, block_instance
         end
         # rubocop:enable Metrics/MethodLength
@@ -228,6 +269,26 @@ module SpeckleConnector
           instance_transform = instance.transformation
           instance.transform!(instance_transform * transform.inverse * instance_transform.inverse)
         end
+
+        def self.calculate_rotation(matrix)
+          # Ensure the matrix is a flat array with 16 elements
+          unless matrix.is_a?(Array) && matrix.size == 16
+            raise ArgumentError, 'Matrix must be an array with 16 elements'
+          end
+
+          # Extract the elements of the 2x2 rotation sub-matrix
+          cos_theta = matrix[0] # First column, first row
+          sin_theta = matrix[1] # Second column, first row
+
+          # Calculate the rotation angle in radians
+          theta = Math.atan2(sin_theta, cos_theta)
+
+          # Ensure the angle is between -π and π
+          theta -= 2 * Math::PI while theta > Math::PI
+          theta += 2 * Math::PI while theta < -Math::PI
+
+          theta
+        end
       end
     end
   end

speckle_connector/src/speckle_objects/other/mapped_block_wrapper.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require_relative '../base'
+
+module SpeckleConnector
+  module SpeckleObjects
+    module Other
+      # MappedBlockWrapper object definition for Speckle.
+      class MappedBlockWrapper < Base
+        SPECKLE_TYPE = 'Objects.Other.MappedBlockWrapper'
+        def initialize(category:, units:, instance:, application_id: nil)
+          super(
+            speckle_type: SPECKLE_TYPE,
+            total_children_count: 0,
+            application_id: application_id,
+            id: nil
+          )
+          self[:category] = category
+          self[:units] = units
+          self[:instance] = instance
+        end
+      end
+    end
+  end
+end

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

@@ -27,6 +27,27 @@ module SpeckleConnector
               self[:active_layer] = active_layer
             end
 
+            def self.to_native(state, model_collection, layer, entities, &convert_to_native)
+              elements = model_collection['elements']
+              views = model_collection['@Views']
+              if views
+                views.each do |view|
+                  new_state, _converted_entities = convert_to_native.call(state, view, layer, entities)
+                  state = new_state
+                end
+              end
+
+              elements.each do |element|
+                new_state, _converted_entities = convert_to_native.call(state, element, layer, entities)
+                state = new_state
+              end
+
+              active_layer = model_collection['active_layer']
+              state.sketchup_state.sketchup_model.active_layer = active_layer unless active_layer.nil?
+
+              return state, []
+            end
+
             def self.from_sketchup_model(sketchup_model, speckle_state, units, preferences, &convert)
               model_collection = ModelCollection.new(
                 name: 'Sketchup Model', active_layer: sketchup_model.active_layer.display_name,
@@ -60,36 +81,17 @@ module SpeckleConnector
             def self.collect_mapped_entities(speckle_state, sketchup_model, units, preferences, &convert)
               mapped_entities = Mapper.mapped_entities_on_selection(sketchup_model)
               mapped_entities.collect do |entity_with_path|
-                convert_mapped_entity(speckle_state, entity_with_path, preferences, units)
+                convert_mapped_entity(speckle_state, entity_with_path, preferences, units, &convert)
               end
             end
 
-            def self.to_native(state, model_collection, layer, entities, &convert_to_native)
-              elements = model_collection['elements']
-              views = model_collection['@Views']
-              if views
-                views.each do |view|
-                  new_state, _converted_entities = convert_to_native.call(state, view, layer, entities)
-                  state = new_state
-                end
-              end
-
-              elements.each do |element|
-                new_state, _converted_entities = convert_to_native.call(state, element, layer, entities)
-                state = new_state
-              end
-
-              active_layer = model_collection['active_layer']
-              state.sketchup_state.sketchup_model.active_layer = active_layer unless active_layer.nil?
-
-              return state, []
-            end
-
-            def self.convert_mapped_entity(speckle_state, entity_with_path, preferences, units)
+            def self.convert_mapped_entity(speckle_state, entity_with_path, preferences, units, &convert)
               entity = entity_with_path[0]
               path = entity_with_path[1..-1]
-
               method = SPECKLE_SCHEMA_DICTIONARY_HANDLER.get_attribute(entity, 'method')
+              if entity.is_a?(Sketchup::ComponentInstance) && method.nil?
+                method = SPECKLE_SCHEMA_DICTIONARY_HANDLER.get_attribute(entity.definition, 'method')
+              end
 
               if !method.nil? && (method.include?('Floor') || method.include?('Wall')) && entity.is_a?(Sketchup::Face)
                 global_transformation = QUERY::Entity.global_transformation(entity, path)
@@ -99,8 +101,19 @@ module SpeckleConnector
                 return [floor, [entity]]
               end
 
-              direct_shape = DIRECT_SHAPE.from_entity(speckle_state, entity, path, units, preferences)
-              return [direct_shape, [entity]]
+              if method == 'Direct Shape'
+                direct_shape = DIRECT_SHAPE.from_entity(speckle_state, entity, path, units, preferences)
+                return [direct_shape, [entity]]
+              end
+
+              if ['New Revit Family', 'Family Instance'].include?(method)
+                _speckle_state, block_instance = SpeckleObjects::Other::BlockInstance.from_component_instance(
+                  entity, units, preferences, speckle_state, path: path, &convert
+                )
+                return [block_instance, [entity]]
+              end
+
+              nil
             end
           end
         end

speckle_connector/src/states/speckle_state.rb

@@ -75,6 +75,12 @@ module SpeckleConnector
         with(:@message_queue => new_queue)
       end
 
+      def with_mapper_init_queue(init_parameters)
+        new_queue = message_queue.merge({ "mapperInitialized":
+                                            "mapperInitialized(#{JSON.generate(init_parameters)})" })
+        with(:@message_queue => new_queue)
+      end
+
       def with_mapper_deselection_queue
         new_queue = message_queue.merge({ "entitiesDeselected": 'entitiesDeselected()' })
         with(:@message_queue => new_queue)

speckle_connector/src/states/state.rb

@@ -50,6 +50,11 @@ module SpeckleConnector
         with(:@speckle_state => new_speckle_state)
       end
 
+      def with_mapper_init_queue(init_parameters)
+        new_speckle_state = speckle_state.with_mapper_init_queue(init_parameters)
+        with(:@speckle_state => new_speckle_state)
+      end
+
       def with_empty_stream_queue
         new_speckle_state = speckle_state.with(:@stream_queue => {})
         with(:@speckle_state => new_speckle_state)

speckle_connector/src/ui/vue_view.rb

@@ -18,6 +18,7 @@ require_relative '../commands/apply_mappings'
 require_relative '../commands/clear_mappings'
 require_relative '../commands/mapper_source_updated'
 
+require_relative '../actions/mapper_initialized'
 require_relative '../actions/reload_accounts'
 require_relative '../actions/load_saved_streams'
 require_relative '../actions/init_local_accounts'
@@ -93,7 +94,8 @@ module SpeckleConnector
           select_mappings_from_table: Commands::ActionCommand.new(@app, Actions::SelectMappingsFromTable),
           show_all_entities: Commands::ActionCommand.new(@app, Actions::ShowAllEntities),
           mapper_source_updated: Commands::MapperSourceUpdated.new(@app),
-          clear_mapper_source: Commands::ActionCommand.new(@app, Actions::ClearMapperSource)
+          clear_mapper_source: Commands::ActionCommand.new(@app, Actions::ClearMapperSource),
+          mapper_initialized: Commands::ActionCommand.new(@app, Actions::MapperInitialized)
         }.freeze
       end
       # rubocop:enable Metrics/MethodLength

ui/src/components/Mapper.vue

@@ -171,7 +171,7 @@
               class="pt-0"
               label="Family"
               :disabled="!entitySelected"
-              :items="families"
+              :items="inputFamilies"
               density="compact"
               clearable
               @change="onSelectedFamilyChange"
@@ -208,7 +208,7 @@
               v-model="selectedCategory"
               class="pt-0"
               label="Category"
-              :items="availableCategories"
+              :items="selectedMethod === 'New Revit Family' ? familyCategories : categories"
               item-value="value"
               item-text="key"
               :disabled="!entitySelected"
@@ -282,14 +282,19 @@ import {groupBy} from "@/utils/groupBy";
 import MappingSource from "@/components/MapperSource.vue";
 import {sourceMap} from "@vue/cli-service/lib/config/terserOptions";
 
-global.mapperSourceUpdated = function (streamId, levels, types) {
+global.mapperSourceUpdated = function (streamId, levels, types, familyInstances) {
   console.log(`Mapper source updated for ${streamId}.`)
+  bus.$emit('mapper-source-updated', JSON.stringify(levels), JSON.stringify(types), JSON.stringify(familyInstances))
 }
 
 global.entitySelected = function (selectionParameters) {
   bus.$emit('entities-selected', JSON.stringify(selectionParameters))
 }
 
+global.mapperInitialized = function (initParameters) {
+  bus.$emit('mapper-initialized', JSON.stringify(initParameters))
+}
+
 global.entitiesDeselected = function () {
   bus.$emit('entities-deselected')
 }
@@ -343,7 +348,7 @@ export default {
       entitySelected: false,
       selectedEntityCount: 0,
       selectedEntities: [],
-      allFamilyTypes: {},
+
       familyTypes: [],
       lastSelectedEntity: null,
 
@@ -355,10 +360,17 @@ export default {
       name: "",
 
       availableMethods: [],
-      availableCategories: [],
-      families: [],
-      allTypes: {},
+      categories: [],
+      familyCategories: [],
+
+      inputCategories: [],
+      inputFamilies: [],
+      inputFamilyTypes: {},
+
+      // comes from source
+      types: {},
       levels: [],
+      familyInstanceTypes: {}, // comes from source as filtered
 
       mappedEntityCount: 0,
       mappedEntities: [],
@@ -531,6 +543,14 @@ export default {
         this.categorySelectionActive = true
         this.nameSelectionActive = true
       }
+      else if (this.selectedMethod === 'New Revit Family'){
+        this.categorySelectionActive = true
+      }
+      else if (this.selectedMethod === 'Family Instance'){
+        this.typeSelectionActive = true
+        this.familySelectionActive = true
+        this.levelSelectionActive = true
+      }
       else if (nativeDefaultMethods.includes(this.selectedMethod)){
         this.typeSelectionActive = false
         this.familySelectionActive = false
@@ -545,53 +565,66 @@ export default {
       }
     },
     getTypesFromSelectedFamily(){
-      this.familyTypes = this.allFamilyTypes[this.selectedFamily]
-      this.selectedFamilyType = this.familyTypes[0].type
-      if (this.selectedFamily === null || this.selectedFamily === undefined){
-        this.selectedFamily = this.families[0]
-      }
-      if (this.familyTypes === null ||this.familyTypes === undefined){
-        this.familyTypes = this.allFamilyTypes[this.selectedFamily]
-      }
-      if (this.selectedFamilyType === null || this.selectedFamilyType === undefined){
-        this.selectedFamilyType = this.familyTypes[0].type
+      // There is no sense to set selected family type if method is not selected
+      if (this.selectedMethod){
+        if (this.sourceState !== 'Not Set'){
+          this.familyTypes = this.inputFamilyTypes[this.selectedFamily]
+          this.selectedFamilyType = this.familyTypes[0].type
+          if (this.selectedFamilyType === null || this.selectedFamilyType === undefined){
+            this.selectedFamilyType = this.familyTypes[0].type
+          }
+        }
+        if (this.selectedFamily === null || this.selectedFamily === undefined){
+          this.selectedFamily = this.inputFamilies[0]
+        }
+        if (this.familyTypes === null ||this.familyTypes === undefined){
+          this.familyTypes = this.inputFamilyTypes[this.selectedFamily]
+        }
       }
     },
     getFamiliesFromSelectedMethod(){
       switch (this.selectedMethod) {
         case 'Floor':
-          this.families = Object.keys(this.allTypes['Floors']);
-          this.allFamilyTypes = this.allTypes['Floors']
+          this.inputFamilies = Object.keys(this.types['Floors']);
+          this.inputFamilyTypes = this.types['Floors']
           break;
         case 'Wall':
-          this.families = Object.keys(this.allTypes['Walls']);
-          this.allFamilyTypes = this.allTypes['Walls']
+          this.inputFamilies = Object.keys(this.types['Walls']);
+          this.inputFamilyTypes = this.types['Walls']
           break;
         case 'Column':
-          this.families = Object.keys(this.allTypes['Columns']);
-          this.allFamilyTypes = this.allTypes['Columns']
+          this.inputFamilies = Object.keys(this.types['Columns']);
+          this.inputFamilyTypes = this.types['Columns']
           break;
         case 'Beam':
-          this.families = Object.keys(this.allTypes['Beams']);
-          this.allFamilyTypes = this.allTypes['Beams']
+          this.inputFamilies = Object.keys(this.types['Beams']);
+          this.inputFamilyTypes = this.types['Beams']
           break;
         case 'Pipe':
-          this.families = Object.keys(this.allTypes['Piping System']);
-          this.allFamilyTypes = this.allTypes['Piping System']
+          this.inputFamilies = Object.keys(this.types['Piping System']);
+          this.inputFamilyTypes = this.types['Piping System']
           break;
         case 'Duct':
-          this.families = Object.keys(this.allTypes['Duct System']);
-          this.allFamilyTypes = this.allTypes['Duct System']
+          this.inputFamilies = Object.keys(this.types['Duct System']);
+          this.inputFamilyTypes = this.types['Duct System']
+          break;
+        case 'Family Instance':
+          this.inputFamilies = Object.keys(this.familyInstanceTypes);
+          this.inputFamilyTypes = this.familyInstanceTypes
           break;
         default:
           break;
       }
-      if (this.selectedFamily === null || this.selectedFamily === undefined){
-        this.selectedFamily = this.families[0]
-      }
-      if (this.selectedLevel === null || this.selectedLevel === undefined){
-        this.selectedLevel = this.levels[0].name
+      if (this.selectedMethod){
+        if (this.selectedFamily === null || this.selectedFamily === undefined){
+          this.selectedFamily = this.inputFamilies[0]
+        }
+        if (this.selectedLevel === null || this.selectedLevel === undefined){
+          this.selectedLevel = this.levels[0].name
+        }
       }
+      console.log(this.selectedFamily, "selectedFamily after")
+      console.log(this.selectedLevel, "selectedLevel after")
     },
     hideOptionalMappingInputs(){
       this.categorySelectionActive = false
@@ -608,7 +641,6 @@ export default {
     },
     clearInputs(){
       this.availableMethods = []
-      this.availableCategories = []
       this.selectedEntities = []
       this.selectionTableData = []
       this.selectedEntityCount = 0
@@ -620,8 +652,6 @@ export default {
       this.selectedLevel = null
       this.selectedFamily = null
       this.selectedFamilyType = null
-      this.allTypes = null
-      this.familyTypes = null
     },
     getSelectionTableData(){
       let groupByClass = groupBy('entityType')
@@ -683,6 +713,7 @@ export default {
           }
           this.selectedMethod = this.lastSelectedEntity['definition']['schema']['method']
           this.selectedCategory = this.lastSelectedEntity['definition']['schema']['category']
+          this.updateMappingInputs()
         }
       }
       // Otherwise set entity mappings.
@@ -694,7 +725,6 @@ export default {
           }else{
             this.name = this.lastSelectedEntity['entityName']
           }
-          console.log("entity not mapped")
           this.updateMappingInputs()
           this.getFamiliesFromSelectedMethod()
           this.getTypesFromSelectedFamily()
@@ -706,7 +736,6 @@ export default {
             this.name = this.lastSelectedEntity['schema']['name']
           }
           this.selectedMethod = this.lastSelectedEntity['schema']['method']
-          console.log("entity is mapped")
           this.updateMappingInputs()
           this.selectedFamily = this.lastSelectedEntity['schema']['family']
           this.selectedCategory = this.lastSelectedEntity['schema']['category']
@@ -814,18 +843,11 @@ export default {
       this.selectedFamily = null
       this.selectedFamilyType = null
       this.selectedLevel = null
-      this.familyTypes = null
-      this.levels = null
       this.availableMethods = null
-      this.availableCategories = null
-      this.allTypes = null
     },
     getDataFromSelection(selectionParameters){
       this.availableMethods = selectionParameters.mappingMethods
-      this.availableCategories = selectionParameters.categories
       this.selectedEntities = selectionParameters.selection
-      this.allTypes = selectionParameters.types
-      this.levels = selectionParameters.levels
       this.selectedLevel = selectionParameters.selectedLevelName
     },
     updateStatesFromSelectionData(){
@@ -838,8 +860,22 @@ export default {
     }
   },
   mounted() {
+    sketchup.exec({name: "mapper_initialized", data: {}})
     sketchup.exec({name: "collect_mapped_entities", data: {}})
 
+    bus.$on('mapper-initialized', async (initParameters) => {
+      const initPars = JSON.parse(initParameters)
+      this.categories = initPars.categories
+      this.familyCategories = initPars.familyCategories
+    })
+
+    bus.$on('mapper-source-updated', async (levels, types, familyInstances) => {
+      // Parse data to json object
+      this.familyInstanceTypes = JSON.parse(familyInstances)
+      this.levels = JSON.parse(levels)
+      this.types = JSON.parse(types)
+    })
+
     bus.$on('entities-selected', async (selectionParameters) => {
       // Parse data to json object
       const selectionPars = JSON.parse(selectionParameters)

ui/src/components/MapperSource.vue

@@ -219,9 +219,4 @@ export default {
     }
   }
 }
-
 </script>
-
-<style scoped>
-
-</style>