Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Runtime > HeadMountedDisplay > IMotionController

Light Theme

Dark Theme

IMotionController

Motion Controller device interface

Windows

MacOS

Linux

Inheritance Hierarchy

IModularFeature

IMotionController

FXRMotionControllerBase

References

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

Syntax

class IMotionController : public IModularFeature

Remarks

Motion Controller device interface

This intentionally does NOT derive from IInputDeviceModule, to allow a clean separation for devices which exclusively track motion with no tactile input

You must MANUALLY call IModularFeatures::Get().RegisterModularFeature( GetModularFeatureName(), this ) in your implementation! This allows motion controllers to be both piggy-backed off HMD devices which support them, as well as standing alone.

Destructors

	Name	Description
	~IMotionController()

Functions

	Name	Description
void	EnumerateSources ( TArray< FMotionControllerSource >&... )	Called to request the motion sources that this IMotionController provides
bool	GetControllerOrientationAndPosition ( const int32 ControllerIndex, const FName MotionSource, FRotator& OutOrientation, FVector& OutPosition, float WorldToMetersScale )	Returns the calibration-space orientation of the requested controller's hand.
bool	GetControllerOrientationAndPositionForTime ( const int32 ControllerIndex, const FName MotionSource, FTimespan Time, bool& OutTimeWasUsed, FRotator& OutOrientation, FVector& OutPosition, bool& OutbProvidedLinearVelocity, FVector& OutLinearVelocity, bool& OutbProvidedAngularVelocity, FVector& OutAngularVelocityRadPerS..., float WorldToMetersScale )	Returns the calibration-space orientation of the requested controller's hand at the specified time for potentially improved temporal precision, particularly fetching the controller transform when a button was pressed on a platform that provides sub-frame timing for button presses.
ETrackingSta...	GetControllerTrackingStatus ( const int32 ControllerIndex, const FName MotionSource )	Returns the tracking status (e.g. not tracked, intertial-only, fully tracked) of the specified controller
float	GetCustomParameterValue ( const FName MotionSource, FName ParameterName, bool& bOutValueFound )	Returns a custom names parameter value
bool	GetHandJointPosition ( const FName MotionSource, int jointIndex, FVector& OutPosition )
FName	GetModularFeatureName()
FName	GetMotionControllerDeviceTypeName()	Returns the device type of the controller.

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

Take our survey

Dismiss