UWindowsMixedRealityInputSimulationEngineSubsystem

Engine subsystem that stores input simulation data for access by the XR device.

Windows
MacOS
Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

USubsystem

UDynamicSubsystem

UEngineSubsystem

UWindowsMixedRealityInputSimulationEngineSubsystem

References

Module

WindowsMixedRealityInputSimulation

Header

/Engine/Plugins/Runtime/WindowsMixedReality/Source/WindowsMixedRealityInputSimulation/Public/WindowsMixedRealityInputSimulationEngineSubsystem.h

Include

#include "WindowsMixedRealityInputSimulationEngineSubsystem.h"

Syntax

[UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(ClassGroup=WindowsMixedReality)
class UWindowsMixedRealityInputSimulationEngineSubsystem : public UEngineSubsystem

Remarks

Engine subsystem that stores input simulation data for access by the XR device.

Functions

Name Description

Public function Const

ETrackingSta...

 

GetControllerTrackingStatus

(
    EControllerHand Hand
)

Current tracking status of a hand.

Public function Const

bool

 

GetHandJointRadius

(
    EControllerHand Hand,
    EWMRHandKeypoint Keypoint,
    float& OutRadius
)

Get the radius of a hand joint. Returns true if the output radius is valid.

Public function Const

bool

 

GetHandJointTransform

(
    EControllerHand Hand,
    EWMRHandKeypoint Keypoint,
    FTransform& OutTransform
)

Get the transform of a hand joint. Returns true if the output transform is valid.

Public function Const

bool

 

GetHandPointerPose

Get the pointer pose for a hand.

Public function Const

const FQuat ...

 

GetHeadOrientation()

Orientation of the HMD.

Public function Const

const FVecto...

 

GetHeadPosition()

Position of the HMD if positional tracking is available.

Public function Static

UWindowsMixe...

 

GetInputSimulationIfEnabled()

Utility function to ensure input simulation is only used when enabled.

Public function Const

bool

 

GetPressState

(
    EControllerHand Hand,
    EHMDInputControllerButtons Button,
    bool OnlyRegisterClicks,
    bool& OutPressState
)

State of buttons and gestures of the hand controller.

Public function Const

bool

 

HasJointPoses

(
    EControllerHand Hand
)

True if joint transforms are available for a hand.

Public function Const

bool

 

HasPositionalTracking()

True if the HMD has a valid head position vector.

Public function Static

bool

 

IsInputSimulationEnabled()

Checks both the user settings and HMD availability to determine if input simulation is enabled.

Public function

void

 

UpdateSimulatedData

(
    bool HasTracking,
    const FQuat& NewHeadOrientation,
    const FVector& NewHeadPosition,
    const FWindowsMixedRealityInputSimu...,
    const FWindowsMixedRealityInputSimu...
)

Update the simulated data.

Overridden from USubsystem

Name Description

Public function Virtual

void

 

Deinitialize()

Implement this for deinitialization of instances of the system

Public function Virtual

void

 

Initialize

(
    FSubsystemCollectionBase& Collecti...
)

Implement this for initialization of instances of the system

Public function Virtual Const

bool

 

ShouldCreateSubsystem

(
    UObject* Outer
)

USubsystem implementation.

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss