The AirGen API allows the user to interact direclty with the scene as well as specify the weather and environment conditions for the simulation. This includes parameters such as wind, precipitation, time-of-day, and more. Example Severe Weather

​
Scene

For any given simulation scenario, the scene is a composition of several non-agent objects, along with other assets such as lighting, weather etc.

​
Geospatial scenery

AirGen contains support for both synthetic and geospatial scenes. The synthetic scenes are generated using Unreal Engine, whereas the geospatial data is loaded through the Cesium platform. Within a geospatial scene, the starting location of the drone can be set through the OriginGeoPoint field in the configuration settings (in order to access this setting, you need to start a custom session instead of a sample scenario). The default latitude and longitude in this section correspond to Seattle, USA. Alternatively, you can also use the setGeoReference() function in the Python API. When using a geospatial scene, the Python client needs to be initialized with the geo=True flag. For example: client = airgen.MultirotorClient(geo=True). AirGen provides the following API functionality that is specific to geospatial scenes/scenarios:
  1. simSetVehicleGeoPose: Set the GPS location and an orientation of the drone.
  2. simSetObjectGeoPose: Set the GPS location and an orientation of an object.
  3. simSetGeoReference: Set the GPS location of the origin of the scene (the vehicle will also be teleported when this function is used).
  4. moveToGPSAsync: Move the drone to a GPS location with specified velocity, yaw behavior.
  5. getGPSData: Get the GPS location of the drone.

​
Scene Ground Truth

Voxel Grid: AirGen allows for on-demand generation and output of a voxel grid representation of the scene. A voxel grid is a representation of the occupancy of a given world/map, by discretizing into cells of a certain size; and recording a voxel if that particular location is occupied. 
client = airgen.MultirotorClient()
center_position = airgen.Vector3r(0, 0, 0) # Center position of the voxel grid
bounds = 10 # Extent in meters
resolution = 0.1 # Resolution in meters
output_file = "map.binvox" # Output file
voxel_grid = client.simCreateVoxelGrid(center_position, bounds, resolution, output_file)

​
Object Interaction

AirGen’s object functionalities offer dynamic interaction capabilities with the environment. Users can place, manipulate, and remove objects, setting up diverse robot testing scenarios.
  • Spawn an object: Spawns a new object from a library of existing objects in the simulation context. For example, the following code spawns a cube 20 meters in front of the robot.
client = airgen.VehicleClient()
asset_list = client.simListAssets()
pose = client.simGetVehiclePose()
pose.position.x_val += 20
scale = airgen.Vector3r(1,1,1)
client.simSpawnObject("Cube_new", "Cube", pose, scale, physics_enabled=True)
  • List available assets: Returns a list of all the assets available within the scope of the current scene.
Once an object is created, its location/size etc. can be customized. For example, we can use the following functions to get and change the characteristics of the cube we spawned earlier.
  • Get current pose of an object: simGetObjectPose fetches the current pose of a specified object.
pose = client.simGetObjectPose("Cube_new")
  • Change object pose: simSetObjectPose can be used to change an object’s position and orientation.
pose.position.x_val += 5
client.simSetObjectPose("Cube_new", pose)
  • Get current scale of an object:
scale = client.simGetObjectScale("Cube_new")
  • Change scale of an object:
client.simSetObjectScale("Cube_new", airgen.Vector3r(5, 5, 5))
  • List all objects in a scene: To get a list of all the objects in a scene (and to select the ones we wish to control), we can use simListSceneObjects(). The objects can also be filtered using wildcards to find some that fit a name pattern.
obj_list = client.simListSceneObjects()
cubes_list = client.simListSceneObjects('Cube.*')
  • Remove an object: Finally, to remove an object from a scene, we can use simDestroyObject.
client.simDestroyObject("Cube_new")
Quick Tips:
  • Ensure object paths are correct to avoid spawn errors.
  • Handle physics-enabled objects with caution.
  • Save your environment state often.

​
Weather and Environment Controls

AirGen offers comprehensive control over environmental conditions, including weather effects, wind, and time of day. These parameters allow users to customize visual effects as well as the physical impact on aerial vehicles in simulation.
By default, all weather effects are disabled. To enable weather effects, you must first call simEnableWeather(True).

​
Weather Parameters

Weather parameters are accessible through simSetWeatherParameter(), which enables users to set various weather effects. These effects impact only visuals and do not alter drone dynamics. Available weather parameters are:
  • Rain
  • Snow
  • Fog
  • Dust
To set a weather parameter, specify the effect using airgen.WeatherParameter and provide a scalar value between 0 and 1, where 1.0 is the maximum effect.

​
Example: Setting Weather Effects

import airgen
client.simSetWeatherParameter(airgen.WeatherParameter.Rain, 1.0)  # Maximum rain
client.simSetWeatherParameter(airgen.WeatherParameter.Fog, 1.0)   # Maximum fog

​
Wind API

The simSetWind() function modifies wind parameters in the simulation and directly impacts both visuals and the drone’s dynamics. The wind is defined using a Vector3r vector, where each component specifies wind speed in meters per second along the North-East-Down (NED) coordinate frame.

​
Example: Setting Wind Conditions

import airgen, time
# Apply a wind of 5 m/s along the North axis (X direction) for 10 seconds
client.simSetWind(airgen.Vector3r(5, 0, 0))
time.sleep(10)
# Reset wind to zero
client.simSetWind(airgen.Vector3r(0, 0, 0))
Aerial Vehicles Only: The wind effect currently influences only aerial vehicles; ground robots are unaffected by simSetWind() settings.

​
Time of Day

To dynamically adjust the time of day within the simulation, use simSetTimeofDay(). This function adjusts sun and moon positions, ambient lighting, and overall sky conditions. Specify the desired date and time in the "YYYY-MM-DD HH:MM:SS" format.

​
Example: Setting Simulation Date and Time

# Set a specific date and time (e.g., midday)
client.simSetTimeofDay(True, "2024-07-22 12:00:00")
# Set nighttime
client.simSetTimeofDay(True, "2024-07-22 00:00:00")