FXRMotionControllerBase

Base utility class for implementations of the [IMotionController](API\Runtime\HeadMountedDisplay\IMotionController) interface

Windows
MacOS
Linux

Inheritance Hierarchy

IModularFeature

IMotionController

FXRMotionControllerBase

References

Module

HeadMountedDisplay

Header

/Engine/Source/Runtime/HeadMountedDisplay/Public/XRMotionControllerBase.h

Include

#include "XRMotionControllerBase.h"

Syntax

class FXRMotionControllerBase : public IMotionController

Remarks

Base utility class for implementations of the IMotionController interface

Destructors

Name Description

Public function Virtual

~FXRMotionControllerBase()

Functions

Name Description

Public function Const

bool

 

GetControllerOrientationAndPosition

(
    const int32 ControllerIndex,
    const EControllerHand DeviceHand,
    FRotator& OutOrientation,
    FVector& OutPosition,
    float WorldToMetersScale
)

Original GetControllerOrientationAndPosition signature for backwards compatibility.

Public function Const

ETrackingSta...

 

GetControllerTrackingStatus

(
    const int32 ControllerIndex,
    const EControllerHand DeviceHand
)

Original GetControllerTrackingStatus signature for backwards compatibility.

Public function Static

bool

 

GetHandEnumForSourceName

(
    const FName Source,
    EControllerHand& OutHand
)

Overridden from IMotionController

Name Description

Public function Virtual Const

void

 

EnumerateSources

(
    TArray< FMotionControllerSource >&...
)

Called to request the motion sources that this IMotionController provides

Public function Virtual Const

bool

 

GetControllerOrientationAndPosition

(
    const int32 ControllerIndex,
    const FName MotionSource,
    FRotator& OutOrientation,
    FVector& OutPosition,
    float WorldToMetersScale
)

Returns the calibration-space orientation of the requested controller's hand.

Public function Virtual Const

ETrackingSta...

 

GetControllerTrackingStatus

(
    const int32 ControllerIndex,
    const FName MotionSource
)

Returns the tracking status (e.g. not tracked, intertial-only, fully tracked) of the specified controller

Public function Virtual Const

float

 

GetCustomParameterValue

(
    const FName MotionSource,
    FName ParameterName,
    bool& bOutValueFound
)

Returns a custom names parameter value

Public function Virtual Const

bool

 

GetHandJointPosition

(
    const FName MotionSource,
    int jointIndex,
    FVector& OutPosition
)

Constants

Name

Description

HMDSourceId

LeftHandSourceId

Explicit source names

RightHandSourceId

Select Skin
Light
Dark

Welcome to the new Unreal Engine 4 Documentation site!

We're working on lots of new features including a feedback system so you can tell us how we are doing. It's not quite ready for use in the wild yet, so head over to the Documentation Feedback forum to tell us about this page or call out any issues you are encountering in the meantime.

We'll be sure to let you know when the new system is up and running.

Post Feedback