UMGSequencePlayer.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 "Blueprint/UserWidget.h"
#include "IMovieScenePlayer.h"
#include "Animation/UMGSequenceTickManager.h"
#include "Animation/WidgetAnimationHandle.h"
#include "Evaluation/MovieSceneEvaluationTemplateInstance.h"
#include "Misc/QualifiedFrameTime.h"
#include "UMGSequencePlayer.generated.h"
 
class UWidgetAnimation;
 
UCLASS(Transient, BlueprintType, MinimalAPI)
class UUMGSequencePlayer : public UObject, public IMovieScenePlayer
{
    GENERATED_BODY()
 
public:
 
    UUMGSequencePlayer(const FObjectInitializer& ObjectInitializer);
 
    UMG_API void InitSequencePlayer(FWidgetAnimationState& InState);
 
    UE_DEPRECATED(5.6, "Please use FWidgetAnimationHandle and FWidgetAnimationState")
    UMG_API void InitSequencePlayer(UWidgetAnimation& InAnimation, UUserWidget& InUserWidget);
 
    UE_DEPRECATED(5.6, "Please use FWidgetAnimationHandle and FWidgetAnimationState")
    UMG_API void Tick(float DeltaTime);
 
    UE_DEPRECATED(5.6, "Please use FWidgetAnimationHandle and FWidgetAnimationState")
    UMG_API void Play(float StartAtTime, int32 InNumLoopsToPlay, EUMGSequencePlayMode::Type InPlayMode, float InPlaybackSpeed, bool bRestoreState);
 
    UE_DEPRECATED(5.6, "Please use FWidgetAnimationHandle and FWidgetAnimationState")
    UMG_API void PlayTo(float StartAtTime, float EndAtTime, int32 InNumLoopsToPlay, EUMGSequencePlayMode::Type InPlayMode, float InPlaybackSpeed, bool bRestoreState);
 
    UE_DEPRECATED(5.6, "Please use FWidgetAnimationHandle and FWidgetAnimationState")
    UMG_API void Stop();
 
    UE_DEPRECATED(5.6, "Please use FWidgetAnimationHandle and FWidgetAnimationState")
    UMG_API void Pause();
 
    UE_DEPRECATED(5.6, "Please use FWidgetAnimationHandle and FWidgetAnimationState")
    UMG_API void Reverse();
 
    UE_DEPRECATED(5.6, "Please use FWidgetAnimationHandle and FWidgetAnimationState")
    UMG_API void SetCurrentTime(float InTime);
 
    UE_DEPRECATED(5.6, "Please use FWidgetAnimationHandle and FWidgetAnimationState")
    UMG_API FQualifiedFrameTime GetCurrentTime() const;
 
    UE_DEPRECATED(5.6, "Please use FWidgetAnimationHandle and FWidgetAnimationState")
    UMG_API const UWidgetAnimation* GetAnimation() const;
 
    UFUNCTION(BlueprintCallable, Category="Animation", meta=(DeprecatedFunction))
    UMG_API FName GetUserTag() const;
 
    UFUNCTION(BlueprintCallable, Category = "Animation", meta=(DeprecatedFunction))
    UMG_API void SetUserTag(FName InUserTag);
 
    UE_DEPRECATED(5.6, "Please use FWidgetAnimationHandle and FWidgetAnimationState")
    UMG_API void SetNumLoopsToPlay(int32 InNumLoopsToPlay);
 
    UE_DEPRECATED(5.6, "Please use FWidgetAnimationHandle and FWidgetAnimationState")
    UMG_API void SetPlaybackSpeed(float PlaybackSpeed);
 
    UE_DEPRECATED(5.6, "Please use FWidgetAnimationHandle and FWidgetAnimationState")
    UMG_API bool IsPlayingForward() const;
 
    UE_DEPRECATED(5.6, "Please use FWidgetAnimationHandle and FWidgetAnimationState")
    UMG_API bool IsStopping() const;
 
public:
 
    UE_DEPRECATED(5.6, "Please use FWidgetAnimationHandle and FWidgetAnimationState")
    UMG_API virtual FMovieSceneRootEvaluationTemplateInstance& GetEvaluationTemplate() override;
 
    UE_DEPRECATED(5.6, "Please use FWidgetAnimationHandle and FWidgetAnimationState")
    UMG_API virtual UMovieSceneEntitySystemLinker* ConstructEntitySystemLinker() override;
 
    UE_DEPRECATED(5.6, "Please use FWidgetAnimationHandle and FWidgetAnimationState")
    UMG_API virtual UObject* AsUObject() override;
 
    UE_DEPRECATED(5.6, "Please use FWidgetAnimationHandle and FWidgetAnimationState")
    UMG_API virtual EMovieScenePlayerStatus::Type GetPlaybackStatus() const override;
 
    UE_DEPRECATED(5.6, "Please use FWidgetAnimationHandle and FWidgetAnimationState")
    UMG_API virtual void SetPlaybackStatus(EMovieScenePlayerStatus::Type InPlaybackStatus) override;
 
    UE_DEPRECATED(5.6, "Please use FWidgetAnimationHandle and FWidgetAnimationState")
    UMG_API virtual IMovieScenePlaybackClient* GetPlaybackClient() override;
 
    UE_DEPRECATED(5.6, "Please use FWidgetAnimationHandle and FWidgetAnimationState")
    UMG_API virtual FMovieSceneSpawnRegister& GetSpawnRegister() override;
 
    UE_DEPRECATED(5.6, "Please use FWidgetAnimationHandle and FWidgetAnimationState")
    UMG_API virtual UObject* GetPlaybackContext() const override;
 
    UE_DEPRECATED(5.6, "Please use FWidgetAnimationHandle and FWidgetAnimationState")
    UMG_API virtual void InitializeRootInstance(TSharedRef<UE::MovieScene::FSharedPlaybackState> NewSharedPlaybackState) override;
 
public:
 
    UMG_API virtual void BeginDestroy() override;
 
    UE_DEPRECATED(5.6, "Please use FWidgetAnimationHandle and FWidgetAnimationState")
    UMG_API void RemoveEvaluationData();
 
    UE_DEPRECATED(5.6, "Please use FWidgetAnimationHandle and FWidgetAnimationState")
    UMG_API void TearDown();
 
    DECLARE_EVENT_OneParam(UUMGSequencePlayer, FOnSequenceFinishedPlaying, UUMGSequencePlayer&);
 
    UE_DEPRECATED(5.6, "Please use FWidgetAnimationHandle and FWidgetAnimationState")
    UMG_API FOnSequenceFinishedPlaying& OnSequenceFinishedPlaying();
 
public:
 
    // Internal API.
    void BroadcastSequenceFinishedPlaying();
 
private:
 
    FWidgetAnimationHandle WidgetAnimationHandle;
 
    FMovieSceneRootEvaluationTemplateInstance RootTemplateInstance;
 
    FOnSequenceFinishedPlaying OnSequenceFinishedPlayingEvent;
};