vLAR's picture
Release PhysInOne Trajectory Recorder 1.1.0 for UE 5.5.4 Windows
e0ada71 verified
|
Raw History Blame Contribute Delete
6.84 kB
# PhysInOne Trajectory Recorder
Record actor and mesh-component trajectories from a new Unreal Engine Play or
Simulate session, using the PhysInOne trajectory JSON layout.
**Version:** 1.1.0. **Precompiled target:** Unreal Engine 5.5.4, Windows 64-bit Editor.
[Download the plugin package](https://huggingface.co/datasets/vLAR/PhysInOne/resolve/main/Utils/data_processing/trajectory/releases/v1.1.0/PhysInOneTrajectory_1.1.0_UE5.5.4_Win64.zip)
The ZIP includes the Editor DLL, C++ source, English and Chinese instructions,
an example map, validation records, and Python helper tools. Python is not required
to use the plugin inside Unreal Editor.
## Install
1. Close your Unreal project and extract the ZIP.
2. Copy its `PhysInOneTrajectory` folder into your project's `Plugins` directory.
Create `Plugins` if it does not exist. For the PhysInOne project:
```text
PhysicBenchmark/
β”œβ”€β”€ PhysInOne.uproject
β”œβ”€β”€ Content/
└── Plugins/
└── PhysInOneTrajectory/
β”œβ”€β”€ PhysInOneTrajectory.uplugin
β”œβ”€β”€ Binaries/Win64/
β”œβ”€β”€ Config/
└── Source/PhysInOneTrajectory/
```
Do not put the plugin in `Content/PhysInOne/Scripts`, or add an extra enclosing
folder between `Plugins` and `PhysInOneTrajectory`.
3. Open the project with **UE 5.5.4**. Under **Edit > Plugins**, enable
**PhysInOne Trajectory Recorder** and restart if prompted.
The binary was built for UE 5.5.4-40574608 with compatible Build ID 37670630.
Other engine builds may require rebuilding from source. The descriptor's 5.5.0
compatible-engine baseline is not a claim that other engine versions were tested.
Linux, macOS, packaged games, and multi-client PIE are not certified by this release.
## Record a scene
1. Open **Window > Place Actors > All Classes**, search for `Trajectory`, and
drag **PhysInOne Trajectory Recorder** into the level. Its position is arbitrary.
2. Select the objects to record and add `moving` under **Actor > Tags** in Details.
Use Actor Tags, not Component Tags. Keep the recorder's **Actor Tag** set to
`moving`; its **Target Actors** array can remain empty.
3. On the recorder, set **Frame Rate = 30**, **Start Frame = 0**,
**Warmup Frames = 0**, **Max Frames = 180**, and enable **Auto Start**.
4. Choose **Simulate** from the Play dropdown (`Alt+S`), or use **Play**.
5. After 180 samples, the recorder finalizes its output. Press **Stop** to end
the simulation; reaching Max Frames does not stop simulation itself.
Alternatively, populate **Target Actors** with the eyedropper or add a
**PhysInOne Trajectory Target** component to selected actors. These selection
methods are combined and deduplicated. See `README_EN.txt` in the ZIP for the
full parameter reference, component filtering, and Blueprint controls.
## Output and coordinate convention
```text
Saved/PhysInOneTrajectories/<SceneName>/<unique-run-directory>/
β”œβ”€β”€ <SceneName>_trajectory.json
β”œβ”€β”€ capture_metadata.json
└── frames.jsonl
```
- Actor and component poses are **world-space** transforms. Locations are in
centimetres, rotations include UE Rotator degrees and an `x,y,z,w` quaternion,
and scales are world scales. **Do not apply the parent transform again.**
- The main JSON retains the released trajectory schema, but includes actor-root
tracks as well as selected component tracks. This world-space guarantee applies
to this plugin's new recordings; it does not redefine legacy release files.
- With Auto Start and zero warmup, frame 0 is the initialized state after BeginPlay
and before the first captured simulation step. BeginPlay can change the original
editor placement. Later samples follow completed fixed simulation steps.
- At 30 FPS, 180 samples cover frames `0..179`; an initial point plus 180 steps
requires **Max Frames = 181**. The JSON's `end_frame` is inclusive.
- `time_seconds` is `frame / frame_rate`; actual world timing and attachment
metadata are saved separately in `capture_metadata.json`.
- Instantaneous linear/angular velocities are **not exported** in this version.
They can only be estimated from sampled poses unless captured separately.
The plugin temporarily changes fixed-step timing while recording and restores
the previous settings afterward. Only one recorder can be active per engine process.
## Validate and recover
Run these commands from the extracted package with Python 3, replacing paths with
your own output paths:
```bash
python validate_trajectory.py "outputs/Scene_trajectory.json"
python recover_journal.py "outputs/frames.jsonl" "outputs/recovered_trajectory.json"
```
After recording stops, check `capture_metadata.json` for `capture_complete=true`
and an empty error. The validator checks format, finite values, frame order and
timestamps, **not physical plausibility**. The journal can recover completed
samples after a crash; it cannot reconstruct unrecorded motion. Recovery refuses
to overwrite existing files.
The separate `check_render_visibility.py` helper uses raw segmentation masks and
matching object metadata to check whether recorded objects are observed. It needs
NumPy; see `README_VISIBILITY.txt`. Incomplete coverage or unresolved IDs must not
be interpreted as proof that an object is absent.
## Important limitations
- This is a **new-simulation recorder**, not a repair tool for old trajectory
JSONs or an exporter for existing Level Sequence keys.
- Simulation samples are not automatically aligned with Movie Render Queue frames.
MRQ warmup, temporal sampling and sequence offsets need a separate alignment
workflow. **Never pair a new simulation's trajectories with old rendered images.**
- Mesh-component transforms do not describe deforming geometry, individual
GeometryCollection fragments, or individual instanced meshes.
- No collision-event log is exported. Very long captures accumulate poses in memory;
split them into bounded sessions.
## Build and update
The source is included. With Visual Studio 2022 C++ tools and the Windows SDK:
```powershell
./build_plugin.ps1 -EngineDir "<engine installation>/UE_5.5" -BuildDir "./build"
```
The script builds Win64 Development Editor in a separate host project. To update,
close your project, back up any local plugin changes, and replace the complete
installed plugin folder. Do not mix DLLs and source from different versions.
Previously saved recorder actors may retain old settings: explicitly check
`Actor Tag=moving` and `Warmup Frames=0`.
`VALIDATION.txt` records the package author's Windows build and runtime tests and
their scope. These controlled tests do not certify every PhysInOne scene or Blueprint.
[Back to the data-processing tools](https://huggingface.co/datasets/vLAR/PhysInOne/blob/main/Utils/data_processing/README.md)