1. Epic GamesDeveloper
  3. UMotionControllerComponent

UMotionControllerComponent

API > API/Runtime > API/Runtime/HeadMountedDisplay

   
Name UMotionControllerComponent
Type class
Header File /Engine/Source/Runtime/HeadMountedDisplay/Public/MotionControllerComponent.h
Include Path #include "MotionControllerComponent.h"

Syntax

UCLASS (Blueprintable, Meta=(BlueprintSpawnableComponent), ClassGroup=MotionController, MinimalAPI)  
class UMotionControllerComponent : public UPrimitiveComponent

Inheritance Hierarchy

Implements Interfaces

Constructors

Name Remarks Include Path Unreal Specifiers

UMotionControllerComponent ( const FObjectInitializer& ObjectInitializer
)

   MotionControllerComponent.h  

Classes

Name Remarks
FViewExtension View extension object that can persist on the render thread without the motion controller component

Typedefs

Name Type Remarks Include Path
FActivateVisualizationComponent TMulticastDelegate_OneParam< void, bool > Delegate for activation of XRDeviceVisualizationComponent. MotionControllerComponent.h

Constants

Name Type Remarks Include Path
OnActivateVisualizationComponent FActivateVisualizationComponent   MotionControllerComponent.h

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
bDisableLowLatencyUpdate uint32 If false, render transforms within the motion controller hierarchy will be updated a second time immediately before rendering. MotionControllerComponent.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="MotionController"
CurrentTrackingStatus ETrackingStatus The tracking status for the device (e.g. full tracking, inertial tracking only, no tracking) MotionControllerComponent.h
  • BlueprintReadOnly
  • Category="MotionController"
MotionSource FName Defines which pose this component should receive from the OpenXR Runtime. MotionControllerComponent.h
  • EditAnywhere
  • BlueprintReadWrite
  • BlueprintSetter=SetTrackingMotionSource
  • Category="MotionController"
PlayerIndex int32 Which player index this motion controller should automatically follow MotionControllerComponent.h
  • EditAnywhere
  • BlueprintReadWrite
  • BlueprintSetter=SetAssociatedPlayerIndex
  • Category="MotionController"

Functions

Public

Name Remarks Include Path Unreal Specifiers

void BeginDestroy()

   MotionControllerComponent.h  

FName GetTrackingMotionSource()

   MotionControllerComponent.h  

EControllerHand GetTrackingSource()

   MotionControllerComponent.h
  • BlueprintGetter
  • Meta=(DeprecatedFunction, DeprecationMessage="Please use the Motion Source property instead of Hand")

virtual void InitializeComponent()

   MotionControllerComponent.h  

bool IsTracked()

 Whether or not this component had a valid tracked device this frame MotionControllerComponent.h
  • BlueprintPure
  • Category="MotionController"

virtual void Serialize ( FArchive& Ar
)

   MotionControllerComponent.h  

void SetAssociatedPlayerIndex ( const int32 NewPlayer
)

   MotionControllerComponent.h
  • BlueprintSetter

void SetTrackingMotionSource ( const FName NewSource
)

   MotionControllerComponent.h
  • BlueprintSetter

void SetTrackingSource ( const EControllerHand NewSource
)

   MotionControllerComponent.h
  • BlueprintSetter
  • Meta=(DeprecatedFunction, DeprecationMessage="Please use the Motion Source property instead of Hand")

void TickComponent ( float DeltaTime,
enum ELevelTick TickType,
FActorComponentTickFunction* ThisTickFunction
)

   MotionControllerComponent.h  

Protected

Name Remarks Include Path Unreal Specifiers

virtual void CreateRenderState_Concurrent ( FRegisterComponentContext* Context
)

   MotionControllerComponent.h  

bool GetAngularVelocity ( FRotator& OutAngularVelocity
) const

 If the motion tracking system provides angular velocity at this time OutAngularVelocity will be that velocity in deg/s in unreal world space and the function will return true. MotionControllerComponent.h
  • BlueprintPure
  • Category="Motion Controller Update"

FVector GetHandJointPosition ( int jointIndex,
bool& bValueFound
)

   MotionControllerComponent.h
  • BlueprintCallable
  • Category="Motion Controller Update"

bool GetLinearAcceleration ( FVector& OutLinearAcceleration
) const

 If the motion tracking system provides linear acceleration at this time the vector will be that acceleration in cm/(s^2) in unreal world space and the function will return true. MotionControllerComponent.h
  • BlueprintPure
  • Category="Motion Controller Update"

bool GetLinearVelocity ( FVector& OutLinearVelocity
) const

 If the motion tracking system provides linear velocity at this time the vector will be that velocity in cm/s in unreal world space and the function will return true. MotionControllerComponent.h
  • BlueprintPure
  • Category="Motion Controller Update"

float GetParameterValue ( FName InName,
bool& bValueFound
)

 Returns the value of a custom parameter on the current in use Motion Controller (see member InUseMotionController). Only valid for the duration of OnMotionControllerUpdated. MotionControllerComponent.h
  • BlueprintCallable
  • Category="Motion Controller Update"

void OnModularFeatureUnregistered ( const FName& Type,
IModularFeature* ModularFeature
)

   MotionControllerComponent.h  

void OnMotionControllerUpdated()

 Blueprint Implementable function for responding to updated data from a motion controller (so we can use custom parameter values from it) MotionControllerComponent.h
  • BlueprintImplementableEvent
  • Category="Motion Controller Update"

bool PollControllerState ( FVector& Position,
FRotator& Orientation,
float WorldToMetersScale
)

 If true, the Position and Orientation args will contain the most recent controller state MotionControllerComponent.h  

bool PollControllerState_GameThread ( FVector& Position,
FRotator& Orientation,
bool& OutbProvidedLinearVelocity,
FVector& OutLinearVelocity,
bool& OutbProvidedAngularVelocity,
FVector& OutAngularVelocityAsAxisAndLength,
bool& OutbProvidedLinearAcceleration,
FVector& OutLinearAcceleration,
float WorldToMetersScale
)

   MotionControllerComponent.h  

bool PollControllerState_RenderThread ( FVector& Position,
FRotator& Orientation,
float WorldToMetersScale
)

   MotionControllerComponent.h  

virtual void SendRenderTransform_Concurrent()

   MotionControllerComponent.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page