IXRTrackingSystem::GetRelativeEyePose

If the device id represents a head mounted display, fetches the relative position of the given eye relative to the eye.

Windows
MacOS
Linux

Override Hierarchy

IXRTrackingSystem::GetRelativeEyePose()

FXRTrackingSystemBase::GetRelativeEyePose()

References

Module

HeadMountedDisplay

Header

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

Include

#include "IXRTrackingSystem.h"

Syntax

bool GetRelativeEyePose
(
    int32 DeviceId,
    EStereoscopicPass Eye,
    FQuat & OutOrientation,
    FVector & OutPosition
)

Remarks

If the device id represents a head mounted display, fetches the relative position of the given eye relative to the eye. If the device is does not represent a stereoscopic tracked camera, orientation and position should be identity and zero and the return value should be false.

Returns

true if the pose is valid or not. If the device is not a stereoscopic device, return false.

Parameters

Parameter

Description

DeviceId

the device to request the eye pose for.

Eye

the eye the pose should be requested for, if passing in any other value than eSSP_LEFT_EYE or eSSP_RIGHT_EYE, the method should return a zero offset.

OutOrientation

The orientation of the eye relative to the device orientation.

OutPosition

The position of the eye relative to the tracked device

Select Skin
Light
Dark

Welcome to the new Unreal Engine 4 Documentation site!

We're working on lots of new features including a feedback system so you can tell us how we are doing. It's not quite ready for use in the wild yet, so head over to the Documentation Feedback forum to tell us about this page or call out any issues you are encountering in the meantime.

We'll be sure to let you know when the new system is up and running.

Post Feedback