addOverlapGroup

R2026b

Add overlap group

Since R2026b

collapse all in page

    Syntax

    overlapGroup = addOverlapGroup(scn,name)

    Description

    overlapGroup = addOverlapGroup(scn,name) adds a named overlap group that you can assign to one or more roads. RoadRunner does not allow automatic junction creation between roads that belong to the same overlap group.

    example

    Examples

    collapse all

    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 dropdown.

    Create a new RoadRunner scene in the current project by using the newScene function, specifying the roadrunner object rrApp.

    newScene(rrApp);

    Create a RoadRunner authoring API object, rrAPI, that references the object for the current RoadRunner instance rrApp. The rrApi object enables you to programmatically author scenes, such as by adding and modifying road and lane components, using MATLAB.

    rrApi = roadrunnerAPI(rrApp);
    Extract the object for your scene from the Scene property of the authoring API object rrApi. The extracted Scene object enables you to specify the scene in which to add scene components, such as roads and lanes. 
    scn = rrApi.Scene;

    Create an overlap group using the addOverlapGroup function. Roads in the same group do not form automatic junctions with each other.

    overlapGroupName = "SceneBuild";
overlapGroup = addOverlapGroup(scn,overlapGroupName)

    Input Arguments

    collapse all

    Current RoadRunner scene, specified as a Scene object.

    Name of the overlap group, specified as a character vector or string scalar.

    For example, there are two the roads, rrRoad1 and rrRoad2 in your existing RoadRunner scene. If you do not want RoadRunner to create automatic junctions where these two roads geometrically overlap, you must assign these two roads to the same overlap groups by setting their name argument. If these two roads belong to different overlap groups, RoadRunner creates automatic junctions at their overlap locations.

    Output Arguments

    collapse all

    Overlap group, specified as an OverlapGroup object.

    Version History

    Introduced in R2026b

    See Also