This repository is a collection of useful gems that are usable in O3DE. Those gems are open source but refer to the license of every gem. Note that this is not a "Canonical" part of O3DE - those gems are third-party contributions and are not tested against any particular version of the O3DE engine.
Toolset for joystick-controlled cameras and spline animation tools.
The tools for expanding the usability of the Spline component in O3DE. It allows to:
- Publish spline points as a path with ROS 2
- Import spline from CSV file
- Export spline to a CSV file
Having a CSV file formatted as :
x,y,z
0.000000,0.000000,0
0.698132,0.642788,0
1.396263,0.984808,0
2.094395,0.866025,0
2.792527,0.342020,0
3.490659,-0.342020,0
4.188790,-0.866025,0
4.886922,-0.984808,0
5.585054,-0.642788,0
6.283185,-0.000000,0
You can modify the Spline component in Editor.
Add SplineToolsEditorComponent next to the Spline component, locate your CSV file (it needs to exist as a source asset), and click the Load button.
If you switch Local Coordinates to true, the component will interpret coordinates as local to entity origin.
To publish spline path, add SplinePublisher next to the Spline component.
Adjust update frequency to set how often the path will be published.
The CSV file can contain the following columns: lat, lon, alt where every row contains the WGS-84 coordinate of the spline's node.
It can be loaded to a georeferenced level as explained in [Georeference section of O3DE documentation]
(https://development--o3deorg.netlify.app/docs/user-guide/interactivity/robotics/georeference/).
It is useful for visualizing paths, roads, and other things at the O3DE level.
Simple, but extremely useful tool that exposes ROS 2 subscription/publication to Script Canvas and LUA. Refer to readme.
A component that allows to look at an entity from 3rd person perspective and to switch camera mode to the free flying mode (to switch mode press the C key). It also allows to enable/disable following the target's rotation and to add a vertical offset to change the look at point of the target entity.
The Spectator camera component can be configured to centre the cursor when moving the camera (this gives the full range of rotation regardless of the available screen space) or to let the cursor move freely on the screen when moving the camera (this reduces the range of rotation, e.g. in third person mode a full rotation may require a few repeats of the (RMB press ->Rotate camera ->RMB release ->Move cursor to previous start position ->Repeat) cycle). By default this option is set to false (cursor is not centered). This option can be configured via the setreg file or by passing --regset flag in the command line. Example:
.setreg:
{
"O3DE":
{
"SpectatorCamera":
{
"MoveCursorToTheCenter": false
}
}
}--regset flag:
./Editor --regset="/O3DE/SpectatorCamera/MoveCursorToTheCenter=true"
Minimal dependency Gem that allows the setup runtime checks and prevents starting the Editor/GameLauncher if the requirements are not met Refer to readme
Deprecated, please use -console-mode switch available in o3de 2409.
The description of said feature is in the original PR.
The level modification tool contains a component called PrefabVariantEditorComponent. This component allows the change a variant of loaded prefab during game mode. It exposes PrefabVariantRequestsBus to Script Canvas or LUA.
A tool that allows the adjusted frequency, activate and deactivate sensor during the game mode.
Gem contains a smoothing component that will mimic the movement of an attached entity with the tracked entity. It offers multiple smoothing methods. It allows the lock Z axis to point up direction.
Useful for robots' movement smoothing.
Component that spawns prefabs using coordinates stored in CSV file. It supports XYZ format as well as WGS84 coordinate system.
CSV file format for coordinates in XYZ system:
x y z name
5.1 37 0 object_name
5.1 44 0 object_name
5.1 51 0 object_name
5.1 58 0 object_name
5.1 65 0 object_name
5.1 72 0 object_name
5.1 79 0 object_name
CSV file format for coordinates in WGS84 system:
alt lat lon name
0 12.5896238486642 30.1930592634115 ball
0 12.5896467730289 30.1931152819367 ball
0 12.5896704915715 30.193170552104 ball
0 12.5896945425591 30.1932257788658 ball
0 12.5897180240288 30.1932813604207 ball
0 12.5897414039641 30.1933370085065 ball
0 12.5897646831551 30.1933927129084 ball
Simple utility Gem that exposes the O3DE console to ROS 2 topics. It has two std_msgs/msg/String topics:
\o3de_console_out
\o3de_console_in
Currently o3de_console_in is usable only.
The gem functionality is available only in Profile/Debug.
A Gem that introduces point clouds to O3DE. It offers:
- PointcloudFeatureProcessor with public API
- Pointcloud product asset
- A public API for configuration (
PointcloudConfigurationBus)
At this moment it accepts PLY as a source asset.
Pointcloud asset was obtained from potree.
A utility gem that introduces a way to control robots in simulation as puppets with Pose messages or TFs.
Component that spawns prefabs using coordinates stored in the GeoJSON format (either in a file or in a raw string). It supports WGS84 coordinate system. This component supports spawning prefabs using GeoJSON stored in the file or stored in the raw string and passed via the ROS2 interface.
Configuration:
- Name - the name that is associated with the spawnable. This parameter is passed as
spawnable_namein the GeoJSON message. - Spawnable - prefab (spawnable) associated with the
Name. - Position std. dev - maximum value of the position standard deviation [metres].
- Rotation std. dev - maximum value of the rotation standard deviation [degrees].
- Scale std. dev - maximum value of the scale standard deviation.
- Place on terrain - switch indicating whether the spawner should perform scene query raytrace to place the spawnable on the terrain (or any other collider).
- Raytrace starting height - WGS84 altitude. If
Place on terrainis set to false, this value will be used as a fixed Z-axis value for the spawn. Otherwise the raytrace will start at this height (converted from WGS84 altitude to Z-axis value using theGeoReference Level Editor Component). - Default seed - seed for randomization.
- Show labels in Editor - switch to enable/disable labels in the Editor for spawned prefabs.
To get all the necessary information, the supported GeoJSON format is extended by a two additional fields (although this format is still correct with a GeoJSON standard) - spawnable_name and id. The spawnable_name is used to match spawn coordinates to a prefab name in a Spawnable Asset Configuration. The id is used to delete/modify the spawned object.
Example of supported GeoJSON:
{
"type": "FeatureCollection",
"features": [
{
"type": "Feature",
"properties": {
"spawnable_name": "ball",
"id": 0
},
"geometry": {
"type": "Point",
"coordinates": [35.19412345678901, 32.58987654321098]
}
},
{
"type": "Feature",
"properties": {
"spawnable_name": "ball",
"id": 1
},
"geometry": {
"type": "MultiPoint",
"coordinates": [
[12.19423456789012, 21.58976543210987],
[12.19454321098765, 21.58923456789012]
]
}
}
]
}
This Gem has defined notification bus - GeoJSONSpawnerNotificationBus.
Available functions:
| Function | Trigger Event | Description |
|---|---|---|
OnEntitiesSpawnBegin() |
When spawning starts | Notifies when batch spawning begins. |
OnEntitiesSpawnFinished() |
When spawning ends | Provides a list of spawned entities and the status code. |
OnEntitiesDespawnBegin() |
When despawning starts | Notifies when batch despawning begins. |
OnEntitiesDespawnFinished() |
When despawning ends | Provides a list of despawned entities and the status code. |
OnEntitySpawn() |
When a single entity spawns | Called per one entity spawn. |
OnEntityDespawn() |
When a single entity despawns | Called per one entity despawn. |
Supports Lua and Script Canvas
Gem provides a component that connects GeoJSONSpawner with ROS 2. This component provides 4 topics and 1 service that allows to control GeoJSONSpawner with ROS 2 messages.
Topics:
geojson/spawn_with_asset_path [std_msgs::msg:String]- topic that allows to spawn entities using a passed path to asset with GeoJSON.geojson/spawn_with_raw_string [std_msgs::msg:String]- topic that allows to spawn entities using a passed raw string with a GeoJSON.geojson/modify [std_msgs::msg::String]- topic that allows to modify spawned entities using the id passed with a spawn request. Usage example: Lets suppose that user spawned prefabs using such GeoJSON:
{
"type": "FeatureCollection",
"features": [
{
"type": "Feature",
"properties": {
"spawnable_name": "ball",
"id": 0
},
"geometry": {
"type": "Point",
"coordinates": [35.19412345678901, 32.58987654321098]
}
},
{
"type": "Feature",
"properties": {
"spawnable_name": "ball",
"id": 1
},
"geometry": {
"type": "MultiPoint",
"coordinates": [
[12.19423456789012, 21.58976543210987],
[12.19454321098765, 21.58923456789012]
]
}
}
]
}
Suppose the user wants to move the Feature Object assigned to ID 0. To do this, remove the Feature Object with ID 1 from the original json, then apply the necessary corrections to the coordinates of the Feature Object with ID 0 and send the GeoJSON thus prepared to the topic geojson/modify.
{
"type": "FeatureCollection",
"features": [
{
"type": "Feature",
"properties": {
"spawnable_name": "ball",
"id": 0
},
"geometry": {
"type": "Point",
"coordinates": [135.19412345678901, 132.58987654321098]
}
}
]
}
geojson/delete_all [std_msgs::msg::Empty]- topic that despawns all entities spawned with GeoJSONSpawner.geojson/delete_by_id [std_msgs/msg/Int32MultiArray]- topic that despawns all entities associated with a given ids.
Service:
geojson/get_spawned_groups_ids [std_srvs/srv/Trigger] - service that returns all spawned ids together with the number of prefabs associated with each id.
ros2 topic pub /geojson/spawn_with_raw_string std_msgs/msg/String "data: '{
\"type\": \"FeatureCollection\",
\"features\": [
{
\"type\": \"Feature\",
\"properties\": {
\"spawnable_name\": \"ball\",
\"id\": 0
},
\"geometry\": {
\"type\": \"Point\",
\"coordinates\": [
[12.194254455922405, 21.58976758326028]
]
}
}
]
}'" --once
ros2 topic pub /geojson/spawn_with_asset_path std_msgs/msg/String "{data: Assets/GeoJSON/output.json}" --once
This request adds 3 more ball spawnables to the group with ID 0.
ros2 topic pub /geojson/modify std_msgs/msg/String "data: '{
\"type\": \"FeatureCollection\",
\"features\": [
{
\"type\": \"Feature\",
\"properties\": {
\"spawnable_name\": \"ball\",
\"id\": 0
},
\"geometry\": {
\"type\": \"MultiPoint\",
\"coordinates\": [
[12.194254455922405, 21.58976758326028],
[12.194254455922415, 21.58976758326018],
[12.194254455922425, 21.58976758326008],
[12.194254455922435, 21.58976758326098]
]
}
}
]
}'" --once
ros2 topic pub /geojson/delete_by_id std_msgs/msg/Int32MultiArray "{data: [0]}" --once
ros2 topic pub /geojson/delete_all std_msgs/msg/Empty "{}" --once
ros2 service call /geojson/get_spawned_groups_ids std_srvs/srv/Trigger
This gem brings gizmo (with some simple API) to be used in game mode. It is gemification of existing ImGui extension called ImGuizmo. This gem comes with only one system component that is active only in game mode. To test this gizmo, activate gem and type in O3DE console (in gamelauncher):
imguizmo_acquire
imguizmo_show 0
There is an API to work with multiple gizmos using handle.
Refer to script canvas example below:
Note Only one gizmo can be rendered at the time!
This gem allows to randomize prefab on spawning.
It has a component called RandomizePoseComponent that modifies an entity during activation.
It allows:
- change translation and rotation and uniform scale of the Transform component,
- deactivate the entity with given probability
Note: that only given entity is modified (not all descendants).
This gem adds support for displaying user defined ImGui GUI. Users can define their own gui using ImGuiProvider::ImGuiProviderNotificationBus. User's component should be handler of the ImGuiProvider::ImGuiProviderNotificationBus::Handler and define method OnImGuiUpdate. Mentioned method should contain all code related to displayed GUI. Acquiring ImGui context and its releasing is handled by the Gem and its system component. User's component should connect to ImGuiProvider::ImGuiProviderNotificationBus using ImGuiProvider::ImGuiFeaturePath aka AZ::IO::Path. Each segment of path represents one depth in the toolbar.
Below example on how to register new feature during component activation:
Visibility of the GUI menu bar can be overridden at the app start using -cl_hide_menu_bar=1.
Setting the flag effectively disables the GUI.
void ExampleComponent::Activate()
{
/*
some implementation
*/
auto pathToFeature = ImGuiProvider::ImGuiFeaturePath{ "Tools/ExampleFeature" };
ImGuiProvider::ImGuiProviderNotificationBus::Handler::BusConnect(pathToFeature);
/*
some implementation
*/
}Gem monitors number of active handler, so ImGui features are available as long as the lifetime of component which registered it.
Gem handles correct displaying of debug menu available using home button. If Gem detects debug menu, registered GUIs disappear. After disabling debug menu, previous state of registered features is restored.
If Gem detects custom GUI feature registered in Editor, viewport icons are moved to prevent covering the registered features.
Gem defines ImGuiProvider::ImGuiProviderNotificationBus and ImGuiProvider::ImGuiProviderRequestBus.
Notification bus methods
Besides OnImGuiUpdate used for updating displayed GUI, notification bus defines methods: OnImGuiSelected and OnImGuiUnselected. Methods are triggered during registered GUI state change, respectively hidden -> visible and visible -> hidden.
Request bus methods
AZStd::optional<ImGuiFeaturePath> GetActiveGuiId() - returns optional with ImGuiProvider::ImGuiFeaturePath. Optional is empty if there is no active GUI.
void SetActiveGUI(ImGuiFeaturePath guiId) - sets GUI with given id as active. Doesn't check if given guiId exists.
