position

R2026b

Set or get actor position

Since R2026b

collapse all in page

    Syntax

    position(actr,pt)
    ptOut = position(actr)

    Description

    Add-On Required: This feature requires the 3D Scenarios add-on.

    position(actr,pt) sets the position of the specified actor. To set the position of an actor, the Behavior property of the actor must be empty and the SimulationStatus property of the associated Scenario object must be "notstarted".

    ptOut = position(actr) gets the position of the specified actor. You can query the position of an actor at any time.

    Input Arguments

    collapse all

    Actor, specified as an m-by-1 vector of Actor objects, where m is the number of actors.

    Actor position, specified as a geospatial table containing geopointshape objects. You can create a geospatial table from latitude, longitude, and height coordinates by using the pointtable function.

    • If the geopointshape objects represent 2D points, then the function places the actors on the terrain or surface specified by the height reference of the points. If the points do not specify a height reference, then the function places the actors on the terrain.

    • If the geopointshape objects represent 3D points, then the function places the actors at the specified heights, relative to the height reference specified by the points.

    Each row of the geospatial table specifies one position. If the table has one row, then the position applies to all the actors. If the table has multiple rows, then the number of rows must match the number of actors.

    Output Arguments

    collapse all

    Actor position, returned as a geospatial table containing geopointshape objects. The geopointshape objects represent 3D points that are referenced to the terrain. Each row of the table corresponds to an actor.

    Version History

    Introduced in R2026b

    See Also

    Functions

    Objects

    Topics