1. Epic GamesDeveloper
  3. UHeadMountedDisplayFunctionLibrary

UHeadMountedDisplayFunctionLibrary

API > API/Plugins > API/Plugins/XRBase

   
Name UHeadMountedDisplayFunctionLibrary
Type class
Header File /Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/HeadMountedDisplayFunctionLibrary.h
Include Path #include "HeadMountedDisplayFunctionLibrary.h"

Syntax

UCLASS (MinimalAPI)  
class UHeadMountedDisplayFunctionLibrary : public UBlueprintFunctionLibrary

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

UHeadMountedDisplayFunctionLibrary ( const FObjectInitializer& ObjectInitializer
)

   HeadMountedDisplayFunctionLibrary.h  

Constants

Name Type Remarks Include Path
OnXRDeviceOnDisconnectDelegate FXRDeviceOnDisconnectDelegate   HeadMountedDisplayFunctionLibrary.h
OnXRTimedInputActionDelegateMap TMap< FName, FXRTimedInputActionDelegate >   HeadMountedDisplayFunctionLibrary.h

Functions

Public

Static

Name Remarks Include Path Unreal Specifiers

static void BreakKey ( FKey InKey,
FString& InteractionProfile,
EControllerHand& Hand,
FName& MotionSource,
FString& Indentifier,
FString& Component
)

 Breaks an XR key apart into the interaction profile, handedness, motion source, indentifier and component. HeadMountedDisplayFunctionLibrary.h
  • BlueprintPure
  • Category="Input|XRTracking"
  • Meta=(NativeBreakFunc)

static void CalibrateExternalTrackingToHMD ( const FTransform& ExternalTrackingTransform
)

 Called to calibrate the offset transform between an external tracking source and the internal tracking source (e.g. mocap tracker to and HMD tracker). HeadMountedDisplayFunctionLibrary.h
  • BlueprintCallable
  • Category="Input|HeadMountedDisplay|ExternalTracking"

static void ClearXRTimedInputActionDelegate ( const FName& ActionPath
)

   HeadMountedDisplayFunctionLibrary.h
  • BlueprintCallable
  • Category="Input|XRTracking"

static EXRDeviceConnectionResult::Type ConnectRemoteXRDevice ( const FString& IpAddress,
const int32 BitRate
)

 Connect to a remote deviceConnect to a remote device for Remote Debugging HeadMountedDisplayFunctionLibrary.h
  • BlueprintCallable
  • Category="XR|HeadMountedDisplay"

static void DisconnectRemoteXRDevice()

 Disconnect remote AR Device HeadMountedDisplayFunctionLibrary.h
  • BlueprintCallable
  • Category="XR|HeadMountedDisplay"

static bool EnableHMD ( bool bEnable
)

 Switches to/from using HMD and stereo rendering. HeadMountedDisplayFunctionLibrary.h
  • BlueprintCallable
  • Category="Input|HeadMountedDisplay"

static TArray< FXRDeviceId > EnumerateTrackedDevices ( const FName SystemId,
EXRTrackedDeviceType DeviceType
)

 Cross XR-System query that will list all XR devices currently being tracked. HeadMountedDisplayFunctionLibrary.h
  • BlueprintCallable
  • Category="Input|XRTracking"

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

 Get the transform and potentially velocity data at a specified time near the current frame in unreal world space. HeadMountedDisplayFunctionLibrary.h
  • BlueprintCallable
  • Category="Input|XRTracking"

static bool GetCurrentInteractionProfile ( const EControllerHand Hand,
FString& InteractionProfile
)

 Get the openXR interaction profile name for the given controller. HeadMountedDisplayFunctionLibrary.h
  • BlueprintCallable
  • Category="Input|XRTracking|OpenXR"

static void GetDevicePose ( const FXRDeviceId& XRDeviceId,
bool& bIsTracked,
FRotator& Orientation,
bool& bHasPositionalTracking,
FVector& Position
)

 Cross XR-System query that returns a specific device's tracked position and orientation (in tracking space). HeadMountedDisplayFunctionLibrary.h
  • BlueprintCallable
  • Category="Input|XRTracking"

static void GetDeviceWorldPose ( UObject* WorldContext,
const FXRDeviceId& XRDeviceId,
bool& bIsTracked,
FRotator& Orientation,
bool& bHasPositionalTracking,
FVector& Position
)

 Cross XR-System query that returns a specific device's position and orientation in world space. HeadMountedDisplayFunctionLibrary.h
  • BlueprintCallable
  • Category="Input|XRTracking"
  • Meta=(WorldContext="WorldContext")

static void GetHandTrackingState ( UObject* WorldContext,
const EXRSpaceType XRSpaceType,
const EControllerHand Hand,
FXRHandTrackingState& HandTrackingState
)

 Cross XR-System query that returns critical information about the motion controller (position, orientation, hand/finger position) HeadMountedDisplayFunctionLibrary.h
  • BlueprintCallable
  • Category="Input|XRTracking"

static void GetHMDData ( UObject* WorldContext,
FXRHMDData& HMDData
)

 Cross XR-System query that returns critical information about the HMD display (position, orientation, device name) HeadMountedDisplayFunctionLibrary.h
  • BlueprintCallable
  • Category="Input|XRTracking"

static FName GetHMDDeviceName()

 Returns the name of the device, so scripts can modify their behaviour appropriately HeadMountedDisplayFunctionLibrary.h
  • BlueprintPure
  • Category="Input|HeadMountedDisplay"

static EHMDWornState::Type GetHMDWornState()

 Returns the worn state of the device. HeadMountedDisplayFunctionLibrary.h
  • BlueprintPure
  • Category="Input|HeadMountedDisplay"

static void GetMotionControllerState ( UObject* WorldContext,
const EXRSpaceType XRSpaceType,
const EControllerHand Hand,
const EXRControllerPoseType ControllerPoseType,
FXRMotionControllerState& MotionControllerState
)

 Cross XR-System query that returns critical information about the motion controller (position, orientation) HeadMountedDisplayFunctionLibrary.h
  • BlueprintCallable
  • Category="Input|XRTracking"

static int32 GetNumOfTrackingSensors()

 If the HMD has multiple positional tracking sensors, return a total number of them currently connected. HeadMountedDisplayFunctionLibrary.h
  • BlueprintPure
  • Category="Input|HeadMountedDisplay"

static void GetOrientationAndPosition ( FRotator& DeviceRotation,
FVector& DevicePosition
)

 Grabs the current orientation and position for the HMD. HeadMountedDisplayFunctionLibrary.h
  • BlueprintPure
  • Category="Input|HeadMountedDisplay"

static float GetPixelDensity ()

 Returns the current XR pixel density. HeadMountedDisplayFunctionLibrary.h
  • BlueprintPure
  • Category="Input|HeadMountedDisplay"
  • Meta=(DeprecatedFunction, Deprecationmessage="Replaced with GetHMDSecondaryScreenPercentage for 5.6.")

static FVector2D GetPlayAreaBounds ( TEnumAsByte< EHMDTrackingOrigin::Type > Origin
)

 Get the bounds of the area where the user can freely move while remaining tracked centered around the specified origin HeadMountedDisplayFunctionLibrary.h
  • BlueprintCallable
  • Category="Input|XRTracking"

static bool GetPlayAreaRect ( FTransform& OutTransform,
FVector2D& OutRect
)

 Get the transform and dimensions of the playable area rectangle. HeadMountedDisplayFunctionLibrary.h
  • BlueprintCallable
  • Category="Input|XRTracking"

static TEnumAsByte< EHMDTrackingOrigin::Type > GetTrackingOrigin()

 Returns current tracking origin type (eye level or floor level). HeadMountedDisplayFunctionLibrary.h
  • BlueprintPure
  • Category="Input|HeadMountedDisplay"

static bool GetTrackingOriginTransform ( TEnumAsByte< EHMDTrackingOrigin::Type > Origin,
FTransform& OutTransform
)

 Get the transform of the specified tracking origin, if available. HeadMountedDisplayFunctionLibrary.h
  • BlueprintCallable
  • Category="Input|XRTracking"

static void GetTrackingSensorParameters ( FVector& Origin,
FRotator& Rotation,
float& LeftFOV,
float& RightFOV,
float& TopFOV,
float& BottomFOV,
float& Distance,
float& NearPlane,
float& FarPlane,
bool& IsActive,
int32 Index
)

 If the HMD has a positional sensor, this will return the game-world location of it, as well as the parameters for the bounding region of tracking. HeadMountedDisplayFunctionLibrary.h
  • BlueprintPure
  • Category="Input|HeadMountedDisplay"
  • Meta=(AdvancedDisplay="LeftFOV,RightFOV,TopFOV,BottomFOV,Distance,NearPlane,FarPlane")

static FTransform GetTrackingToWorldTransform ( UObject* WorldContext
)

 Returns a transform that can be used to convert points from tracking space to world space. HeadMountedDisplayFunctionLibrary.h
  • BlueprintCallable
  • Category="Input|HeadMountedDisplay"
  • Meta=(WorldContext="WorldContext")

static FString GetVersionString()

 Returns name of tracking system specific version string. HeadMountedDisplayFunctionLibrary.h
  • BlueprintPure
  • Category="HeadMountedDisplay"

static void GetVRFocusState ( bool& bUseFocus,
bool& bHasFocus
)

 Returns current state of VR focus. HeadMountedDisplayFunctionLibrary.h
  • BlueprintPure
  • Category="Input|HeadMountedDisplay"
  • Meta=(DisplayName="Get VR Focus State")

static float GetWorldToMetersScale ( UObject* WorldContext
)

 Returns the World to Meters scale, which corresponds to the scale of the world as perceived by the player HeadMountedDisplayFunctionLibrary.h
  • BlueprintPure
  • Category="Input|HeadMountedDisplay"
  • Meta=(WorldContext="WorldContext")
Returns the current XR secondary screen precentage. HeadMountedDisplayFunctionLibrary.h
  • BlueprintPure
  • Category="Input|HeadMountedDisplay"
  • Meta=(DisplayName="Get XR Secondary Screen Percentage")

static int32 GetXRSystemFlags()

 Returns the flags for the device, so scripts can modify their behaviour appropriately HeadMountedDisplayFunctionLibrary.h
  • BlueprintPure
  • Category="Input|HeadMountedDisplay"

static bool HasValidTrackingPosition()

 If the HMD supports positional tracking, whether or not we are currently being tracked HeadMountedDisplayFunctionLibrary.h
  • BlueprintPure
  • Category="Input|HeadMountedDisplay"

static bool IsDeviceTracking ( const FXRDeviceId& XRDeviceId
)

 Cross XR-System query that returns whether the specified device is tracked or not. HeadMountedDisplayFunctionLibrary.h
  • BlueprintCallable
  • Category="Input|XRTracking"
Returns whether or not the HMD hardware is connected and ready to use. HeadMountedDisplayFunctionLibrary.h
  • BlueprintPure
  • Category="Input|HeadMountedDisplay"
  • Meta=(KeyWords="HMD")

static bool IsHeadMountedDisplayEnabled()

 Returns whether or not we are currently using the head mounted display. HeadMountedDisplayFunctionLibrary.h
  • BlueprintPure
  • Category="Input|HeadMountedDisplay"
  • Meta=(KeyWords="HMD")

static bool IsSpectatorScreenModeControllable()

 Return true if spectator screen mode control is available. HeadMountedDisplayFunctionLibrary.h
  • BlueprintPure
  • Category="Input|HeadMountedDisplay|SpectatorScreen"

static void ResetOrientationAndPosition ( float Yaw,
EOrientPositionSelector::Type Options
)

 Resets orientation by setting roll and pitch to 0, assuming that current yaw is forward direction and assuming current position as a 'zero-point' (for positional tracking). HeadMountedDisplayFunctionLibrary.h
  • BlueprintCallable
  • Category="Input|HeadMountedDisplay"

static void SetClippingPlanes ( float Near,
float Far
)

 Sets near and far clipping planes (NCP and FCP) for stereo rendering. HeadMountedDisplayFunctionLibrary.h
  • BlueprintCallable
  • Category="Input|HeadMountedDisplay"

static bool SetHMDColorScaleAndBias ( FLinearColor ColorScale,
FLinearColor ColorBias
)

 Multiply the post-compositor frame by a color and add a bias. HeadMountedDisplayFunctionLibrary.h
  • BlueprintCallable
  • Category="Input|HeadMountedDisplay"

static void SetSpectatorScreenMode ( ESpectatorScreenMode Mode
)

 Sets the social screen mode. HeadMountedDisplayFunctionLibrary.h
  • BlueprintCallable
  • Category="Input|HeadMountedDisplay|SpectatorScreen"

static void SetSpectatorScreenModeTexturePlusEyeLayout ( FVector2D EyeRectMin,
FVector2D EyeRectMax,
FVector2D TextureRectMin,
FVector2D TextureRectMax,
bool bDrawEyeFirst,
bool bClearBlack,
bool bUseAlpha
)

 Setup the layout for ESpectatorScreenMode::TexturePlusEye. HeadMountedDisplayFunctionLibrary.h
  • BlueprintCallable
  • Category="Input|HeadMountedDisplay|SpectatorScreen"

static void SetSpectatorScreenTexture ( UTexture* InTexture
)

 Change the texture displayed on the social screen HeadMountedDisplayFunctionLibrary.h
  • BlueprintCallable
  • Category="Input|HeadMountedDisplay|SpectatorScreen"

static void SetTrackingOrigin ( TEnumAsByte< EHMDTrackingOrigin::Type > Origin
)

 Sets current tracking origin type (eye level or floor level). HeadMountedDisplayFunctionLibrary.h
  • BlueprintCallable
  • Category="Input|HeadMountedDisplay"

static void SetWorldToMetersScale ( UObject* WorldContext,
float NewScale
)

 Sets the World to Meters scale, which changes the scale of the world as perceived by the player HeadMountedDisplayFunctionLibrary.h
  • BlueprintCallable
  • Category="Input|HeadMountedDisplay"
  • Meta=(WorldContext="WorldContext")

static void SetXRDisconnectDelegate ( const FXRDeviceOnDisconnectDelegate& InDisconnectedDelegate
)

   HeadMountedDisplayFunctionLibrary.h
  • BlueprintCallable
  • Category="XR|HeadMountedDisplay"

static void SetXRTimedInputActionDelegate ( const FName& ActionName,
const FXRTimedInputActionDelegate& InDelegate
)

 Hook up a delegate to get an OpenXR action event with action time. HeadMountedDisplayFunctionLibrary.h
  • BlueprintCallable
  • Category="Input|XRTracking"

static void UpdateExternalTrackingHMDPosition ( const FTransform& ExternalTrackingTransform
)

 Called after calibration to attempt to pull the internal tracker (e.g. HMD tracking) in line with the external tracker (e.g. mocap tracker). HeadMountedDisplayFunctionLibrary.h
  • BlueprintCallable
  • Category="Input|HeadMountedDisplay|ExternalTracking"

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page