Usage Instructions
This tool supports building LOD2.0 level detailed building models based on building footprint polygons and necessary parameter information such as building height.
The system provides General Urban Building Material Library, where the Commercial, Industrial, and Residential folders correspond to commercial, industrial, and residential land use types respectively. Each folder contains textures categorized by building structural parts: FlatRoof for flat roof textures, InnerWall for parapet/eave textures, PitchedRoof for sloped roof textures, and LOD2Facades for building facade textures. They can be downloaded as needed.
General Material Naming Convention
Common Structural Part Materials (FlatRoof/InnerWall/PitchedRoof)
Naming format: [Mat prefix + Building type]_[Structural part]_[Specific material (number)]. For example: MatResidence_FlatRoof_Shuini(11).jpg. Detailed rules are as follows:
| Field | Description |
|---|---|
| Building type (with Mat prefix) | Corresponds to land use type, uniformly add Mat material prefix. Building types include: MatResidence (Residential), MatCommercial/MatBussiness (Commercial), MatIndustrial (Industrial). |
| Structural part | Strictly corresponds to building structural parts. Options include FlatRoof (flat roof), InnerWall (parapet/eave), PitchedRoof (sloped roof). |
| Specific material (number) | Use Pinyin or English to label the specific material, with numbers in parentheses indicating different texture styles under the same material type, e.g., Shuini(11) = Cement No. 11. |
- LOD2 Building Facade Materials (LOD2Facades)
Naming format: [Mat prefix + Building type]_[Building level]_[Building height type + number]_[Facade type]_[Width]_[Height]_[Rows]_[Columns]_[Bottom row]. For example: MatResidence_LOD2_MiddleFacade3_front_36_36_4_4_1.jpg, meaning: Residential type, LOD2 level, Middle facade number 3, front texture, actual width 36 meters, height 36 meters, vertically divisible into 4 rows, horizontally divisible into 4 columns, bottom row is row 1.
Detailed rules are as follows:
| Field | Description |
|---|---|
| Building type | Residence, Commercial/Business, Industrial. Uniformly add material prefix Mat, corresponding to land use type. |
| Building level | Specifies the detail level of the building model, e.g., LOD2. |
| Building height type | Classified by building height, can include number identifiers. Options include: LowerFacade (low-rise), MiddleFacade (mid-rise), HigherFacade (high-rise). |
| Facade type | Automatically matched based on the side length of building vector faces. Options include: front (matches the longest side), side (matches the second longest side), wall (matches very narrow sides). |
| Width | Actual width of the texture, unit: meters. |
| Height | Actual height of the texture, unit: meters. |
| Rows | Maximum vertical subdivisions without cutting doors and windows. |
| Columns | Maximum horizontal subdivisions without cutting doors and windows. |
| Bottom row | Number of bottom rows that do not participate in vertical texture repetition. |
- PBR Material Naming Convention
Build detailed building models with PBR materials, can be used with Glass, Metal, Stone types from the material library. PBR materials consist of JSON configuration files and texture file groups.
- JSON Configuration File Naming Convention
Same as LOD2Facades general materials, only add PBRMat prefix before the building type. For example: PBRMatResidence_LOD2_MiddleFacade3_front_36_36_4_4_1.json
- PBR Texture File Naming Convention
Naming format: M_Structural part/Facade type_Material category_Material type_Number_Texture type, for example M_Facade_Wall_Stone_Terrazzo_05_BaseColorMap.png. Detailed rules are as follows:
| Field | Description |
|---|---|
| Prefix | Fixed as M_, representing Material, used to uniformly distinguish material files |
| Structural part/Facade type | Identifies the building structure or facade type corresponding to the texture. Same rules as LOD2Facades general materials, e.g., Facade_Wall, PitchedRoof. |
| Material category | Material major category and specific type, separated by underscore, e.g., Stone_Terrazzo represents Stone_Terrazzo. |
| Number | Numeric identifier to distinguish different texture styles under the same material category. |
| Texture type | PBR standard texture type. Options include:
|
Parameter Descriptions
| Parameter Name | Parameter Description | Parameter Type |
|---|---|---|
| Footprint Dataset | Input the 2D polygon dataset representing building footprints. | DatasetVector |
| Building Height: | Enter a value directly or select an attribute field to set the height of the resulting building model, in meters. | String |
| Base Elevation (Optional) |
Enter a value directly or select an attribute field to set the base elevation of the resulting building model, in meters. | String |
| Asset Path | Specify the storage path for assets such as texture maps and roof appendage resources required to build the building model. | String |
| With Texture (Optional) |
Set whether to add texture maps to the building model. If unchecked, the resulting building model will be a white model. If no asset path is specified, this parameter will be invalid. | Boolean |
| Build Roof Appendages (Optional) |
Set whether to add roof appendages to the building model. If unchecked, the resulting building model will not include roof appendages. If no asset path is specified, this parameter will be invalid. | Boolean |
| Roof Type: (Optional) |
Select an attribute field to specify the roof type of the resulting building model. If left empty, the roof will be generated according to random rules. | String |
| Parcel Vector Polygon (Optional) |
Input a 2D polygon dataset to specify the land use type of the parcel where the building is located. Buildings on the same parcel will use the same material effect. | DatasetVector |
| Land Use Type Field (Optional) |
Select an attribute field to identify the land use type of the parcel. Subsequent land use type labels will be matched based on the values of this field. The tool will select appropriate building materials based on the land use type. | String |
| Commercial Land Label (Optional) |
Input attribute values representing commercial land in the land use type field. Multiple values should be separated by commas, e.g., Parking Lot, Commercial Land. | String |
| Industrial Land Label (Optional) |
Input attribute values representing industrial land in the land use type field. Multiple values should be separated by commas, e.g., Food Factory, Textile Factory. | String |
| Residential Land Label (Optional) |
Input attribute values representing residential land in the land use type field. Multiple values should be separated by commas, e.g., Residential Area, Public Land. | String |
| Undefined Area Land Use Type (Optional) |
Specify the type for areas where land use type cannot be distinguished. Options include: Residential Land, Industrial Land, Commercial Land. | BudingUsageType |
| Detailed Model Area Polygon (Optional) |
Input a 2D polygon dataset to specify key areas. Buildings within this area will be built as more complex models. | DatasetVector |
| Target Datasource | Specify the datasource to store the resulting model dataset. | Datasource |
| Result Dataset Name (Optional) |
Set the name of the resulting model dataset. Default value is "building". | String |
Output Results
| Parameter Name | Parameter Description | Parameter Type |
|---|---|---|
| Result Dataset | Result dataset | Object |