1. Epic GamesDeveloper
  3. UMotionControllerComponent

UMotionControllerComponent

API > API/Runtime > API/Runtime/HeadMountedDisplay

Inheritance Hierarchy

  • UPrimitiveComponent
  • UMotionControllerComponent

References

   
Module HeadMountedDisplay
Header /Engine/Source/Runtime/HeadMountedDisplay/Public/MotionControllerComponent.h
Include #include "MotionControllerComponent.h"

Syntax

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

Variables

  Type Name Description
Protected variable FVector AngularVelocityAsAxisAndLength  
Public variable UProperty Category, EditAnywhere BlueprintReadWrite uint32: 1 bDisableLowLatencyUpdate If false, render transforms within the motion controller hierarchy will be updated a second time immediately before rendering.
Protected variable bool bHasAuthority Whether or not this component has authority within the frame
Protected variable bool bPolledHMD_GameThread  
Protected variable bool bPolledHMD_RenderThread  
Protected variable bool bProvidedAngularVelocity  
Protected variable bool bProvidedLinearAcceleration  
Protected variable bool bProvidedLinearVelocity Velocity and acceleration data for the motion controller, if available.
Protected variable bool bTracked Whether or not this component had a valid tracked controller associated with it this frame
Public variable UProperty Category BlueprintReadOnly ETrackingStatus CurrentTrackingStatus The tracking status for the device (e.g. full tracking, inertial tracking only, no tracking)
Protected variable IMotionController * InUseMotionController Cached Motion Controller that can be read by GetParameterValue. Only valid for the duration of OnMotionControllerUpdated.
Protected variable FVector LinearAcceleration  
Protected variable FVector LinearVelocity Note: these values are in tracking space, which is also the space relative to the parent of the motioncontroller component, and still need to be converted to unreal space by the TrackingToWorldTransform for use.
Public variable UProperty Category, EditAnywhere BlueprintReadWrite blueprintsetter FName MotionSource Defines which pose this component should receive from the OpenXR Runtime.
Public variable UProperty Category, EditAnywhere BlueprintReadWrite blueprintsetter int32 PlayerIndex Which player index this motion controller should automatically follow
Protected variable IMotionController * PolledMotionController_GameThread  
Protected variable IMotionController * PolledMotionController_RenderThread  
Protected variable FCriticalSection PolledMotionControllerMutex  
Protected variable FVector RenderThreadComponentScale  
Protected variable FTransform RenderThreadRelativeTransform  
Protected variable TSharedPtr< FViewExtension, ESPMode::ThreadSafe > ViewExtension  

Constructors

  Type Name Description
Public function  

UMotionControllerComponent ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Public function void  
Protected function Virtual void

CreateRenderState_Concurrent ( FRegisterComponentContext* Context
)

  
Protected function Const UFunction BlueprintPure, Category bool

GetAngularVelocity ( FRotator& OutAngularVelocity
)

 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.
Protected function UFunction BlueprintCallable, Category FVector

GetHandJointPosition ( int jointIndex,
bool& bValueFound
)

  
Protected function Const UFunction BlueprintPure, Category bool

GetLinearAcceleration ( FVector& OutLinearAcceleration
)

 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.
Protected function Const UFunction BlueprintPure, Category bool

GetLinearVelocity ( FVector& OutLinearVelocity
)

 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.
Protected function UFunction BlueprintCallable, Category 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.
Public function FName  
Public function Const UFunction Meta blueprintgetter EControllerHand  
Public function Virtual void  
Public function Const UFunction BlueprintPure, Category bool Whether or not this component had a valid tracked device this frame
Protected function void

OnModularFeatureUnregistered ( const FName& Type,
IModularFeature* ModularFeature
)

  
Protected function UFunction Category, BlueprintImplementableEvent void Blueprint Implementable function for responding to updated data from a motion controller (so we can use custom parameter values from it)
Protected function bool

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

 If true, the Position and Orientation args will contain the most recent controller state
Protected function bool

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

  
Protected function bool

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

  
Protected function Virtual void  
Public function Virtual void

Serialize ( FArchive& Ar
)

  
Public function UFunction blueprintsetter void

SetAssociatedPlayerIndex ( const int32 NewPlayer
)

  
Public function UFunction blueprintsetter void

SetTrackingMotionSource ( const FName NewSource
)

  
Public function UFunction Meta blueprintsetter void

SetTrackingSource ( const EControllerHand NewSource
)

  
Public function void

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

  

Classes

  Type Name Description
Protected class FViewExtension View extension object that can persist on the render thread without the motion controller component  

Typedefs

Name Description
FActivateVisualizationComponent Delegate for activation of XRDeviceVisualizationComponent.

Constants

Name Description
OnActivateVisualizationComponent  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page