1. Epic GamesDeveloper
  3. UMotionControllerComponent

UMotionControllerComponent

API > API/Runtime > API/Runtime/HeadMountedDisplay

Inheritance Hierarchy

References

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

Syntax

class UMotionControllerComponent : public UPrimitiveComponent

Variables

  Type Name Description
Public variable uint32: 1 bDisableLowLatencyUpdate If false, render transforms within the motion controller hierarchy will be updated a second time immediately before rendering.
Public variable ETrackingStatus CurrentTrackingStatus The tracking status for the device (e.g. full tracking, inertial tracking only, no tracking)
Public variable TObjectPtr< UPrimitiveComponent > DisplayComponent  
Public variable FXRDeviceId DisplayDeviceId  
Public variable EModelLoadStatus DisplayModelLoadState  
Protected variable IMotionController * InUseMotionController Cached Motion Controller that can be read by GetParameterValue. Only valid for the duration of OnMotionControllerUpdated.
Public variable FName MotionSource Defines which pose this component should receive from the OpenXR Runtime.
Public variable int32 PlayerIndex Which player index this motion controller should automatically follow
Public variable int32 PreEditMaterialCount  

Constructors

  Type Name Description
Public function  

UMotionControllerComponent ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Protected function Const 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 FVector

GetHandJointPosition ( int jointIndex,
bool& bValueFound
)

  
Protected function Const 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 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 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 EControllerHand  
Public function Const bool Whether or not this component had a valid tracked device this frame
Public function void Callback for asynchronous display model loads (to set materials, etc.)
Protected function void Blueprint Implementable function for responding to updated data from a motion controller (so we can use custom parameter values from it)
Public function void

RefreshDisplayComponent ( const bool bForceDestroy
)

 The following private properties/members are now deprecated and will be removed in later versions.
Public function void

SetAssociatedPlayerIndex ( const int32 NewPlayer
)

  
Public function void

SetTrackingMotionSource ( const FName NewSource
)

  
Public function void

SetTrackingSource ( const EControllerHand NewSource
)

  

Overridden from UActorComponent

  Type Name Description
Protected function Virtual void Used to create any rendering thread information for this component
Public function Virtual void Initializes the component.
Public function Virtual void

OnComponentDestroyed ( bool bDestroyingHierarchy
)

 Called when a component is destroyed
Public function Virtual void Called when a component is registered, after Scene is set, but before CreateRenderState_Concurrent or OnCreatePhysicsState are called.
Protected function Virtual void Called to send a transform update for this component to the rendering thread
Public function Virtual void

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

 Function called every frame on this ActorComponent.

Overridden from UObject

  Type Name Description
Public function Virtual void Called before destroying the object.
Public function Virtual void

PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

 Called when a property on this object has been modified externally
Public function Virtual void Do any object-specific cleanup required immediately after loading an object.
Public function Virtual void

PreEditChange ( FProperty* PropertyAboutToChange
)

 This is called when a property is about to be modified externally
Public function Virtual void Handles reading, writing, and reference collecting using FArchive.

Enums

  Type Name Description
Public enum EModelLoadStatus    

Typedefs

Name Description
FActivateVisualizationComponent Delegate for activation of XRDeviceVisualizationComponent.

Constants

Name Description
CustomModelSourceId  
OnActivateVisualizationComponent  

Deprecated Variables

  Type Name Description
Public variable bool bDisplayDeviceModel bDisplayDeviceModel is deprecated. Please use the XRDeviceVisualizationComponent for rendering instead.
Public variable TObjectPtr< UStaticMesh > CustomDisplayMesh CustomDisplayMesh is deprecated. Please use the XRDeviceVisualizationComponent for rendering instead.
Public variable TArray< TObjectPtr< UMaterialInterface > > DisplayMeshMaterialOverrides DisplayMeshMaterialOverrides is deprecated. Please use the XRDeviceVisualizationComponent for rendering instead.
Public variable FName DisplayModelSource DisplayModelSource is deprecated. Please use the XRDeviceVisualizationComponent for rendering instead.

Deprecated Functions

  Type Name Description
Public function void

SetCustomDisplayMesh ( UStaticMesh* NewDisplayMesh
)

 SetCustomDisplayMesh is deprecated. Please use the XRDeviceVisualizationComponent for rendering instead.
Public function void

SetDisplayModelSource ( const FName NewDisplayModelSource
)

 SetDisplayModelSource is deprecated. Please use the XRDeviceVisualizationComponent for rendering instead.
Public function void

SetShowDeviceModel ( const bool bShowControllerModel
)

 SetShowDeviceModel is deprecated. Please use the XRDeviceVisualizationComponent for rendering instead.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page