Vehicle Scenarios

Drive cycles, driver models, test maneuvers, and 3D simulation in Unreal Engine^® visualization environment

To configure vehicle scenarios, use the drive cycle, driver, and 3D simulation blocks.

Drive Cycle Source block — Generates a standard or user-specified longitudinal drive cycle. By default, the block includes the FTP–75 drive cycle. To install additional drive cycles from a support package, see Support Package for Maneuver and Drive Cycle Data. The support package has drive cycles that include gear shift schedules, for example JC08 and CUEDC.
Driver blocks — Implement controllers that generate normalized steering, acceleration, and braking commands to track velocity or displacement.
3D simulation blocks (requires Simulink^® 3D Animation™) — Integrate Unreal Engine with Simulink so that you can interrogate the world around the vehicle for virtually testing perception, control, and planning algorithms.

Figures of vehicle in 3D parking lot, double lane, highway

Blocks

Driver

Lateral Driver	Lateral path-tracking controller
Longitudinal Driver	Longitudinal speed-tracking controller
Predictive Driver	Predictive driver controller to track longitudinal speed and lateral path

Drive Cycle and Maneuvers

Acceleration and Braking	Generate steering, accelerator, and brake commands (Since R2024b)
Constant Radius	Generate commands for tracking constant radius path (Since R2024b)
Drive Cycle Source	Standard or specified longitudinal drive cycle
Fishhook	Generate commands to conduct fishhook maneuver (Since R2024b)
Lane Change	Generate commands to conduct lane change maneuvers (Since R2024b)
Slowly Increasing Steer	Generate commands to conduct linearly increasing steering maneuver (Since R2024b)
Swept Sine	Generate commands to conduct swept sine maneuver (Since R2024b)
Sine With Dwell	Generate single sinusoidal steering command (Since R2024b)

3D Environment Vehicles (requires Simulink 3D Animation)

Simulation 3D Vehicle	Implement vehicle in 3D environment
Simulation 3D Vehicle with Ground Following	Implement vehicle that follows ground in 3D environment
Simulation 3D Three-Wheeled Vehicle	Implement three-wheeled vehicle in 3D environment (Since R2023b)
Simulation 3D Motorcycle	Implement motorcycle in 3D environment (Since R2021b)
Simulation 3D Tractor	Implement tractor in 3D environment (Since R2020b)
Simulation 3D Trailer	Implement trailer in 3D environment (Since R2020b)
Simulation 3D Dolly	Implement dolly in 3D environment (Since R2021b)
Simulation 3D Physics Vehicle	Implement controllable 6DOF vehicle 3D environment (Since R2022b)

3D Environment Sensors (requires Simulink 3D Animation)

Simulation 3D Terrain Sensor	Implement multipoint terrain sensor in 3D environment (Since R2022a)
Vehicle Terrain Sensor	Vehicle and tire distances to objects
Simulation 3D Ray Tracer	Implement ray tracing in 3D environment (Since R2022b)
Simulation 3D Camera Get	Camera image

3D Environment Configuration (requires Simulink 3D Animation)

Simulation 3D Scene Configuration	Scene configuration for 3D simulation environment
Simulation 3D Actor Transform Get	Get actor translation, rotation, scale
Simulation 3D Actor Transform Set	Set actor translation, rotation, scale
Simulation 3D Message Get	Retrieve data from Unreal Engine visualization environment
Simulation 3D Message Set	Send data to Unreal Engine visualization environment

Scenes and Vehicle Dimensions

expand all

Scenes

Curved Road	Curved road 3D environment
Double Lane Change	Double lane change 3D environment
Large Parking Lot	Large parking lot 3D environment
Open Surface	Open surface 3D environment
Parking Lot	Parking lot 3D environment
Straight Road	Straight road 3D environment
US City Block	US city block 3D environment
US Highway	US highway 3D environment
Virtual Mcity	Virtual Mcity 3D environment
ZalaZone Automotive Proving Ground High-Speed Handling Course	High-speed handling course 3D environment
ZalaZONE Automotive Proving Ground Hill Tracks	Climbs with varying gradients 3D environment

Vehicles

Box Truck	Box truck vehicle dimensions
Hatchback	Hatchback vehicle dimensions
Muscle Car	Muscle car vehicle dimensions
Sedan	Sedan vehicle dimensions
Small Pickup Truck	Small pickup truck vehicle dimensions
Sport Utility Vehicle	Sport utility vehicle dimensions
Cab-Over Tractor	Cab-over tractor dimensions
Formula Student Vehicle	Formula student vehicle dimensions
Conventional Tractor	Conventional tractor dimensions
One-Axle Trailer	One-axle trailer dimensions
Two-Axle Trailer	Two-axle trailer dimensions
Three-Axle Trailer	Three-axle trailer dimensions
One-Axle Dolly	One-axle dolly dimensions
Two-Axle Dolly	Two-axle dolly dimensions
Three-Axle Dolly	Three-axle dolly dimensions
Motor Bike	Motor bike dimensions
Scooter	Scooter dimensions
Sports Bike	Sports bike dimensions
Tuk tuk	Tuk tuk vehicle dimensions

Functions

expand all

Unreal Engine Projects

`copyExampleSim3dProject`	Copy support package files and plugins to specified folders (Since R2022b)
`sim3d.Editor`	Interface to the Unreal Engine project
`sim3d.maps`	Access additional scenes from the server (Since R2022b)
`sim3d.maps.Map.download`	Download maps from the server (Since R2022b)
`sim3d.maps.Map.server`	List of maps available for download from the server (Since R2022b)
`sim3d.maps.Map.delete`	Delete local maps downloaded from the server (Since R2022b)
`sim3d.maps.Map.local`	List of locally available maps (Since R2022b)
`open`	Open the Unreal Editor
`ASim3dActor`	Abstract class to use as a base class for user-defined Unreal Engine C++ or blueprint actors (Since R2020b)
`Sim3dSetup`	C++ method that sets up actor in Unreal Engine 3D simulation (Since R2020b)
`Sim3dStep`	C++ method that steps actor in Unreal Engine 3D simulation (Since R2020b)
`Sim3dRelease`	C++ method that releases actor in Unreal Engine 3D simulation (Since R2020b)
`StartSimulation3DMessageReader`	Constructs a message reader object in the Unreal Editor (Since R2020b)
`ReadSimulation3DMessage`	Receives message from Simulink model using a message reader object (Since R2020b)
`StopSimulation3DMessageReader`	Deletes message reader object in the Unreal Editor (Since R2020b)
`StartSimulation3DMessageWriter`	Constructs a message writer object in the Unreal Editor (Since R2020b)
`WriteSimulation3DMessage`	Sends message to Simulink model using a message writer object (Since R2020b)
`StopSimulation3DMessageWriter`	Deletes message writer object in the Unreal Editor (Since R2020b)

Topics

Simulation Basics

3D Simulation for Vehicle Dynamics Blockset
Learn how to visualize vehicle performance in a 3D environment using the Unreal Engine from Epic Games^®.
Unreal Engine Simulation Environment Requirements and Limitations
When simulating in the Unreal Engine environment, keep these software requirements, minimum hardware requirements, and limitations in mind.
How Unreal Engine Simulation for Vehicle Dynamics Blockset Works
Learn about the co-simulation framework between Simulink and the Unreal Engine and how block execution order affects 3D simulation.
Coordinate Systems in Vehicle Dynamics Blockset
Understand coordinate systems for representing vehicle dynamics.
Send and Receive Double-Lane Change Scene Data
Use the Simulation 3D Message Set and Simulation 3D Message Get blocks to communicate with the double-lane change scene.
Create and Use an Oval Track
Create an oval track with RoadRunner and use it in a Vehicle Dynamics Blockset™ simulation that co-simulates with Unreal^®.

Scene Customization

Customize 3D Scenes for Vehicle Dynamics Simulations

To customize scenes and vehicles, use the Vehicle Dynamics Blockset Interface for Unreal Engine Projects support package.
- STEP 1: Install Support Package and Configure Environment
- STEP 2: Migrate Projects Developed Using Prior Support Packages
- STEP 3: Customize Scenes Using Simulink and Unreal Editor
- STEP 4: Package Custom Scenes into Executable
Get Started Communicating with the Unreal Engine Visualization Environment
Use the Simulation 3D Message Get and Simulation 3D Message Set blocks to communicate with the Unreal Editor.
Animate Custom Actors in the Unreal Editor
Animate a custom bicycle actor.
Build Light in Unreal Editor
Build and use lighting in the Unreal Editor.
Create Empty Project in Unreal Engine
Create empty project to use in custom scenes.
Place Cameras on Actors in the Unreal Editor
Place camera blocks on static and custom actors.
Prepare Custom Vehicle Mesh for the Unreal Editor
Create custom vehicle mesh for the Simulation 3D Vehicle and Simulation 3D Vehicle with Ground Following blocks.

Related Information

Using Unreal Engine with Simulink

Featured Examples

Scene Interrogation with Camera and Ray Tracing Reference Application

Interrogate a 3D Unreal Engine scene with a vehicle dynamics model by using a camera and ray tracing reference application project.

Open Script

Follow Waypoints Around Oval Track

Simulate vehicle driving around oval track specified by waypoints. Model loads a minimum number of waypoints and uses a MATLAB^® function to determine the next heading waypoint.

Open Model

Place Cones on Formula Student Skidpad Track Using Simulation 3D Animation Functions

Place cones on a Skidpad track using Simulation 3D Animation Functions.

Open Live Script

Generate Skidpad Test

Generate skidpad tests for student competitions. View simulation in 3D environment.

Open Live Script