InputDeviceProperties.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "CoreMinimal.h"
#include "UObject/Object.h"
#include "GenericPlatform/IInputInterface.h"
#include "GameFramework/InputDeviceSubsystem.h"
 
#include "InputDeviceProperties.generated.h"
 
class UCurveLinearColor;
class UCurveFloat;
 
#if WITH_EDITOR
    struct FPropertyChangedChainEvent;
#endif  // WITH_EDITOR
 
UCLASS(Abstract, Blueprintable, BlueprintType, EditInlineNew, CollapseCategories, meta = (ShowWorldContextPin), MinimalAPI)
class UInputDeviceProperty : public UObject
{
    friend class UInputDeviceSubsystem;
 
    GENERATED_BODY()
public:
 
    ENGINE_API UInputDeviceProperty(const FObjectInitializer& ObjectInitializer = FObjectInitializer::Get());
 
protected:
 
    UFUNCTION(BlueprintNativeEvent, Category = "InputDevice")
    ENGINE_API void EvaluateDeviceProperty(const FPlatformUserId PlatformUser, const FInputDeviceId DeviceId, const float DeltaTime, const float Duration);
 
    ENGINE_API virtual void EvaluateDeviceProperty_Implementation(const FPlatformUserId PlatformUser, const FInputDeviceId DeviceId, const float DeltaTime, const float Duration);
 
    UFUNCTION(BlueprintNativeEvent, Category = "InputDevice")
    ENGINE_API void ResetDeviceProperty(const FPlatformUserId PlatformUser, const FInputDeviceId DeviceId, bool bForceReset = false);
 
    ENGINE_API virtual void ResetDeviceProperty_Implementation(const FPlatformUserId PlatformUser, const FInputDeviceId DeviceId, bool bForceReset = false);
 
    UFUNCTION(Category = "InputDevice")
    ENGINE_API virtual void ApplyDeviceProperty(const FPlatformUserId UserId, const FInputDeviceId DeviceId);
    
    virtual FInputDeviceProperty* GetInternalDeviceProperty() { return nullptr; };
    
public:
 
    ENGINE_API float GetDuration() const;
    
    ENGINE_API virtual float RecalculateDuration();
 
    // Post edit change property to update the duration if there are any dynamic options like for curves
#if WITH_EDITOR
    ENGINE_API virtual void PostEditChangeChainProperty(FPropertyChangedChainEvent& PropertyChangedEvent) override;
#endif  // WITH_EDITOR
 
protected:
 
    static ENGINE_API void ApplyDeviceProperty_Internal(const FPlatformUserId UserId, const FInputDeviceId DeviceId, FInputDeviceProperty* RawProperty);
 
    template<class TDataLayout>
    const TDataLayout* GetDeviceSpecificData(const FPlatformUserId UserId, const FInputDeviceId DeviceId, const TMap<FName, TDataLayout>& InMap) const;
 
    template<class TDataLayout>
    TDataLayout* GetDeviceSpecificDataMutable(const FPlatformUserId UserId, const FInputDeviceId DeviceId, TMap<FName, TDataLayout>& InMap)
    {
        return GetDeviceSpecificData<TDataLayout>(UserId, DeviceId, InMap);
    }
 
    UPROPERTY(VisibleAnywhere, BlueprintReadWrite, Category = "Info")
    float PropertyDuration = 0.0f;
};
 
template<class TDataLayout>
const TDataLayout* UInputDeviceProperty::GetDeviceSpecificData(const FPlatformUserId UserId, const FInputDeviceId DeviceId, const TMap<FName, TDataLayout>& InDeviceData) const
{
    if (const UInputDeviceSubsystem* SubSystem = UInputDeviceSubsystem::Get())
    {
        // If we were given a valid device, use that. Otherwise, default to the player's most recently used device
        const FHardwareDeviceIdentifier Hardware = DeviceId.IsValid() ? SubSystem->GetInputDeviceHardwareIdentifier(DeviceId) : SubSystem->GetMostRecentlyUsedHardwareDevice(UserId);
        
        // Check if there are any per-input device overrides available
        if (const TDataLayout* DeviceDetails = InDeviceData.Find(Hardware.HardwareDeviceIdentifier))
        {
            return DeviceDetails;
        }
    }
 
    return nullptr;
}
 
// UColorInputDeviceProperty
 
USTRUCT(BlueprintType)
struct FDeviceColorData
{
    GENERATED_BODY()
 
    
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "Color")
    bool bEnable = true;
    
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "Color")
    bool bResetAfterCompletion = false;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "Color")
    FColor LightColor = FColor::White;
};
 
UCLASS(Blueprintable, BlueprintType, meta = (DisplayName = "Device Color (Static)"))
class UColorInputDeviceProperty : public UInputDeviceProperty
{
    GENERATED_BODY()
 
public:
 
    virtual void EvaluateDeviceProperty_Implementation(const FPlatformUserId PlatformUser, const FInputDeviceId DeviceId, const float DeltaTime, const float Duration) override;
    virtual void ResetDeviceProperty_Implementation(const FPlatformUserId PlatformUser, const FInputDeviceId DeviceId, bool bForceReset = false) override;
    virtual FInputDeviceProperty* GetInternalDeviceProperty() override;
 
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "Color")
    FDeviceColorData ColorData;
 
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "Color", meta = (GetOptions = "Engine.InputPlatformSettings.GetAllHardwareDeviceNames"))
    TMap<FName, FDeviceColorData> DeviceOverrideData;
 
private:
 
    FInputDeviceLightColorProperty InternalProperty;
};
 
 
// UColorInputDeviceCurveProperty
 
USTRUCT(BlueprintType)
struct FDeviceColorCurveData
{
    GENERATED_BODY()
 
    
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "Color")
    bool bEnable = true;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "Color")
    bool bResetAfterCompletion = true;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "Color")
    TObjectPtr<UCurveLinearColor> DeviceColorCurve;
};
 
UCLASS(Blueprintable, BlueprintType, meta = (DisplayName = "Device Color (Curve)"))
class UColorInputDeviceCurveProperty : public UInputDeviceProperty
{
    GENERATED_BODY()
 
public:
 
    virtual void EvaluateDeviceProperty_Implementation(const FPlatformUserId PlatformUser, const FInputDeviceId DeviceId, const float DeltaTime, const float Duration) override;
    virtual void ResetDeviceProperty_Implementation(const FPlatformUserId PlatformUser, const FInputDeviceId DeviceId, bool bForceReset = false) override;
    virtual FInputDeviceProperty* GetInternalDeviceProperty() override;
    virtual float RecalculateDuration() override;
 
protected:
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "Color")
    FDeviceColorCurveData ColorData;
 
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "Color", meta = (GetOptions = "Engine.InputPlatformSettings.GetAllHardwareDeviceNames"))
    TMap<FName, FDeviceColorCurveData> DeviceOverrideData;
 
private:
 
    FInputDeviceLightColorProperty InternalProperty;
};
 
 
// UInputDeviceTriggerEffect
 
USTRUCT(BlueprintType)
struct FDeviceTriggerBaseData
{
    GENERATED_BODY()
 
    
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "Triggers")
    EInputDeviceTriggerMask AffectedTriggers = EInputDeviceTriggerMask::All;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "Triggers")
    bool bResetUponCompletion = true;
};
 
UCLASS(Abstract, meta = (DisplayName = "Base Trigger Effect"), MinimalAPI)
class UInputDeviceTriggerEffect : public UInputDeviceProperty
{
    GENERATED_BODY()
 
public: 
 
    ENGINE_API virtual FInputDeviceProperty* GetInternalDeviceProperty() override;
    ENGINE_API virtual void ResetDeviceProperty_Implementation(const FPlatformUserId PlatformUser, const FInputDeviceId DeviceId, bool bForceReset = false) override;
    ENGINE_API virtual void ApplyDeviceProperty(const FPlatformUserId UserId, const FInputDeviceId DeviceId) override;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "Triggers")
    FDeviceTriggerBaseData BaseTriggerData;
 
protected:
 
    FInputDeviceTriggerResetProperty ResetProperty = {};
};
 
// UInputDeviceTriggerFeedbackProperty
 
USTRUCT(BlueprintType)
struct FDeviceTriggerFeedbackData
{
    GENERATED_BODY()
 
    
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "DeviceProperty")
    TObjectPtr<UCurveFloat> FeedbackPositionCurve;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "DeviceProperty")
    TObjectPtr<UCurveFloat> FeedbackStrenghCurve;
};
 
UCLASS(Blueprintable, meta = (DisplayName = "Trigger Feedback"))
class UInputDeviceTriggerFeedbackProperty : public UInputDeviceTriggerEffect
{
    GENERATED_BODY()
 
public:
    
    UInputDeviceTriggerFeedbackProperty();
    
    virtual void EvaluateDeviceProperty_Implementation(const FPlatformUserId PlatformUser, const FInputDeviceId DeviceId, const float DeltaTime, const float Duration) override;    
    virtual FInputDeviceProperty* GetInternalDeviceProperty() override;
    virtual float RecalculateDuration() override;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "Trigger")
    FDeviceTriggerFeedbackData TriggerData;
 
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "Trigger", meta = (GetOptions = "Engine.InputPlatformSettings.GetAllHardwareDeviceNames"))
    TMap<FName, FDeviceTriggerFeedbackData> DeviceOverrideData;
 
private:
 
    int32 GetPositionValue(const FDeviceTriggerFeedbackData* Data, const float Duration) const;
    int32 GetStrengthValue(const FDeviceTriggerFeedbackData* Data, const float Duration) const;
 
    FInputDeviceTriggerFeedbackProperty InternalProperty;
};
 
// UInputDeviceTriggerResistanceProperty
 
USTRUCT(BlueprintType)
struct FDeviceTriggerTriggerResistanceData
{
    GENERATED_BODY()
 
    
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "DeviceProperty", meta = (UIMin = "0", UIMAX = "9"))
    int32 StartPosition = 0;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "DeviceProperty", meta = (UIMin = "0", UIMAX = "8"))
    int32 StartStrengh = 0;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "DeviceProperty", meta = (UIMin = "0", UIMAX = "9"))
    int32 EndPosition = 0;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "DeviceProperty", meta = (UIMin = "0", UIMAX = "8"))
    int32 EndStrengh = 0;
};
 
UCLASS(Blueprintable, meta = (DisplayName = "Trigger Resistance"))
class UInputDeviceTriggerResistanceProperty : public UInputDeviceTriggerEffect
{
    GENERATED_BODY()
 
public:
 
    UInputDeviceTriggerResistanceProperty();
 
    virtual void EvaluateDeviceProperty_Implementation(const FPlatformUserId PlatformUser, const FInputDeviceId DeviceId, const float DeltaTime, const float Duration) override;
    virtual FInputDeviceProperty* GetInternalDeviceProperty() override;
 
protected:
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "Trigger")
    FDeviceTriggerTriggerResistanceData TriggerData;
 
 
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "Trigger", meta = (GetOptions = "Engine.InputPlatformSettings.GetAllHardwareDeviceNames"))
    TMap<FName, FDeviceTriggerTriggerResistanceData> DeviceOverrideData;
 
private:
 
    FInputDeviceTriggerResistanceProperty InternalProperty;
};
 
 
// UInputDeviceTriggerVibrationProperty
 
 
USTRUCT(BlueprintType)
struct FDeviceTriggerTriggerVibrationData
{
    GENERATED_BODY()
 
    
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "DeviceProperty")
    TObjectPtr<UCurveFloat> TriggerPositionCurve;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "DeviceProperty")
    TObjectPtr<UCurveFloat> VibrationFrequencyCurve;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "DeviceProperty")
    TObjectPtr<UCurveFloat> VibrationAmplitudeCurve;
};
 
UCLASS(Blueprintable, meta = (DisplayName = "Trigger Vibration"))
class UInputDeviceTriggerVibrationProperty : public UInputDeviceTriggerEffect
{
    GENERATED_BODY()
 
public:
 
    UInputDeviceTriggerVibrationProperty();
 
    virtual void EvaluateDeviceProperty_Implementation(const FPlatformUserId PlatformUser, const FInputDeviceId DeviceId, const float DeltaTime, const float Duration) override;
    virtual FInputDeviceProperty* GetInternalDeviceProperty() override;
    virtual float RecalculateDuration() override;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "Trigger")
    FDeviceTriggerTriggerVibrationData TriggerData;
 
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "Trigger", meta = (GetOptions = "Engine.InputPlatformSettings.GetAllHardwareDeviceNames"))
    TMap<FName, FDeviceTriggerTriggerVibrationData> DeviceOverrideData;
 
private:
 
    int32 GetTriggerPositionValue(const FDeviceTriggerTriggerVibrationData* Data, const float Duration) const;
    int32 GetVibrationFrequencyValue(const FDeviceTriggerTriggerVibrationData* Data, const float Duration) const;
    int32 GetVibrationAmplitudeValue(const FDeviceTriggerTriggerVibrationData* Data, const float Duration) const;
 
    FInputDeviceTriggerVibrationProperty InternalProperty;
};
 
// UInputDeviceSoundBasedVibrationProperty
 
class USoundBase;
class UEndpointSubmix;
 
USTRUCT(BlueprintType)
struct FAudioBasedVibrationData
{
    GENERATED_BODY()
 
    FAudioBasedVibrationData();
    
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "DeviceProperty")
    TObjectPtr<USoundBase> Sound;
};
 
UCLASS(Blueprintable, meta = (DisplayName = "Audio Based Vibration (Experimental)"))
class UInputDeviceAudioBasedVibrationProperty : public UInputDeviceProperty
{
    GENERATED_BODY()
 
public:
    virtual void EvaluateDeviceProperty_Implementation(const FPlatformUserId PlatformUser, const FInputDeviceId DeviceId, const float DeltaTime, const float Duration) override;
    virtual void ApplyDeviceProperty(const FPlatformUserId UserId, const FInputDeviceId DeviceId) override;
    virtual FInputDeviceProperty* GetInternalDeviceProperty() override;
    virtual float RecalculateDuration() override;
    
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "Trigger")
    FAudioBasedVibrationData Data;
 
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "Trigger", meta = (GetOptions = "Engine.InputPlatformSettings.GetAllHardwareDeviceNames"))
    TMap<FName, FAudioBasedVibrationData> DeviceOverrideData;
 
private:
 
    const FAudioBasedVibrationData* GetRelevantData(const FPlatformUserId UserId, const FInputDeviceId DeviceId) const;
};