1. Epic GamesDeveloper
  3. UHeadMountedDisplayFunctionLibrary

UHeadMountedDisplayFunctionLibrary

API > API/Plugins > API/Plugins/XRBase

Inheritance Hierarchy

References

   
Module XRBase
Header /Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/HeadMountedDisplayFunctionLibrary.h
Include #include "HeadMountedDisplayFunctionLibrary.h"

Syntax

UCLASS&40;&41;  
class UHeadMountedDisplayFunctionLibrary : public UBlueprintFunctionLibrary

Constructors

  Type Name Description
Public function    

Functions

  Type Name Description
Public function Static UFunction BlueprintPure, Category, Meta 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.
Public function Static UFunction BlueprintCallable, Category 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).
Public function Static UFunction BlueprintCallable, Category void

ClearXRTimedInputActionDelegate ( const FName& ActionPath
)

  
Public function Static UFunction BlueprintCallable, Category, Meta bool

ConfigureGestures ( const FXRGestureConfig& GestureConfig
)

  
Public function Static UFunction BlueprintCallable, Category EXRDeviceConnectionResult::Type

ConnectRemoteXRDevice ( const FString& IpAddress,
const int32 BitRate
)

 Connect to a remote deviceConnect to a remote device for Remote Debugging
Public function Static UFunction BlueprintCallable, Category void Disconnect remote AR Device
Public function Static UFunction BlueprintCallable, Category bool

EnableHMD ( bool bEnable
)

 Switches to/from using HMD and stereo rendering.
Public function Static UFunction BlueprintCallable, Category, Meta void

EnableLowPersistenceMode ( bool bEnable
)

 Switches between low and full persistence modes.
Public function Static UFunction BlueprintCallable, Category TArray< FXRDeviceId >

EnumerateTrackedDevices ( const FName SystemId,
EXRTrackedDeviceType DeviceType
)

 Cross XR-System query that will list all XR devices currently being tracked.
Public function Static UFunction BlueprintCallable, Category, Meta 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& AngularVelocityAsAxisAndLength,
bool& bProvidedLinearAcceleration,
FVector& LinearAcceleration
)

 Get the transform and potentially velocity data at a specified time near the current frame in unreal world space.
Public function Static UFunction BlueprintCallable, Category 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.
Public function Static UFunction BlueprintCallable, Category bool

GetCurrentInteractionProfile ( const EControllerHand Hand,
FString& InteractionProfile
)

 Get the openXR interaction profile name for the given controller.
Public function Static UFunction BlueprintCallable, Category 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).
Public function Static UFunction BlueprintCallable, Category, Meta 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.
Public function Static UFunction BlueprintCallable, Category void

GetHMDData ( UObject* WorldContext,
FXRHMDData& HMDData
)

 Cross XR-System query that returns critical information about the HMD display (position, orientation, device name)
Public function Static UFunction BlueprintPure, Category FName Returns the name of the device, so scripts can modify their behaviour appropriately
Public function Static UFunction BlueprintPure, Category EHMDWornState::Type Returns the worn state of the device.
Public function Static UFunction BlueprintCallable, Category void

GetMotionControllerData ( UObject* WorldContext,
const EControllerHand Hand,
FXRMotionControllerData& MotionControllerData
)

 Cross XR-System query that returns critical information about the motion controller (position, orientation, hand/finger position)
Public function Static UFunction BlueprintPure, Category int32 If the HMD has multiple positional tracking sensors, return a total number of them currently connected.
Public function Static UFunction BlueprintPure, Category void

GetOrientationAndPosition ( FRotator& DeviceRotation,
FVector& DevicePosition
)

 Grabs the current orientation and position for the HMD.
Public function Static UFunction BlueprintPure, Category float Returns the current VR pixel density.
Public function Static UFunction BlueprintCallable, Category FVector2D Get the bounds of the area where the user can freely move while remaining tracked centered around the specified origin
Public function Static UFunction BlueprintCallable, Category bool

GetPlayAreaRect ( FTransform& OutTransform,
FVector2D& OutRect
)

 Get the transform and dimensions of the playable area rectangle.
Public function Static UFunction BlueprintPure, Category, Meta void

GetPositionalTrackingCameraParameters ( FVector& CameraOrigin,
FRotator& CameraRotation,
float& HFOV,
float& VFOV,
float& CameraDistance,
float& NearPlane,
float& FarPlane
)

 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.
Public function Static UFunction BlueprintPure, Category TEnumAsByte< EHMDTrackingOrigin::Type > Returns current tracking origin type (eye level or floor level).
Public function Static UFunction BlueprintCallable, Category bool

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

 Get the transform of the specified tracking origin, if available.
Public function Static UFunction BlueprintPure, Category, Meta 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.
Public function Static UFunction BlueprintCallable, Category, Meta FTransform Returns a transform that can be used to convert points from tracking space to world space.
Public function Static UFunction BlueprintPure, Category FString Returns name of tracking system specific version string.
Public function Static UFunction BlueprintPure, Category, Meta void

GetVRFocusState ( bool& bUseFocus,
bool& bHasFocus
)

 Returns current state of VR focus.
Public function Static UFunction BlueprintPure, Category, Meta float

GetWorldToMetersScale ( UObject* WorldContext
)

 Returns the World to Meters scale, which corresponds to the scale of the world as perceived by the player
Public function Static UFunction BlueprintPure, Category int32 Returns the flags for the device, so scripts can modify their behaviour appropriately
Public function Static UFunction BlueprintPure, Category bool If the HMD supports positional tracking, whether or not we are currently being tracked
Public function Static UFunction BlueprintCallable, Category bool

IsDeviceTracking ( const FXRDeviceId& XRDeviceId
)

 Cross XR-System query that returns whether the specified device is tracked or not.
Public function Static UFunction BlueprintPure, Category, Meta bool Returns whether or not the HMD hardware is connected and ready to use.
Public function Static UFunction BlueprintPure, Category, Meta bool Returns whether or not we are currently using the head mounted display.
Public function Static UFunction BlueprintPure, Category, Meta bool Returns true, if HMD is in low persistence mode. 'false' otherwise.
Public function Static UFunction BlueprintPure, Category bool Return true if spectator screen mode control is available.
Public function Static UFunction BlueprintCallable, Category void 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).
Public function Static UFunction BlueprintCallable, Category void

SetClippingPlanes ( float Near,
float Far
)

 Sets near and far clipping planes (NCP and FCP) for stereo rendering.
Public function Static UFunction BlueprintCallable, Category void

SetSpectatorScreenMode ( ESpectatorScreenMode Mode
)

 Sets the social screen mode.
Public function Static UFunction BlueprintCallable, Category void

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

 Setup the layout for ESpectatorScreenMode::TexturePlusEye.
Public function Static UFunction BlueprintCallable, Category void Change the texture displayed on the social screen
Public function Static UFunction BlueprintCallable, Category void Sets current tracking origin type (eye level or floor level).
Public function Static UFunction BlueprintCallable, Category, Meta void

SetWorldToMetersScale ( UObject* WorldContext,
float NewScale
)

 Sets the World to Meters scale, which changes the scale of the world as perceived by the player
Public function Static UFunction BlueprintCallable, Category void

SetXRDisconnectDelegate ( const FXRDeviceOnDisconnectDelegate& InDisconnectedDelegate
)

  
Public function Static UFunction BlueprintCallable, Category void

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

 Hook up a delegate to get an OpenXR action event with action time.
Public function Static UFunction BlueprintCallable, Category 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).

Constants

Name Description
OnXRDeviceOnDisconnectDelegate  
OnXRTimedInputActionDelegateMap  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page