Apartment Layout


Apartment Layout

Attention! The plugin is purchased for the specified version of the Autodesk product!

To use the purchased license, use the Personal account of the ModPlus software installed on Your computer
Old price: 0.00 USD
72.00 USD

Try before you buy


Most of the plugins in the ModPlus software are free! But, approximately 30% of the plugins are paid. However, these plugins are distributed on the principle "Try before you buy" - which means that you can use these plugins in almost their full functionality and buy them only if you want!
  • Comprehensive implementation of Apartment Layout
    About files with the extension .mpif
    The file with the .mpif extension is a special installation file of the ModPlus (ModPlus Install File).
    These files allow you to install and update all ModPlus components using the auto-update module in case you do not have access to the internet or modplus.org


    32x32px 16x16px dark 32x32px dark 16x16px

    Related news and articles


    The plugin contains a set of tools to perform a apartment building layout. The tools are presented as tabs in a logical sequence of execution:

    • set basic settings
    • create or map parameters
    • check and correct invalid rooms
    • complete the collection of apartments
    • calculate areas and apartments typology
    • number the apartments

    Each tab contains switchable instructions.

    The "Functional purpose" parameter, to be completed manually, is used for identification of rooms to be processed.

    Example Excel file with the room matrix and apartment types - download.




    Apartment identifier - sets the value of the "Functional purpose" parameter, by which the rooms to be processed will be defined. The default value is "Apartment".

    Allowed identifiers - the list of values that can be in the "Functional purpose" parameter, but must not be processed by the plugin algorithms.

    Restore hidden instructions - restores hidden instructions on all tabs.

    Apartment areas


    Rounding areas - specifies parameters for rounding the area when calculating. Rounding is taken into account at each step of the calculation (room area is rounded, then the calculated apartment areas are rounded).

    Below there are drop-down lists indicating which area - rounded without/by coefficient - to use for calculating living area, apartment area and total apartment area.



    This tab contains a list of parameters that are required for the plugin to work. The list specifies the parameter name, parameter data type, and parameter description. On the right side of the list you can specify custom common parameters from the current document (parameter mapping). Parameter mapping data is stored in the document.

    Parameter data types - text, area, currency - allow you to work with rooms that are in groups.

    Use system parameter "Number" instead of "RM_Room number" parameter - if checked, the room number will be written to the system parameter "Number". In this case, the parameter "Room_Number" may not be added to the project.

    Open parameter list in notepad - displays a list of parameters in notepad, allowing you to add parameters to the file of general parameters.

    Create missing parameters - creation of all parameters missing from the list in the current document

    Save as default - saves the current parameter mapping as default. If you run the plugin in another document that has parameters from the mapping, they will be automatically selected in the list.


    All subsequent tabs become available if two conditions are met: all the necessary parameters are present in the document and the apartment identifier is specified in the settings.



    The sources contain the data needed to calculate the areas of the apartments and to determine apartment types.

    You can create and store in the plugin several source variants (several room matrices and several tables of apartment types). The processing will be performed on the current sources. That is, the sources selected in the drop-down lists.

    You can export the current sources - the current matrix and the current table of apartment types - to a single Excel file using the Export current sources to Excel button, and you can export all existing sources to a single Excel file using the Export all sources to Excel button.

    Room matrix


    The table contains the data used for calculating the apartment areas:

    • Room Name (the value of the built-in parameter "Name") is the key by which the values below are matched
    • Finishing thickness - thickness of rough finish of compartment in millimeters, which enables taking the finishing layer into account without modeling. It is written to the room parameter (AP_ Finishing thickness) and taken into account when calculating the area of the room (AP_Rounded area).
    • Room type - drop-down list that specifies room type (Residential/Non-residential/Non-heated). It is written to the room parameter (AP_Room Type).
    • Area factor - a decreasing coefficient with a valid value from 0.1 to 1.0. It is written in the room parameter (AP_Area Factor). It is taken into account when calculating the area with a coefficient (AP_Area with factor) and the area of unheated rooms with a coefficient (AP_Non-heated rooms area). It can also be taken into account when calculating the apartment area, living area and total area, if the corresponding option is specified in the settings (tab " Apartment areas").
    • Numbering priority - specify the numbering priority within the apartment

    Export, Import - export/import of room matrix to/from Excel. When importing, it is possible both to overwrite the current table in full and to supplement it.

    Apartment types


    The table contains the data used to determine apartment types when calculating the area of apartments according to the following criteria:

    • Number of living rooms
    • Minimum area - if a value of 0 is specified, will not be taken into account
    • Maximum area - if a value of 0 is entered, will not be taken into account
    • Contains rooms - the list of rooms that must be present in the apartment. The rooms are to be separated by semicolons. Optional
    • Not contains rooms - a list of rooms that are to be absent in the apartment. The rooms are to be separated by semi-colons. Optional

    Below the list there is a drop-down list, indicating what kind of area (floor, living area, total area), the value of which is specified in columns "Minimum area" and "Maximum area" must be used when defining the type of apartment.

    Export, Import - export/import of apartment types to/from Excel. When importing, it is possible both to overwrite the current table in full and to supplement it.

    Initial Check


    It includes checking if there are unplaced rooms in the project, checking if the "Functional purpose" parameter is filled in correctly and if the pair of "Functional purpose" + "Name" parameter values correspond to the ones defined in the room matrix.

    7 - deleting of selected rooms in the "Unplaced rooms" table
    8 - deletion of all rooms in the table "Unplaced rooms"
    9 - in line: highlighting and zooming in a non-invalid room. To the right of the table - highlighting and zooming in all non-invalid rooms in the current view

    Note: if a invalid room has the problem "Functional purpose parameter has invalid value", but the value of this parameter is necessary for current project, this value should be added to the list " Allowed identifiers" on the tab "Settings".

    Note: Checking of unenclosed rooms is not performed at this stage.



    Displays the apartments whose rooms have been locked. Locked rooms will be ignored when collecting apartments, regardless of the "Functional purpose" parameter value. The locking of apartments is done on the "Collecting apartments" tab.
    To unlock the apartments, select the apartments and press the lock open variant button.

    Collecting apartments


    Automated collection of apartments, which is made through geometrical characteristics of rooms, taking into consideration the connection of rooms through windows, doors and room dividers.

    During apartment collection all rooms belonging to one apartment are assigned a common value in parameter "AP_Apartment ID". The value of the parameter can change when collecting apartments again.

    Apartment collection can be performed on the current view, on the entire project, or on selected rooms.

    The collection of apartments allows to identify unenclosed rooms, rooms without openings, as well as spaces without rooms in the project. Such rooms will be displayed in the list of "Invalid rooms".

    Several apartments can be merged into one. To do this, select the apartments in the list and click merge button to the right of the list. If the selected apartments are on different levels, they will not be merged.

    Apartments can be locked. The rooms of the locked apartments will be ignored during the next apartment collection, regardless of the value of the "Functional purpose" parameter. To lock the apartments, select the apartments in the list and press the lock button. The locked apartments will be removed from the current list and added to the list on the "Blocked" tab.

    Note: it is recommended to perform a visual inspection of this stage by means of color schemes.

    Calculate apartments


    Apartment calculation includes: filling in the data from the "Room matrix" source, calculating the apartment areas, numbering the rooms in the apartment, taking into account the numbering priority, and defining the apartment type from the "Apartment types" source. All obtained values are assigned to the parameters of compartments included in the apartment.

    When calculating the apartment areas, the "AP_Apartment tag" parameter is also filled in: the room of the apartment with the largest area is filled in with "1" value, the other rooms are filled in with "0" value.

    Apartment calculation can be performed on the current view, on the entire project, or on selected rooms.

    The plugin has a built-in automatic recalculation service that:

    • performs apartment area recalculation and apartment type definition when the geometry of the rooms included in the apartment changes
    • performs full recalculation (completion according to the room matrix, area calculation, calculation of number of living rooms, numbering of rooms, defining the type of apartment) after deletion of rooms, included in the apartment

    The automatic recalculation service only processes rooms with a filled in " AP_Apartment ID" parameter.

    The automatic recalculation service works even after the license validity period has expired, as long as the rooms have a full " AP_Apartment ID" parameter.

    Apartment editor


    The apartment editor allows you to make manual changes to the values of the apartment areas, as well as to merge multilevel apartments. When merging multilevel apartments, the areas are recalculated and the value of the "AP_Levels count" parameter is filled in.

    IMPORTANT: When recalculating apartments on a particular level, the parameter values of rooms belonging to the multilevel apartment, but located on another level, will not be recalculated.



    Numbering can be done by grouping the apartments by Housings and/or Sections by enabling the corresponding options and by specifying the parameter names from which to take the value of the Housing and/or Sections. In this case, it is considered that the sections are subgroups for the housings. The " End-to-end numbering" property means that the numbering in the next group will continue, not start from the value set in the "Initial number" property.

    If you select the Point option in the Start of numbering property, then you will have to select the room determining from which apartment the numbering will start for each group of apartments:


    If the Parameter value to number option is enabled, a prefix with the specified parameter value (if any), separated by a hyphen, is added to the apartment number. If the Housing to number and Section to number options are enabled, the same prefixes will be added, according to the parameters specified in the grouping. All values are added in the sequence "Housing-Section-Parameter-Number".

    You can number the apartments in the current view or in the whole project.

    Numbering by curve - allows to number the apartments, along the curve that crosses the apartments. The curve can be a Detail line or a Model line. When numbering by curve, the grouping by Housings and Sections, as well as the Numbering direction and Start of numbering are not taken into account. When numbering throughout the project, the selected curve will be used on all floors.

    The number of the apartments is set to the parameter "AP_Apartment Number".

    Views of apartments


    Creating apartment views is done by duplicating the current view, followed by cropping along the contour of the apartment. First of all, an attempt is made to create a crop contour considering the thickness of the enclosing walls (only for Revit 2020 and higher). If unsuccessful, an attempt is made to create a crop contour taking into account the thickest of the enclosing walls. If the crop contour is not created, the apartment contour obtained from the room boundaries will be used. If the option "Try to use apartment type as view name" is enabled, the created views will be given a name of the type "LEVEL_NAME - Apartment APARTMENT_TYPE".

  • Change history for

    2023 Year

    Revit: Apartment Layout (25.01.2023)

    A more detailed message if the parameter value could not be set because the parameter has the "Read-only" property.

    Revit: Apartment Layout (09.01.2023)

    Fixed a bug when trying to clear room parameters when the "Use system parameter Number" option is enabled.

    2022 Year

    Revit: Apartment Layout (09.12.2022)

    Fixed apartment unlocking bug.

    Revit: Apartment Layout (28.11.2022)

    Removed plugin loading through manifest file.

    Revit: Apartment Layout (24.11.2022)

    The algorithm for determining the room boundary has been amended to take into account cases where the original boundary contains segments that are less than 1 foot long.
    Changed icons.
    Added command access settings on the ribbon.

    Revit: Apartment Layout (23.10.2022)

    Added ability to lock apartments from repeated collection.
    Added ability to perform numbering of apartments by curve.
    Added possibility to use system parameter "Number" for numbering rooms.
    The maximum Finish thickness in the room matrix has been increased to 200 mm.

    Revit: Apartment Layout (13.10.2022)

    Fixed apartment calculation error in Revit 2020.

    Revit: Apartment Layout (07.10.2022)

    Taking into account the inner contours of the room when calculating area.

    Revit: Apartment Layout (05.09.2022)

    Processing arc room separators.

    Revit: Apartment Layout (19.07.2022)

    Changes in the numbering algorithm.

    Revit: Apartment Layout (21.06.2022)

    Changed strategy for rounding numbers that are halfway between the other two.

    Revit: Apartment Layout (19.05.2022)

    Added possibility to set options of parameters pre-clearing.
    Added possibility to set the filling order for "Room index" parameter.
    Added possibility to set filling rules for "Apartment tag" parameter.

    Revit: Apartment Layout (07.05.2022)

    Исправлена ошибка, при которой выводилось лишнее слово «TEXT» при открытии параметров в текстовом документе.

    Revit: Apartment Layout (30.04.2022)

    Displaying information about apartments that have one or more rooms with a blank "Room type" parameter in the list of area calculation results.

    Revit: Apartment Layout (31.03.2022)

    Ignoring some errors when searching for openings in building envelopes.

    Revit: Apartment Layout (20.03.2022)

    Added "Apartment Editor" tab and work with multilevel apartments.
    Added ability to output parameters to the notepad.

    Revit: Apartment Layout (14.03.2022)

    Added an option to specify the delimiter used in the number when including " Housing ", " Section " and/or parameter value in the number.

    Revit: Apartment Layout (24.02.2022)

    Added ability to merge apartments.

    Revit: Apartment Layout (17.02.2022)

    Added additional check through the openings placed in the curtain walls when collecting apartments (only for elements of the current document).

    Revit: Apartment Layout (16.02.2022)

    Fixed an error that in some cases did not write area to parameters.

    Revit: Apartment Layout (14.02.2022)

    Added possibility to create several named sources.
    Improved rounding algorithms when calculating areas.

    Revit: Apartment Layout (11.02.2022)

    Prohibit export of empty sources.

    2021 Year

    Revit: Apartment Layout (26.12.2021)

    Added parameter "AP_Total area without factor" which receives the sum of all apartment room areas without taking into account unheated rooms and without taking into account the reduction factor.
    Added possibility to fill in the room matrix (tab "Sources") with names of rooms of the current project.
    Addition of the room separators transformations located in linked files.
    Ignored "The target instance does not exist in the given phase" error when accessing FromRoom/ToRoom properties of opening families.
    Fixed an issue where the decreasing factor value in the "Room matrix" table did not change when changing the value with the mouse.
  • Комментарии для сайта Cackle

ModPlus 2015-2023