FMotionVectorSimulation

Singleton class used for optionally overriding previous transforms for motion vector computation.

Windows
MacOS
Linux

Inheritance Hierarchy

References

Module

Engine

Header

/Engine/Source/Runtime/Engine/Public/Rendering/MotionVectorSimulation.h

Include

#include "Rendering/MotionVectorSimulation.h"

Syntax

class FMotionVectorSimulation :
    public FTickableGameObject,
    public FUObjectArray::FUObjectDeleteListener

Remarks

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.

Constructors

No constructors are accessible with public or protected access.

Destructors

No destructors are accessible with public or protected access.

Functions

Name Description

Public function

void

 

ClearPreviousTransform

(
    USceneComponent* Component
)

Clear the simulated previous transform for the specified component

Public function Static

FMotionVecto...

 

Get()

Access the singleton instance for motion vector simulation

Public function Const

TOptional< F...

 

GetPreviousTransform

(
    USceneComponent* Component
)

Check if the specified scene component has a simulated transform and return the result as an optional transform.

Public function Const

bool

 

GetPreviousTransform

(
    USceneComponent* Component,
    FTransform* OutTransform
)

Check if the specified scene component has a simulated transform, setting the specified transform if so.

Public function Static

bool

 

IsEnabled()

Check whether motion vector simulation is enabled. When disabled, no transforms will be returned.

Public function

void

 

SetPreviousTransform

(
    USceneComponent* Component,
    const FTransform& SimulatedPreviou...
)

Assign a simulated previous frame transform for the specified component.
Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss