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
|
|---|---|---|---|---|---|
FXRMotionControllerBase::GetControllerOrientationAndPosition | /Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/XRMotionControllerBase.h | Returns the calibration-space orientation of the requested controller's hand.
True if the device requested is valid and tracked, false otherwise | XRBase | virtual bool GetControllerOrientationAndPosition ( const int32 ControllerIndex, const [FName](API\Runtime\Core\UObject\FName) MotionSource, FRotator & OutOrientation, FVector & OutPosition, bool & OutbProvidedLinearVelocity, FVector & OutLinearVelocity, bool & OutbProvidedAngularVelocity, FVector & OutAngularVelocityAsAxisAndLength, bool & OutbProvidedLinearAcceleration, FVector & OutLinearAcceleration, float WorldToMetersScale ) const | [] |
FXRMotionControllerBase::GetControllerTrackingStatus | /Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/XRMotionControllerBase.h | Returns the tracking status (e.g. not tracked, intertial-only, fully tracked) of the specified controller
Tracking status of the specified controller, or ETrackingStatus::NotTracked if the device is not found | XRBase | ETrackingStatus GetControllerTrackingStatus ( const int32 ControllerIndex, const [FName](API\Runtime\Core\UObject\FName) MotionSource ) const | [] |
FXRMotionControllerBase::GetCustomParameterValue | /Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/XRMotionControllerBase.h | Returns a custom names parameter value
The value of the parameter | XRBase | virtual float GetCustomParameterValue ( const [FName](API\Runtime\Core\UObject\FName) MotionSource, [FName](API\Runtime\Core\UObject\FName) ParameterName, bool & bOutValueFound ) const | [] |
FXRMotionControllerBase::GetHandJointPosition | /Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/XRMotionControllerBase.h | XRBase | virtual bool GetHandJointPosition ( const [FName](API\Runtime\Core\UObject\FName) MotionSource, int jointIndex, FVector & OutPosition ) const | [] |
|
FXRMotionControllerBase::~FXRMotionControllerBase | /Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/XRMotionControllerBase.h | XRBase | virtual ~FXRMotionControllerBase() | [] |
|
FXRMotionControllerBase | /Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/XRMotionControllerBase.h | Base utility class for implementations of theIMotionControllerinterface | XRBase | class FXRMotionControllerBase : public [IMotionController](API\Runtime\HeadMountedDisplay\IMotionController) | [] |
FXRMotionControllerBaseLegacy::GetControllerOrientationAndPosition | /Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/XRMotionControllerBase.h | These are overridden to call into the backward compatibility functions below. They are final and private because a legacy vr plugin would not use or implement these functions. | XRBase | virtual bool GetControllerOrientationAndPosition &40; const int32 ControllerIndex, const FName MotionSource, FRotator & OutOrientation, FVector & OutPosition, float WorldToMetersScale &41; const | [] |
FXRMotionControllerBaseLegacy::GetControllerOrientationAndPosition | /Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/XRMotionControllerBase.h | Original GetControllerOrientationAndPosition signature for backwards compatibility. They are pure virtual because a legacy plugin must implement them and public because a legacy vr plugin could use them internally. | XRBase | bool GetControllerOrientationAndPosition ( const int32 ControllerIndex, const EControllerHand DeviceHand, FRotator & OutOrientation, FVector & OutPosition, float WorldToMetersScale ) const | [] |
FXRMotionControllerBaseLegacy::GetControllerTrackingStatus | /Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/XRMotionControllerBase.h | Returns the tracking status (e.g. not tracked, intertial-only, fully tracked) of the specified controller
Tracking status of the specified controller, or ETrackingStatus::NotTracked if the device is not found | XRBase | virtual ETrackingStatus GetControllerTrackingStatus &40; const int32 ControllerIndex, const FName MotionSource &41; const | [] |
FXRMotionControllerBaseLegacy::GetControllerTrackingStatus | /Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/XRMotionControllerBase.h | Original GetControllerTrackingStatus signature for backwards compatibility. | XRBase | ETrackingStatus GetControllerTrackingStatus ( const int32 ControllerIndex, const EControllerHand DeviceHand ) const | [] |
FXRRenderBridge::NeedsNativePresent | /Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/XRRenderBridge.h | Called from render thread to see if a native present will be requested for this frame.
true if native Present will be requested for this frame; false otherwise. Must match value subsequently returned by Present for this frame. | XRBase | virtual bool NeedsNativePresent() | [] |
FXRMotionControllerBaseLegacy | /Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/XRMotionControllerBase.h | This class adapts deprecated or maintenence only xr plugins which use the old EControllerHand motion sources to the newerFNameMotionSource API. If a plugin is still in active development it should refactor and derive fromIMotionControllerorFXRMotionControllerBaserather than derive from this class. | XRBase | class FXRMotionControllerBaseLegacy : public [FXRMotionControllerBase](API\Plugins\XRBase\FXRMotionControllerBase) | [] |
FXRRenderBridge::OnBackBufferResize | /Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/XRRenderBridge.h | Called when viewport is resized. | XRBase | virtual void OnBackBufferResize() | [] |
FXRRenderBridge::UpdateViewport | /Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/XRRenderBridge.h | Override this method in case the render bridge needs access to the current viewport or RHI viewport before rendering the current frame. Note that youshould notcall Viewport->SetCustomPresent() from this method, as that is handled by the XRRenderTargetManager implementation. | XRBase | virtual void UpdateViewport ( const class [FViewport](API\Runtime\Engine\FViewport) & Viewport, class [FRHIViewport](API\Runtime\RHI\FRHIViewport) * InViewportRHI ) | [] |
FXRRenderBridge::FXRRenderBridge | /Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/XRRenderBridge.h | XRBase | FXRRenderBridge() | [] |
|
FXRRenderBridge | /Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/XRRenderBridge.h | XRBase | class FXRRenderBridge : public [FRHICustomPresent](API\Runtime\RHI\FRHICustomPresent) | [] |
|
FXRRenderTargetManager::CalculateRenderTargetSize | /Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/XRRenderTargetManager.h | Calculates dimensions of the render target texture for direct rendering of distortion. This implementation calculates the size based on the current value of vr.pixeldensity. | XRBase | virtual void CalculateRenderTargetSize ( const class [FViewport](API\Runtime\Engine\FViewport) & Viewport, uint32 & InOutSizeX, uint32 & InOutSizeY ) | [] |
FXRRenderTargetManager::GetActiveRenderBridge_GameThread | /Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/XRRenderTargetManager.h | Return the current render bridge for use by the current viewport. Override this method if your device implements a customFXRRenderBridge. Should only return non-null if the render bridge is initialized and should be used for the current frame | XRBase | virtual [FXRRenderBridge](API\Plugins\XRBase\FXRRenderBridge) * GetActiveRenderBridge_GameThread ( bool bUseSeparateRenderTarget ) | [] |
FXRRenderTargetManager::UpdateViewport | /Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/XRRenderTargetManager.h | Updates viewport for direct rendering of distortion. Should be called on a game thread. | XRBase | virtual void UpdateViewport ( bool bUseSeparateRenderTarget, const class [FViewport](API\Runtime\Engine\FViewport) & Viewport, class [SViewport](API\Runtime\Slate\Widgets\SViewport) * ViewportWidget ) | [] |
FXRRenderTargetManager::NeedReAllocateViewportRenderTarget | /Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/XRRenderTargetManager.h | Returns true, if render target texture must be re-calculated. | XRBase | virtual bool NeedReAllocateViewportRenderTarget ( const class [FViewport](API\Runtime\Engine\FViewport) & Viewport ) | [] |
FXRRenderTargetManager::UpdateViewportRHIBridge | /Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/XRRenderTargetManager.h | Most implementations don't need to override this method and override GetActiveRenderBridge_GameThread instead. | XRBase | virtual void UpdateViewportRHIBridge ( bool bUseSeparateRenderTarget, const class [FViewport](API\Runtime\Engine\FViewport) & Viewport, [FRHIViewport](API\Runtime\RHI\FRHIViewport) *const ViewportRHI ) | [] |
FXRRenderTargetManager::UpdateViewportWidget | /Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/XRRenderTargetManager.h | Optional method called when the ViewportWidget is not null | XRBase | virtual void UpdateViewportWidget ( bool bUseSeparateRenderTarget, const class [FViewport](API\Runtime\Engine\FViewport) & Viewport, class [SViewport](API\Runtime\Slate\Widgets\SViewport) * ViewportWidget ) | [] |
FXRRenderTargetManager | /Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/XRRenderTargetManager.h | CommonIStereoRenderTargetManagerimplementation that can be used by HMD implementations in order to get default implementations for most methods. | XRBase | class FXRRenderTargetManager : public [IStereoRenderTargetManager](API\Runtime\Engine\IStereoRenderTargetManager) | [] |
FXRSwapChain::GenerateMips_RenderThread | /Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/XRSwapChain.h | XRBase | void GenerateMips_RenderThread ( [FRHICommandListImmediate](API\Runtime\RHI\FRHICommandListImmediate) & RHICmdList ) | [] |
|
FXRSwapChain::GetSwapChain | /Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/XRSwapChain.h | XRBase | [TArray](API\Runtime\Core\Containers\TArray)< FTextureRHIRef > GetSwapChain() const | [] |
|
FXRSwapChain::GetSwapChainIndex_RHIThread | /Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/XRSwapChain.h | XRBase | uint32 GetSwapChainIndex_RHIThread() | [] |
|
FXRSwapChain::GetSwapChainLength | /Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/XRSwapChain.h | XRBase | uint32 GetSwapChainLength() const | [] |
|
FXRSwapChain::GetTexture | /Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/XRSwapChain.h | XRBase | [FRHITexture](API\Runtime\RHI\FRHITexture) * GetTexture() const | [] |
|
FXRSwapChain::GetTexture2D | /Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/XRSwapChain.h | XRBase | FRHITexture2D * GetTexture2D() const | [] |
|
FXRSwapChain::GetTexture2DArray | /Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/XRSwapChain.h | XRBase | FRHITexture2DArray * GetTexture2DArray() const | [] |
|
FXRSwapChain::GetTextureCube | /Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/XRSwapChain.h | XRBase | FRHITextureCube * GetTextureCube() const | [] |
|
FXRSwapChain::GetTextureRef | /Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/XRSwapChain.h | XRBase | const FTextureRHIRef & GetTextureRef() const | [] |
|
FXRSwapChain::IncrementSwapChainIndex_RHIThread | /Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/XRSwapChain.h | XRBase | virtual void IncrementSwapChainIndex_RHIThread() | [] |
|
FXRSwapChain::ReleaseCurrentImage_RHIThread | /Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/XRSwapChain.h | XRBase | virtual void ReleaseCurrentImage_RHIThread() | [] |
|
FXRSwapChain::ReleaseResources_RHIThread | /Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/XRSwapChain.h | XRBase | virtual void ReleaseResources_RHIThread() | [] |
|
FXRSwapChain::WaitCurrentImage_RHIThread | /Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/XRSwapChain.h | XRBase | virtual void WaitCurrentImage_RHIThread ( int64 TimeoutNanoseconds ) | [] |
|
FXRSwapChain::FXRSwapChain | /Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/XRSwapChain.h | XRBase | FXRSwapChain ( [TArray](API\Runtime\Core\Containers\TArray)< FTextureRHIRef > && InRHITextureSwapChain, const FTextureRHIRef & AliasedTexture ) | [] |
|
FXRSwapChain::~FXRSwapChain | /Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/XRSwapChain.h | XRBase | virtual ~FXRSwapChain() | [] |
|
FXRSwapChain | /Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/XRSwapChain.h | FXRSwapChain. | XRBase | class FXRSwapChain : public [TSharedFromThis< FXRSwapChain, ESPMode::ThreadSafe >](API\Runtime\Core\Templates\TSharedFromThis) | [
{
"type": "FTextureRHIRef",
"name": "RHITexture",
"description": ""
},
{
"type": "TArray< FTextur...",
"name": "RHITextureSwapChain",
"description": ""
},
{
"type": "std::atomic_uin...",
"name": "SwapChainIndex_RHIThread",
"description": ""
}
] |
FXRSwapChainPtr | /Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/XRSwapChain.h | XRBase | typedef [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FXRSwapChain](API\Plugins\XRBase\FXRSwapChain), ESPMode::ThreadSafe > FXRSwapChainPtr | [] |
|
FXRTimedInputActionDelegate | /Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/HeadMountedDisplayFunctionLibrary.h | XRBase | class FXRTimedInputActionDelegate | [] |
|
FXRTrackingSystemBase::CalibrateExternalTrackingSource | /Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/XRTrackingSystemBase.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 | virtual void CalibrateExternalTrackingSource ( const FTransform & ExternalTrackingTransform ) | [] |
FXRTrackingSystemBase::ComputeTrackingToWorldTransform | /Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/XRTrackingSystemBase.h | XRBase | FTransform ComputeTrackingToWorldTransform ( [FWorldContext](API\Runtime\Engine\Engine\FWorldContext) & WorldContext ) const | [] |
|
FXRTrackingSystemBase::CountTrackedDevices | /Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/XRTrackingSystemBase.h | The default implementation calls EnumerateTrackedDevices and returns the number of elements added to the array.
the count of matching tracked devices. | XRBase | virtual uint32 CountTrackedDevices ( EXRTrackedDeviceType Type ) | [] |
FXRTrackingSystemBase::CreateLoadingScreen | /Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/XRTrackingSystemBase.h | Override this method if you need to customize theIXRLoadingScreenimplementation. It will be called fromGetLoadingScreen()if LoadingScreen is not valid | XRBase | virtual [IXRLoadingScreen](API\Runtime\HeadMountedDisplay\IXRLoadingScreen) * CreateLoadingScreen() | [] |
FXRTrackingSystemBase::DoesSupportPositionalTracking | /Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/XRTrackingSystemBase.h | Whether or not the system supports positional tracking (either via sensor or other means). The default implementation always returns false, indicating that only rotational tracking is supported. | XRBase | virtual bool DoesSupportPositionalTracking() const | [] |
FXRTrackingSystemBase::GetARCompositionComponent | /Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/XRTrackingSystemBase.h | Access optionsal ARCompositionComponent | XRBase | virtual [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FARSupportInterface](API\Runtime\AugmentedReality\FARSupportInterface), ESPMode::ThreadSafe > GetARCompositionComponent() | [] |
FXRTrackingSystemBase::GetARCompositionComponent | /Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/XRTrackingSystemBase.h | XRBase | virtual const [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< const [FARSupportInterface](API\Runtime\AugmentedReality\FARSupportInterface), ESPMode::ThreadSafe > GetARCompositionComponent() const | [] |
|
FXRTrackingSystemBase::GetCurrentInteractionProfile | /Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/XRTrackingSystemBase.h | XRBase | virtual bool GetCurrentInteractionProfile ( const EControllerHand Hand, [FString](API\Runtime\Core\Containers\FString) & InteractionProfile ) | [] |
|
FXRTrackingSystemBase::GetFloorToEyeTrackingTransform | /Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/XRTrackingSystemBase.h | Returns a transform for converting from 'Floor' origin space to 'Eye' origin space. The default implementation always returns the identity. | XRBase | virtual bool GetFloorToEyeTrackingTransform ( FTransform & OutFloorToEye ) const | [] |
FXRTrackingSystemBase::GetLoadingScreen | /Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/XRTrackingSystemBase.h | Access the loading screen interface associated with this tracking system, if any.
anIXRLoadingScreenpointer or a nullptr if this tracking system does not support loading screens. | XRBase | virtual [IXRLoadingScreen](API\Runtime\HeadMountedDisplay\IXRLoadingScreen) * GetLoadingScreen() | [] |
FXRTrackingSystemBase::GetMotionControllerData | /Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/XRTrackingSystemBase.h | Platform Agnostic Query about MotionControllers details | XRBase | virtual void GetMotionControllerData ( [UObject](API\Runtime\CoreUObject\UObject\UObject) * WorldContext, const EControllerHand Hand, [FXRMotionControllerData](API\Runtime\HeadMountedDisplay\FXRMotionControllerData) & MotionControllerData ) | [] |
FXRTrackingSystemBase::GetRelativeEyePose | /Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/XRTrackingSystemBase.h | If the device id represents a head mounted display, fetches the relative position of the given eye relative to the eye. If the device is does not represent a stereoscopic tracked camera, orientation and position should be identity and zero and the return value should be false.
true if the pose is valid or not. If the device is not a stereoscopic device, return false. | XRBase | virtual bool GetRelativeEyePose ( int32 DeviceId, int32 ViewIndex, FQuat & OutOrientation, FVector & OutPosition ) | [] |
FXRTrackingSystemBase::GetTrackedDevicePropertySerialNumber | /Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/XRTrackingSystemBase.h | If the device id represents a tracking sensor, reports the serial number as a string if the device supports it.
the serial number of the device if it's available. | XRBase | virtual [FString](API\Runtime\Core\Containers\FString) GetTrackedDevicePropertySerialNumber ( int32 DeviceId ) | [] |
FXRTrackingSystemBase::GetTrackedDeviceType | /Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/XRTrackingSystemBase.h | If the device id represents a tracking sensor, reports the device type.
the device type enum. | XRBase | virtual EXRTrackedDeviceType GetTrackedDeviceType ( int32 DeviceId ) const | [] |
FXRTrackingSystemBase::GetTrackingOrigin | /Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/XRTrackingSystemBase.h | The default implementation always reports 'eye'-level tracking. | XRBase | virtual [EHMDTrackingOrigin::Type](API\Runtime\HeadMountedDisplay\EHMDTrackingOrigin__Type) GetTrackingOrigin() const | [] |
FXRTrackingSystemBase::GetTrackingSensorProperties | /Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/XRTrackingSystemBase.h | If the device id represents a tracking sensor, reports the frustum properties in game-world space of the sensor.
The default implementation returns false for all device ids.
true if the device tracking is valid and supports returning tracking sensor properties. | XRBase | virtual bool GetTrackingSensorProperties ( int32 DeviceId, FQuat & OutOrientation, FVector & OutPosition, [FXRSensorProperties](API\Runtime\HeadMountedDisplay\FXRSensorProperties) & OutSensorProperties ) | [] |
FXRTrackingSystemBase::GetTrackingToWorldTransform | /Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/XRTrackingSystemBase.h | Returns the system's latest known tracking-to-world transform. | XRBase | virtual FTransform GetTrackingToWorldTransform() const | [] |
FXRTrackingSystemBase::GetVersionString | /Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/XRTrackingSystemBase.h | Returns version string. | XRBase | virtual [FString](API\Runtime\Core\Containers\FString) GetVersionString() const | [] |
FXRTrackingSystemBase::GetXRCamera | /Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/XRTrackingSystemBase.h | Get the IXCamera instance for the given device.
The default implementation only supports a singleIXRCamerafor the HMD Device, returning aFDefaultXRCamerainstance.
a shared pointer to anIXRCamera. | XRBase | virtual [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< class [IXRCamera](API\Runtime\HeadMountedDisplay\IXRCamera), ESPMode::ThreadSafe > GetXRCamera ( int32 DeviceId ) | [] |
FXRTrackingSystemBase::HasValidTrackingPosition | /Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/XRTrackingSystemBase.h | If the system currently has valid tracking positions. If not supported at all, returns false. Defaults to callingDoesSupportPositionalTracking(); | XRBase | virtual bool HasValidTrackingPosition() | [] |
FXRTrackingSystemBase::IsTracking | /Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/XRTrackingSystemBase.h | Check current tracking status of a device.
The default implementation returns the result of calling GetCurrentPose(DeviceId, ...), ignoring the returned pose.
true if the system currently has valid tracking info for the given device ID. | XRBase | virtual bool IsTracking ( int32 DeviceId ) | [] |
FXRTrackingSystemBase::OnPlayAreaChanged | /Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/XRTrackingSystemBase.h | XRBase | virtual void OnPlayAreaChanged() | [] |
|
FXRTrackingSystemBase::OnInteractionProfileChanged | /Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/XRTrackingSystemBase.h | Meant to be called by sub-classes whenever the interaction profile is altered. | XRBase | virtual void OnInteractionProfileChanged() | [] |
FXRTrackingSystemBase::OnTrackingOriginChanged | /Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/XRTrackingSystemBase.h | Meant to be called by sub-classes whenever the tracking origin is altered. | XRBase | virtual void OnTrackingOriginChanged() | [] |
FXRTrackingSystemBase::RefreshTrackingToWorldTransform | /Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/XRTrackingSystemBase.h | Intended to be called fromOnStartGameFrame() | XRBase | FTransform RefreshTrackingToWorldTransform ( [FWorldContext](API\Runtime\Engine\Engine\FWorldContext) & WorldContext ) | [] |
FXRTrackingSystemBase::SetTrackingOrigin | /Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/XRTrackingSystemBase.h | The default implementations simply ignores the origin value. | XRBase | virtual void SetTrackingOrigin ( [EHMDTrackingOrigin::Type](API\Runtime\HeadMountedDisplay\EHMDTrackingOrigin__Type) NewOrigin ) | [] |
FXRTrackingSystemBase::UpdateExternalTrackingPosition | /Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/XRTrackingSystemBase.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 | virtual void UpdateExternalTrackingPosition ( const FTransform & ExternalTrackingTransform ) | [] |
FXRTrackingSystemBase::UpdateTrackingToWorldTransform | /Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/XRTrackingSystemBase.h | Refreshes the system's known tracking-to-world transform. | XRBase | virtual void UpdateTrackingToWorldTransform ( const FTransform & TrackingToWorldOverride ) | [] |
FXRTrackingSystemBase::FXRTrackingSystemBase | /Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/XRTrackingSystemBase.h | XRBase | FXRTrackingSystemBase ( [IARSystemSupport](API\Runtime\AugmentedReality\IARSystemSupport) * InARImplementation ) | [] |
|
FXRTrackingSystemBase::~FXRTrackingSystemBase | /Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/XRTrackingSystemBase.h | XRBase | virtual ~FXRTrackingSystemBase() | [] |
|
FXRTrackingSystemBase | /Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/XRTrackingSystemBase.h | Base utility class for implementations of theIXRTrackingSysteminterface Contains helpers and default implementation of most abstract methods, so final implementations only need to override features that they support. | XRBase | class FXRTrackingSystemBase : public [IXRTrackingSystem](API\Runtime\HeadMountedDisplay\IXRTrackingSystem) | [
{
"type": "FTransform",
"name": "CachedTrackingToWorld",
"description": ""
},
{
"type": "FTransform",
"name": "CalibratedOffset",
"description": "If the tracker is trying to lock itself to an external tracking source for drift control, this stores the calibrated offset between the external tracking system and the internal tracking system (e.g. a location from a mocap system tracker to the HMD's internal IMU)."
},
{
"type": "IXRLoadingScree...",
"name": "LoadingScreen",
"description": ""
},
{
"type": "TSharedPtr< cla...",
"name": "XRCamera",
"description": ""
}
] |
FXRInteractionProfileChanged | /Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/XRTrackingSystemBase.h | XRBase | typedef TMulticastDelegate_NoParams< void > FXRInteractionProfileChanged | [] |
|
FXRPlayAreaChanged | /Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/XRTrackingSystemBase.h | XRBase | typedef TMulticastDelegate_NoParams< void > FXRPlayAreaChanged | [] |
|
FXRTrackingOriginChanged | /Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/XRTrackingSystemBase.h | XRBase | typedef TMulticastDelegate_OneParam< void, const [IXRTrackingSystem](API\Runtime\HeadMountedDisplay\IXRTrackingSystem) * > FXRTrackingOriginChanged | [] |
|
OnXRInteractionProfileChanged | /Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/XRTrackingSystemBase.h | XRBase | static [FXRInteractionProfileChanged](API\Plugins\XRBase\FXRTrackingSystemDelegates\FXRInteractionProfileChanged) OnXRInteractionProfileChanged; | [] |
|
OnXRPlayAreaChanged | /Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/XRTrackingSystemBase.h | XRBase | static [FXRPlayAreaChanged](API\Plugins\XRBase\FXRTrackingSystemDelegates\FXRPlayAreaChanged) OnXRPlayAreaChanged; | [] |
|
OnXRTrackingOriginChanged | /Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/XRTrackingSystemBase.h | XRBase | static [FXRTrackingOriginChanged](API\Plugins\XRBase\FXRTrackingSystemDelegates\FXRTrackingOriginChanged) OnXRTrackingOriginChanged; | [] |
|
FXRTrackingSystemDelegates | /Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/XRTrackingSystemBase.h | XRBase | class FXRTrackingSystemDelegates | [] |
|
GetLayerDescMember | /Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/StereoLayerManager.h | XRBase | bool GetLayerDescMember ( const [IStereoLayers::FLayerDesc](API\Runtime\Engine\IStereoLayers\FLayerDesc) & Layer, [IStereoLayers::FLayerDesc](API\Runtime\Engine\IStereoLayers\FLayerDesc) & OutLayerDesc ) | [] |
|
MarkLayerTextureForUpdate | /Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/StereoLayerManager.h | XRBase | void MarkLayerTextureForUpdate ( [IStereoLayers::FLayerDesc](API\Runtime\Engine\IStereoLayers\FLayerDesc) & Layer ) | [] |
|
SetLayerDescMember | /Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/StereoLayerManager.h | XRBase | void SetLayerDescMember ( [IStereoLayers::FLayerDesc](API\Runtime\Engine\IStereoLayers\FLayerDesc) & OutLayer, const [IStereoLayers::FLayerDesc](API\Runtime\Engine\IStereoLayers\FLayerDesc) & InLayerDesc ) | [] |
|
TStereoLayerManager::CopyLayers | /Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/StereoLayerManager.h | XRBase | void CopyLayers ( [TArray](API\Runtime\Core\Containers\TArray)< LayerType > & OutArray, bool bMarkClean ) | [] |
|
TStereoLayerManager::CopySortedLayers | /Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/StereoLayerManager.h | XRBase | void CopySortedLayers ( [TArray](API\Runtime\Core\Containers\TArray)< LayerType > & OutArray, bool bMarkClean ) | [] |
|
TStereoLayerManager::CreateLayer | /Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/StereoLayerManager.h | Creates a new layer from a given texture resource, which is projected on top of the world as a quad.
A unique identifier for the layer created | XRBase | virtual uint32 CreateLayer ( const [FLayerDesc](API\Runtime\Engine\IStereoLayers\FLayerDesc) & InLayerDesc ) | [] |
TStereoLayerManager::DestroyLayer | /Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/StereoLayerManager.h | Destroys the specified layer, stopping it from rendering over the world. | XRBase | virtual void DestroyLayer ( uint32 LayerId ) | [] |
TStereoLayerManager::ForEachLayer | /Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/StereoLayerManager.h | XRBase | void ForEachLayer ( [TFunction](API\Runtime\Core\GenericPlatform\TFunction)< void(uint32, LayerType &)> Func, bool bMarkClean ) | [] |
|
TStereoLayerManager::GetAllocatedTexture | /Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/StereoLayerManager.h | Get texture reference to HMD swapchain to avoid the copy path, useful for continuous update layers | XRBase | virtual void GetAllocatedTexture ( uint32 LayerId, FTextureRHIRef & Texture, FTextureRHIRef & LeftTexture ) | [] |
TStereoLayerManager::GetLayerDesc | /Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/StereoLayerManager.h | Get the currently set layer description
Whether the returned layer description is valid | XRBase | virtual bool GetLayerDesc ( uint32 LayerId, [FLayerDesc](API\Runtime\Engine\IStereoLayers\FLayerDesc) & OutLayerDesc ) | [] |
TStereoLayerManager::GetStereoLayersDirty | /Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/StereoLayerManager.h | XRBase | bool GetStereoLayersDirty() | [] |
|
TStereoLayerManager::HideBackgroundLayer | /Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/StereoLayerManager.h | If pushing and popping layer state is supported, the visibility of the background layer should be part of the saved state. | XRBase | virtual void HideBackgroundLayer() | [] |
TStereoLayerManager::MarkTextureForUpdate | /Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/StereoLayerManager.h | Marks this layers texture for update | XRBase | virtual void MarkTextureForUpdate ( uint32 LayerId ) | [] |
TStereoLayerManager::IsBackgroundLayerVisible | /Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/StereoLayerManager.h | Tell if the background layer is visible. Platforms that do not implement Hide/ShowBackgroundLayer() always return true. | XRBase | virtual bool IsBackgroundLayerVisible() const | [] |
TStereoLayerManager::PopLayerState | /Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/StereoLayerManager.h | Currently active layers will be destroyed and replaced with the previous state. | XRBase | virtual void PopLayerState() | [] |
TStereoLayerManager::PushLayerState | /Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/StereoLayerManager.h | In either case, layers created afterPushLayerState()will be destroyed upon callingPopLayerState(). | XRBase | virtual void PushLayerState ( bool bPreserve ) | [] |
TStereoLayerManager::SetLayerDesc | /Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/StereoLayerManager.h | Set the a new layer description | XRBase | virtual void SetLayerDesc ( uint32 LayerId, const [FLayerDesc](API\Runtime\Engine\IStereoLayers\FLayerDesc) & InLayerDesc ) | [] |
TStereoLayerManager::ShowBackgroundLayer | /Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/StereoLayerManager.h | Optional method to undo the effect of hiding the 3D scene. No-op if not supported by the platform. | XRBase | virtual void ShowBackgroundLayer() | [] |
TStereoLayerManager::SupportsLayerState | /Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/StereoLayerManager.h | Returns true if the StereoLayers implementation supports saving and restoring state using Push/PopLayerState() | XRBase | virtual bool SupportsLayerState() | [] |
TStereoLayerManager::UpdateLayer | /Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/StereoLayerManager.h | XRBase | virtual void UpdateLayer ( LayerType & Layer, uint32 LayerId, bool bIsValid ) | [] |
|
TStereoLayerManager::UpdateSplashScreen | /Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/StereoLayerManager.h | Update splash screens from current state | XRBase | virtual void UpdateSplashScreen() | [] |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.