WidgetAnimationState.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "Blueprint/UMGSequencePlayMode.h"
#include "Animation/UMGSequenceTickManager.h"
#include "CoreMinimal.h"
#include "Evaluation/MovieScenePlayback.h"
#include "Evaluation/MovieScenePlaybackManager.h"
#include "EntitySystem/MovieSceneSharedPlaybackState.h"
#include "Misc/QualifiedFrameTime.h"
#include "MovieSceneFwd.h"
#include "Templates/SharedPointer.h"
#include "UObject/ObjectMacros.h"
 
class UUserWidget;
class UWidgetAnimation;
class UUMGSequencePlayer;
struct FWidgetAnimationHandle;
struct FWidgetAnimationState;
 
DECLARE_MULTICAST_DELEGATE_OneParam(FOnWidgetAnimationEvent, FWidgetAnimationState&);
 
struct FWidgetAnimationStatePlayParams
{
    double StartAtTime = 0;
    TOptional<double> EndAtTime;
    TOptional<double> StartOffset;
    TOptional<double> EndOffset;
    int32 NumLoopsToPlay = 1;
    float PlaybackSpeed = 1.f;
    EUMGSequencePlayMode::Type PlayMode = EUMGSequencePlayMode::Forward;
    bool bRestoreState = false;
};
 
struct FWidgetAnimationState : public TSharedFromThis<FWidgetAnimationState>
{
public:
 
    FWidgetAnimationState();
 
    void Initialize(UWidgetAnimation* InAnimation, UUserWidget* InUserWidget);
 
    UUserWidget* GetUserWidget() const { return WeakUserWidget.Get(); }
 
    const UWidgetAnimation* GetAnimation() const { return Animation; }
 
    TSharedPtr<UE::MovieScene::FSharedPlaybackState> GetSharedPlaybackState() const { return WeakPlaybackState.Pin(); }
 
    FName GetUserTag() const { return UserTag; }
 
    void SetUserTag(FName InUserTag) { UserTag = InUserTag; }
 
    bool IsStopping() const { return bIsStopping; }
 
    bool IsPendingDelete() const { return bIsPendingDelete; }
 
    FOnWidgetAnimationEvent& GetOnWidgetAnimationFinished() { return OnWidgetAnimationFinishedEvent; }
 
public:
 
    UMG_API UUMGSequencePlayer* GetOrCreateLegacyPlayer();
 
    UMG_API UUMGSequencePlayer* GetLegacyPlayer() const;
 
    UMG_API FWidgetAnimationHandle GetAnimationHandle() const;
 
    UMG_API bool IsPlayingForward() const;
 
    UMG_API EMovieScenePlayerStatus::Type GetPlaybackStatus() const;
 
    UMG_API void SetPlaybackStatus(EMovieScenePlayerStatus::Type InPlaybackStatus);
 
    UMG_API FQualifiedFrameTime GetCurrentTime() const;
 
    UMG_API void SetCurrentTime(float InTime);
 
    UMG_API void SetNumLoopsToPlay(int32 InNumLoopsToPlay);
 
    UMG_API void SetPlaybackSpeed(float PlaybackSpeed);
 
    UMG_API void Tick(float InDeltaSeconds);
 
    UMG_API void Play(const FWidgetAnimationStatePlayParams& PlayParams);
 
    UMG_API void Stop();
 
    UMG_API void Pause();
 
    UMG_API void Reverse();
 
    UMG_API void RemoveEvaluationData();
 
    UMG_API void TearDown();
 
    UMG_API bool IsValid() const;
 
    UMG_API void AddReferencedObjects(FReferenceCollector& Collector);
 
private:
 
    bool NeedsLegacyPlayer() const;
 
    void FlushIfPrivateLinker();
 
    void OnBegunPlay();
    void OnStopped();
 
private:
 
    TObjectPtr<UWidgetAnimation> Animation;
 
    TObjectPtr<UUMGSequencePlayer> LegacyPlayer;
 
    TWeakObjectPtr<UUserWidget> WeakUserWidget;
 
private:
 
    TWeakPtr<UE::MovieScene::FSharedPlaybackState> WeakPlaybackState;
    
    TObjectPtr<UMovieSceneEntitySystemLinker> PrivateLinker;
 
    FMovieScenePlaybackManager PlaybackManager;
 
    EUMGSequencePlayMode::Type PlayMode;
 
    FName UserTag;
 
    float BlockedDeltaTimeCompensation;
 
    bool bRestoreState : 1;
 
    bool bIsBeginningPlay : 1;
 
    bool bIsStopping : 1;
 
    bool bIsPendingDelete : 1;
 
    FOnWidgetAnimationEvent OnWidgetAnimationFinishedEvent;
};