Add instance metadata to gfx-replay. - Githubissues

facebookresearch / habitat-sim

A flexible, high-performance 3D simulator for Embodied AI research.

https://aihabitat.org/

MIT License

2.64k stars 424 forks source link

Add instance metadata to gfx-replay. #2377

Closed 0mdc closed 6 months ago

0mdc commented 6 months ago

Motivation and Context

This changeset adds an InstanceMetadata entry to gfx-replay keyframes so that this information can be made available to external players.

This information can be used to do commands on gfx-replay instances based on real simulation IDs, for example:

Hiding an agent.
Highlighting an object's mesh.
Tooling.
...

How Has This Been Tested

Added test.
Tested in Unity gfx-replay client.

Types of changes

[ ] Docs change / refactoring / dependency upgrade
[ ] Bug fix (non-breaking change which fixes an issue)
[x] New feature (non-breaking change which adds functionality)
[ ] Breaking change (fix or feature that would cause existing functionality to change)

Checklist

[x] My code follows the code style of this project.
[] My change requires a change to the documentation.
[x] I have updated the documentation accordingly.
[x] I have read the CONTRIBUTING document.
[x] I have completed my CLA (see CONTRIBUTING)
[x] I have added tests to cover my changes.
[x] All new and existing tests passed.