CurveSequence.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "CoreMinimal.h"
#include "Animation/CurveHandle.h"
#include "Containers/Ticker.h"
 
class FActiveTimerHandle;
class SWidget;
enum class EActiveTimerReturnType : uint8;
 
struct FCurveSequence : public TSharedFromThis<FCurveSequence>
{
public:
 
    struct FSlateCurve
    {
        FSlateCurve( float InStartTime, float InDurationSeconds, const ECurveEaseFunction InEaseFunction )
            : DurationSeconds(InDurationSeconds)
            , StartTime(InStartTime)
            , EaseFunction(InEaseFunction)
        {
        }
 
        float DurationSeconds;
 
        float StartTime;
 
        ECurveEaseFunction EaseFunction;
    };
 
    SLATECORE_API FCurveSequence( );
 
    SLATECORE_API ~FCurveSequence();
 
    SLATECORE_API FCurveSequence( const float InStartTimeSeconds, const float InDurationSeconds, const ECurveEaseFunction InEaseFunction = ECurveEaseFunction::Linear  );
 
    SLATECORE_API FCurveHandle AddCurve( const float InStartTimeSeconds, const float InDurationSeconds, const ECurveEaseFunction InEaseFunction = ECurveEaseFunction::Linear );
 
    SLATECORE_API FCurveHandle AddCurveRelative( const float InOffset, const float InDurationSecond, const ECurveEaseFunction InEaseFunction = ECurveEaseFunction::Linear );
 
    SLATECORE_API void Play( const TSharedRef<SWidget>& InOwnerWidget, bool bPlayLooped = false, const float StartAtTime = 0.0f, bool bRequiresActiveTimer = true);
 
    SLATECORE_API void Play(const FTickerDelegate& InDelegate, bool bPlayLooped = false, const float StartAtTime = 0.0f);
 
    SLATECORE_API void PlayReverse( const TSharedRef<SWidget>& InOwnerWidget, bool bPlayLooped = false, const float StartAtTime = 0.0f, bool bRequiresActiveTimer = true);
 
    SLATECORE_API void Reverse( );
 
    SLATECORE_API void Pause();
 
    SLATECORE_API void Resume( );
 
    SLATECORE_API void PlayRelative(const TSharedRef<SWidget>& InOwnerWidget, bool bForward);
 
    SLATECORE_API bool IsPlaying( ) const;
 
    SLATECORE_API float GetSequenceTime( ) const;
 
    SLATECORE_API bool IsInReverse( ) const;
 
    SLATECORE_API bool IsForward( ) const;
 
    SLATECORE_API void JumpToStart( );
 
    SLATECORE_API void JumpToEnd( );
 
    SLATECORE_API bool IsAtStart( ) const;
 
    SLATECORE_API bool IsAtEnd( ) const;
 
    SLATECORE_API bool IsLooping() const;
 
    SLATECORE_API float GetLerp() const;
 
    SLATECORE_API const FCurveSequence::FSlateCurve& GetCurve( int32 CurveIndex ) const;
 
protected:
 
    SLATECORE_API void SetStartTime( double InStartTime );
 
private:
    void RegisterActiveTimerIfNeeded(TSharedRef<SWidget> InOwnerWidget);
 
    bool TickPlay(float InDeltaTime, FTickerDelegate InUserDelegate);
 
    EActiveTimerReturnType EnsureSlateTickDuringAnimation( double InCurrentTime, float InDeltaTime );
 
private:
 
    TWeakPtr<SWidget> OwnerWidget;
 
    TWeakPtr<FActiveTimerHandle> ActiveTimerHandle;
 
    FTSTicker::FDelegateHandle TickerHandle;
 
    TArray<FSlateCurve> Curves;
 
    double StartTime;
 
    double PauseTime;
 
    double TotalDuration;
 
    uint8 bInReverse : 1;
 
    uint8 bIsLooping : 1;
 
    uint8 bIsPaused : 1;
};