In the context of ArcGIS, the Camera is used to set the data loading point for an ArcGIS level. Several Actors and components that come with the ArcGIS Maps SDK for Unreal Engine are essential for rendering and interacting with your ArcGIS level.
ArcGIS Camera Component
The ArcGIS Camera Component controls the data that is loaded into your scene. It is an important part of the system that creates a window into the GIS world. You need to attach an ArcGIS Camera Component to an Actor to load tiles and scene nodes for the ArcGIS Map. When the camera moves, this Component will set the view that will determine what tiles and scene nodes are streamed and rendered. The ArcGIS Camera Component inherits from Unreal Engine's Camera Component and contains all of that class's properties. The main difference is that an ArcGIS Camera Component requires an ArcGIS View to visualize the ArcGIS Map.
You can find the ArcGIS Camera Component script here:
ArcGIS Maps SDK for Unreal Engine C++ Classes > ArcGISMapsSDK > Public > ArcGISMapsSDK > Components
There is a setting exposed on the ArcGIS Camera Component to control data quality:
- Quality Scaling Factor: This option allows you to control the quality of the GIS content being rendered. A higher number indicates higher quality and a higher impact on performance. The default number is
2.
Set up an ArcGIS Camera
The ArcGIS Camera Component requires an ArcGIS Location Component to be attached to the same Actor. This allows the ArcGIS Camera and its Actor to be accurately positioned in the ArcGIS level. These components are typically attached to a Pawn Actor to allow you to control its movement during runtime. For more information about the ArcGIS Location Component, see the Location Component topic.
The ArcGIS Location Component transforms Unreal Engine coordinates into GIS coordinates and defines the position. The ArcGIS Camera Component defines the tilt and heading of the point from which the level is observed.
Values for camera
- 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).
- Heading: Provides the ability to either get or set the map view rotation value. This is also known as yaw or azimuth. It represents the number of degrees by which the map's data will be rotated, measured counterclockwise from the north. To rotate clockwise, use a negative value.
- Pitch: Provides the ability to either get or set a map view's pitch. Pitch is the equivalent of moving a plane's nose up or down (rotating along the axis that passes through the plane's wings). Positive values, looking forward, are above the horizon (pointing upward) and negative values are below the horizon (pointing downward).
- Roll: Provides the ability to either get or set a map view's roll. Roll is the equivalent of tilting a plane's wings up or down (rotating along the axis that passes through the center of the plane from front to back). A zero value is perfectly horizontal. Positive values will tilt the left side upward (or right side downward). Negative values do the opposite.
To set up an ArcGIS Camera:
You can create an ArcGIS Camera from the Models Panel UI Camera tab.
- Click on the Camera tab.
- Fill in the values for the camera position and rotation.
- Click on the Create button.
When you create a camera with this feature, it will create a Default Pawn in the Outliner panel with the ArcGIS Camera and ArcGIS Location components attached. For information about the Default Pawn, see the Unreal Engine's documentation.
If you find a better camera angle while you navigate around during the Editor mode, click on the Align with View to update the initial camera position for the runtime.
You can move the camera around by using WASD keys during the Editor mode regardless you attach a controller Component to it before it responds to player input. For the runtime, you can attach your own controller Component to the Default Pawn. You can also replace the Default Pawn with the sample ArcGIS Pawn that is used in the sample levels. For information about the sample ArcGIS Pawn, see the ArcGIS Pawn section.
To replace the Default Pawn with the sample ArcGIS Pawn:
-
Open the location below in the Content Drawer.
Plugins > ArcGIS Maps SDK for Unreal ENgine C++ Classes > ArcGISSamples > Public
-
Click on the ArcGIS Pawn to select it. When it is selected the background color changes to blue.
-
Right click the Default Pawn in the Outliner panel.
-
Click on Replace Selected Actor with, then select ArcGIS Pawn.
To set up an ArcGIS Camera:
-
Open the Place Actors panel.
-
Search for the Default Pawn in the All Classes, and drag and drop it into the Viewport.
-
Select the Default Pawn from the Outliner panel.
-
While having Default Pawn selected, navigate to the Details panel, and click on + Add button to attach both the ArcGIS Camera and the ArcGIS Location Components.
-
Select the ArcGIS Location Component, and fill in the values for the camera Position and Location accordingly.
If you find a better camera angle while you navigate around during the Editor mode, right-click on the Default Pawn and select Snap Object to View to update the initial camera position for the runtime.
You can move the camera around by using WASD keys during the Editor mode regardless you attach a controller Component to it before it responds to player input. For the runtime, you can attach your own controller Component to the Default Pawn. You can also replace the Default Pawn with the sample ArcGIS Pawn that is used in the sample levels. For information about the sample ArcGIS Pawn, see the ArcGIS Pawn section.
To replace the Default Pawn with the sample ArcGIS Pawn:
-
Open the location below in the Content Drawer.
Plugins > ArcGIS Maps SDK for Unreal ENgine C++ Classes > ArcGISSamples > Public
-
Click on the ArcGIS Pawn to select it. When it is selected the background color changes to blue.
-
Right-click the Default Pawn in the Outliner panel.
-
Click on Replace Selected Actor with, then select ArcGIS Pawn.
- Use the Create ArcGIS Camera with Location Heading Pitch Roll node in the ArcGIS Camera category to create an ArcGIS Camera.
- Use the Get Component by Class and select ArcGIS Location to set the camera position with the ArcGIS Location Component that is attached to a Pawn.
- Use the Create ArcGIS Point with XYZ Spatial Reference node in the ArcGIS Point category to set the camera position.
- Use the Create ArcGIS Rotation node in the ArcGIS Rotation to set pitch, roll, and heading.
- Use the Set Position node in the ArcGIS Location Component category to push the location values and the angle for the ArcGIS Location Component.
If the node does not appear, uncheck the Context Sensitive checkbox at the top right of the Context Menu.
ArcGIS Pawn is a sample Pawn that has ArcGIS Camera Component and ArcGIS Location Component attached and has the script move the camera around during runtime. You can use Default Pawn and attach ArcGIS Camera Component and ArcGIS Location Component, and write your input controller for the runtime.
You can programmatically set the position by using an ArcGISPoint to set the camera position and an ArcGISRotation to set the pitch, roll, and heading of the ArcGIS Pawn.
You can find sample code that demonstrates how to place and set up an ArcGIS Pawn in the SampleAPIMapCreator.cpp file. The sample script file is in:
Plugins/ArcGISMapsSDK/Source/ArcGISSamples/Private
Set a Fixed Data Loading Point
It is not a requirement to attach an ArcGIS Camera Component to your Pawn Actor. In some cases, you may want to use an ArcGIS Camera as a fixed loading point to only bring in a set level of detail into your scene. You can attach the ArcGIS Camera Component and an ArcGIS Location Component to an empty Actor, then set the position of the Actor.
ArcGIS Pawn
ArcGIS Maps SDK for Unreal Engine comes with a sample ArcGIS Pawn that you can use in your ArcGIS levels. This Pawn Actor correctly wraps and moves around the Earth in both Global and Local mode, and it is controlled by using the WASD keys and mouse during runtime. It contains an ArcGIS Camera Component and an ArcGIS Location Component. The Modes Panel UI and the Details panel sync with an Actor that has both Components attached on play and set its initial position and rotation. If you want to move the ArcGIS Pawn position to the current editor camera position during the editor time, you can either click on the Align with View button under the Camera tab in Models Panel UI or right-click on the ArcGIS Pawn in the Outliner panel and select Snap Object to View.
You can find the ArcGIS Pawn in the Unreal Editor Content Browser:
Plugins > ArcGIS Maps SDK for Unreal Engine C++ Classes > ArcGISSamples > Public
Render a video
In Unreal Engine, you create a video by using camera animation. Please refer to the Unreal Engine Documentation to learn how to do this.
If you want to create a video in a small area and do not want the LODs to change, set a Fixed Data Loading Point and set the location to match the Cine Camera Actor.
If you are working with a larger area and need to change the LODs, you should set ArcGIS Pawn at the same location as the Cine Camera Actor, and then attach it to your Cine Camera Actor in the scene. Alternatively, you could attach the ArcGIS Camera Component to your Cine Camera Actor. This way the scene can be rendered properly by synchronizing the movement of ArcGIS Camera with Cine Camera Actor. See below for an example setup.
