Skip to content

Experiment plugin

A plugin containing logic for running MRI experiments in Unreal Engine.

Implements logic useful for MRI experiments, including: replication and information extraction / re-rendering basic TTL handling and skeleton for experiment logic Settings I/O

Many of the logic here are scaffolds for building experiments, and the user will need to subclass and implement many of the virtual functions, and also extend some enum definitions.

Classes

Class Description
AExperimentFrameCaptureCamera An actor that captures rendered frames from the scene to disk or to memory.
AExperimentSpectatorController Player controller used during demo playback to follow the subject and capture data.
AExperimentSubjectController Base controller for subjects in MRI experiments.
AExperimentSubjectState Replicated player state holding all per-frame data needed for experiment logging and replay.
ExperimentState A single-frame snapshot of all experiment state, collected during demo playback.
FExperimentModule A plugin containing logic for running MRI experiments in Unreal Engine.
IExperimentAgentComponentVisitor Visitor interface for reading state from Experiment agent components.
UExperimentAgentComponent Abstract base component for all MRI experiment agents (subject pawn, NPCs, etc.).
UExperimentDemoSubsystem Game instance subsystem that manages demo recording, playback, and replay enumeration.
UExperimentLoggerComponent Base actor component that collects per-frame experiment state during demo playback.
UExperimentPlayerAgentComponent Agent component marking the subject's (player's) pawn for state logging.
UExperimentSettings Per-session configuration loaded from an INI-style settings file.
UExperimentSettingsSubsystem Game instance subsystem that owns the experiment settings for a session.
UExperimentType Utility class providing string conversion and numeric casting for EExperimentType.
USemSegTagger Writes semantic segmentation labels into the custom depth stencil buffer.

Structs

Struct Description
EntityState Tick/frame record of the position, rotation, type, and ID of a single agent entity at one frame.
FExperimentCameraDescription Describes one frame-capture camera requested in the settings file.
FReplayInfo Blueprint-accessible struct describing a single replay recording.