Programmatic Scene and Scenario Management

Programmatically open, import, and manage scenes and scenarios by using a roadrunner object

The roadrunner object enables you to manage RoadRunner scenarios from the MATLAB^® command line. You can open, save, import, and export scenarios, scenes, and projects. You can also set scenario variables and create simulations for RoadRunner Scenario. To get started using RoadRunner with MATLAB, see Connect MATLAB and RoadRunner to Control and Analyze Simulations.

RoadRunner also provides MATLAB functions to convert custom data into the RoadRunner HD Map data model and import your data into RoadRunner. Using these functions, you can create a new map, edit an existing map, and read and write from file. You can also represent lanes, lane boundaries, lane markings, junctions, barriers, and signs in the HD map. You can query a HD map and retrieve information about the current lane, neighbouring lanes, road geometry, and projection point on centerline of a lane at a specified actor pose within the HD map.

Objects

`roadrunner`	Start RoadRunner application using MATLAB (Since R2022a)
`roadrunnerHDMap`	Create RoadRunner HD Map using MATLAB (Since R2022b)
`roadrunnerHDMapQuery`	Query RoadRunner HD Map (Since R2026a)

Functions

expand all

Scenarios

`newScenario`	Create new scenario in RoadRunner Scenario using MATLAB (Since R2022a)
`openScenario`	Open scenario in RoadRunner Scenario using MATLAB (Since R2022a)
`saveScenario`	Save scenario in RoadRunner Scenario using MATLAB (Since R2022a)
`exportScenario`	Export scenario from RoadRunner Scenario using MATLAB (Since R2022a)
`importScenario`	Import file into RoadRunner Scenario using MATLAB (Since R2022a)
`getScenarioVariable`	Get the value of RoadRunner scenario variable using MATLAB (Since R2022a)
`getAllScenarioVariables`	Get the values of all RoadRunner scenario variables using MATLAB (Since R2023b)
`setScenarioVariable`	Set RoadRunner scenario variable using MATLAB (Since R2022a)
`setCameraMode`	Set camera mode to visualize RoadRunner scenario simulation using MATLAB (Since R2026a)
`createSimulation`	Create RoadRunner Scenario simulation using MATLAB (Since R2022a)
`prepareSimulation`	Submit simulation data to RoadRunner Scenario simulation engine using MATLAB (Since R2024a)
`simulateScenario`	Simulate RoadRunner scenario using MATLAB (Since R2024a)
`remapAnchor`	Remap anchors in RoadRunner Scenario in MATLAB (Since R2022b)
`getAnchors`	Retrieve anchor attributes from RoadRunner scenario using MATLAB (Since R2024a)
`exportActorTrajectoryToCSV`	Export trajectories of actors in RoadRunner scenario to comma-separated values (CSV) files using MATLAB (Since R2025a)
`exportVideo`	Export RoadRunner scenario simulation data to video file using MATLAB (Since R2026a)

Scenes

`newScene`	Create new RoadRunner scene using MATLAB (Since R2022a)
`openScene`	Open RoadRunner scene using MATLAB (Since R2022a)
`saveScene`	Save RoadRunner scene using MATLAB (Since R2022a)
`exportScene`	Export RoadRunner scene using MATLAB (Since R2022a)
`importScene`	Import scene into RoadRunner using MATLAB (Since R2022a)
`exportCustomFormat`	Export RoadRunner scene to custom format using MATLAB (Since R2022a)
`changeWorldSettings`	Modify world settings of active scene using MATLAB (Since R2023b)

Project

`newProject`	Create new RoadRunner project using MATLAB (Since R2022a)
`openProject`	Open RoadRunner project using MATLAB (Since R2022a)
`saveProject`	Save RoadRunner project using MATLAB (Since R2022a)
`connect`	Connect to open instance of RoadRunner using MATLAB (Since R2022a)
`close`	Close RoadRunner using MATLAB (Since R2022a)
`status`	Get current status of RoadRunner using MATLAB (Since R2022b)
`roadrunnerSetup`	Start RoadRunner interactively using MATLAB (Since R2023b)

HD Maps

`write`	Write HD Map to binary file using MATLAB (Since R2022b)
`read`	Read HD Map from binary file using MATLAB (Since R2022b)
`plot`	Plot RoadRunner HD Map using MATLAB (Since R2022b)
`readCRS`	Read coordinate reference system (CRS) data from RoadRunner HD map using MATLAB (Since R2023a)
`convertToStruct`	Convert RoadRunner HD Map into MATLAB structure (Since R2026a)

Query HD Maps

`getLane`	Get information about lane from RoadRunner HD Map (Since R2026a)
`getNeighborLanes`	Get information about neighboring lanes from RoadRunner HD Map (Since R2026a)
`getRoadTerrain`	Get road information from RoadRunner HD Map (Since R2026a)
`getProjectionPointOnLane`	Get information about projection point on lane from RoadRunner HD Map (Since R2026a)

Topics

Connect MATLAB and RoadRunner to Control and Analyze Simulations
Use MATLAB with RoadRunner to control simulations programmatically and model actors in MATLAB or Simulink^®.
Simulate a RoadRunner Scenario Using MATLAB Functions
Automate running and visualizing simulations with RoadRunner Scenario using MATLAB functions.
What Is a RoadRunner Pose Matrix?
Understand the position and orientation of a RoadRunner actor using its four-by-four pose matrix.
Convert Scenes Between Formats Using MATLAB Functions
Import multiple scenes in a RoadRunner project and export them to a supported format using MATLAB functions.
Export Multiple Scenes Using MATLAB
Export all RoadRunner scenes in a project to a supported format using MATLAB functions.
Build Simple Roads Programmatically Using RoadRunner HD Map
Build simple roads using RoadRunner HD Map MATLAB functions.
Build Pikes Peak RoadRunner 3D Scene Using RoadRunner HD Map
Build RoadRunner 3D scene for Pikes Peak, Colorado using MATLAB functions.
Build RoadRunner Scene with Intersection and Static Objects Using RoadRunner HD Map
Build RoadRunner scene containing road intersection and surrounding static objects using RoadRunner HD Map.