Navigation
API > API/Runtime > API/Runtime/Engine
Singleton class used for optionally overriding previous transforms for motion vector computation. This predominantly used by Sequencer on camera cut frames to forcibly inform the renderer of simulated trajectories for primitive components and cameras. Transforms are stored in an unintrusive sparse map per-component to avoid paying a memory cost for all components. Simulated transforms are only valid for the frame that they were added, and are removed on a subsequent tick.
| Name | FMotionVectorSimulation |
| Type | class |
| Header File | /Engine/Source/Runtime/Engine/Public/Rendering/MotionVectorSimulation.h |
| Include Path | #include "Rendering/MotionVectorSimulation.h" |
Syntax
class FMotionVectorSimulation :
public FTickableGameObject ,
public FUObjectArray::FUObjectDeleteListener
Inheritance Hierarchy
- FTickableObjectBase → FTickableGameObject → FMotionVectorSimulation
- FUObjectArray::FUObjectDeleteListener → FMotionVectorSimulation
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FMotionVectorSimulation() |
Rendering/MotionVectorSimulation.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
~FMotionVectorSimulation() |
Rendering/MotionVectorSimulation.h |
Structs
| Name | Remarks |
|---|---|
| FSimulatedTransform |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| MapCriticalSection | FCriticalSection | Rendering/MotionVectorSimulation.h | ||
| SimulatedTransforms | TMap< const UObjectBase *, FSimulatedTransform > | Rendering/MotionVectorSimulation.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void ClearPreviousTransform
(
UObject* Component |
Clear the simulated previous transform for the specified component | Rendering/MotionVectorSimulation.h | |
TOptional< FTransform > GetPreviousTransform
(
UObject* Object |
Check if the specified uboject has a simulated transform and return the result as an optional transform. | Rendering/MotionVectorSimulation.h | |
bool GetPreviousTransform
(
UObject* Object, |
Check if the specified scene component has a simulated transform, setting the specified transform if so. | Rendering/MotionVectorSimulation.h | |
void SetPreviousTransform
(
UObject* Object, |
Assign a simulated previous frame transform for the specified object. | Rendering/MotionVectorSimulation.h |
Overridden from FUObjectDeleteListener
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual SIZE_T GetAllocatedSize() |
Rendering/MotionVectorSimulation.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static FMotionVectorSimulation & Get() |
Access the singleton instance for motion vector simulation | Rendering/MotionVectorSimulation.h | |
static bool IsEnabled() |
Check whether motion vector simulation is enabled. When disabled, no transforms will be returned. | Rendering/MotionVectorSimulation.h |