FWidgetAnimationHandle Struct Reference

#include <WidgetAnimationHandle.h>

Public Member Functions
UMG_API	FWidgetAnimationHandle ()
UMG_API FWidgetAnimationState *	GetAnimationState () const
UMG_API TSharedPtr< FWidgetAnimationState >	PinAnimationState () const
UMG_API UUMGSequencePlayer *	GetSequencePlayer () const
	operator UUMGSequencePlayer * () const
UMG_API bool	IsValid () const
UMG_API FName	GetUserTag () const
UMG_API void	SetUserTag (FName InUserTag)

Friends
class	UUserWidget
struct	FWidgetAnimationState
uint32	GetTypeHash (const FWidgetAnimationHandle &Handle)

Detailed Description

Handle to an ongoing or finished widget animation.

Constructor & Destructor Documentation

FWidgetAnimationHandle()

FWidgetAnimationHandle::FWidgetAnimationHandle

(

)

Creates an invalid handle.

Member Function Documentation

GetAnimationState()

FWidgetAnimationState * FWidgetAnimationHandle::GetAnimationState

(

)

const

Gets the animation state.

GetSequencePlayer()

UUMGSequencePlayer * FWidgetAnimationHandle::GetSequencePlayer

(

)

const

GetUserTag()

FName FWidgetAnimationHandle::GetUserTag

(

)

const

Gets the user tag associated with the running animation.

IsValid()

bool FWidgetAnimationHandle::IsValid

(

)

const

Returns whether this handle is valid. A valid handle may still return a null animation state if the animation has finished playing.

operator UUMGSequencePlayer *()

FWidgetAnimationHandle::operator UUMGSequencePlayer * ( ) const

inline

PinAnimationState()

TSharedPtr< FWidgetAnimationState > FWidgetAnimationHandle::PinAnimationState

(

)

const

Gets the animation state.

SetUserTag()

void FWidgetAnimationHandle::SetUserTag

(

FName

InUserTag

)

Sets the user tag associated with the running animation.

Friends And Related Symbol Documentation

FWidgetAnimationState

friend struct FWidgetAnimationState

friend

GetTypeHash

uint32 GetTypeHash ( const FWidgetAnimationHandle &  Handle )

friend

Type hash for using handles in maps and other containers.

UUserWidget

friend class UUserWidget

friend

---

The documentation for this struct was generated from the following files:

• Engine/Source/Runtime/UMG/Public/Animation/WidgetAnimationHandle.h
• Engine/Source/Runtime/UMG/Private/Animation/WidgetAnimationHandle.cpp