Interpolator.h

Go to the documentation of this file.

// Copyright Blue Isle Studios Inc 2017. All Rights Reserved.
 
#pragma once
 
#include "GameFramework/Actor.h"
#include "Kismet/KismetMathLibrary.h"
#include "Interpolator.generated.h"
 
DECLARE_DYNAMIC_DELEGATE_OneParam(FInterpolationSignature, float, Value);
DECLARE_DELEGATE_OneParam(FInterpolationDelegate, struct FInterpolationEntry&);
 
USTRUCT(Blueprintable)
struct FInterpolationEntry
{
    GENERATED_USTRUCT_BODY()
 
    FInterpolationEntry() {}
 
    FInterpolationEntry(UObject* Object, FInterpolationDelegate Event, FInterpolationSignature DynamicEvent, FInterpolationDelegate OnCompleteEvent, FInterpolationSignature OnCompleteDynamicEvent, float TE, float TT, float S, float E, EEasingFunc::Type Ease, UCurveFloat* C)
        : DynamicDelegate(DynamicEvent), CompleteDynamicDelegate(OnCompleteDynamicEvent), Delegate(Event), CompleteDelegate(OnCompleteEvent), TimeElapsed(TE), TimeTotal(TT), Start(S), End(E), EaseType(Ease), Curve(C), CallingObject(Object)
    {
        Counter++;
        ID = Counter;
        bIsValid = true;
    }
 
    FInterpolationSignature DynamicDelegate;
    FInterpolationSignature CompleteDynamicDelegate;
    FInterpolationDelegate Delegate;
    FInterpolationDelegate CompleteDelegate;
 
    float TimeElapsed = 0.f;
    float TimeTotal = 0.f;
    float DeltaTime = 0.0f;
    float Start = 0.f;
    float End = 0.f;
    float PercentCompleted = 0.0f;
    float Value = 0.0f;
    bool bInverted = false;
    bool bIsValid = false;
    EEasingFunc::Type EaseType;
    UCurveFloat* Curve = nullptr;
 
    bool bReplicated = false;
 
    UPROPERTY()
    uint32 ID = 0;
 
    static uint32 Counter;
 
    UPROPERTY()
    UObject* CallingObject = nullptr;
 
    bool bCompleted = false;
 
    bool operator==(const FInterpolationEntry& rhs) const
    {
        return ID == rhs.ID;
    }
};
 
UCLASS()
class PROJECTX_API AInterpolator : public AActor
{
    GENERATED_UCLASS_BODY()
 
public: 
    virtual void Tick(float DeltaTime) override;
    virtual void BeginPlay() override;
    virtual void EndPlay(const EEndPlayReason::Type EndPlayReason);
 
    /* Interpolates a value from 0 to 1 over the specified amount of time, using a selected curve.
    @param TimeTotal - the amount of time for the value to go from 0 to 1
    @param EaseType - Select from a number of simple curves which affect how the value interpolates
    @param Event - calls back each time the value interpolates towards 1
    @param On Complete Event - calls back once the value has fully interpolated towards 1
    @return Interpolation ID */
    UFUNCTION(BlueprintCallable, Category = "Interpolation", meta = (WorldContext = "WorldContextObject", AutoCreateRefTerm = "OnCompleteEvent"))
    static int32 InterpolateOverTimeSimple(UObject* WorldContextObject, float TimeTotal, EEasingFunc::Type EaseType, const FInterpolationSignature& Event, const FInterpolationSignature& OnCompleteEvent);
    static uint32 InterpolateOverTimeSimple(UObject* WorldContextObject, float TimeTotal, EEasingFunc::Type EaseType, const FInterpolationDelegate& Event, const FInterpolationDelegate& OnCompleteEvent);
    static uint32 InterpolateOverTimeSimple(UObject* WorldContextObject, float TimeTotal, EEasingFunc::Type EaseType, const FInterpolationDelegate& Event);
 
    /* Interpolates a value from Start to End over the specified amount of time with an optional starting point and custom curve. 
    @return Interpolation ID */
    UFUNCTION(BlueprintCallable, Category = "Interpolation", meta = (WorldContext = "WorldContextObject", AutoCreateRefTerm = "OnCompleteEvent"))
    static int32 InterpolateOverTimeCustomCurve(UObject* WorldContextObject, float TimeElapsed, float TimeTotal, float Start, float End, UCurveFloat* Curve, const FInterpolationSignature& Event, const FInterpolationSignature& OnCompleteEvent);
    static int32 InterpolateOverTimeCustomCurve(UObject* WorldContextObject, float TimeElapsed, float TimeTotal, float Start, float End, UCurveFloat* Curve, const FInterpolationSignature& Event);
    static int32 InterpolateOverTimeCustomCurve(UObject* WorldContextObject, float TimeElapsed, float TimeTotal, float Start, float End, UCurveFloat* Curve, const FInterpolationDelegate& Event);
    static int32 InterpolateOverTimeCustomCurve(UObject* WorldContextObject, float TimeElapsed, float TimeTotal, float Start, float End, UCurveFloat* Curve, const FInterpolationDelegate& Event, const FInterpolationDelegate& OnCompleteEvent);
 
    /* Interpolates a value from Start to End over the specified amount of time with an optional starting point and selection of stock curves. 
    @return Interpolation ID */
    UFUNCTION(BlueprintCallable, Category = "Interpolation", meta = (WorldContext = "WorldContextObject", AutoCreateRefTerm = "OnCompleteEvent"))
    static int32 InterpolateOverTime(UObject* WorldContextObject, float TimeElapsed, float TimeTotal, float Start, float End, EEasingFunc::Type EaseType, const FInterpolationSignature& Event, const FInterpolationSignature& OnCompleteEvent);
    static uint32 InterpolateOverTime(UObject* WorldContextObject, float TimeElapsed, float TimeTotal, float Start, float End, EEasingFunc::Type EaseType, const FInterpolationDelegate &Event, const FInterpolationDelegate& OnCompleteEvent);
    static uint32 InterpolateOverTime(UObject* WorldContextObject, float TimeElapsed, float TimeTotal, float Start, float End, EEasingFunc::Type EaseType, const FInterpolationDelegate &Event);
    static uint32 InterpolateOverTime(UObject* WorldContextObject, float TimeElapsed, float TimeTotal, float Start, float End, const FInterpolationDelegate& Event, const FInterpolationSignature& DynamicEvent, const FInterpolationDelegate& OnCompleteEvent, const FInterpolationSignature& OnCompleteDynamicEvent, EEasingFunc::Type EaseType = EEasingFunc::Linear, UCurveFloat* Curve = nullptr, bool bReplicated = false);
 
    static uint32 InterpolateOverTimeReplicated(UObject* WorldContextObject, float StartTime, float EndTime, float Start, float End, EEasingFunc::Type EaseType, const FInterpolationDelegate& Event);
 
    static FInterpolationEntry* GetInterpolationEntry(const FInterpolationDelegate& Event);
    static FInterpolationEntry* GetInterpolationEntry(const FInterpolationSignature& Event);
 
    /* Stops the execution of this interpolation and clears it. */
    UFUNCTION(BlueprintCallable, Category = "Interpolation")
    static void ClearInterpolation(const UObject* Caller, const int32 ID);
 
    /* Checks if the interpolation ID is currently executing */
    UFUNCTION(BlueprintPure, Category = "Interpolation")
    static bool IsInterpolationActive(const UObject* Caller, const int32 ID) { return GetInterpolationEntryByID(Caller, ID) != nullptr; };
 
    /* Completes the interpolation by calling the final interpolation frame as well as the oncomplete event. */
    UFUNCTION(BlueprintCallable, Category = "Interpolation")
    static void CompleteInterpolation(const UObject* Caller, const int32 ID);
 
    /* Grabs an interpolation by id so that it can be modified while running. */
    static FInterpolationEntry* GetInterpolationEntryByID(const UObject* Caller, const uint32 ID);
 
    /* Stops the execution of all interpolations on this object. */
    UFUNCTION(BlueprintCallable, Category = "Interpolation")
    static void ClearInterpolatorsForObject(const UObject* Object);
 
    /* Completes and clears all interpolators. */
    static void NotifyLevelTravel();
 
    /* Inverts the playback of an interpolator */
    UFUNCTION(BlueprintCallable, Category = "Interpolation")
    static void InvertInterpolator(const UObject* Caller, const int32 ID);
 
public:
    static AInterpolator* GetInterpolator(UObject* WorldContextObject);
 
private:
    static void CalculateEntryValue(FInterpolationEntry* Entry, bool bFromTick = false);
 
private:
    friend class UProjectXGameInstance;
    static TArray<FInterpolationEntry> InterpolationList;
    static TWeakObjectPtr<AInterpolator> Singleton;
};