| Label | Explanation | Data Type |
Input Dataset
| The input building layer or layer file (.lyrx). | Building Layer; Layer File |
Output Scene Layer Package
| The output scene layer package (.slpk). | File |
Output Coordinate System (Optional) | The coordinate system of the output scene layer package. It can be any projected or custom coordinate system. Supported geographic coordinate systems include WGS84 and China Geodetic Coordinate System 2000. WGS84 and EGM96 Geoid are the default horizontal and vertical coordinate systems, respectively. The coordinate system can be specified in any of the following ways:
| Spatial Reference |
Geographic Transformation (Optional) | The datum transformation method that will be used when the input layer's coordinate system uses a datum that differs from the output coordinate system. All transformations are bidirectional, regardless of the direction implied by their names. For example, NAD_1927_to_WGS84_3 will work correctly even if the datum conversion is from WGS84 to NAD 1927. Note:The ArcGIS coordinate system data is required for vertical datum transformations between ellipsoidal and gravity-related and two gravity-related datums. | String |
Texture Optimization (Optional) | Specifies the textures that will be optimized according to the target platform where the scene layer package is used. Caution:Optimizations that include KTX2 may take significant time to process. For fastest results, use the Desktop or None options.
| String |
Target Cloud Connection
(Optional) | The target cloud connection file (.acs) where the scene layer content (.i3sREST) will be output. | Folder |
Summary
Creates a scene layer package (.slpk) or scene layer content (.i3sREST) from a building layer input.
Usage
-
To use BIM data as input, you must first add the BIM data to an active global or local scene as a building layer. The building layer, or the layer file (.lyrx) created from the building layer, can then be used as input to the tool. For more information about working with BIM data, see What is BIM data.
Building layers whose source are feature classes in a geodatabase can be used as input. You can use the BIM File To Geodatabase tool to copy BIM features to a geodatabase. Use the Make Building Layer tool to create a building layer from the BIM features.
Individual category or discipline layers are not supported as input to this tool. Individual category layers can be used as input to the Create 3D Object Scene Layer Content tool, but they must first be copied to a geodatabase using the Copy Features tool and added as a stand-alone multipatch feature class to the scene.
Filters that are created on the building layer are written to the scene layer package and are consumed in clients that support reading filters.
Big integer, date only, time only, and timestamp offset fields are not currently supported in scene layers. Use the Export Features tool to create a copy of a feature class without unsupported field types that you can input to this tool.
For more information about building scene layers, see Building scene layers.
Match the output coordinate system with the spatial reference of the web scene in which it will be displayed. If the intended display environment will be a global web scene, use the GCS WGS84 or China Geodetic Coordinate System 2000 as the output coordinate system. A vertical coordinate system for a global scene must be ellipsoidal, EGM2008 Geoid, or EGM96 Geoid.
Consider the following when defining z-coordinates in the 3D data being processed:
- If the output scene layer package will have x,y coordinates in GCS WGS84, the z-coordinate system can be defined using any ellipsoidal datum or EGM96 or EGM2008 through the Output Coordinate System parameter. If the z-coordinate system is undefined, the vertical units will be meters.
- If the output scene layer package will store x,y values in projected coordinates and the z-coordinate system is not defined, the vertical units will be the same as the x,y coordinates. For 3D features with undefined z-units that differ from the x,y units, you can use either the Adjust 3D Z tool to convert z-values to a matching linear unit or the Define Projection tool to define the correct z-datum.
Use the Target Cloud Connection parameter to output scene layer content to an object store located in the cloud such as Amazon S3, Azure Blob storage, Alibaba OSS, or Google Cloud. This content can be published as a scene service and the location you choose must be registered as a user-managed data store in ArcGIS Enterprise.
You can build a connection file (.acs) using the Create Cloud Storage Connection File tool.
A scene layer package can be uploaded and published directly to ArcGIS Online or Portal for ArcGIS in a browser. You can also use the Share Package tool to upload and publish directly to ArcGIS Online or Portal for ArcGIS.
Use the Time Zone environment if the input feature class contains date fields. Using this environment will encode the time value in the local time with an offset from UTC, or in UTC if that option is chosen. For more information about using time with scene layers, see Time-enabled scene layers.
Parameters
arcpy.management.CreateBuildingSceneLayerPackage(in_dataset, out_slpk, {out_coor_system}, {transform_method}, {texture_optimization}, {target_cloud_connection})| Name | Explanation | Data Type |
in_dataset | The input building layer or layer file (.lyrx). | Building Layer; Layer File |
out_slpk | The output scene layer package (.slpk). | File |
out_coor_system (Optional) | The coordinate system of the output scene layer package. It can be any projected or custom coordinate system. Supported geographic coordinate systems include WGS84 and China Geodetic Coordinate System 2000. WGS84 and EGM96 Geoid are the default horizontal and vertical coordinate systems, respectively. The coordinate system can be specified in any of the following ways:
| Spatial Reference |
transform_method [transform_method,...] (Optional) | The datum transformation method that will be used when the input layer's coordinate system uses a datum that differs from the output coordinate system. All transformations are bidirectional, regardless of the direction implied by their names. For example, NAD_1927_to_WGS84_3 will work correctly even if the datum conversion is from WGS84 to NAD 1927. Note:The ArcGIS coordinate system data is required for vertical datum transformations between ellipsoidal and gravity-related and two gravity-related datums. | String |
texture_optimization (Optional) | Specifies the textures that will be optimized according to the target platform where the scene layer package is used. Caution:Optimizations that include KTX2 may take significant time to process. For fastest results, use the DESKTOP or NONE options.
| String |
target_cloud_connection (Optional) | The target cloud connection file (.acs) where the scene layer content (.i3sREST) will be output. | Folder |
Code sample
The following script demonstrates how to use the CreateBuildingSceneLayerPackage function in the Python window.
import arcpy
arcpy.management.CreateBuildingSceneLayerPackage(
r'c:\temp\buildings.lyrx', r'c:\temp\output.slpk',
arcpy.SpatialReference(4326), 'DESKTOP')The following script demonstrates how to use the CreateBuildingSceneLayerPackage function in the Python window and output to a cloud storage file.
import arcpy
arcpy.management.CreateBuildingSceneLayerPackage(
r'c:\temp\buildings.lyrx', None, arcpy.SpatialReference(4326),
'DESKTOP', r'c:\cloudConnections\AWS.acs')Environments
Special cases
- Parallel Processing Factor
If the Parallel Processing Factor value is unspecified, the tool will run with a default value of 80 percent of the available cores.