WidgetAnimationHandle.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "CoreTypes.h"
#include "Kismet/BlueprintFunctionLibrary.h"
#include "Templates/SharedPointerFwd.h"
 
#include "WidgetAnimationHandle.generated.h"
 
#define UE_API UMG_API
 
class UUMGSequencePlayer;
class UUserWidget;
struct FWidgetAnimationState;
 
USTRUCT(BlueprintType)
struct FWidgetAnimationHandle
{
    GENERATED_BODY()
 
public:
 
    UMG_API FWidgetAnimationHandle();
 
    UMG_API FWidgetAnimationState* GetAnimationState() const;
 
    UMG_API TSharedPtr<FWidgetAnimationState> PinAnimationState() const;
 
public:
 
    // For backwards compatibility in C++ code.
    UMG_API UUMGSequencePlayer* GetSequencePlayer() const;
    inline operator UUMGSequencePlayer*() const { return GetSequencePlayer(); }
 
public:
 
    UMG_API bool IsValid() const;
 
    UMG_API FName GetUserTag() const;
 
    UMG_API void SetUserTag(FName InUserTag);
 
public:
 
    friend uint32 GetTypeHash(const FWidgetAnimationHandle& Handle)
    {
        return GetTypeHash(Handle.WeakState);
    }
 
private:
 
    UMG_API FWidgetAnimationHandle(TSharedPtr<FWidgetAnimationState> InState);
 
private:
 
    TWeakPtr<FWidgetAnimationState> WeakState;
 
    // Only UUserWidget and FWidgetAnimationState can create handles.
    friend class UUserWidget;
    friend struct FWidgetAnimationState;
};
 
UCLASS(MinimalAPI)
class UWidgetAnimationHandleFunctionLibrary : public UBlueprintFunctionLibrary
{
    GENERATED_BODY()
 
public:
 
    UFUNCTION(BlueprintPure, Category = "UMG")
    static UE_API FName GetUserTag(const FWidgetAnimationHandle& Target);
 
    UFUNCTION(BlueprintCallable, Category = "UMG")
    static UE_API void SetUserTag(UPARAM(ref) FWidgetAnimationHandle& Target, FName InUserTag);
};
 
#undef UE_API