Project

Specify RoadRunner project folder

Since R2025a

expand all in page

    Description

    The Project object represents the project folder for the current RoadRunner session. Use a Project object to specify the project folder from which to retrieve asset objects. You can use the asset objects to assign assets to actors in your scenario. For more information on the RoadRunner project system, see RoadRunner Project and Scene System (RoadRunner).

    Creation

    To return the Project object that represents your current RoadRunner project folder, extract the Project property of your roadrunnerAPI object and assign it to a variable. For example, prj = roadrunnerAPI(rrApp).Project creates the Project object prj.

    Properties

    expand all

    This property is read-only.

    Full path to the RoadRunner project folder, represented as a string scalar.

    Tip

    To specify a different project folder, specify the ProjectFolder argument of the roadrunner function as a new folder path. Alternatively, you can set a different default project folder by using the roadrunnerSetup function.

    Object Functions

    getAssetExtract object for specified asset
    createAssetCreate new asset

    Examples

    collapse all

    Extract a Project object in MATLAB® to represent your current RoadRunner project folder.

    Create a roadrunner object, specifying the path to an existing project. For example, this code shows the path to a project, on a Windows® machine, located at "C:\RR\MyProject". This code assumes that RoadRunner is installed in the default location, and returns an object, rrApp, that provides functions for performing basic tasks such as opening, closing, and saving scenes and projects.

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

    Note

    If you are opening RoadRunner from MATLAB for the first time, or if you have changed the RoadRunner installation location since you last opened it from MATLAB, you can use the roadrunnerSetup function to specify new default project and installation folders to use when opening RoadRunner. You can save these folders between MATLAB sessions by selecting the Across MATLAB sessions option from the corresponding drop down.

    Open an existing scene in RoadRunner by using the openScene function, specifying the roadrunner object rrApp and the filename of the specific scene that you want to open. Then, use the newScenario function to create a new scenario.

    openScene(rrApp,"ScenarioBasic.rrscene")
newScenario(rrApp)

    Create an object for the RoadRunner authoring API, rrApi, that references the object for the current RoadRunner instance rrApp. The rrApi object enables you to programmatically author scenarios, such as by adding and modifying actors and logic components, using MATLAB.

    rrApi = roadrunnerAPI(rrApp);
    Extract the object for your scenario from the Scenario property of the authoring API object rrApi. The extracted Scenario object enables you to specify the scenario in which to add scenario components such as actors and logic.
    scnro = rrApi.Scenario;
    Extract the object for your RoadRunner project from the Project property of the authoring API object rrApi. The extracted Project object enables you to specify the project folder for the current RoadRunner session from which to retrieve asset objects. You can use the asset objects to assign assets to actors in your scenario.
    prj = rrApi.Project;

    Version History

    Introduced in R2025a

    See Also

    | | | |

    Topics