IMotionController.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "CoreMinimal.h"
#include "UObject/ObjectMacros.h"
#include "UObject/ObjectPtr.h"
#include "Features/IModularFeature.h"
 
#include "IMotionController.generated.h"
 
enum class EControllerHand : uint8;
 
UENUM(BlueprintType)
enum class ETrackingStatus : uint8
{
    NotTracked,
    InertialOnly, //Note This value of the enum is deprecated and only used by legacy platforms.  Please do not introduce new usages of it.
    Tracked,
};
 
struct FMotionControllerSource
{
    FName SourceName;
#if WITH_EDITOR
    FName EditorCategory;
#endif
 
    FMotionControllerSource(FName InSourceName = NAME_None)
        : SourceName(InSourceName)
    {}
};
 
class IMotionController : public IModularFeature
{
public:
    virtual ~IMotionController() {}
 
    static inline FName FeatureName = FName(TEXT("MotionController"));
    static FName GetModularFeatureName()
    {
        return FeatureName;
    }
 
    virtual FName GetMotionControllerDeviceTypeName() const = 0;
 
    virtual bool GetControllerOrientationAndPosition(const int32 ControllerIndex, const FName MotionSource, FRotator& OutOrientation, FVector& OutPosition, float WorldToMetersScale) const = 0;
 
    virtual bool GetControllerOrientationAndPosition(const int32 ControllerIndex, const FName MotionSource, FRotator& OutOrientation, FVector& OutPosition, bool& OutbProvidedLinearVelocity, FVector& OutLinearVelocity, bool& OutbProvidedAngularVelocity, FVector& OutAngularVelocityAsAxisAndLength, bool& OutbProvidedLinearAcceleration, FVector& OutLinearAcceleration, float WorldToMetersScale) const = 0;
 
    virtual bool GetControllerOrientationAndPositionForTime(const int32 ControllerIndex, const FName MotionSource, FTimespan Time, bool& OutTimeWasUsed, FRotator& OutOrientation, FVector& OutPosition, bool& OutbProvidedLinearVelocity, FVector& OutLinearVelocity, bool& OutbProvidedAngularVelocity, FVector& OutAngularVelocityAsAxisAndLength, bool& OutbProvidedLinearAcceleration, FVector& OutLinearAcceleration, float WorldToMetersScale) const = 0;
 
    static inline FRotator AngularVelocityAsAxisAndLengthToRotator(const FVector AngularVelocityAsAxisAndLength)
    {
        FVector Direction;
        double Angle;
        AngularVelocityAsAxisAndLength.ToDirectionAndLength(Direction, Angle);
        return FQuat(Direction, 1.0).Rotator() * Angle; // Note FQuat cannot represent >180 degree roration, so we build a quaternion of the correct axis for 1 radian and then scale the resulting rotator by the actual number of radians.
    }
 
    virtual ETrackingStatus GetControllerTrackingStatus(const int32 ControllerIndex, const FName MotionSource) const = 0;
 
    virtual void EnumerateSources(TArray<FMotionControllerSource>& SourcesOut) const = 0;
 
    virtual float GetCustomParameterValue(const FName MotionSource, FName ParameterName, bool& bOutValueFound) const = 0;
    
    virtual bool GetHandJointPosition(const FName MotionSource, int jointIndex, FVector& OutPosition) const = 0;
 
    virtual bool SetEnhancedInputUserSettings(TObjectPtr<class UEnhancedInputUserSettings> InputSettings = nullptr) { return true; };
 
    virtual bool AttachInputMappingContexts(const TSet<TObjectPtr<class UInputMappingContext>>& InputMappingContexts) { return true; };
 
    // explicit source names
    static HEADMOUNTEDDISPLAY_API FName LeftHandSourceId;
    static HEADMOUNTEDDISPLAY_API FName RightHandSourceId;
    static HEADMOUNTEDDISPLAY_API FName HMDSourceId;
    static HEADMOUNTEDDISPLAY_API FName HeadSourceId; // Note Head and HMD are interchangable.  HMD is the legacy term.
 
    static HEADMOUNTEDDISPLAY_API bool GetHandEnumForSourceName(const FName Source, EControllerHand& OutHand);
};