Main Content

openScene

Open RoadRunner scene using MATLAB

    Description

    example

    openScene(rrApp,filename) opens a specified scene file from the current RoadRunner project. If the specified scene does not belong to the current project, then RoadRunner determines the project to which the scene belongs and opens the scene from that project instead.

    Examples

    collapse all

    Open a project in RoadRunner using the roadrunner function by specifying the location in which to create a project. This example assumes that RoadRunner is installed in its default location in Windows.

    Specify the path to an existing project. For example, this code shows the path to a project located on C:\RR\MyProject. The function returns a roadrunner object, rrApp, that provides functions for performing basic workflow tasks such as opening, closing, and saving scenes and projects.

    projectFolder = "C:\RR\MyProject";
    rrApp = roadrunner(projectFolder);

    Open an existing scene in the current RoadRunner project.

    filename = "FourWaySignal.rrscene";
    openScene(rrApp,filename);

    Input Arguments

    collapse all

    RoadRunner application associated with a project, specified as a roadrunner object. This object provides functions for performing common workflow tasks such as opening, closing, and saving scenes and projects. rrApp provides functions that support importing data from files and exporting scenes to other formats from RoadRunner.

    RoadRunner scene file to open, specified as a character vector or string scalar. This argument specifies the absolute or relative path to the scene file you want to open. If you specify a relative path, then the path is relative to the Scenes folder of the current project. filename must end with .rrscene or have no extension. If it has no extension, then RoadRunner appends the .rrscene extension to the file name before opening the scene.

    Example: openScene(rrApp,"FourWaySignal.rrscene") open the FourWaySignal.rrscene scene file from the Scenes folder of the current project.

    Data Types: char | string

    Version History

    Introduced in R2022a