1. Epic GamesDeveloper
  3. UWidgetAnimation

UWidgetAnimation

API > API/Runtime > API/Runtime/UMG

   
Name UWidgetAnimation
Type class
Header File /Engine/Source/Runtime/UMG/Public/Animation/WidgetAnimation.h
Include Path #include "Animation/WidgetAnimation.h"

Syntax

UCLASS (BlueprintType, MinimalAPI)  
class UWidgetAnimation : public UMovieSceneSequence

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

UWidgetAnimation ( const FObjectInitializer& ObjectInitializer
)

   Animation/WidgetAnimation.h  

Typedefs

Name Type Remarks Include Path
FFixupWidgetDynamicBindingsEvent TMulticastDelegate_OneParam< void, UWidgetAnimation * >   Animation/WidgetAnimation.h

Constants

Name Type Remarks Include Path
FixupWidgetDynamicBindingsEvent FFixupWidgetDynamicBindingsEvent   Animation/WidgetAnimation.h

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
AnimationBindings TArray< FWidgetAnimationBinding >   Animation/WidgetAnimation.h  
MovieScene TObjectPtr< UMovieScene > Pointer to the movie scene that controls this animation. Animation/WidgetAnimation.h  

Protected

Name Type Remarks Include Path Unreal Specifiers
bLegacyFinishOnStop bool Whether to finish evaluation on stop. Animation/WidgetAnimation.h  
DisplayLabel FString The friendly name for this animation displayed in the designer. Animation/WidgetAnimation.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void BindToAnimationFinished ( UUserWidget* Widget,
FWidgetAnimationDynamicEvent Delegate
)

   Animation/WidgetAnimation.h
  • BlueprintCallable
  • Category=Animation
  • Meta=(BlueprintInternalUseOnly="TRUE")

void BindToAnimationStarted ( UUserWidget* Widget,
FWidgetAnimationDynamicEvent Delegate
)

 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. Animation/WidgetAnimation.h
  • BlueprintCallable
  • Category=Animation
  • Meta=(BlueprintInternalUseOnly="TRUE")

const TArray< FWidgetAnimationBinding > & GetBindings()

 Get Animation bindings of the animation Animation/WidgetAnimation.h  

const FString & GetDisplayLabel()

   Animation/WidgetAnimation.h  

float GetEndTime ()

 Get the end time of this animation. Animation/WidgetAnimation.h
  • BlueprintCallable
  • Category="Animation"

bool GetLegacyFinishOnStop()

 Whether to finish evaluation on stop Animation/WidgetAnimation.h  

float GetStartTime ()

 Get the start time of this animation. Animation/WidgetAnimation.h
  • BlueprintCallable
  • Category="Animation"

void RemoveBinding ( const UObject& PossessedObject
)

 Remove Animation Binding Animation/WidgetAnimation.h  

void RemoveBinding ( const FWidgetAnimationBinding& Binding
)

   Animation/WidgetAnimation.h  

void SetDisplayLabel ( const FString& InDisplayLabel
)

 Sets the friendly name of the animation to display in the editor Animation/WidgetAnimation.h  

void UnbindAllFromAnimationFinished ( UUserWidget* Widget
)

   Animation/WidgetAnimation.h
  • BlueprintCallable
  • Category=Animation
  • Meta=(BlueprintInternalUseOnly="TRUE")

void UnbindAllFromAnimationStarted ( UUserWidget* Widget
)

   Animation/WidgetAnimation.h
  • BlueprintCallable
  • Category=Animation
  • Meta=(BlueprintInternalUseOnly="TRUE")

void UnbindFromAnimationFinished ( UUserWidget* Widget,
FWidgetAnimationDynamicEvent Delegate
)

   Animation/WidgetAnimation.h
  • BlueprintCallable
  • Category=Animation
  • Meta=(BlueprintInternalUseOnly="TRUE")

void UnbindFromAnimationStarted ( UUserWidget* Widget,
FWidgetAnimationDynamicEvent Delegate
)

   Animation/WidgetAnimation.h
  • BlueprintCallable
  • Category=Animation
  • Meta=(BlueprintInternalUseOnly="TRUE")

Overridden from UMovieSceneSequence

Name Remarks Include Path Unreal Specifiers

virtual void BindPossessableObject ( const FGuid& ObjectId,
UObject& PossessedObject,
UObject* Context
)

   Animation/WidgetAnimation.h  

virtual bool CanPossessObject ( UObject& Object,
UObject* InPlaybackContext
) const

   Animation/WidgetAnimation.h  

virtual UObject * CreateDirectorInstance ( TSharedRef< const FSharedPlaybackState > SharedPlaybackState,
FMovieSceneSequenceID SequenceID
)

   Animation/WidgetAnimation.h  

virtual const FSlateBrush * GetCustomBrushForBinding ( FGuid BindingID
) const

   Animation/WidgetAnimation.h  

virtual FText GetDisplayName()

 Returns the DisplayLabel if set, otherwise the object name Animation/WidgetAnimation.h  

virtual UMovieScene * GetMovieScene()

   Animation/WidgetAnimation.h  

virtual UObject * GetParentObject ( UObject* Object
) const

   Animation/WidgetAnimation.h  

virtual bool IsFilterSupportedImpl ( const FString& InFilterName
) const

   Animation/WidgetAnimation.h  

virtual ETrackSupport IsTrackSupportedImpl ( TSubclassOf< class UMovieSceneTrack > InTrackClass
) const

   Animation/WidgetAnimation.h  

virtual void IterateDynamicBindings ( TFunction< void(const FGuid&, FMovieSceneDynamicBinding&)> InCallback
)

   Animation/WidgetAnimation.h  

virtual void LocateBoundObjects ( const FGuid& ObjectId,
const UE::UniversalObjectLocator::FResolveParams& ResolveParams,
TSharedPtr< const FSharedPlaybackState > SharedPlaybackState,
TArray< UObject*, TInlineAllocator< 1 > >& OutObjects
) const

   Animation/WidgetAnimation.h  

virtual void UnbindInvalidObjects ( const FGuid& ObjectId,
UObject* InContext
)

   Animation/WidgetAnimation.h  

virtual void UnbindObjects ( const FGuid& ObjectId,
const TArray< UObject* >& InObjects,
UObject* InContext
)

   Animation/WidgetAnimation.h  

virtual void UnbindPossessableObjects ( const FGuid& ObjectId
)

   Animation/WidgetAnimation.h  

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual bool IsPostLoadThreadSafe()

   Animation/WidgetAnimation.h  

Protected

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual void PostLoad()

 Called after this object has been deserialized Animation/WidgetAnimation.h  

Static

Name Remarks Include Path Unreal Specifiers

static UWidgetAnimation * GetNullAnimation()

 Get a placeholder animation. Animation/WidgetAnimation.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page