| UObjectBase
|
Module |
|
Header |
/Engine/Source/Runtime/HeadMountedDisplay/Public/HeadMountedDisplayFunctionLibrary.h |
Include |
#include "HeadMountedDisplayFunctionLibrary.h" |
class UHeadMountedDisplayFunctionLibrary : public UBlueprintFunctionLibrary
Name | Description | |
---|---|---|
|
UHeadMountedDisplayFunctionLibrary ( |
Name | Description | ||
---|---|---|---|
|
CalibrateExternalTrackingToHMD ( |
Called to calibrate the offset transform between an external tracking source and the internal tracking source (e.g. mocap tracker to and HMD tracker). |
|
|
ClearXRTimedInputActionDelegate ( |
||
|
ConfigureGestures ( |
||
|
EXRDeviceCon... |
ConnectRemoteXRDevice |
Connect to a remote device Connect to a remote device for Remote Debugging |
|
DisconnectRemoteXRDevice() |
Disconnect remote AR Device |
|
|
EnableHMD ( |
Switches to/from using HMD and stereo rendering. |
|
|
EnableLowPersistenceMode ( |
Switches between low and full persistence modes. |
|
|
EnumerateTrackedDevices ( |
Cross XR-System query that will list all XR devices currently being tracked. |
|
|
GetControllerTransformForTime |
Get the transform and potentially velocity data at a specified time near the current frame in unreal world space. |
|
|
GetDevicePose ( |
Cross XR-System query that returns a specific device's tracked position and orientation (in tracking space). |
|
|
GetDeviceWorldPose |
Cross XR-System query that returns a specific device's position and orientation in world space. |
|
|
GetHMDData ( |
Cross XR-System query that returns critical information about the HMD display (position, orientation, device name) |
|
|
GetHMDDeviceName() |
Returns the name of the device, so scripts can modify their behaviour appropriately |
|
|
EHMDWornStat... |
GetHMDWornState() |
Returns the worn state of the device. |
|
GetMotionControllerData ( |
Cross XR-System query that returns critical information about the motion controller (position, orientation, hand/finger position) |
|
|
GetNumOfTrackingSensors() |
If the HMD has multiple positional tracking sensors, return a total number of them currently connected. |
|
|
GetOrientationAndPosition |
Grabs the current orientation and position for the HMD. |
|
|
float |
GetPixelDensity() |
Returns the current VR pixel density. |
|
GetPlayAreaBounds |
Get the bounds of the area where the user can freely move while remaining tracked centered around the specified origin |
|
|
GetPositionalTrackingCameraParameters |
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. |
|
|
TEnumAsByte<... |
GetTrackingOrigin() |
Returns current tracking origin type (eye level or floor level). |
|
GetTrackingSensorParameters |
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. |
|
|
GetTrackingToWorldTransform ( |
Returns a transform that can be used to convert points from tracking space to world space. |
|
|
GetVersionString() |
Returns name of tracking system specific version string. |
|
|
GetVRFocusState |
Returns current state of VR focus. |
|
|
float |
GetWorldToMetersScale ( |
Returns the World to Meters scale, which corresponds to the scale of the world as perceived by the player |
|
GetXRSystemFlags() |
Returns the flags for the device, so scripts can modify their behaviour appropriately |
|
|
HasValidTrackingPosition() |
If the HMD supports positional tracking, whether or not we are currently being tracked |
|
|
IsDeviceTracking ( |
Cross XR-System query that returns whether the specified device is tracked or not. |
|
|
IsHeadMountedDisplayConnected() |
Returns whether or not the HMD hardware is connected and ready to use. |
|
|
IsHeadMountedDisplayEnabled() |
Returns whether or not we are currently using the head mounted display. |
|
|
IsInLowPersistenceMode() |
Returns true, if HMD is in low persistence mode. 'false' otherwise. |
|
|
IsSpectatorScreenModeControllable() |
Return true if spectator screen mode control is available. |
|
|
ResetOrientationAndPosition ( |
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). |
|
|
SetClippingPlanes ( |
Sets near and far clipping planes (NCP and FCP) for stereo rendering. |
|
|
SetSpectatorScreenMode ( |
Sets the social screen mode. |
|
|
SetSpectatorScreenModeTexturePlusEyeLayout |
Setup the layout for ESpectatorScreenMode::TexturePlusEye. |
|
|
SetSpectatorScreenTexture ( |
Change the texture displayed on the social screen |
|
|
SetTrackingOrigin |
Sets current tracking origin type (eye level or floor level). |
|
|
SetWorldToMetersScale ( |
Sets the World to Meters scale, which changes the scale of the world as perceived by the player |
|
|
SetXRDisconnectDelegate ( |
||
|
SetXRTimedInputActionDelegate ( |
Hook up a delegate to get an OpenXR action event with action time. |
|
|
UpdateExternalTrackingHMDPosition ( |
Called after calibration to attempt to pull the internal tracker (e.g. HMD tracking) in line with the external tracker (e.g. mocap tracker). |
Name |
Description |
---|---|
OnXRDeviceOnDisconnectDelegate |
|
OnXRTimedInputActionDelegateMap |
Name | Description | ||
---|---|---|---|
|
float |
GetScreenPercentage() |
Use GetPixelDensity instead |