Skip to content

Commit 2bf8efc

Browse files
authored
Merge pull request #225859 from stevemunk/SM-Drawing-Package-Guide-Reference-style-Links
Update drawing-package-guide.md
2 parents 9e5572c + 2276035 commit 2bf8efc

File tree

1 file changed

+32
-29
lines changed

1 file changed

+32
-29
lines changed

articles/azure-maps/drawing-package-guide.md

Lines changed: 32 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -4,40 +4,37 @@ titleSuffix: Microsoft Azure Maps Creator
44
description: Learn how to prepare a Drawing package for the Azure Maps Conversion service
55
author: stevemunk
66
ms.author: v-munksteve
7-
ms.date: 05/18/2021
7+
ms.date: 01/31/2023
88
ms.topic: how-to
99
ms.service: azure-maps
1010
services: azure-maps
11-
1211
---
1312

14-
15-
1613
# Conversion Drawing package guide
1714

18-
This guide shows you how to prepare your Drawing Package for the [Azure Maps Conversion service](/rest/api/maps/v2/conversion) using specific CAD commands to correctly prepare your DWG files and manifest file for the Conversion service.
15+
This guide shows you how to prepare your Drawing Package for the [Azure Maps Conversion service] using specific CAD commands to correctly prepare your DWG files and manifest file for the Conversion service.
1916

2017
To start with, make sure your Drawing Package is in .zip format, and contains the following files:
2118

2219
* One or more drawing files in DWG format.
2320
* A Manifest file describing DWG files and facility metadata.
2421

25-
If you don't have your own package to reference along with this guide, you may download the [sample Drawing package](https://github.com/Azure-Samples/am-creator-indoor-data-examples).
22+
If you don't have your own package to reference along with this guide, you may download the [sample drawing package].
2623

2724
You may choose any CAD software to open and prepare your facility drawing files. However, this guide is created using Autodesk's AutoCAD® software. Any commands referenced in this guide are meant to be executed using Autodesk's AutoCAD® software.
2825

2926
>[!TIP]
30-
>For more information about drawing package requirements that aren't covered in this guide, see [Drawing Package Requirements](drawing-requirements.md).
27+
>For more information about drawing package requirements that aren't covered in this guide, see [Drawing Package Requirements].
3128
3229
## Glossary of terms
3330

3431
For easy reference, here are some terms and definitions that are important as you read this guide.
3532

36-
| Term | Definition |
37-
|:-------|:------------|
38-
| Layer | An AutoCAD DWG layer from the drawing file.|
39-
| Entity | An AutoCAD DWG entity from the drawing file. |
40-
| Level |An area of a building at a set elevation. For example, the floor of a building.  |
33+
| Term | Definition |
34+
|:--------|:---------------------------------------------|
35+
| Layer | An AutoCAD DWG layer from the drawing file. |
36+
| Entity | An AutoCAD DWG entity from the drawing file. |
37+
| Level | An area of a building at a set elevation. For example, the floor of a building. |
4138
| Feature | An object that combines a geometry with more metadata information. |
4239
| Feature classes | A common blueprint for features. For example, a *unit* is a feature class, and an *office* is a feature. |
4340

@@ -59,43 +56,43 @@ You may choose any CAD software to open and prepare your facility drawing files.
5956

6057
### Bind External References
6158

62-
Each floor of a facility must be provided as one DWG file. If there are no external references, then nothing more needs to be done. However, if there are any external references, they must be bound to a single drawing. To bind an external reference, you may use the `XREF` command. After binding, each external reference drawing will be added as a block reference. If you need to make changes to any of these layers, remember to explode the block references by using the `XPLODE` command.
59+
Each floor of a facility must be provided as one DWG file. If there are no external references, then nothing more needs to be done. However, if there are any external references, they must be bound to a single drawing. To bind an external reference, you may use the `XREF` command. Each external reference drawing will be added as a block reference after binding. If you need to make changes to any of these layers, remember to explode the block references by using the `XPLODE` command.
6360

6461
### Unit of measurement
6562

6663
The drawings can be created using any unit of measurement. However, all drawings must use the same unit of measurement. So, if one floor of the facility is using millimeters, then all other floors (drawings) must also be in millimeters. You can verify or modify the measurement unit by using the `UNITS` command.
6764

6865
The following image shows the Drawing Units window within Autodesk's AutoCAD® software that you can use to verify the unit of measurement.
6966

70-
:::image border="true" type="content" source="./media/drawing-package-guide/units.png" alt-text="Drawing Units window within Autodesk's AutoCAD® software":::
67+
:::image type="content" source="./media/drawing-package-guide/units.png" alt-text="Screenshot of the drawing units window in Autodesk's AutoCAD® software.":::
7168

7269
### Alignment
7370

74-
Each floor of a facility is provided as an individual DWG file. As a result, it's possible that the floors are not perfectly aligned when stacked on top of each other. Azure Maps Conversion service requires that all drawings be aligned with the physical space. To verify alignment, use a reference point that can span across floors, such as an elevator or column that spans multiple floors. you can view all the floors by opening a new drawing, and then use the `XATTACH` command to load all floor drawings. If you need to fix any alignment issues, you can use the reference points and the `MOVE` command to realign the floors that require it.
71+
Each floor of a facility is provided as an individual DWG file. As a result, it's possible that the floors aren't perfectly aligned when stacked on top of each other. Azure Maps Conversion service requires that all drawings be aligned with the physical space. To verify alignment, use a reference point that can span across floors, such as an elevator or column that spans multiple floors. you can view all the floors by opening a new drawing, and then use the `XATTACH` command to load all floor drawings. If you need to fix any alignment issues, you can use the reference points and the `MOVE` command to realign the floors that require it.
7572

7673
### Layers
7774

7875
Ensure that each layer of a drawing contains entities of one feature class. If a layer contains entities for walls, then it can't have other features such as units or doors. However, a feature class can be split up over multiple layers. For example, you can have three layers in the drawing that contain wall entities.
7976

8077
Furthermore, each layer has a list of supported entity types and any other types are ignored. For example, if the Unit Label layer only supports single-line text, a multiline text or Polyline on the same layer is ignored.
8178

82-
For a better understanding of layers and feature classes, see [Drawing Package Requirements](drawing-requirements.md).
79+
For a better understanding of layers and feature classes, see [Drawing Package Requirements].
8380

8481
### Exterior layer
8582

8683
A single level feature is created from each exterior layer or layers. This level feature defines the level's perimeter. It's important to ensure that the entities in the exterior layer meet the requirements of the layer. For example, a closed Polyline is supported; but an open Polyline isn't. If your exterior layer is made of multiple line segments, they must be provided as one closed Polyline. To join multiple line segments together, select all line segments and use the `JOIN` command.
8784

8885
The following image is taken from the sample package, and shows the exterior layer of the facility in red. The unit layer is turned off to help with visualization.
8986

90-
:::image border="true" type="content" source="./media/drawing-package-guide/exterior.png" alt-text="Exterior layer of a facility.":::
87+
:::image type="content" source="./media/drawing-package-guide/exterior.png" alt-text="Screenshot showing the exterior layer of a facility.":::
9188

9289
### Unit layer
9390

9491
Units are navigable spaces in the building, such as offices, hallways, stairs, and elevators. A closed entity type such as Polygon, closed Polyline, Circle, or closed Ellipse is required to represent each unit. So, walls and doors alone won't create a unit because there isn’t an entity that represents the unit.
9592

96-
The following image is taken from the [sample Drawing package](https://github.com/Azure-Samples/am-creator-indoor-data-examples) and shows the unit label layer and unit layer in red. All other layers are turned off to help with visualization. Also, one unit is selected to help show that each unit is a closed Polyline.
93+
The following image is taken from the [sample drawing package] and shows the unit label layer and unit layer in red. All other layers are turned off to help with visualization. Also, one unit is selected to help show that each unit is a closed Polyline.
9794

98-
:::image border="true" type="content" source="./media/drawing-package-guide/unit.png" alt-text="Unit layer of a facility.":::
95+
:::image type="content" source="./media/drawing-package-guide/unit.png" alt-text="Screenshot showing the unit layer of a facility.":::
9996

10097
### Unit label layer
10198

@@ -105,25 +102,25 @@ If you'd like to add a name property to a unit, you'll need to add a separate la
105102

106103
Doors are optional. However, doors may be used if you'd like to specify the entry point(s) for a unit. Doors can be drawn in any way if it's a supported entity type by the door layer. The door must overlap the boundary of a unit and the overlapping edge of the unit is then be treated as an opening to the unit.
107104

108-
The following image is taken from the [sample Drawing package](https://github.com/Azure-Samples/am-creator-indoor-data-examples) and shows a unit with a door (in red) drawn on the unit boundary.
105+
The following image is taken from the [sample drawing package] and shows a unit with a door (in red) drawn on the unit boundary.
109106

110-
:::image border="true" type="content" source="./media/drawing-package-guide/door.png" alt-text="Door layer of a facility.":::
107+
:::image type="content" source="./media/drawing-package-guide/door.png" alt-text="Screenshot showing the door layer of a facility.":::
111108

112109
### Wall layer
113110

114-
The wall layer is meant to represent the physical extents of a facility such as walls and columns. The Azure Maps Conversion service perceives walls as physical structures that are an obstruction to routing. With that in mind, a wall should be thought as a physical structure that one can see, but not walk though. Anything that can’t be seen won't captured in this layer. If a wall has inner walls or columns inside, then only the exterior should be captured.
111+
The wall layer is meant to represent the physical extents of a facility such as walls and columns. The Azure Maps Conversion service perceives walls as physical structures that are an obstruction to routing. With that in mind, a wall should be thought as a physical structure that one can see, but not walk through. Anything that can’t be seen won't captured in this layer. If a wall has inner walls or columns inside, then only the exterior should be captured.
115112

116113
## Step 3: Prepare the manifest
117114

118115
The Drawing package Manifest is a JSON file. The Manifest tells the Azure Maps Conversion service how to read the facility DWG files and metadata. Some examples of this information could be the specific information each DWG layer contains, or the geographical location of the facility.
119116

120-
To achieve a successful conversion, all “required” properties must be defined. A sample manifest file can be found inside the [sample Drawing package](https://github.com/Azure-Samples/am-creator-indoor-data-examples). This guide does not cover properties supported by the manifest. For more information about manifest properties, see [Manifest File Properties](drawing-requirements.md#manifest-file-requirements).
117+
To achieve a successful conversion, all “required” properties must be defined. A sample manifest file can be found inside the [sample drawing package]. This guide doesn't cover properties supported by the manifest. For more information about manifest properties, see [Manifest File Properties].
121118

122119
### Building levels
123120

124121
The building level specifies which DWG file to use for which level. A level must have a level name and ordinal that describes that vertical order of each level. Every facility must have an ordinal 0, which is the ground floor of a facility. An ordinal 0 must be provided even if the drawings occupy a few floors of a facility. For example, floors 15-17 can be defined as ordinal 0-2, respectively.
125122

126-
The following example is taken from the [sample Drawing package](https://github.com/Azure-Samples/am-creator-indoor-data-examples). The facility has three levels: basement, ground, and level 2. The filename contains the full file name and path of the file relative to the manifest file within the .zip Drawing package.
123+
The following example is taken from the [sample drawing package]. The facility has three levels: basement, ground, and level 2. The filename contains the full file name and path of the file relative to the manifest file within the .zip Drawing package.
127124

128125
```json
129126
    "buildingLevels": {
@@ -185,15 +182,15 @@ The following example of the `dwgLayers` object in the manifest.
185182

186183
The following image shows the layers from the corresponding DWG drawing viewed in Autodesk's AutoCAD® software.
187184

188-
:::image border="true" type="content" source="./media/drawing-package-guide/layer.png" alt-text="DwgLayers in Autodesk's AutoCAD® software":::
185+
:::image type="content" source="./media/drawing-package-guide/layer.png" alt-text="Screenshot showing the DwgLayers in Autodesk's AutoCAD® software.":::
189186

190187
### unitProperties
191188

192189
The `unitProperties` object allows you to define other properties for a unit that you can’t do in the DWG file. Examples could be directory information of a unit or the category type of a unit. A unit property is associated with a unit by having the `unitName` object match the label in the `unitLabel` layer.
193190

194-
The following image is taken from the [sample Drawing package](https://github.com/Azure-Samples/am-creator-indoor-data-examples). It displays the unit label that's associated to the unit property in the manifest.
191+
The following image is taken from the [sample drawing package]. It displays the unit label that's associated to the unit property in the manifest.
195192

196-
:::image border="true" type="content" source="./media/drawing-package-guide/unit-property.png" alt-text="Unit label that will be associated to the unity property in the manifest":::
193+
:::image type="content" source="./media/drawing-package-guide/unit-property.png" alt-text="Screenshot showing the unit label that will be associated to the unity property in the manifest.":::
197194

198195
The following snippet shows the unit property object that is associated with the unit.
199196

@@ -221,9 +218,15 @@ The following snippet shows the unit property object that is associated with the
221218

222219
## Step 4: Prepare the Drawing Package
223220

224-
You should now have all the DWG drawings prepared to meet Azure Maps Conversion service requirements. A manifest file has also been created to help describe the facility. All files will need to be zipped into a single archive file, with the `.zip` extension. It's important that the manifest file is named `manifest.json` and is placed in the root directory of the zipped package. All other files can be in any directory of the zipped package if the filename includes the relative path to the manifest. For an example of a drawing package, see the [sample Drawing package](https://github.com/Azure-Samples/am-creator-indoor-data-examples).
221+
You should now have all the DWG drawings prepared to meet Azure Maps Conversion service requirements. A manifest file has also been created to help describe the facility. All files will need to be zipped into a single archive file, with the `.zip` extension. It's important that the manifest file is named `manifest.json` and is placed in the root directory of the zipped package. All other files can be in any directory of the zipped package if the filename includes the relative path to the manifest. For an example of a drawing package, see the [sample drawing package].
225222

226223
## Next steps
227224

228225
> [!div class="nextstepaction"]
229-
> [Tutorial: Creating a Creator indoor map](tutorial-creator-indoor-maps.md)
226+
> [Tutorial: Creating a Creator indoor map]
227+
228+
[Azure Maps Conversion service]: /rest/api/maps/v2/conversion
229+
[sample drawing package]: https://github.com/Azure-Samples/am-creator-indoor-data-examples
230+
[Manifest File Properties]: drawing-requirements.md#manifest-file-requirements
231+
[Drawing Package Requirements]: drawing-requirements.md
232+
[Tutorial: Creating a Creator indoor map]: tutorial-creator-indoor-maps.md

0 commit comments

Comments
 (0)