ForceFeedbackEffect.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/Object.h"
#include "Curves/CurveFloat.h"
#include "ForceFeedbackParameters.h"
#include "GameFramework/InputDevicePropertyHandle.h"
#include "ForceFeedbackEffect.generated.h"
 
class UForceFeedbackEffect;
struct FForceFeedbackValues;
class UInputDeviceProperty;
 
USTRUCT()
struct FForceFeedbackChannelDetails
{
    GENERATED_USTRUCT_BODY()
 
    
    UPROPERTY(EditAnywhere, Category="ChannelDetails")
    uint32 bAffectsLeftLarge:1;
 
    UPROPERTY(EditAnywhere, Category="ChannelDetails")
    uint32 bAffectsLeftSmall:1;
 
    UPROPERTY(EditAnywhere, Category="ChannelDetails")
    uint32 bAffectsRightLarge:1;
 
    UPROPERTY(EditAnywhere, Category="ChannelDetails")
    uint32 bAffectsRightSmall:1;
 
    UPROPERTY(EditAnywhere, Category="ChannelDetails")
    FRuntimeFloatCurve Curve;
 
    FForceFeedbackChannelDetails()
        : bAffectsLeftLarge(true)
        , bAffectsLeftSmall(true)
        , bAffectsRightLarge(true)
        , bAffectsRightSmall(true)
    {
    }
};
 
USTRUCT()
struct FActiveForceFeedbackEffect
{
    GENERATED_USTRUCT_BODY()
 
    UPROPERTY()
    TObjectPtr<class UForceFeedbackEffect> ForceFeedbackEffect;
 
    FForceFeedbackParameters Parameters;
    float PlayTime;
 
    FPlatformUserId PlatformUser = PLATFORMUSERID_NONE;
 
    bool bActivatedDeviceProperties;
 
    UPROPERTY()
    TSet<FInputDevicePropertyHandle> ActiveDeviceProperties;
 
    FActiveForceFeedbackEffect()
        : ForceFeedbackEffect(nullptr)
        , PlayTime(0.f)
        , PlatformUser(PLATFORMUSERID_NONE)
        , bActivatedDeviceProperties(false)
    {
    }
 
    FActiveForceFeedbackEffect(UForceFeedbackEffect* InEffect, FForceFeedbackParameters InParameters, FPlatformUserId InPlatformUser)
        : ForceFeedbackEffect(InEffect)
        , Parameters(InParameters)
        , PlayTime(0.f)
        , PlatformUser(InPlatformUser)
        , bActivatedDeviceProperties(false)
    {
    }
 
    ENGINE_API ~FActiveForceFeedbackEffect();
 
    // Updates the final force feedback values based on this effect.  Returns true if the effect should continue playing, false if it is finished.
    ENGINE_API bool Update(float DeltaTime, FForceFeedbackValues& Values);
 
    // Activates all the device properties with the input device subsystem
    ENGINE_API void ActivateDeviceProperties();
 
    ENGINE_API void ResetDeviceProperties();
 
    // Gets the current values at the stored play time
    ENGINE_API void GetValues(FForceFeedbackValues& Values) const;
};
 
USTRUCT()
struct FForceFeedbackEffectOverridenChannelDetails
{
    GENERATED_BODY()
 
    FForceFeedbackEffectOverridenChannelDetails();
 
    UPROPERTY(EditAnywhere, Category="ForceFeedbackEffect")
    TArray<FForceFeedbackChannelDetails> ChannelDetails;
};
 
UCLASS(BlueprintType, MinimalAPI)
class UForceFeedbackEffect : public UObject
{
    GENERATED_UCLASS_BODY()
 
    UPROPERTY(EditAnywhere, Category="ForceFeedbackEffect")
    TArray<FForceFeedbackChannelDetails> ChannelDetails;
 
    UPROPERTY(EditAnywhere, Category = "ForceFeedbackEffect", Meta = (GetOptions = "Engine.InputPlatformSettings.GetAllHardwareDeviceNames"))
    TMap<FName, FForceFeedbackEffectOverridenChannelDetails> PerDeviceOverrides;
 
    UPROPERTY(EditAnywhere, Instanced, Category = "ForceFeedbackEffect")
    TArray<TObjectPtr<UInputDeviceProperty>> DeviceProperties;
 
    UPROPERTY(Category=Info, AssetRegistrySearchable, VisibleAnywhere, BlueprintReadOnly)
    float Duration;
 
#if WITH_EDITOR
    virtual void PostEditChangeChainProperty( struct FPropertyChangedChainEvent& PropertyChangedEvent) override;
#endif
 
    float GetDuration();
 
    float GetTotalDevicePropertyDuration();
 
    void GetValues(const float EvalTime, FForceFeedbackValues& Values, const FPlatformUserId PlatformUser, float ValueMultiplier = 1.f) const;
 
    const TArray<FForceFeedbackChannelDetails>& GetCurrentChannelDetails(const FPlatformUserId PlatformUser) const;
};