1. Epic GamesDeveloper
  3. UMotionTrackedDeviceFunctionLibrary

UMotionTrackedDeviceFunctionLibrary

API > API/Plugins > API/Plugins/XRBase

   
Name UMotionTrackedDeviceFunctionLibrary
Type class
Header File /Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/MotionTrackedDeviceFunctionLibrary.h
Include Path #include "MotionTrackedDeviceFunctionLibrary.h"

Syntax

UCLASS ()  
class UMotionTrackedDeviceFunctionLibrary : public UBlueprintFunctionLibrary

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

UMotionTrackedDeviceFunctionLibrary ( const FObjectInitializer& ObjectInitializer
)

   MotionTrackedDeviceFunctionLibrary.h  

Functions

Public

Static

Name Remarks Include Path Unreal Specifiers

static void DisableMotionTrackingForComponent ( const UMotionControllerComponent* MotionControllerComponent
)

 Disable tracking of the specified controller, by player index and tracked device type. MotionTrackedDeviceFunctionLibrary.h
  • BlueprintCallable
  • Category="Input|MotionTracking"

static void DisableMotionTrackingOfAllControllers()

 Disable tracking for all controllers. MotionTrackedDeviceFunctionLibrary.h
  • BlueprintCallable
  • Category="Input|MotionTracking"

static void DisableMotionTrackingOfControllersForPlayer ( int32 PlayerIndex
)

 Disable tracking for all controllers associated with the specified player. MotionTrackedDeviceFunctionLibrary.h
  • BlueprintCallable
  • Category="Input|MotionTracking"

static void DisableMotionTrackingOfDevice ( int32 PlayerIndex,
EControllerHand Hand
)

 Disable tracking of the specified controller, by player index and tracked device type. MotionTrackedDeviceFunctionLibrary.h
  • BlueprintCallable
  • Category="Input|MotionTracking"
  • Meta=(DeprecatedFunction, DeprecationMessage="EControllerHand has been deprecated, please use DisableMotionTrackingOfSource instead.")

static void DisableMotionTrackingOfSource ( int32 PlayerIndex,
FName SourceName
)

 Disable tracking of the specified controller, by player index and tracked device type. MotionTrackedDeviceFunctionLibrary.h
  • BlueprintCallable
  • Category="Input|MotionTracking"

static bool EnableMotionTrackingForComponent ( UMotionControllerComponent* MotionControllerComponent
)

 Enable tracking of the specified controller, by player index and tracked device type. MotionTrackedDeviceFunctionLibrary.h
  • BlueprintCallable
  • Category="Input|MotionTracking"

static bool EnableMotionTrackingOfDevice ( int32 PlayerIndex,
EControllerHand Hand
)

 Enable tracking of the specified controller, by player index and tracked device type. MotionTrackedDeviceFunctionLibrary.h
  • BlueprintCallable
  • Category="Input|MotionTracking"
  • Meta=(DeprecatedFunction, DeprecationMessage="EControllerHand has been deprecated, please use EnableMotionTrackingOfSource instead.")

static bool EnableMotionTrackingOfSource ( int32 PlayerIndex,
FName SourceName
)

 Enable tracking of the specified controller, by player index and tracked device type. MotionTrackedDeviceFunctionLibrary.h
  • BlueprintCallable
  • Category="Input|MotionTracking"

static TArray< FName > EnumerateMotionSources()

 Returns a list of all available motion sources (FNames associated with discrete tracking data that can be used to drive MotionControllerComponents). MotionTrackedDeviceFunctionLibrary.h
  • BlueprintCallable
  • Category="Input|MotionTracking"

static FName GetActiveTrackingSystemName ()

 Returns the system name used to distinguish the current tracking system. MotionTrackedDeviceFunctionLibrary.h
  • BlueprintCallable
  • Category="Input|MotionTracking"

static int32 GetMaximumMotionTrackedControllerCount()

 Get the maximum number of controllers that can be tracked. MotionTrackedDeviceFunctionLibrary.h
  • BlueprintPure
  • Category="Input|MotionTracking"

static int32 GetMotionTrackingEnabledControllerCount()

 Get the number of controllers for which tracking is enabled. MotionTrackedDeviceFunctionLibrary.h
  • BlueprintPure
  • Category="Input|MotionTracking"

static bool IsMotionSourceTracking ( int32 PlayerIndex,
FName SourceName
)

 Queries the specified source's tracking status and returns true if it has tracking. MotionTrackedDeviceFunctionLibrary.h
  • BlueprintCallable
  • Category="Input|MotionTracking"
Returns true if it is necessary for the game to manage how many motion tracked devices it is asking to be tracked simultaneously. MotionTrackedDeviceFunctionLibrary.h
  • BlueprintPure
  • Category="Input|MotionTracking"

static bool IsMotionTrackingEnabledForComponent ( const UMotionControllerComponent* MotionControllerComponent
)

 Returns true if tracking is enabled for the specified device. MotionTrackedDeviceFunctionLibrary.h
  • BlueprintPure
  • Category="Input|MotionTracking"

static bool IsMotionTrackingEnabledForDevice ( int32 PlayerIndex,
EControllerHand Hand
)

 Returns true if tracking is enabled for the specified device. MotionTrackedDeviceFunctionLibrary.h
  • BlueprintPure
  • Category="Input|MotionTracking"
  • Meta=(DeprecatedFunction, DeprecationMessage="EControllerHand has been deprecated, please use IsMotionTrackingEnabledForSource instead.")

static bool IsMotionTrackingEnabledForSource ( int32 PlayerIndex,
FName SourceName
)

 Returns true if tracking is enabled for the specified device. MotionTrackedDeviceFunctionLibrary.h
  • BlueprintPure
  • Category="Input|MotionTracking"

static void SetIsControllerMotionTrackingEnabledByDefault ( bool Enable
)

 Set whether motion tracked controllers activate on creation by default, or do not and must be explicitly activated. MotionTrackedDeviceFunctionLibrary.h
  • BlueprintCallable
  • Category="Input|MotionTracking"

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page