Skip to main content

Using Custom Controllers

In this tutorial, you will learn how to set up controllers other than Cesium’s DynamicPawn and build out a level based on imported photogrammetry.

Video version of this tutorial. Keep reading for the written tutorial.

You’ll learn how to:

  • Import a Content Pack
  • Change the game mode in your level
  • Use physics-based controls on Cesium 3D Tilesets
  • Change between character controllers in play
  • Optimize level settings for a smooth experience

Prerequisites

  • Know how to set up a basic Cesium for Unreal application. Check out our Cesium for Unreal Quickstart guide for instructions on starting with the Cesium for Unreal plugin.
  • Know how to import a photogrammetry tileset from Cesium ion. Read the Adding Datasets guide.

1Set up level and photogrammetry data

Start with the 01_CesiumWorld level in the Cesium for Unreal Samples. Or, set up a new world with a Cesium World Terrain and Cesium SunSky as outlined in the Cesium for Unreal Quickstart guide.

1This level will use a high-resolution dataset of Denver, Colorado, USA. Open the Cesium ion window and click the Add button. Search in your ion assets to find “Aerometrex Denver Photogrammetry”, then click the Add to Level button.

Cesium for Unreal controllers ionWindow
Information

Is Aerometrex Denver Photogrammetry missing from the asset list? Visit the Aerometrex Denver Photogrammetry Asset Depot page and click Add to my assets. Then return to Unreal Engine, close the Cesium ion Assets panel, and click the Add button again on the Cesium panel to re-open and refresh the asset list.

2There are two ways to set the georeference. If you have a specific longitude and latitude in mind, you can set it directly: Select the CesiumGeoreference actor in the World Outliner and in the Details panel, look for the Origin Latitude, Origin Longitude, and Origin Height parameters. Set them to the following coordinates to start in Denver:

Origin Latitude = 39.752827

Origin Longitude = -104.999689

Origin Height = 1570.879421

Cesium for Unreal controllers denverGeoreferenceLocation

Alternatively, you can double click on the Aerometrex Denver Photogrammetry in the World Outliner. This will move the scene view to the location of the photogrammetry. You can navigate using the scene view to the location where you would like the world origin to be, and use the Place Georeference Origin Here button.

3You’ll see that the Cesium World Terrain is clipping through the Denver photogrammetry.

Cesium for Unreal controllers worldTerrainClipping

4In the Outliner, select the Aerometrex Denver Photogrammetry actor and set the Z Location to 600.0. This will raise the height so that the Cesium World Terrain and the photogrammetry don’t intersect.

Cesium for Unreal controllers denverNotClipping

2Import a Third Person Character

Information

The Cesium for Unreal Samples already contain a ThirdPersonCharacter and ThirdPersonGameMode. If you are using the sample project, you can skip this section. The Sample Project ThirdPersonCharacter can be found in CesiumSamples/Maps/03/ThirdPersonController.

1In the Content Browser window, select the green Add/Import button. Then, select Add Feature or Content Pack at the top of the menu that appears.

Cesium for Unreal controllers contentBrowserButtons

2A new window will appear to add content to the project. For this tutorial, import the Third Person template - Select Third Person, then the green Add to Project button. Feel free to import other templates, or build your own.

Cesium for Unreal controllers importingThirdPerson

Importing this content has added four new folders to the top level of the project’s Content folder - GeometryMannequinThirdPerson, and ThirdPersonBP. Reorganize these as needed to fit your project’s organization system.

3Place a character controller in the world

In this step, you’ll learn how to place your pawn in the world. If you wish to have the pawn spawned when beginning play, you can alternatively place a PlayerStart actor in the level and change the GameMode Override in the World Settings panel to the desired game mode.

1In the Place Actor panel, search for “Third Person Character”. Drag-and-drop this actor into the scene. To focus on the pawn, double-click its label in the World Outliner.

Cesium for Unreal controllers dragPawnIn
Information

Sometimes the ThirdPersonCharacter may not show up in the Place Actor panel. If that occurs, find the actor via the Content Browser. If using the Sample Project, the actor will be in CesiumSamples/Maps/03/ThirdPersonController. Otherwise, the default location after importing the Third Person template is ThirdPersonBP/Blueprints.

2In the Details panel with the ThirdPersonCharacter selected, find the Transform section. Click the yellow arrow next to the location axes to reset its position.

Cesium for Unreal controllers resetTransform

To make sure the player is facing the right direction when entering play mode, set the third rotation value to 220.0. The ThirdPersonCharacter should now be facing Union Station.

3In the Details panel, search for “possess”. Select the dropdown next to Auto Possess Player and select Player 0.

Cesium for Unreal controllers autoPossessSetting

Now in Play mode, you will be able to control the ThirdPersonCharacter with the mouse and WASD keys or a handheld game controller.

Information

If you try to play the level right now, you’ll notice that your actor may begin to fall before the Denver photogrammetry is fully loaded. Read on to find out how to fix this. For this reason, it is also recommended that you disable physics on any physics objects that you are not currently interacting with.

4Set up a safe starting location

Because 3D Tiles tilesets contain quite a bit of data and are streamed to Unreal Engine, they may take a moment to load in fully. This can cause problems for actors that begin simulating right away, like the physics on your character. In this step, you will place some geometry underneath the photogrammetry to ensure a safe spawn.

1In the Place Actor panel, drag a Cube into the game world.

2Reset the location of the Cube and set the scale to 4.0, 4.0, 0.5.

Cesium for Unreal controllers cubeScale

3Using the translate gizmo, move the cube down in the Z axis until it is just barely hidden under the floor, or set the Z Location to -130.0.

Cesium for Unreal controllers cubePosition

4Press Play. The ThirdPersonCharacter should now stay in place as the world is loaded in.

Information

Placing actors in a level is safe as long as you do not change the CesiumGeoreference origin. Changing the CesiumGeoreference origin now will result in all these actors moving to the new origin. To learn more about how to safely place and georeference actors, read Placing Objects on the Globe and Building Global Scenes with Sublevels.

5Set up a Vehicle Controller

1Follow the procedure outlined in Step 2 to import the Vehicle Advanced template.

Cesium for Unreal controllers importCar

2Drag the VehicleBlueprint into the scene. Place it on the street in front of the ThirdPersonCharacter.

Cesium for Unreal controllers carPlacement

3Create another cube to act as the starting platform for the VehicleBlueprint. Place it just under the photogrammetry where the VehicleBlueprint is.

4Unlike the ThirdPersonCharacter, this pawn does not get automatically possessed. Instead, you’ll set up a simple Blueprint to switch the controlled pawn in play. Open the Level Blueprint using the top bar.

Cesium for Unreal controllers openLevelBlueprint

5From the World Outliner, drag-and-drop the VehicleBlueprint and ThirdPersonCharacter actors into the Event Graph in the Level Blueprint. You will see a node for each actor has been created in the Event Graph.

6Right click on an empty area in the Event Graph to pull up a menu for adding nodes. Search for “keyboard c” to find the C keypress event. Click on this to create a Keyboard Event.

Cesium for Unreal controllers cInput

7From the “Released” pin on the Keyboard Event, drag onto an empty spot on the graph and release the mouse. The search menu will appear again. Uncheck the Context Sensitive box, and search for un possess to find the Un Possess node.

Cesium for Unreal controllers unPossessNode

8Add a Possess node and a Get Player Controller node. Link them as shown in the below image.

Cesium for Unreal controllers nodeSetup

9The C key will switch controls to the ThirdPersonCharacter. Connect the ThirdPersonCharacter node to the empty “In pawn” input on the Possess node.

Cesium for Unreal controllers nodeSetupWithController

10Select the entire graph and copy-paste it to duplicate it. Select the new Keyboard Event node. In the Details panel, change the input key from C to V.

Cesium for Unreal controllers changeInputKey

11Hook up the new V Keyboard Event to the duplicated event graph and replace the “In Pawn” of the Possess node to the VehicleBlueprint.

Cesium for Unreal controllers nodeSetupFull

12Press the Compile button and the Save buttons on the top bar. Now, if you play the level, you’ll be able to switch to the VehicleBlueprint by pressing V, and the ThirdPersonCharacter by pressing C.

13You’ll notice that if you drive away with the car and then switch back to the character controller, the car might fall through the world due to tiles unloading. This also happens when you look away from the car if you have “Frustrum Culling” enabled. You’ll need to disable physics when not controlling the car. Back in the Level Blueprint, create a new Set Simulate Physics node.

Information

To learn more about Frustrum Culling, visit the Placing Objects on the Globe page. It will also be explained a little more later in this tutorial.

14Connect the Set Simulate Physics node to the Possess node for the ThirdPersonCharacter. Duplicate the VehicleBlueprint node and connect it to the “Target” input of the Set Simulate Physics node. The Blueprint Editor will automatically create a conversion node to get the VehicleBlueprint’s mesh.

15Make sure the “Simulate” input on the Set Simulate Physics node is set to false.

Cesium for Unreal controllers nodeSimulatePhysics

16Copy and paste the new nodes and connect the duplicates to the V Keyboard Event graph. This time, make sure the “Simulate” input on the Set Simulate Physics node is set to true.

Cesium for Unreal controllers nodesFullWithPhysics

17Press Play - The vehicle should now stay right where you left it.

6Optimize the level for play

In this step, you will adjust two available settings to help ensure a smooth experience. While you will need to decide the best settings for your project based on your performance requirements, you’ll learn about these settings and their benefits and drawbacks.

1With the Aerometrex Denver Photogrammetry actor selected, find the Cesium section in the DetailsPanel. Open the first section, Level of Detail to reveal the Maximum Screen Space Error setting.

Cesium for Unreal controllers screenSpaceError

2The Maximum Screen Space Error setting allows you to control the Level of Detail of your 3D Tileset. A higher number corresponds with a lower level of detail, and better performance. By default, it’s set to 16. Try lowering it to 2 - You’ll see a much higher resolution, but the scene will take longer to load fully.

Cesium for Unreal controllers sseComparison

3As you play, you may notice that tiles that are out of view stop rendering and may take some time to load again when you turn around. Open the Tile Culling section of the Details panel to find the setting, Enable Frustrum Culling.

Cesium for Unreal controllers frustrumCulling

Disabling this setting will ensure that tiles will no longer be unloaded as you turn the camera. However, you may notice the overall quality of tiles may drop with this setting disabled.

Next Steps

Want to try out a different project? Visit the Build a Flight Tracker with Cesium for Unreal tutorial. Or, take a look at the Build Worlds tutorial section.

Content and code examples at cesium.com/learn are available under the Apache 2.0 license. You can use the code examples in your commercial or non-commercial applications.