An ArcGIS Map contains references to layers of geographic content and is the foundation for all visual mapping applications in the ArcGIS Maps SDK for Unreal Engine.
To build an app with ArcGIS Maps SDK for Unreal Engine, you define an ArcGIS Map, a camera (to display geographic data and to navigate around), and environments such as sky and light.
Key concepts
In addition to the basemap and data layers, you also specify the type of ArcGIS Map (global or local), the origin position, and an elevation surface (for topographic context in 3D).
Global scene
A global scene is created using the global map type to display your 2D and 3D content on an ellipsoid.
A global scene is useful when you want to understand or contextualize phenomena that wrap around the ellipsoidal surface of the earth, such as global weather measurements, airline traffic paths, and shipping lanes.
Local scene
A local scene is created using the local map type that projects the terrain and layers on a planar surface rather than on an ellipsoid.
Local scenes can be used for displaying or analyzing data at the local or city scale and are valuable for urban planning and visualizations when you want to view defined areas such as campus facilities or building developments. They can also be used to represent the entire world, and have the option of using a fixed extent to clip with rectangular or circular shapes.
Origin position
To place geographic content within an Unreal Engine level, you must specify where the 0, 0, 0 origin coordinate of the game engine space is in the real-world coordinate space. You do this when you create an ArcGIS Map.
You can specify an origin position anywhere within a spatial reference's coordinate space. See Spatial references for more details about working with spatial references.
Values for Origin position
- X (Longitude) : Specifies the east–west position of a point on the Earth's surface. A projected position value for projected coordinate systems or a longitude value for geographic coordinate systems.
- Y (Latitude) : Specifies the north–south position of a point on the Earth's surface. A projected position value for projected coordinate systems or a latitude value for geographic coordinate systems.
- Z (Altitude) : The vertical distance of the camera above the terrain.
- Spatial Reference WKID : The spatial reference of the X, Y and Z values in Well-Known ID (WKID).
Depending on your app requirements, choose between a global or local scene when you create an ArcGIS Map. Global scene and local scenes both use layers to display different types of geographic data. The data is typically provided from the basemap layer service and data services.
Camera
Cameras are essential for displaying your game to the player. In ArcGIS Maps SDK for Unreal Engine, a camera is used for loading GIS data into your scene.
Elevation
Elevation surfaces add to 3D visualizations by creating relief in your 3D scene. They define height values across the extent of your ArcGIS Map's content, and ArcGIS Map will drape layers on top of the elevation surface.
In most cases, elevation data is read from an elevation service, but can also be read from an image tile package stored locally.
Creating an ArcGIS Map
ArcGIS Map is a container of GIS content and sends information to Unreal Engine about what and how it should be rendered.
The Modes Panel UI and ArcGIS Map Component contain the settings for the Map Type and the Origin position. When you select one of the preset basemap, the spatial reference of an ArcGIS Map created is defined by the basemap. When you don't set any basemap, the spatial reference will be defined by the first layer loaded.
You can manually specify the spatial reference according to the basemap and other layers if you use Blueprints or C++ API to create an ArcGIS Map. When a spatial reference is specified for the ArcGIS Map, you can add basemap and other layers with the specified spatial reference. When it's not defined, the first layer loaded, typically a basemap, defines the spatial reference of the ArcGIS Map.
To create an ArcGIS Map:
The Models Panel UI contains the settings for Map Type, Origin Position in the Map page.
- Click on the Map tab, and find the Map Type section to select
GlobalorLocal. - In the Origin Position, set the origin position values and spatial reference WKID.
- Click on the Create button.
When there is an ArcGIS Map already created in the scene, the UI pulls the configured values. You can modify the values during the editor time.
If you select Local, you can configure an extent. For more information about setting up an extent, see local scene.
- Place the ArcGIS Map Actor in your current level by doing drag-and-drop of the ArcGIS Map Actor. You can search for the ArcGISMap Actor directly from the search bar of the Place Actors panel, or you can find it in the Unreal Editor Content Drawer with the directory below:
Plugins > ArcGIS Maps SDK for Unreal Engine C++ Class > ArcGISMapsSDK > Public > ArcGISMapsSDK > Actors
- Select ArcGIS Map Actor in your Outliner panel, and navigate to the Details panel.
- In the ArcGIS Map Component, set the position values and spatial reference WKID.
- Set the Basemap URL and API key.
- Find the Map Type section to select
GlobalorLocal.
If you select Local, you can configure an extent. For more information about setting up an extent, see local scene.
- To create a map using Blueprints, select a node start with Create in their name under ArcGIS Maps SDK > ArcGIS Map.
- Select
GlobalorLocalin the Map Type option in the node. - To set a spatial reference with a WKID, use node in ArcGIS Maps SDK > Spatial Reference, and select Create Spatial Reference.
- To set a spatial reference with a WKT, use node in ArcGIS Maps SDK > Spatial Reference, and select Create Spatial Reference from WKText.
- To set the spatial reference to Web Mercator (Auxiliary Sphere) (WKID: 3857) or WGS 84 (WKID: 4326), you can use the Web Mercator or WGS84 node.
If you select Local, you can configure an extent. For more information about setting up an extent, see local scene.
Create ArcGISMap and define Local or Global with ArcGISMap. With C++ API, you can specify the spatial reference for the ArcGISMap.
To populate the Origin Position value from a C++ script, specify it with ArcGISPoint.
To set up an extent, see local scene.
You can find the sample code to set up ArcGIS Map in the SampleAPIMapCreator.cpp file. The sample script file is in:
Plugins/ArcGISMapsSDK/Source/ArcGISSamples/Private