UMotionTrackedDeviceFunctionLibrary

Windows
MacOS
Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UBlueprintFunctionLibrary

UMotionTrackedDeviceFunctionLibrary

References

Module

HeadMountedDisplay

Header

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

Include

#include "MotionTrackedDeviceFunctionLibrary.h"

Syntax

class UMotionTrackedDeviceFunctionLibrary : public UBlueprintFunctionLibrary

Constructors

Name Description

Public function

UMotionTrackedDeviceFunctionLibrary

(
    const FObjectInitializer& ObjectIn...
)

Functions

Name Description

Public function Static

void

 

DisableMotionTrackingForComponent

(
    const UMotionControllerComponent&#...
)

Disable tracking of the specified controller, by player index and tracked device type.

Public function Static

void

 

DisableMotionTrackingOfAllControllers()

Disable tracking for all controllers.

Public function Static

void

 

DisableMotionTrackingOfControllersForPlayer

(
    int32 PlayerIndex
)

Disable tracking for all controllers associated with the specified player.

Public function Static

void

 

DisableMotionTrackingOfDevice

(
    int32 PlayerIndex,
    EControllerHand Hand
)

Disable tracking of the specified controller, by player index and tracked device type.

Public function Static

void

 

DisableMotionTrackingOfSource

(
    int32 PlayerIndex,
    FName SourceName
)

Disable tracking of the specified controller, by player index and tracked device type.

Public function Static

bool

 

EnableMotionTrackingForComponent

(
    UMotionControllerComponent* Mo...
)

Enable tracking of the specified controller, by player index and tracked device type.

Public function Static

bool

 

EnableMotionTrackingOfDevice

(
    int32 PlayerIndex,
    EControllerHand Hand
)

Enable tracking of the specified controller, by player index and tracked device type.

Public function Static

bool

 

EnableMotionTrackingOfSource

(
    int32 PlayerIndex,
    FName SourceName
)

Enable tracking of the specified controller, by player index and tracked device type.

Public function Static

TArray< FNam...

 

EnumerateMotionSources()

Returns a list of all available motion sources (FNames associated with discrete tracking data that can be used to drive MotionControllerComponents).

Public function Static

FName

 

GetActiveTrackingSystemName()

Returns the system name used to distinguish the current tracking system.

Public function Static

int32

 

GetMaximumMotionTrackedControllerCount()

Get the maximum number of controllers that can be tracked.

Public function Static

int32

 

GetMotionTrackingEnabledControllerCount()

Get the number of controllers for which tracking is enabled.

Public function Static

bool

 

IsMotionSourceTracking

(
    int32 PlayerIndex,
    FName SourceName
)

Queries the specified source's tracking status and returns true if it has tracking.

Public function Static

bool

 

IsMotionTrackedDeviceCountManagementNecessary()

Returns true if it is necessary for the game to manage how many motion tracked devices it is asking to be tracked simultaneously.

Public function Static

bool

 

IsMotionTrackingEnabledForComponent

(
    const UMotionControllerComponent&#...
)

Returns true if tracking is enabled for the specified device.

Public function Static

bool

 

IsMotionTrackingEnabledForDevice

(
    int32 PlayerIndex,
    EControllerHand Hand
)

Returns true if tracking is enabled for the specified device.

Public function Static

bool

 

IsMotionTrackingEnabledForSource

(
    int32 PlayerIndex,
    FName SourceName
)

Returns true if tracking is enabled for the specified device.

Public function Static

void

 

SetIsControllerMotionTrackingEnabledByDefault

(
    bool Enable
)

Set whether motion tracked controllers activate on creation by default, or do not and must be explicitly activated.

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