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 Aerospace Blockset™ 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

AccessTokenID — 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 and https://ion.cesium.com/.

UseTrueOrigin — Use Earth center as origin

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.

OriginHeight — 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 OriginLatitude and OriginLongitude.

Dependencies

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

OriginLatitude — 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.

OriginLongitude — 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.

MapStyle — Raster overlay type

Aerial (default) | Aerial with labels | Road

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

AdditionalAssetIDs — Local dataset IDs

[] (default) | array | vector

Local dataset IDs, specified as an array or vector.

UseAdvancedSunSky — 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).

SolarTime — Current Solar time

11 (default) | real scalar

Current Solar time, specified as scalar hours from midnight.

Dependencies

To use this property, set UseAdvancedSunSky to on.

TimeZone — TimeZone

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 UseAdvancedSunSky 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 UseAdvancedSunSky 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 UseAdvancedSunSky to on.

Year — Year

2022 (default) | scalar real

Year, specified as a scalar real.

UseDaylightSavingTime — Daylight saving time

off (default) | on

Select this check box to enable daylight saving time.

Dependencies

To use this property, set UseAdvancedSunSky to on.

DSTStartDay — 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 UseAdvancedSunSky to on.

DSTStartMonth — 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 UseAdvancedSunSky to on.

DSTEndDay — 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 UseAdvancedSunSky to on.

DSTEndMonth — 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 UseAdvancedSunSky to on.

DSTSwitchHour — 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 UseAdvancedSunSky to on.

Object Functions

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

Version History

Introduced in R2024b