SceneAnchorPoint

Scene anchor point

Since R2025a

expand all in page

    Description

    The SceneAnchorPoint object represents a scene anchor defined in the scene associated to the current scenario. You can use a SceneAnchorPoint object to specify the positions of other scenario objects, such as actors, and anchor them to roads. For more information on anchors in RoadRunner Scenario, see Scenario Anchoring System (RoadRunner Scenario).

    Creation

    To extract a SceneAnchorPoint object that represents a scene anchor in your RoadRunner scenario, use the findSceneAnchor function to retrieve an existing scene anchor by specifying your scenario object and the name of the anchor. For example, sceneAnchor = findSceneAnchor(scnro,"ScenarioStart") returns an object, sceneAnchor, that represents the anchor named "ScenarioStart" in the scenario scnro.

    Properties

    expand all

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

    Examples

    collapse all

    Use the findSceneAnchor function to extract the object for the default scene anchor "ScenarioStart" in the associated scene ScenarioBasic.rrscene.

    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 scenes and scenarios, such as by adding and modifying roads, actors, and logic components, using MATLAB.

    rrApi = roadrunnerAPI(rrApp);
    Extract the scene and scenario objects from the Scene and Scenario properties of the authoring API object rrApi, respectively. The extracted Scene object enables you to specify the scene in which to add scene components such as roads and lanes. The extracted Scenario (RoadRunner Scenario) object enables you to specify the scenario in which to add scenario components such as actors and logic.
    scn = rrApi.Scene;
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 roads in your scene, or to actors in your scenario.
    prj = rrApi.Project;

    Use findSceneAnchor to extract the scene anchor named "ScenarioStart" to a SceneAnchorPoint object, sceneAnchor. You can use the sceneAnchor object to specify positions for the actors and anchor them to roads in your scenario. For more information, see anchorToPoint and autoAnchor.

    sceneAnchor = findSceneAnchor(scnro,"ScenarioStart");

    Version History

    Introduced in R2025a

    See Also

    | | | |

    Topics