className
stringlengths 1
167
| headerPath
stringlengths 14
166
| description
stringlengths 0
1.62k
| module
stringlengths 3
36
| code
stringlengths 0
11.4k
| variables
listlengths 0
395
|
|---|---|---|---|---|---|
TStereoLayerManager::WithLayer | /Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/StereoLayerManager.h | XRBase | void WithLayer ( uint32 LayerId, [TFunction](API\Runtime\Core\GenericPlatform\TFunction)< void(LayerType *)> Func ) | []
|
|
TStereoLayerManager::TStereoLayerManager | /Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/StereoLayerManager.h | XRBase | TStereoLayerManager() | []
|
|
TStereoLayerManager::~TStereoLayerManager | /Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/StereoLayerManager.h | XRBase | virtual ~TStereoLayerManager() | []
|
|
TStereoLayerManager | /Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/StereoLayerManager.h | Thread safety: Updates and the two protected access methods use a critical section to ensure atomic access to the layer structures. Therefore, it is probably better to copy layers before performing time consuming operations using CopyLayers and reserve ForEachLayer for simple processing or operations where you need to know the user-facing layer id. The WithLayer method is useful if you already know the id of a layer you need to access in a thread safe manner. | XRBase | template<typename LayerType> class TStereoLayerManager : public [IStereoLayers](API\Runtime\Engine\IStereoLayers) | []
|
TXRLoadingScreenBase::AddSplash | /Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/XRLoadingScreenBase.h | Registers a splash to be shown while the loading screen is active. | XRBase | virtual void AddSplash ( const [FSplashDesc](API\Runtime\HeadMountedDisplay\IXRLoadingScreen\FSplashDesc) & Splash ) | []
|
TXRLoadingScreenBase::ApplyDeltaRotation | /Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/XRLoadingScreenBase.h | XRBase | void ApplyDeltaRotation ( const SplashType & Splash ) | []
|
|
TXRLoadingScreenBase::ClearSplashes | /Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/XRLoadingScreenBase.h | IXRLoadingScreeninterface | XRBase | virtual void ClearSplashes() | []
|
TXRLoadingScreenBase::DoAddSplash | /Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/XRLoadingScreenBase.h | XRBase | void DoAddSplash ( SplashType & Splash ) | []
|
|
TXRLoadingScreenBase::DoDeleteSplash | /Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/XRLoadingScreenBase.h | XRBase | void DoDeleteSplash ( SplashType & Splash ) | []
|
|
TXRLoadingScreenBase::DoHideSplash | /Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/XRLoadingScreenBase.h | XRBase | void DoHideSplash ( SplashType & Splash ) | []
|
|
TXRLoadingScreenBase::DoShowSplash | /Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/XRLoadingScreenBase.h | XRBase | void DoShowSplash ( SplashType & Splash ) | []
|
|
TXRLoadingScreenBase::GetStatId | /Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/XRLoadingScreenBase.h | Return the stat id to use for this tickable | XRBase | virtual [TStatId](API\Runtime\Core\Stats\TStatId) GetStatId() const | []
|
TXRLoadingScreenBase::HideLoadingScreen | /Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/XRLoadingScreenBase.h | Hides the loading screen. | XRBase | virtual void HideLoadingScreen() | []
|
TXRLoadingScreenBase::IsPlayingLoadingMovie | /Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/XRLoadingScreenBase.h | Returns whether a loading movie is playing or not. | XRBase | bool IsPlayingLoadingMovie() const | []
|
TXRLoadingScreenBase::IsShown | /Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/XRLoadingScreenBase.h | Returns whether the loading screen is currently active or not. | XRBase | virtual bool IsShown() const | []
|
TXRLoadingScreenBase::IsTickable | /Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/XRLoadingScreenBase.h | Pure virtual that must be overloaded by the inheriting class. It is used to determine whether an object is ready to be ticked. This is required for example for allUObjectderived classes as they might be loaded async and therefore won't be ready immediately.
true if class is ready to be ticked, false otherwise. | XRBase | virtual bool IsTickable() const | []
|
TXRLoadingScreenBase::ShowLoadingScreen | /Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/XRLoadingScreenBase.h | Activates the loading screen. If called while the loading screen is active, this will reinitialize the positions of all splashes according to the current HMD pose. | XRBase | virtual void ShowLoadingScreen() | []
|
TXRLoadingScreenBase::Tick | /Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/XRLoadingScreenBase.h | FTickableObjectRenderThreadinterface | XRBase | virtual void Tick ( float DeltaTime ) | []
|
TXRLoadingScreenBase::TXRLoadingScreenBase | /Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/XRLoadingScreenBase.h | XRBase | TXRLoadingScreenBase ( class [IXRTrackingSystem](API\Runtime\HeadMountedDisplay\IXRTrackingSystem) * InTrackingSystem ) | []
|
|
TXRLoadingScreenBase | /Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/XRLoadingScreenBase.h | Base utility class for implementations of theIXRLoadingScreeninterface | XRBase | template<typename SplashType> class TXRLoadingScreenBase : public [IXRLoadingScreen](API\Runtime\HeadMountedDisplay\IXRLoadingScreen), protected [FTickableObjectRenderThread](API\Runtime\RenderCore\FTickableObjectRenderThread) | [
{
"type": "bool",
"name": "bShowing",
"description": ""
},
{
"type": "FQuat",
"name": "HMDOrientation",
"description": ""
},
{
"type": "double",
"name": "LastTimeInSeconds",
"description": ""
},
{
"type": "TArray< SplashT...",
"name": "Splashes",
"description": ""
},
{
"type": "float",
"name": "SystemDisplayInterval",
"description": ""
},
{
"type": "IXRTrackingSyst...",
"name": "TrackingSystem",
"description": ""
}
]
|
UAsyncTask_LoadXRDeviceVisComponent::Activate | /Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/XRAssetFunctionLibrary.h | Called to trigger the action once the delegates have been bound | XRBase | virtual void Activate() | []
|
UAsyncTask_LoadXRDeviceVisComponent::AddDeviceVisualizationComponentAsync | /Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/XRAssetFunctionLibrary.h | XRBase | [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Meta=(BlueprintInternalUseOnly="true", DefaultToSelf="Target"), Category="XR|Devices") static [UAsyncTask_LoadXRDeviceVisComponent](API\Plugins\XRBase\UAsyncTask_LoadXRDeviceVisCompon-) * AddDeviceVisualizationComponentAsync ( [AActor](API\Runtime\Engine\GameFramework\AActor) * Target, const [FXRDeviceId](API\Runtime\HeadMountedDisplay\FXRDeviceId) & XRDeviceId, bool bManualAttachment, const FTransform & RelativeTransform, [UPrimitiveComponent](API\Runtime\Engine\Components\UPrimitiveComponent) *& NewComponent ) | []
|
|
UAsyncTask_LoadXRDeviceVisComponent::AddNamedDeviceVisualizationComponentAsync | /Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/XRAssetFunctionLibrary.h | XRBase | [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Meta=(BlueprintInternalUseOnly="true", DefaultToSelf="Target"), Category="XR|Devices") static [UAsyncTask_LoadXRDeviceVisComponent](API\Plugins\XRBase\UAsyncTask_LoadXRDeviceVisCompon-) * AddNamedDeviceVisualizationComponentAsync ( [AActor](API\Runtime\Engine\GameFramework\AActor) * Target, const [FName](API\Runtime\Core\UObject\FName) SystemName, const [FName](API\Runtime\Core\UObject\FName) DeviceName, bool bManualAttachment, const FTransform & RelativeTransform, [FXRDeviceId](API\Runtime\HeadMountedDisplay\FXRDeviceId) & XRDeviceId, [UPrimitiveComponent](API\Runtime\Engine\Components\UPrimitiveComponent) *& NewComponent ) | []
|
|
ELoadStatus | /Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/XRAssetFunctionLibrary.h | XRBase | enum ELoadStatus { Pending, LoadSuccess, LoadFailure, } | []
|
|
UAsyncTask_LoadXRDeviceVisComponent::UAsyncTask_LoadXRDeviceVisComponent | /Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/XRAssetFunctionLibrary.h | XRBase | UAsyncTask_LoadXRDeviceVisComponent ( const [FObjectInitializer](API\Runtime\CoreUObject\UObject\FObjectInitializer) & ObjectInitializer ) | []
|
|
UAsyncTask_LoadXRDeviceVisComponent | /Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/XRAssetFunctionLibrary.h | XRBase | [UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)() class UAsyncTask_LoadXRDeviceVisComponent : public [UBlueprintAsyncActionBase](API\Runtime\Engine\Kismet\UBlueprintAsyncActionBase) | [
{
"type": "FDeviceModelLoa...",
"name": "OnLoadFailure",
"description": ""
},
{
"type": "FDeviceModelLoa...",
"name": "OnModelLoaded",
"description": ""
}
]
|
|
UHeadMountedDisplayFunctionLibrary::BreakKey | /Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/HeadMountedDisplayFunctionLibrary.h | Breaks an XR key apart into the interaction profile, handedness, motion source, indentifier and component. | XRBase | [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintPure, Category="Input|XRTracking", Meta=(NativeBreakFunc)) static void BreakKey ( [FKey](API\Runtime\InputCore\FKey) InKey, [FString](API\Runtime\Core\Containers\FString) & InteractionProfile, EControllerHand & Hand, [FName](API\Runtime\Core\UObject\FName) & MotionSource, [FString](API\Runtime\Core\Containers\FString) & Indentifier, [FString](API\Runtime\Core\Containers\FString) & Component ) | []
|
UHeadMountedDisplayFunctionLibrary::CalibrateExternalTrackingToHMD | /Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/HeadMountedDisplayFunctionLibrary.h | Called to calibrate the offset transform between an external tracking source and the internal tracking source (e.g. mocap tracker to and HMD tracker). This should be called once per session, or when the physical relationship between the external tracker and internal tracker changes (e.g. it was bumped or reattached). After calibration, calling UpdateExternalTrackingPosition will try to correct the internal tracker to the calibrated offset to prevent drift between the two systems | XRBase | [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="Input|HeadMountedDisplay|ExternalTracking") static void CalibrateExternalTrackingToHMD ( const FTransform & ExternalTrackingTransform ) | []
|
UHeadMountedDisplayFunctionLibrary::ClearXRTimedInputActionDelegate | /Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/HeadMountedDisplayFunctionLibrary.h | XRBase | [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="Input|XRTracking") static void ClearXRTimedInputActionDelegate ( const [FName](API\Runtime\Core\UObject\FName) & ActionPath ) | []
|
|
UHeadMountedDisplayFunctionLibrary::ConfigureGestures | /Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/HeadMountedDisplayFunctionLibrary.h | XRBase | [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="Input|XRTracking", Meta=(DeprecatedFunction, DeprecationMessage="ConfigureGestures is deprecated as of 5.3. It has had no function for some time.")) static bool ConfigureGestures ( const [FXRGestureConfig](API\Runtime\HeadMountedDisplay\FXRGestureConfig) & GestureConfig ) | []
|
|
UHeadMountedDisplayFunctionLibrary::ConnectRemoteXRDevice | /Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/HeadMountedDisplayFunctionLibrary.h | Connect to a remote device for Remote Debugging | XRBase | [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="XR|HeadMountedDisplay") static [EXRDeviceConnectionResult::Type](API\Runtime\HeadMountedDisplay\EXRDeviceConnectionResult__Type) ConnectRemoteXRDevice ( const [FString](API\Runtime\Core\Containers\FString) & IpAddress, const int32 BitRate ) | []
|
UHeadMountedDisplayFunctionLibrary::DisconnectRemoteXRDevice | /Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/HeadMountedDisplayFunctionLibrary.h | Disconnect remote AR Device | XRBase | [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="XR|HeadMountedDisplay") static void DisconnectRemoteXRDevice() | []
|
UHeadMountedDisplayFunctionLibrary::EnableHMD | /Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/HeadMountedDisplayFunctionLibrary.h | Switches to/from using HMD and stereo rendering.
(Boolean) True, if the request was successful. | XRBase | [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="Input|HeadMountedDisplay") static bool EnableHMD ( bool bEnable ) | []
|
UHeadMountedDisplayFunctionLibrary::EnableLowPersistenceMode | /Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/HeadMountedDisplayFunctionLibrary.h | Switches between low and full persistence modes. | XRBase | [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="Input|HeadMountedDisplay", Meta=(DeprecatedFunction, DeprecationMessage="This functionality is no longer available. HMD platforms that support low persistence will always enable it.")) static void EnableLowPersistenceMode ( bool bEnable ) | []
|
UHeadMountedDisplayFunctionLibrary::EnumerateTrackedDevices | /Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/HeadMountedDisplayFunctionLibrary.h | Cross XR-System query that will list all XR devices currently being tracked.
A list of device identifiers matching the query. Use these to query and operate on the device (e.g. through GetDevicePose, AddDeviceVisualizationComponent, etc.) | XRBase | [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="Input|XRTracking") static [TArray](API\Runtime\Core\Containers\TArray)< [FXRDeviceId](API\Runtime\HeadMountedDisplay\FXRDeviceId) > EnumerateTrackedDevices ( const [FName](API\Runtime\Core\UObject\FName) SystemId, EXRTrackedDeviceType DeviceType ) | []
|
UHeadMountedDisplayFunctionLibrary::GetControllerTransformForTime2 | /Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/HeadMountedDisplayFunctionLibrary.h | Get the transform and potentially velocity data at a specified time near the current frame in unreal world space. This is intended for use with sub-frame input action timing data from SetXRTimedInputActionDelegate, or future support for timestamps in the core input system. The valid time window is platform dependent, but the intention per OpenXR is to fetch transforms for times from, at most, the previous few frames in the past or future. The OpenXR spec suggests that 50ms in the past should return an accurate result. There is no guarantee for the future, but the underlying system is likely to have been designed to predict out to about 50ms as well. On some platforms this will always just return a cached position and rotation, ignoring time. bTimeWasUsed will be false in that case. AngularVelocity is a Rotator in degrees/second. Be aware that this Rotator may have windings (rotations greater than 360 degrees) and some mathmatical operations (such as conversion to quaternion) will remove the windings. In some cases that is OK becuase the resulting final rotation is the same, but in some cases it would generate incorrect results. | XRBase | [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="Input|XRTracking") static bool GetControllerTransformForTime2 ( [UObject](API\Runtime\CoreUObject\UObject\UObject) * WorldContext, const int32 ControllerIndex, const [FName](API\Runtime\Core\UObject\FName) MotionSource, [FTimespan](API\Runtime\Core\Misc\FTimespan) Time, bool & bTimeWasUsed, FRotator & Orientation, FVector & Position, bool & bProvidedLinearVelocity, FVector & LinearVelocity, bool & bProvidedAngularVelocity, FRotator & AngularVelocity, bool & bProvidedLinearAcceleration, FVector & LinearAcceleration ) | []
|
UHeadMountedDisplayFunctionLibrary::GetControllerTransformForTime | /Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/HeadMountedDisplayFunctionLibrary.h | AngularVelocityRadPerSec is a vector where direction is the axis of rotation and length is the speed of rotation in radians per second. Note that it is not difficult to rotate a controller at more than 0.5 or 1 rotation per second briefly and some mathmatical operations (such as conversion to quaternion) lose rotations beyond 180 degrees or 360 degrees. In some cases that is OK becuase the resulting final rotation is the same, but in some cases it would generate incorrect results. | XRBase | [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="Input|XRTracking", Meta=(DeprecatedFunction, DeprecationMessage="Use new GetControllerTransformForTime2 which represents angular velocity as an FRotator rather than in the non-standard way this function represented it.")) static bool GetControllerTransformForTime ( [UObject](API\Runtime\CoreUObject\UObject\UObject) * WorldContext, const int32 ControllerIndex, const [FName](API\Runtime\Core\UObject\FName) MotionSource, [FTimespan](API\Runtime\Core\Misc\FTimespan) Time, bool & bTimeWasUsed, FRotator & Orientation, FVector & Position, bool & bProvidedLinearVelocity, FVector & LinearVelocity, bool & bProvidedAngularVelocity, FVector & AngularVelocityAsAxisAndLength, bool & bProvidedLinearAcceleration, FVector & LinearAcceleration ) | []
|
UHeadMountedDisplayFunctionLibrary::GetCurrentInteractionProfile | /Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/HeadMountedDisplayFunctionLibrary.h | Get the openXR interaction profile name for the given controller. Returns true if the openxr call is successfully made. The string may be empty if there is no interaction profile associated with the controller. | XRBase | [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="Input|XRTracking|OpenXR") static bool GetCurrentInteractionProfile ( const EControllerHand Hand, [FString](API\Runtime\Core\Containers\FString) & InteractionProfile ) | []
|
UHeadMountedDisplayFunctionLibrary::GetDevicePose | /Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/HeadMountedDisplayFunctionLibrary.h | Cross XR-System query that returns a specific device's tracked position and orientation (in tracking space). | XRBase | [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="Input|XRTracking") static void GetDevicePose ( const [FXRDeviceId](API\Runtime\HeadMountedDisplay\FXRDeviceId) & XRDeviceId, bool & bIsTracked, FRotator & Orientation, bool & bHasPositionalTracking, FVector & Position ) | []
|
UHeadMountedDisplayFunctionLibrary::GetDeviceWorldPose | /Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/HeadMountedDisplayFunctionLibrary.h | Cross XR-System query that returns a specific device's position and orientation in world space. | XRBase | [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="Input|XRTracking", Meta=(WorldContext="WorldContext")) static void GetDeviceWorldPose ( [UObject](API\Runtime\CoreUObject\UObject\UObject) * WorldContext, const [FXRDeviceId](API\Runtime\HeadMountedDisplay\FXRDeviceId) & XRDeviceId, bool & bIsTracked, FRotator & Orientation, bool & bHasPositionalTracking, FVector & Position ) | []
|
UHeadMountedDisplayFunctionLibrary::GetHMDData | /Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/HeadMountedDisplayFunctionLibrary.h | Cross XR-System query that returns critical information about the HMD display (position, orientation, device name) | XRBase | [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="Input|XRTracking") static void GetHMDData ( [UObject](API\Runtime\CoreUObject\UObject\UObject) * WorldContext, [FXRHMDData](API\Runtime\HeadMountedDisplay\FXRHMDData) & HMDData ) | []
|
UHeadMountedDisplayFunctionLibrary::GetHMDDeviceName | /Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/HeadMountedDisplayFunctionLibrary.h | Returns the name of the device, so scripts can modify their behaviour appropriatelyFNamespecific to the currently active HMD device type. "None" implies no device, "Unknown" implies a device with no description. | XRBase | [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintPure, Category="Input|HeadMountedDisplay") static [FName](API\Runtime\Core\UObject\FName) GetHMDDeviceName() | []
|
UHeadMountedDisplayFunctionLibrary::GetHMDWornState | /Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/HeadMountedDisplayFunctionLibrary.h | Returns the worn state of the device.
Unknown, Worn, NotWorn. If the platform does not detect this it will always return Unknown. | XRBase | [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintPure, Category="Input|HeadMountedDisplay") static [EHMDWornState::Type](API\Runtime\HeadMountedDisplay\EHMDWornState__Type) GetHMDWornState() | []
|
UHeadMountedDisplayFunctionLibrary::GetNumOfTrackingSensors | /Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/HeadMountedDisplayFunctionLibrary.h | If the HMD has multiple positional tracking sensors, return a total number of them currently connected. | XRBase | [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintPure, Category="Input|HeadMountedDisplay") static int32 GetNumOfTrackingSensors() | []
|
UHeadMountedDisplayFunctionLibrary::GetMotionControllerData | /Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/HeadMountedDisplayFunctionLibrary.h | Cross XR-System query that returns critical information about the motion controller (position, orientation, hand/finger position) | XRBase | [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="Input|XRTracking") static void GetMotionControllerData ( [UObject](API\Runtime\CoreUObject\UObject\UObject) * WorldContext, const EControllerHand Hand, [FXRMotionControllerData](API\Runtime\HeadMountedDisplay\FXRMotionControllerData) & MotionControllerData ) | []
|
UHeadMountedDisplayFunctionLibrary::GetOrientationAndPosition | /Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/HeadMountedDisplayFunctionLibrary.h | Grabs the current orientation and position for the HMD. If positional tracking is not available, DevicePosition will be a zero vector | XRBase | [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintPure, Category="Input|HeadMountedDisplay") static void GetOrientationAndPosition ( FRotator & DeviceRotation, FVector & DevicePosition ) | []
|
UHeadMountedDisplayFunctionLibrary::GetPixelDensity | /Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/HeadMountedDisplayFunctionLibrary.h | Returns the current VR pixel density. Pixel density sets the VR render target texture size as a factor of recommended texture size. The recommended texture size is the size that will result in no under sampling in most distorted area of the view when computing the final image to be displayed on the device by the runtime compositor.
(float) The pixel density to be used in VR mode. | XRBase | [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintPure, Category="Input|HeadMountedDisplay") static float GetPixelDensity() | []
|
UHeadMountedDisplayFunctionLibrary::GetPlayAreaRect | /Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/HeadMountedDisplayFunctionLibrary.h | Get the transform and dimensions of the playable area rectangle. Returns false if none currently specified/available. | XRBase | [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="Input|XRTracking") static bool GetPlayAreaRect ( FTransform & OutTransform, FVector2D & OutRect ) | []
|
UHeadMountedDisplayFunctionLibrary::GetPlayAreaBounds | /Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/HeadMountedDisplayFunctionLibrary.h | Get the bounds of the area where the user can freely move while remaining tracked centered around the specified origin | XRBase | [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="Input|XRTracking") static FVector2D GetPlayAreaBounds ( [TEnumAsByte](API\Runtime\Core\Containers\TEnumAsByte)< [EHMDTrackingOrigin::Type](API\Runtime\HeadMountedDisplay\EHMDTrackingOrigin__Type) > Origin ) | []
|
UHeadMountedDisplayFunctionLibrary::GetPositionalTrackingCameraParameters | /Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/HeadMountedDisplayFunctionLibrary.h | 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. This allows an in-game representation of the legal positional tracking range. All values will be zeroed if the sensor is not available or the HMD does not support it. | XRBase | [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintPure, Category="Input|HeadMountedDisplay", Meta=(DeprecatedFunction, DeprecationMessage="Use new GetTrackingSensorParameters / GetNumOfTrackingSensors")) static void GetPositionalTrackingCameraParameters ( FVector & CameraOrigin, FRotator & CameraRotation, float & HFOV, float & VFOV, float & CameraDistance, float & NearPlane, float & FarPlane ) | []
|
UHeadMountedDisplayFunctionLibrary::GetTrackingOrigin | /Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/HeadMountedDisplayFunctionLibrary.h | Returns current tracking origin type (eye level or floor level). | XRBase | [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintPure, Category="Input|HeadMountedDisplay") static [TEnumAsByte](API\Runtime\Core\Containers\TEnumAsByte)< [EHMDTrackingOrigin::Type](API\Runtime\HeadMountedDisplay\EHMDTrackingOrigin__Type) > GetTrackingOrigin() | []
|
UHeadMountedDisplayFunctionLibrary::GetTrackingOriginTransform | /Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/HeadMountedDisplayFunctionLibrary.h | Get the transform of the specified tracking origin, if available. | XRBase | [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="Input|XRTracking") static bool GetTrackingOriginTransform ( [TEnumAsByte](API\Runtime\Core\Containers\TEnumAsByte)< [EHMDTrackingOrigin::Type](API\Runtime\HeadMountedDisplay\EHMDTrackingOrigin__Type) > Origin, FTransform & OutTransform ) | []
|
UHeadMountedDisplayFunctionLibrary::GetTrackingSensorParameters | /Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/HeadMountedDisplayFunctionLibrary.h | 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. This allows an in-game representation of the legal positional tracking range. All values will be zeroed if the sensor is not available or the HMD does not support it. | XRBase | [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintPure, Category="Input|HeadMountedDisplay", Meta=(AdvancedDisplay="LeftFOV,RightFOV,TopFOV,BottomFOV,Distance,NearPlane,FarPlane")) 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 ) | []
|
UHeadMountedDisplayFunctionLibrary::GetTrackingToWorldTransform | /Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/HeadMountedDisplayFunctionLibrary.h | Returns a transform that can be used to convert points from tracking space to world space. Does NOT include the set WorldToMeters scale, as that is added in by the backing XR system to their tracking space poses. | XRBase | [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="Input|HeadMountedDisplay", Meta=(WorldContext="WorldContext")) static FTransform GetTrackingToWorldTransform ( [UObject](API\Runtime\CoreUObject\UObject\UObject) * WorldContext ) | []
|
UHeadMountedDisplayFunctionLibrary::GetVersionString | /Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/HeadMountedDisplayFunctionLibrary.h | Returns name of tracking system specific version string. | XRBase | [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintPure, Category="HeadMountedDisplay") static [FString](API\Runtime\Core\Containers\FString) GetVersionString() | []
|
UHeadMountedDisplayFunctionLibrary::GetVRFocusState | /Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/HeadMountedDisplayFunctionLibrary.h | Returns current state of VR focus. | XRBase | [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintPure, Category="Input|HeadMountedDisplay", Meta=(DisplayName="Get VR Focus State")) static void GetVRFocusState ( bool & bUseFocus, bool & bHasFocus ) | []
|
UHeadMountedDisplayFunctionLibrary::GetWorldToMetersScale | /Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/HeadMountedDisplayFunctionLibrary.h | Returns the World to Meters scale, which corresponds to the scale of the world as perceived by the player
How many Unreal units correspond to one meter in the real world | XRBase | [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintPure, Category="Input|HeadMountedDisplay", Meta=(WorldContext="WorldContext")) static float GetWorldToMetersScale ( [UObject](API\Runtime\CoreUObject\UObject\UObject) * WorldContext ) | []
|
UHeadMountedDisplayFunctionLibrary::GetXRSystemFlags | /Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/HeadMountedDisplayFunctionLibrary.h | Returns the flags for the device, so scripts can modify their behaviour appropriately
IsAR, IsTablet, IsHeadMounted. Returns false | XRBase | [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintPure, Category="Input|HeadMountedDisplay") static int32 GetXRSystemFlags() | []
|
UHeadMountedDisplayFunctionLibrary::HasValidTrackingPosition | /Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/HeadMountedDisplayFunctionLibrary.h | If the HMD supports positional tracking, whether or not we are currently being tracked | XRBase | [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintPure, Category="Input|HeadMountedDisplay") static bool HasValidTrackingPosition() | []
|
UHeadMountedDisplayFunctionLibrary::IsDeviceTracking | /Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/HeadMountedDisplayFunctionLibrary.h | Cross XR-System query that returns whether the specified device is tracked or not. | XRBase | [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="Input|XRTracking") static bool IsDeviceTracking ( const [FXRDeviceId](API\Runtime\HeadMountedDisplay\FXRDeviceId) & XRDeviceId ) | []
|
UHeadMountedDisplayFunctionLibrary::IsHeadMountedDisplayEnabled | /Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/HeadMountedDisplayFunctionLibrary.h | Returns whether or not we are currently using the head mounted display.
(Boolean) status of HMD | XRBase | [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintPure, Category="Input|HeadMountedDisplay", Meta=(KeyWords="HMD")) static bool IsHeadMountedDisplayEnabled() | []
|
UHeadMountedDisplayFunctionLibrary::IsInLowPersistenceMode | /Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/HeadMountedDisplayFunctionLibrary.h | Returns true, if HMD is in low persistence mode. 'false' otherwise. | XRBase | [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintPure, Category="Input|HeadMountedDisplay", Meta=(DeprecatedFunction, DeprecationMessage="This functionality is no longer available. HMD platforms that support low persistence will always enable it.")) static bool IsInLowPersistenceMode() | []
|
UHeadMountedDisplayFunctionLibrary::IsSpectatorScreenModeControllable | /Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/HeadMountedDisplayFunctionLibrary.h | Return true if spectator screen mode control is available. | XRBase | [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintPure, Category="Input|HeadMountedDisplay|SpectatorScreen") static bool IsSpectatorScreenModeControllable() | []
|
OnXRDeviceOnDisconnectDelegate | /Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/HeadMountedDisplayFunctionLibrary.h | XRBase | static [FXRDeviceOnDisconnectDelegate](API\Plugins\XRBase\FXRDeviceOnDisconnectDelegate) OnXRDeviceOnDisconnectDelegate; | []
|
|
OnXRTimedInputActionDelegateMap | /Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/HeadMountedDisplayFunctionLibrary.h | XRBase | static [TMap](API\Runtime\Core\Containers\TMap)< [FName](API\Runtime\Core\UObject\FName), [FXRTimedInputActionDelegate](API\Plugins\XRBase\FXRTimedInputActionDelegate) > OnXRTimedInputActionDelegateMap; | []
|
|
UHeadMountedDisplayFunctionLibrary::IsHeadMountedDisplayConnected | /Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/HeadMountedDisplayFunctionLibrary.h | Returns whether or not the HMD hardware is connected and ready to use. It may or may not actually be in use.
(Boolean) status whether the HMD hardware is connected and ready to use. It may or may not actually be in use. | XRBase | [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintPure, Category="Input|HeadMountedDisplay", Meta=(KeyWords="HMD")) static bool IsHeadMountedDisplayConnected() | []
|
UHeadMountedDisplayFunctionLibrary::ResetOrientationAndPosition | /Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/HeadMountedDisplayFunctionLibrary.h | 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). | XRBase | [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="Input|HeadMountedDisplay") static void ResetOrientationAndPosition ( float Yaw, [EOrientPositionSelector::Type](API\Runtime\HeadMountedDisplay\EOrientPositionSelector__Type) Options ) | []
|
UHeadMountedDisplayFunctionLibrary::SetClippingPlanes | /Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/HeadMountedDisplayFunctionLibrary.h | Sets near and far clipping planes (NCP and FCP) for stereo rendering. Similar to 'stereo ncp= fcp' console command, but NCP and FCP set by this call won't be saved in .ini file. | XRBase | [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="Input|HeadMountedDisplay") static void SetClippingPlanes ( float Near, float Far ) | []
|
UHeadMountedDisplayFunctionLibrary::SetSpectatorScreenModeTexturePlusEyeLayout | /Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/HeadMountedDisplayFunctionLibrary.h | Setup the layout for ESpectatorScreenMode::TexturePlusEye. | XRBase | [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="Input|HeadMountedDisplay|SpectatorScreen") static void SetSpectatorScreenModeTexturePlusEyeLayout ( FVector2D EyeRectMin, FVector2D EyeRectMax, FVector2D TextureRectMin, FVector2D TextureRectMax, bool bDrawEyeFirst, bool bClearBlack, bool bUseAlpha ) | []
|
UHeadMountedDisplayFunctionLibrary::SetSpectatorScreenMode | /Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/HeadMountedDisplayFunctionLibrary.h | Sets the social screen mode. | XRBase | [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="Input|HeadMountedDisplay|SpectatorScreen") static void SetSpectatorScreenMode ( ESpectatorScreenMode Mode ) | []
|
UHeadMountedDisplayFunctionLibrary::SetSpectatorScreenTexture | /Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/HeadMountedDisplayFunctionLibrary.h | Change the texture displayed on the social screen | XRBase | [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="Input|HeadMountedDisplay|SpectatorScreen") static void SetSpectatorScreenTexture ( [UTexture](API\Runtime\Engine\Engine\UTexture) * InTexture ) | []
|
UHeadMountedDisplayFunctionLibrary::SetTrackingOrigin | /Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/HeadMountedDisplayFunctionLibrary.h | Sets current tracking origin type (eye level or floor level). | XRBase | [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="Input|HeadMountedDisplay") static void SetTrackingOrigin ( [TEnumAsByte](API\Runtime\Core\Containers\TEnumAsByte)< [EHMDTrackingOrigin::Type](API\Runtime\HeadMountedDisplay\EHMDTrackingOrigin__Type) > Origin ) | []
|
UHeadMountedDisplayFunctionLibrary::SetWorldToMetersScale | /Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/HeadMountedDisplayFunctionLibrary.h | Sets the World to Meters scale, which changes the scale of the world as perceived by the player | XRBase | [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="Input|HeadMountedDisplay", Meta=(WorldContext="WorldContext")) static void SetWorldToMetersScale ( [UObject](API\Runtime\CoreUObject\UObject\UObject) * WorldContext, float NewScale ) | []
|
UHeadMountedDisplayFunctionLibrary::SetXRDisconnectDelegate | /Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/HeadMountedDisplayFunctionLibrary.h | XRBase | [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="XR|HeadMountedDisplay") static void SetXRDisconnectDelegate ( const [FXRDeviceOnDisconnectDelegate](API\Plugins\XRBase\FXRDeviceOnDisconnectDelegate) & InDisconnectedDelegate ) | []
|
|
UHeadMountedDisplayFunctionLibrary::SetXRTimedInputActionDelegate | /Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/HeadMountedDisplayFunctionLibrary.h | Hook up a delegate to get an OpenXR action event with action time. For a boolean input the the 'value' parameter of the delegate will be 1.0 for a press and 0.0 for a release. For an analog input the value's range is action and platform specific. Use in combination with GetControllerTransformForTime for potentially improved temporal transform precision and velocity data. "Left Grip" is an example of a valid ActionName. Note: this is likely to be replaced by native support for event times in the core input system at some time in the future. | XRBase | [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="Input|XRTracking") static void SetXRTimedInputActionDelegate ( const [FName](API\Runtime\Core\UObject\FName) & ActionName, const [FXRTimedInputActionDelegate](API\Plugins\XRBase\FXRTimedInputActionDelegate) & InDelegate ) | []
|
UHeadMountedDisplayFunctionLibrary::UpdateExternalTrackingHMDPosition | /Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/HeadMountedDisplayFunctionLibrary.h | Called after calibration to attempt to pull the internal tracker (e.g. HMD tracking) in line with the external tracker (e.g. mocap tracker). This will set the internal tracker's base offset and rotation to match and realign the two systems. This can be called every tick, or whenever realignment is desired. Note that this may cause choppy movement if the two systems diverge relative to each other, or a big jump if called infrequently when there has been significant drift | XRBase | [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="Input|HeadMountedDisplay|ExternalTracking") static void UpdateExternalTrackingHMDPosition ( const FTransform & ExternalTrackingTransform ) | []
|
UHeadMountedDisplayFunctionLibrary::UHeadMountedDisplayFunctionLibrary | /Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/HeadMountedDisplayFunctionLibrary.h | XRBase | UHeadMountedDisplayFunctionLibrary ( const [FObjectInitializer](API\Runtime\CoreUObject\UObject\FObjectInitializer) & ObjectInitializer ) | []
|
|
UHeadMountedDisplayFunctionLibrary | /Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/HeadMountedDisplayFunctionLibrary.h | XRBase | [UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)() class UHeadMountedDisplayFunctionLibrary : public [UBlueprintFunctionLibrary](API\Runtime\Engine\Kismet\UBlueprintFunctionLibrary) | []
|
|
UMotionTrackedDeviceFunctionLibrary::DisableMotionTrackingOfDevice | /Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/MotionTrackedDeviceFunctionLibrary.h | Disable tracking of the specified controller, by player index and tracked device type. | XRBase | [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="Input|MotionTracking", Meta=(DeprecatedFunction, DeprecationMessage="EControllerHand has been deprecated, please use DisableMotionTrackingOfSource instead.")) static void DisableMotionTrackingOfDevice ( int32 PlayerIndex, EControllerHand Hand ) | []
|
UMotionTrackedDeviceFunctionLibrary::DisableMotionTrackingOfSource | /Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/MotionTrackedDeviceFunctionLibrary.h | Disable tracking of the specified controller, by player index and tracked device type. | XRBase | [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="Input|MotionTracking") static void DisableMotionTrackingOfSource ( int32 PlayerIndex, [FName](API\Runtime\Core\UObject\FName) SourceName ) | []
|
UMotionTrackedDeviceFunctionLibrary::DisableMotionTrackingForComponent | /Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/MotionTrackedDeviceFunctionLibrary.h | Disable tracking of the specified controller, by player index and tracked device type. | XRBase | [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="Input|MotionTracking") static void DisableMotionTrackingForComponent ( const class [UMotionControllerComponent](API\Runtime\HeadMountedDisplay\UMotionControllerComponent) * MotionControllerComponent ) | []
|
UMotionTrackedDeviceFunctionLibrary::DisableMotionTrackingOfAllControllers | /Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/MotionTrackedDeviceFunctionLibrary.h | Disable tracking for all controllers. | XRBase | [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="Input|MotionTracking") static void DisableMotionTrackingOfAllControllers() | []
|
UMotionTrackedDeviceFunctionLibrary::DisableMotionTrackingOfControllersForPlayer | /Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/MotionTrackedDeviceFunctionLibrary.h | Disable tracking for all controllers associated with the specified player. | XRBase | [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="Input|MotionTracking") static void DisableMotionTrackingOfControllersForPlayer ( int32 PlayerIndex ) | []
|
UMotionTrackedDeviceFunctionLibrary::EnableMotionTrackingForComponent | /Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/MotionTrackedDeviceFunctionLibrary.h | Enable tracking of the specified controller, by player index and tracked device type.
(Boolean) true if the specified device is now set to be tracked. This could fail due to tracking limits, or on invalid input. | XRBase | [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="Input|MotionTracking") static bool EnableMotionTrackingForComponent ( class [UMotionControllerComponent](API\Runtime\HeadMountedDisplay\UMotionControllerComponent) * MotionControllerComponent ) | []
|
UMotionTrackedDeviceFunctionLibrary::EnableMotionTrackingOfDevice | /Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/MotionTrackedDeviceFunctionLibrary.h | Enable tracking of the specified controller, by player index and tracked device type.
(Boolean) true if the specified device is now set to be tracked. This could fail due to tracking limits, or on invalid input. | XRBase | [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="Input|MotionTracking", Meta=(DeprecatedFunction, DeprecationMessage="EControllerHand has been deprecated, please use EnableMotionTrackingOfSource instead.")) static bool EnableMotionTrackingOfDevice ( int32 PlayerIndex, EControllerHand Hand ) | []
|
UMotionTrackedDeviceFunctionLibrary::EnableMotionTrackingOfSource | /Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/MotionTrackedDeviceFunctionLibrary.h | Enable tracking of the specified controller, by player index and tracked device type.
(Boolean) true if the specified device is now set to be tracked. This could fail due to tracking limits, or on invalid input. | XRBase | [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="Input|MotionTracking") static bool EnableMotionTrackingOfSource ( int32 PlayerIndex, [FName](API\Runtime\Core\UObject\FName) SourceName ) | []
|
UMotionTrackedDeviceFunctionLibrary::GetActiveTrackingSystemName | /Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/MotionTrackedDeviceFunctionLibrary.h | Returns the system name used to distinguish the current tracking system. If no XR tracking system is active, then the name 'None' is returned. | XRBase | [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="Input|MotionTracking") static [FName](API\Runtime\Core\UObject\FName) GetActiveTrackingSystemName() | []
|
UMotionTrackedDeviceFunctionLibrary::EnumerateMotionSources | /Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/MotionTrackedDeviceFunctionLibrary.h | Returns a list of all available motion sources (FNames associated with discrete tracking data that can be used to drive MotionControllerComponents). | XRBase | [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="Input|MotionTracking") static [TArray](API\Runtime\Core\Containers\TArray)< [FName](API\Runtime\Core\UObject\FName) > EnumerateMotionSources() | []
|
UMotionTrackedDeviceFunctionLibrary::GetMaximumMotionTrackedControllerCount | /Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/MotionTrackedDeviceFunctionLibrary.h | Get the maximum number of controllers that can be tracked.
(int) number of controllers that can be tracked, or -1 if there is no limit (IsMotionTrackedDeviceCountManagementNecessary()should return false). | XRBase | [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintPure, Category="Input|MotionTracking") static int32 GetMaximumMotionTrackedControllerCount() | []
|
UMotionTrackedDeviceFunctionLibrary::GetMotionTrackingEnabledControllerCount | /Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/MotionTrackedDeviceFunctionLibrary.h | Get the number of controllers for which tracking is enabled.
(int) number of controllers tracked now, or -1 if this query is unsupported (IsMotionTrackedDeviceCountManagementNecessary()should return false). | XRBase | [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintPure, Category="Input|MotionTracking") static int32 GetMotionTrackingEnabledControllerCount() | []
|
UMotionTrackedDeviceFunctionLibrary::IsMotionSourceTracking | /Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/MotionTrackedDeviceFunctionLibrary.h | Queries the specified source's tracking status and returns true if it has tracking.
Tracking status of the specified controller. | XRBase | [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="Input|MotionTracking") static bool IsMotionSourceTracking ( int32 PlayerIndex, [FName](API\Runtime\Core\UObject\FName) SourceName ) | []
|
UMotionTrackedDeviceFunctionLibrary::IsMotionTrackedDeviceCountManagementNecessary | /Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/MotionTrackedDeviceFunctionLibrary.h | Returns true if it is necessary for the game to manage how many motion tracked devices it is asking to be tracked simultaneously. On some platforms this is unnecessary because all supported devices can be tracked simultaneously.
(Boolean) true if the game might need to manage which motion tracked devices are actively tracked. | XRBase | [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintPure, Category="Input|MotionTracking") static bool IsMotionTrackedDeviceCountManagementNecessary() | []
|
UMotionTrackedDeviceFunctionLibrary::IsMotionTrackingEnabledForDevice | /Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/MotionTrackedDeviceFunctionLibrary.h | Returns true if tracking is enabled for the specified device.
(Boolean) true if the specified device is set to be tracked. | XRBase | [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintPure, Category="Input|MotionTracking", Meta=(DeprecatedFunction, DeprecationMessage="EControllerHand has been deprecated, please use IsMotionTrackingEnabledForSource instead.")) static bool IsMotionTrackingEnabledForDevice ( int32 PlayerIndex, EControllerHand Hand ) | []
|
UMotionTrackedDeviceFunctionLibrary::IsMotionTrackingEnabledForSource | /Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/MotionTrackedDeviceFunctionLibrary.h | Returns true if tracking is enabled for the specified device.
(Boolean) true if the specified device is set to be tracked. | XRBase | [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintPure, Category="Input|MotionTracking") static bool IsMotionTrackingEnabledForSource ( int32 PlayerIndex, [FName](API\Runtime\Core\UObject\FName) SourceName ) | []
|
UMotionTrackedDeviceFunctionLibrary::IsMotionTrackingEnabledForComponent | /Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/MotionTrackedDeviceFunctionLibrary.h | Returns true if tracking is enabled for the specified device.
(Boolean) true if the specified device is set to be tracked. | XRBase | [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintPure, Category="Input|MotionTracking") static bool IsMotionTrackingEnabledForComponent ( const class [UMotionControllerComponent](API\Runtime\HeadMountedDisplay\UMotionControllerComponent) * MotionControllerComponent ) | []
|
UMotionTrackedDeviceFunctionLibrary::SetIsControllerMotionTrackingEnabledByDefault | /Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/MotionTrackedDeviceFunctionLibrary.h | Set whether motion tracked controllers activate on creation by default, or do not and must be explicitly activated. | XRBase | [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="Input|MotionTracking") static void SetIsControllerMotionTrackingEnabledByDefault ( bool Enable ) | []
|
UMotionTrackedDeviceFunctionLibrary::UMotionTrackedDeviceFunctionLibrary | /Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/MotionTrackedDeviceFunctionLibrary.h | XRBase | UMotionTrackedDeviceFunctionLibrary ( const [FObjectInitializer](API\Runtime\CoreUObject\UObject\FObjectInitializer) & ObjectInitializer ) | []
|
|
FVRNotificationsDelegate | /Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/VRNotificationsComponent.h | XRBase | class FVRNotificationsDelegate | []
|
|
UMotionTrackedDeviceFunctionLibrary | /Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/MotionTrackedDeviceFunctionLibrary.h | XRBase | [UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)() class UMotionTrackedDeviceFunctionLibrary : public [UBlueprintFunctionLibrary](API\Runtime\Engine\Kismet\UBlueprintFunctionLibrary) | []
|
|
UVRNotificationsComponent::OnRegister | /Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/VRNotificationsComponent.h | Called when a component is registered, after Scene is set, but before CreateRenderState_Concurrent or OnCreatePhysicsState are called. | XRBase | virtual void OnRegister() | []
|
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.