sim3d.environment.GeospatialConfiguration

Create 3D environment in Unreal Engine

Since R2024b

Description

The sim3d.environment.GeospatialConfiguration object implements a 3D simulation environment that is rendered by using the Unreal Engine^® from Epic Games^®. The UAV Toolbox Interface for Unreal Engine Projects integrates the 3D simulation environment with Simulink^® so that you can query the world around the vehicle and virtually test perception, control, and planning algorithms.

Note

sim3d.environment.GeospatialConfiguration requires Simulink 3D Animation™.

Creation

Syntax

gsConfig = sim3d.environment.GeospatialConfiguration(Name = Value)

Description

gsConfig = sim3d.environment.GeospatialConfiguration(Name = Value) creates a sim3d.environment.GeospatialConfiguration object that defines the 3D environment in the Unreal Engine specified by options using one or more optional name-value arguments.

Output Arguments

gsConfig — Actor object

sim3d.environment.GeospatialConfiguration object

Geospatial object, returned as a sim3d.environment.GeospatialConfiguration object.

Properties

Access token ID — ID of stored token

string representing ID of stored token

ID of stored token, specified as a string. To create this token, create a Cesium Ion^® account, then generate the token through this account. The Authentication Manager stores the token from Cesium Ion. For more information, see Visualize with Cesium (Aerospace Blockset) and https://ion.cesium.com/.

Use Earth center as origin (ECEF) — Use Earth center as origin (ECEF)

0 or false (default) | 1 or true

Use Earth center as origin (ECEF), specified as 0 (false) or 1 (true). Set this property to true to position aerospace vehicles with respect to the Earth center.

Origin height (m) — Height at georeference point on globe

real scalar

Height at georeference point on the globe, specified as a real scalar. This parameter represents the height above the 1984 World Geodetic System (WGS84) ellipsoid model of the Earth at the latitude and longitude specified in Origin latitude and Origin longitude.

Dependencies

To use this property, set Use Earth center as origin (ECEF) to off.

Origin latitude — Latitude

real scalar

Latitude, specified as a real scalar in decimal degrees.

Dependencies

To use this property, set Use Earth center as origin (ECEF) to off.

Origin longitude — Longitude

real scalar

Longitude, specified as a real scalar in decimal degrees.

Dependencies

To use this property, set Use Earth center as origin (ECEF) to off.

Map style — Raster overlay type

Aerial (default) | Aerial with labels | Road

Raster overlay type, specified as Aerial, Aerial with labels, or Road.

Additional asset IDs — Local dataset IDs

[] (default) | array | vector

Local dataset IDs, specified as an array or vector.

Use advanced Sun sky — Georeferenced, location-accurate Sun Sky actor

0 or false (default) | 1 or true

Georeferenced, location-accurate Sun Sky actor, specified as 0 (false) or 1 (true).

Solar time — Current solar time

11 (default) | real scalar

Current solar time, specified as scalar hours from midnight.

Dependencies

To use this property, set Use advanced Sun sky to on.

Time zone — Time zone

11 (default) | scalar real

Time zone, specified as hours offset from Greenwich Mean Time (GMT). To specify hours before GMT, use a minus sign (-).

Dependencies

To use this property, set Use advanced Sun sky to on.

Day — Day

21 (default) | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 25 | 26 | 27 | 28 | 29 | 30 | 31

Day, specified as a scalar in the range 1 and 31.

Dependencies

To use this property, set Use advanced Sun sky to on.

Month — Month

9 (default) | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12

Month, specified as a scalar from 1 to 12.

Dependencies

To use this property, set Use advanced Sun sky to on.

Year — Year

2022 (default) | scalar real

Year, specified as a scalar real.

Use daylight saving time (DST) — Daylight saving time

off (default) | on

Select this check box to enable daylight saving time.

Dependencies

To use this property, set Use advanced Sun sky to on.

DST start day — Start day of daylight saving time

10 (default) | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 25 | 26 | 27 | 28 | 29 | 30 | 31

Start day of daylight saving time, specified as a scalar from 1 to 31.

Dependencies

To use this property, set Use advanced Sun sky to on.

DST start month — Start month of daylight saving time

3 (default) | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12

Start month of daylight saving time, specified as a scalar from 1 to 12.

Dependencies

To use this property, set Use advanced Sun sky to on.

DST end day — Last day of daylight saving time

3 (default) | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 25 | 26 | 27 | 28 | 29 | 30 | 31

Last day of daylight saving time, specified as a scalar from 1 to 31.

Dependencies

To use this property, set Use advanced Sun sky to on.

DST end month — Last month of daylight saving time

11 (default) | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12

Last month of daylight saving time, specified as a scalar from 1 to 12.

Dependencies

To use this property, set Use advanced Sun sky to on.

DST switch hour — Hour when daylight saving time switches

2 (default) | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24

Hour when daylight saving time switches, specified as a scalar from 1 to 24.

Dependencies

To use this property, set Use advanced Sun sky to on.

TilesetSource — Tileset Source

'Earth Terrain' (default) | 'URL' | 'None'

Tileset source, specified as one of 'Earth Terrain', 'URL', or 'None'.

Data Types: string

Url — File path of locally stored 3d tileset data

string

File path of locally stored 3d tileset data, specified as a string.

Dependencies

To use this property, set the TilesetSource property to Url.

Data Types: string

Object Functions

sim3d.environment.GeospatialConfiguration.createAccessToken	Create access token
sim3d.environment.GeospatialConfiguration.getAccessTokenIDs	Get access token
sim3d.environment.GeospatialConfiguration.deleteAccessToken	Delete access token
sim3d.environment.GeospatialConfiguration.updateAccessToken	Update access token

Examples

Specify Geospatial Map as Scene

This example shows how to create a world object and specify GeospatialMap as the scene.

world = sim3d.World('Map',"/MathWorksGeoSpatial/Maps/GeoSpatialMap");

Create access token. Enter a unique token ID and token value shown on Cesium ion account. Skip this step if you already have created a token in this MATLAB session. For information on how to create an Access token in your Cesium ion account, see Visualize with Cesium (Aerospace Blockset). In the Create new token dialog box, enter the unique token ID string and copy and paste the access token created from the Cesium Ion page. For example, for token ID MyNewToken, enter these values.

sim3d.environment.GeospatialConfiguration.createAccessToken();

Configure the Geospatial actor using the token ID you created.

geoConfig = sim3d.environment.GeospatialConfiguration(AccessTokenID="MyNewToken",...
                                                        UseAdvancedSunSky=true,...
                                                        OriginLatitude=41.881154,...
                                                        OriginLongitude=-87.620836,...
                                                        OriginHeight=200.0);

ans = 
""

Add Geospatial configuration to the world object.

world.add(geoConfig);

Run simulation.

world.createViewport();
world.run(0.02, inf);

To view the map from a preset view, left-click in the executable window and select a number from 1 to 9.

Version History

Introduced in R2024b

R2025a: sim3d.environment.GeospatialConfiguration class has two new properties

The UAV Toolbox now offers additional support for offline dataset loading in Cesium^® to allow Air-Gap use-cases. The sim3d.environment.GeospatialConfiguration class has two new properties TilesetSource and Url.

You can use the TilesetSource property to select the value of the URL property as the source, where you can specify the file path of your offline tileset data.