ForceFeedbackComponent.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
 
#pragma once
#include "GameFramework/ForceFeedbackAttenuation.h"
#include "Components/SceneComponent.h"
#include "Tickable.h"
#include "UObject/GCObject.h"
#include "ForceFeedbackComponent.generated.h"
 
struct FDisplayDebugManager;
struct FForceFeedbackValues;
class UForceFeedbackEffect;
 
class FForceFeedbackManager : public FTickableGameObject, FGCObject
{
private:
 
    FForceFeedbackManager(UWorld* InWorld)
        : World(InWorld)
    {
    }
 
public:
 
    static FForceFeedbackManager* Get(UWorld* World, bool bCreateIfMissing = false);
 
    void AddActiveComponent(UForceFeedbackComponent* ForceFeedbackComponent);
    void RemoveActiveComponent(UForceFeedbackComponent* ForceFeedbackComponent);
 
    void Update(FVector Location, FForceFeedbackValues& Values, const FPlatformUserId UserId) const;
 
    void DrawDebug(const FVector Location, FDisplayDebugManager& DisplayDebugManager, const FPlatformUserId UserId) const;
 
private:
    virtual void AddReferencedObjects( FReferenceCollector& Collector ) override;
    virtual FString GetReferencerName() const override;
    virtual UWorld* GetTickableGameObjectWorld() const override;
    virtual void Tick( float DeltaTime ) override;
    virtual bool IsTickable() const override;
    virtual TStatId GetStatId() const override;
 
    TObjectPtr<UWorld> World;
    TArray<TObjectPtr<UForceFeedbackComponent>> ActiveForceFeedbackComponents;
 
    static void OnWorldCleanup(UWorld* World, bool bSessionEnded, bool bCleanupResources);
 
    static TArray<FForceFeedbackManager*> PerWorldForceFeedbackManagers;
    static FDelegateHandle OnWorldCleanupHandle;
};
 
DECLARE_DYNAMIC_MULTICAST_DELEGATE_OneParam( FOnForceFeedbackFinished, UForceFeedbackComponent*, ForceFeedbackComponent);
 
UCLASS(ClassGroup=(Utility), hidecategories=(Object, ActorComponent, Physics, Rendering, Mobility, LOD), ShowCategories=Trigger, meta=(BlueprintSpawnableComponent), MinimalAPI)
class UForceFeedbackComponent : public USceneComponent
{
    GENERATED_BODY()
 
public:
 
    ENGINE_API UForceFeedbackComponent(const FObjectInitializer& ObjectInitializer);
 
    UPROPERTY(EditAnywhere, BlueprintReadOnly, Category=ForceFeedback)
    TObjectPtr<UForceFeedbackEffect> ForceFeedbackEffect;
 
    UPROPERTY()
    uint8 bAutoDestroy:1;
 
    UPROPERTY()
    uint8 bStopWhenOwnerDestroyed:1;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category=ForceFeedback)
    uint8 bLooping:1;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category=ForceFeedback)
    uint8 bIgnoreTimeDilation:1;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category=Attenuation)
    uint8 bOverrideAttenuation:1;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category=ForceFeedback)
    float IntensityMultiplier;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category=Attenuation, meta=(EditCondition="!bOverrideAttenuation"))
    TObjectPtr<class UForceFeedbackAttenuation> AttenuationSettings;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category=Attenuation, meta=(EditCondition="bOverrideAttenuation"))
    struct FForceFeedbackAttenuationSettings AttenuationOverrides;
 
    UPROPERTY(BlueprintAssignable)
    FOnForceFeedbackFinished OnForceFeedbackFinished;
 
    UFUNCTION(BlueprintCallable, Category="ForceFeedback")
    ENGINE_API void SetForceFeedbackEffect( UForceFeedbackEffect* NewForceFeedbackEffect);
 
    UFUNCTION(BlueprintCallable, Category="ForceFeedback")
    ENGINE_API virtual void Play(float StartTime = 0.f);
 
    UFUNCTION(BlueprintCallable, Category="ForceFeedback")
    ENGINE_API virtual void Stop();
 
    UFUNCTION(BlueprintCallable, Category="ForceFeedback")
    ENGINE_API void SetIntensityMultiplier(float NewIntensityMultiplier);
 
    UFUNCTION(BlueprintCallable, Category="ForceFeedback")
    ENGINE_API void AdjustAttenuation(const FForceFeedbackAttenuationSettings& InAttenuationSettings);
 
    //~ Begin UObject Interface.
#if WITH_EDITORONLY_DATA
    ENGINE_API virtual void PostEditChangeProperty(FPropertyChangedEvent& PropertyChangedEvent) override;
    ENGINE_API virtual void Serialize(FArchive& Ar) override;
#endif // WITH_EDITOR
    //~ End UObject Interface.
 
    //~ Begin USceneComponent Interface
    ENGINE_API virtual void Activate(bool bReset=false) override;
    ENGINE_API virtual void Deactivate() override;
    //~ End USceneComponent Interface
 
    //~ Begin ActorComponent Interface.
#if WITH_EDITORONLY_DATA
    ENGINE_API virtual void OnRegister() override;
#endif
    ENGINE_API virtual void OnUnregister() override;
    ENGINE_API virtual const UObject* AdditionalStatObject() const override;
    ENGINE_API virtual bool IsReadyForOwnerToAutoDestroy() const override;
    //~ End ActorComponent Interface.
 
    ENGINE_API const FForceFeedbackAttenuationSettings* GetAttenuationSettingsToApply() const;
 
    UFUNCTION(BlueprintCallable, Category = "ForceFeedback", meta = (DisplayName = "Get Attenuation Settings To Apply", ScriptName="GetAttenuationSettingsToApply"))
    ENGINE_API bool BP_GetAttenuationSettingsToApply(FForceFeedbackAttenuationSettings& OutAttenuationSettings) const;
 
    ENGINE_API void CollectAttenuationShapesForVisualization(TMultiMap<EAttenuationShape::Type, FBaseAttenuationSettings::AttenuationShapeDetails>& ShapeDetailsMap) const;
 
private:
    
    float PlayTime;
 
#if WITH_EDITORONLY_DATA
    ENGINE_API void UpdateSpriteTexture();
#endif
 
    ENGINE_API bool Advance(float DeltaTime);
    ENGINE_API void Update(FVector Location, FForceFeedbackValues& Values, const FPlatformUserId UserId) const;
    ENGINE_API void StopInternal(bool bRemoveFromManager = true);
 
    friend FForceFeedbackManager;
};