Navigation
API > API/Runtime > API/Runtime/UMG > API/Runtime/UMG/Animation
Inheritance Hierarchy
- UObjectBase
- UObjectBaseUtility
- UObject
- UMovieSceneSignedObject
- UMovieSceneSequence
- UWidgetAnimation
References
| Module | UMG |
| Header | /Engine/Source/Runtime/UMG/Public/Animation/WidgetAnimation.h |
| Include | #include "Animation/WidgetAnimation.h" |
Syntax
class UWidgetAnimation : public UMovieSceneSequence
Variables
| Type | Name | Description | |
|---|---|---|---|
| TArray< FWidgetAnimationBinding > | AnimationBindings | ||
| TObjectPtr< UMovieScene > | MovieScene | Pointer to the movie scene that controls this animation. |
Constructors
| Type | Name | Description | |
|---|---|---|---|
UWidgetAnimation
(
const FObjectInitializer& ObjectInitializer |
Functions
| Type | Name | Description | |
|---|---|---|---|
| void | BindToAnimationFinished
(
UUserWidget* Widget, |
||
| void | BindToAnimationStarted
(
UUserWidget* Widget, |
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. | |
| const TArray< FWidgetAnimationBinding > & | GetBindings () |
Get Animation bindings of the animation | |
| const FString & | |||
| float | GetEndTime () |
Get the end time of this animation. | |
| bool | Whether to finish evaluation on stop | ||
| UWidgetAnimation * | Get a placeholder animation. | ||
| float | GetStartTime () |
Get the start time of this animation. | |
| void | RemoveBinding
(
const UObject& PossessedObject |
Remove Animation Binding | |
| void | RemoveBinding
(
const FWidgetAnimationBinding& Binding |
Remove Animation Binding | |
| void | SetDisplayLabel
(
const FString& InDisplayLabel |
Sets the friendly name of the animation to display in the editor | |
| void | UnbindAllFromAnimationFinished
(
UUserWidget* Widget |
||
| void | UnbindAllFromAnimationStarted
(
UUserWidget* Widget |
||
| void | UnbindFromAnimationFinished
(
UUserWidget* Widget, |
||
| void | UnbindFromAnimationStarted
(
UUserWidget* Widget, |
Overridden from UMovieSceneSequence
| Type | Name | Description | |
|---|---|---|---|
| void | BindPossessableObject
(
const FGuid& ObjectId, |
Called when Sequencer has created an object binding for a possessable object | |
| bool | CanPossessObject
(
UObject& Object, |
Check whether the given object can be possessed by this animation. | |
| UObject * | CreateDirectorInstance
(
IMovieScenePlayer& Player, |
Called to retrieve or construct a director instance to be used for the specified player | |
| FText | Returns the DisplayLabel if set, otherwise the object name | ||
| UMovieScene * | Get the movie scene that controls this animation. | ||
| UObject * | GetParentObject
(
UObject* Object |
Get the logical parent object for the supplied object (not necessarily its outer). | |
| ETrackSupport | IsTrackSupported
(
TSubclassOf< class UMovieSceneTrack > InTrackClass |
Sequences can determine whether they support a particular track type | |
| void | LocateBoundObjects
(
const FGuid& ObjectId, |
Locate all the objects that correspond to the specified object ID, using the specified context | |
| void | UnbindInvalidObjects
(
const FGuid& ObjectId, |
Unbinds specific objects from the provided GUID that do not resolve | |
| void | UnbindObjects
(
const FGuid& ObjectId, |
Unbinds specific objects from the provided GUID | |
| void | UnbindPossessableObjects
(
const FGuid& ObjectId |
Unbinds all possessable objects from the provided GUID. |
Overridden from UObject
| Type | Name | Description | |
|---|---|---|---|
| bool | Called during async load to determine if PostLoad can be called on the loading thread. | ||
| void | PostLoad () |
Called after this object has been deserialized |