UHeadMountedDisplayFunctionLibrary::GetControllerTransformForTime

Get the transform and potentially velocity data at a specified time near the current frame in unreal world space.

Windows
MacOS
Linux

References

Module

HeadMountedDisplay

Header

/Engine/Source/Runtime/HeadMountedDisplay/Public/HeadMountedDisplayFunctionLibrary.h

Include

#include "HeadMountedDisplayFunctionLibrary.h"

Source

/Engine/Source/Runtime/HeadMountedDisplay/Private/HeadMountedDisplayFunctionLibrary.cpp

Syntax

static bool GetControllerTransformForTime
(
    UObject * WorldContext,
    const int32 ControllerIndex,
    const FName MotionSource,
    FTimespan Time,
    bool & bTimeWasUsed,
    FRotator & Orientation,
    FVector & Position,
    bool & bProvidedLinearVelocity,
    FVector & LinearVelocity,
    bool & bProvidedAngularVelocity,
    FVector & AngularVelocityRadPerSec
)

Remarks

Get the transform and potentially velocity data at a specified time near the current frame in unreal world space. This is intended for use with sub-frame input action timing data from SetXRTimedInputActionDelegate, or future support for timestamps in the core input system. The valid time window is platform dependent, but the intention per OpenXR is to fetch transforms for times from, at most, the previous few frames in the past or future. The OpenXR spec suggests that 50ms in the past should return an accurate result. There is no guarantee for the future, but the underlying system is likely to have been designed to predict out to about 50ms as well. On some platforms this will always just return a cached position and rotation, ignoring time. bTimeWasUsed will be false in that case.

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss