UWidgetAnimation

Inheritance Hierarchy

Syntax

class UWidgetAnimation : public UMovieSceneSequence

Variables

Name Description

Public variable

TArray < FWidget ...

 

AnimationBindings

Public variable

UMovieScene ...

 

MovieScene

Pointer to the movie scene that controls this animation.

Constructors

Name Description

Public function

UWidgetAnimation

(
    const FObjectInitializer & ObjectIn...
)

Functions

Name Description

Public function

void

 

BindToAnimationFinished

(
    UUserWidget * Widget,
    FWidgetAnimationDynamicEvent Delega...
)

Public function

void

 

BindToAnimationStarted

(
    UUserWidget * Widget,
    FWidgetAnimationDynamicEvent Delega...
)

These animation binding functions were added so that we could cleanly upgrade assets from before animation sharing, they don't actually modify the animation, they just pipe through to the UUserWidget .

Public function Const

const TArray ...

 

GetBindings()

Get Animation bindings of the animation

Public function Const

const FStrin ...

 

GetDisplayLabel()

Public function Const

float

 

GetEndTime()

Get the end time of this animation.

Public function Const

bool

 

GetLegacyFinishOnStop()

Whether to finish evaluation on stop

Public function Static

UWidgetAnima ...

 

GetNullAnimation()

Get a placeholder animation.

Public function Const

float

 

GetStartTime()

Get the start time of this animation.

Public function

void

 

SetDisplayLabel

(
    const FString & InDisplayLabel
)

Sets the friendly name of the animation to display in the editor

Public function

void

 

UnbindAllFromAnimationFinished

(
    UUserWidget * Widget
)

Public function

void

 

UnbindAllFromAnimationStarted

(
    UUserWidget * Widget
)

Public function

void

 

UnbindFromAnimationFinished

(
    UUserWidget * Widget,
    FWidgetAnimationDynamicEvent Delega...
)

Public function

void

 

UnbindFromAnimationStarted

(
    UUserWidget * Widget,
    FWidgetAnimationDynamicEvent Delega...
)

Overridden from UMovieSceneSequence

Name Description

Public function Virtual

void

 

BindPossessableObject

(
    const FGuid & ObjectId,
    UObject & PossessedObject,
    UObject * Context
)

Called when Sequencer has created an object binding for a possessable object

Public function Virtual Const

bool

 

CanPossessObject

(
    UObject & Object,
    UObject * InPlaybackContext
)

Check whether the given object can be possessed by this animation.

Public function Virtual

UObject *...

 

CreateDirectorInstance

(
    IMovieScenePlayer & Player
)

Called to retrieve or construct a director instance to be used for the specified player

Public function Virtual Const

FText

 

GetDisplayName()

Returns the DisplayLabel if set, otherwise the object name

Public function Virtual Const

UMovieScene ...

 

GetMovieScene()

Get the movie scene that controls this animation.

Public function Virtual Const

UObject *...

 

GetParentObject

(
    UObject * Object
)

Get the logical parent object for the supplied object (not necessarily its outer).

Public function Virtual Const

void

 

LocateBoundObjects

(
    const FGuid & ObjectId,
    UObject * Context,
    TArray < UObject *, TInlineAlloc ...
)

Locate all the objects that correspond to the specified object ID, using the specified context

Public function Virtual

void

 

UnbindPossessableObjects

(
    const FGuid & ObjectId
)

Unbinds all possessable objects from the provided GUID.

Overridden from UObject

Name Description

Public function Virtual Const

bool

 

IsPostLoadThreadSafe()

Called during async load to determine if PostLoad can be called on the loading thread.

Protected function Virtual

void

 

PostLoad()

Called after this object has been deserialized

Deprecated Variables

Name Description

Public variable

FOnWidgetAnimat ...

 

OnAnimationFinished_DEPRECATED

Fires when the widget animation is finished.

Public variable

FOnWidgetAnimat ...

 

OnAnimationStarted_DEPRECATED

Fires when the widget animation starts playing.

References

Module

UMG

Header

Runtime/UMG/Public/Animation/WidgetAnimation.h