MATLAB Functions for Scene and Scenario Management

R2026b

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

RoadRunner provides MATLAB^® functions for performing common workflow tasks such as opening, closing, and saving scenes, scenarios, and projects and importing and exporting scenes and scenarios. These functions operate through a MATLAB object, roadrunner, that opens and sets up the main RoadRunner user interface so that you can control it programmatically. 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.

Functions

expand all

Create RoadRunner Object

roadrunner Start RoadRunner application (Since R2022a)

Manage RoadRunner Environment

`roadrunnerSetup`	Start RoadRunner interactively using MATLAB (Since R2023b)
`roadrunner.connect`	Connect to open instance of RoadRunner (Since R2022a)
`status`	Get current status of RoadRunner (Since R2022b)
`getAPIPort`	Retrieve RoadRunner API server port number (Since R2022b)
`getCoSimPort`	Retrieve RoadRunner Scenario API server port number (Since R2022b)
`close`	Close RoadRunner (Since R2022a)

Manage Project

`newProject`	Create new RoadRunner project (Since R2022a)
`openProject`	Open RoadRunner project (Since R2022a)
`saveProject`	Save RoadRunner project (Since R2022a)

Manage Scene and Scenario

`newScene`	Create new RoadRunner scene (Since R2022a)
`openScene`	Open RoadRunner scene (Since R2022a)
`saveScene`	Save RoadRunner scene (Since R2022a)
`changeWorldSettings`	Modify world settings of active scene (Since R2023b)
`newScenario`	Create new scenario in RoadRunner Scenario (Since R2022a)
`openScenario`	Open scenario in RoadRunner Scenario (Since R2022a)
`saveScenario`	Save scenario in RoadRunner Scenario (Since R2022a)

Export and Import

`importScene`	Import scene into RoadRunner (Since R2022a)
`exportScene`	Export RoadRunner scene (Since R2022a)
`exportCustomFormat`	Export RoadRunner scene or scenario using custom export configuration (Since R2022a)
`importScenario`	Import file into RoadRunner Scenario (Since R2022a)
`exportScenario`	Export scenario from RoadRunner Scenario (Since R2022a)
`exportActorTrajectoryToCSV`	Export trajectories of actors in RoadRunner scenario to comma-separated values (CSV) files (Since R2025a)

Query and Modify Scenario Variables and Anchors

`getScenarioVariable`	Get the value of RoadRunner scenario variable (Since R2022a)
`getAllScenarioVariables`	Get the values of all RoadRunner scenario variables (Since R2023b)
`setScenarioVariable`	Set RoadRunner scenario variable (Since R2022a)
`getAnchors`	Retrieve anchor attributes from RoadRunner scenario (Since R2024a)
`remapAnchor`	Remap anchors in RoadRunner Scenario (Since R2022b)

Simulate Scenario

`setCameraMode`	Set camera mode to visualize RoadRunner scenario simulation (Since R2026a)
`prepareSimulation`	Submit simulation data to RoadRunner Scenario simulation engine (Since R2024a)
`createSimulation`	Create RoadRunner Scenario simulation (Since R2022a)
`simulateScenario`	Simulate RoadRunner scenario (Since R2024a)
`exportVideo`	Export RoadRunner scenario simulation data to video file (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^®.
What Is a RoadRunner Pose Matrix?
Understand the position and orientation of a RoadRunner actor using its four-by-four pose matrix.

Featured Examples

Export Multiple Scenes Using MATLAB

Export all RoadRunner scenes in a project to a supported format using MATLAB functions.

Open Live Script

Convert Scenes Between Formats Using MATLAB Functions

Import multiple scenes in a RoadRunner project, and export them to a supported format using MATLAB functions.

Open Live Script

Simulate a RoadRunner Scenario Using MATLAB Functions

Automate running and visualizing simulations with RoadRunner Scenario using MATLAB functions.

Open Live Script