IXRCamera

Interface used by the camera component to figure out the final position of a motion tracked camera.

Windows
MacOS
Linux

Inheritance Hierarchy

References

Module

HeadMountedDisplay

Header

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

Include

#include "IXRCamera.h"

Syntax

class IXRCamera : public IIdentifiableXRDevice

Remarks

Interface used by the camera component to figure out the final position of a motion tracked camera.

To reduce duplicated code, implementations should use the FXRCameraBase instead of implementing this interface directly.

Constructors

Name Description

Public function

IXRCamera()

Functions

Name Description

Public function

void

 

ApplyHMDRotation

(
    APlayerController * PC,
    FRotator & ViewRotation
)

Optionally called by APlayerController to apply the orientation of the headset to the PC's rotation.

Public function

void

 

CalculateStereoCameraOffset

(
    const enum EStereoscopicPass Stereo...,
    FRotator & ViewRotation,
    FVector & ViewLocation
)

Calculates the offset for the camera position, given the specified eye pass, position and rotation.

Public function Virtual

bool

 

GetPassthroughCameraUVs_RenderThread

(
    TArray < FVector2D >& OutUVs
)

Fetches the UV coordinates of an AR passthrough camera relative to the screen.

Public function Const

bool

 

GetUseImplicitHMDPosition()

Gets the view offset mode to assume an implied HMD position

Public function

void

 

OverrideFOV

(
    float& InOutFOV
)

Override the Field of View for the player camera component.

Public function

void

 

SetupLateUpdate

(
    const FTransform & ParentToWorld,
    USceneComponent * Component,
    bool bSkipLateUpdate
)

Setup state for applying the render thread late update

Public function

bool

 

UpdatePlayerCamera

(
    FQuat & CurrentOrientation,
    FVector & CurrentPosition
)

Apply the orientation and position of the headset to the Camera.

Public function

void

 

UseImplicitHMDPosition

(
    bool bInImplicitHMDPosition
)

Set the view offset mode to assume an implied HMD position

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