Suburban scene

Suburban Unreal Engine environment

Since R2022b

Description

The Suburban scene is an Unreal Engine^® environment of a suburban area that contains houses with backyards, trees, power poles, and vehicles on the road. The scene is rendered using the Unreal Engine from Epic Games^®.

Setup

To simulate a UAV flight in this scene:

1. Add a Simulation 3D Scene Configuration block to your Simulink^® model.

2. In this block, set the Scene source parameter to Default Scenes.

3. View the currently available scenes in the Scene name parameter. If you have not previously installed this scene, click Install.

4. In the installer dialog box, select the Suburban scene, and click Next. MATLAB restarts after the scene is installed.

5. After the Suburban scene is installed, select the scene from the Scene name parameter.

Examples

Simulate Simple Flight Scenario Using Suburban Scene Map in Unreal Engine Environment

This example shows how to download and access the Suburban scene map from the Simulation 3D Scene Configuration block, and use it to simulate a simple flight scenario in the Unreal Engine® simulation environment.

Download Suburban Scene Map

To begin, check the maps available in the server.

sim3d.maps.Map.server

        MapName                        Description                    Version
    ________________    __________________________________________    _______

    "Suburban scene"    "a suburban area beyond the city's border"      "1"  

Download the Suburban scene from the server.

sim3d.maps.Map.download("Suburban scene")

Map is successfully downloaded and is up-to-date

Check if the downloaded maps are available in your local machine.

sim3d.maps.Map.local

        MapName                        Description                    Version
    ________________    __________________________________________    _______

    "Suburban scene"    "a suburban area beyond the city's border"      "1"  

Add Suburban Scene Map to Simulink model

Open the Simulink model.

open_system("uavSuburbanScene")

Open the Simulation 3D Scene Configuration block mask and set Scene name to Suburban scene.

set_param("uavSuburbanScene/Simulation 3D Scene Configuration", "SceneDesc", "Suburban scene");

open_system("uavSuburbanScene/Simulation 3D Scene Configuration")

Add UAV Vehicle

Open the Simulation 3D UAV Vehicle block mask and set the color of the vehicle in Color to Yellow or any color of your choice. Specify the name of the vehicle in Name as Quadrotor1.

open_system("uavSuburbanScene/Simulation 3D UAV Vehicle")

To change the prespective of the scene to follow behind the UAV, set Scene view to Quadrotor1 in Simulation 3D Scene Configuration block.

Simulate Model

When the simulation begins, it can take a few seconds for the visualization engine to initialize, especially when you are running it for the first time.

sim("uavSuburbanScene","StopTime","10");

Tips

• You can modify this scene If you have the UAV Toolbox Interface for Unreal Engine Projects support package. In the Unreal Engine project file that comes with the support package, this scene is named Suburban scene.

  For more details on customizing scenes, see Customize Unreal Engine Scenes for UAVs.

Version History

Introduced in R2022b

R2024a: Addition of stencil ID

The suburban scene assets now have stencil ID which enables you to run semantic segmentation using the Simulation 3D Camera block. For an example of running semantic segmentation in a UAV simulation, see Depth and Semantic Segmentation Visualization Using Unreal Engine Simulation.