newProject

Create new RoadRunner project using MATLAB

Since R2022a

collapse all in page

    Syntax

    newProject(rrApp,projectFolder)
    newProject(rrApp,projectFolder,Name=Value)

    Description

    newProject(rrApp,projectFolder) creates a new RoadRunner project folder in the location specified by projectFolder. RoadRunner creates the specified folder, also attempting to create any folders in the specified file path that do not already exist. If a folder with the same name already exists in the specified location, then RoadRunner returns an error.

    example

    newProject(rrApp,projectFolder,Name=Value) sets options using one or more name-value arguments.

    Examples

    collapse all

    This example uses:

    Open Live Script

    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,InstallationFolder='C:\Program Files\RoadRunner R2023a\bin\win64');

    Specify a location for a new project folder. Use the newProject function to create a new RoadRunner project in the specified location. The name of the project folder determines the name of the new project. 

    newProjectFolder = "C:\My New Project";
newProject(rrApp,newProjectFolder);

    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 project folder path, specified as a character vector or string scalar. Use this argument to specify the project folder in which to create a new scene when opening RoadRunner. For details about the RoadRunner project folder structure, see RoadRunner Project and Scene System (RoadRunner).

    Example: roadrunner("C:\My New Project") specifies to create a new scene in the My New Project folder when opening RoadRunner on a Windows® machine.

    Data Types: char | string

    Name-Value Arguments

    collapse all

    Example: newProject(rrApp,"C:\RR\MyProject",AssetLibraries="RoadRunner_Asset_Library")

    Specify optional pairs of arguments as Name1=Value1,...,NameN=ValueN, where Name is the argument name and Value is the corresponding value. Name-value arguments must appear after other arguments, but the order of the pairs does not matter.

    RoadRunner asset libraries to include in the new project, specified as a character vector or string scalar. The only valid entry is "RoadRunner_Asset_Library", which includes the RoadRunner Asset Library assets in the project. If you do not specify AssetLibraries, then RoadRunner includes only the assets that come installed with RoadRunner projects by default.

    Data Types: char | string

    Version History

    Introduced in R2022a

    See Also

    | |

    Topics