1. Epic GamesDeveloper
  3. UPropertyAnimatorCoreBase

UPropertyAnimatorCoreBase

Abstract base class for any Animator, holds a set of linked properties

API > API/Plugins > API/Plugins/PropertyAnimatorCore

Abstract base class for any Animator, holds a set of linked properties

   
Name UPropertyAnimatorCoreBase
Type class
Header File /Engine/Plugins/VirtualProduction/PropertyAnimatorCore/Source/PropertyAnimatorCore/Public/Animators/PropertyAnimatorCoreBase.h
Include Path #include "Animators/PropertyAnimatorCoreBase.h"

Syntax

UCLASS (MinimalAPI, Abstract, EditInlineNew, AutoExpandCategories=("Animator"))  
class UPropertyAnimatorCoreBase :  
    public UObject ,  
    public IPropertyAnimatorCorePresetable

Inheritance Hierarchy

Implements Interfaces

Derived Classes

Constructors

Name Remarks Include Path Unreal Specifiers

UPropertyAnimatorCoreBase()

   Animators/PropertyAnimatorCoreBase.h  

Typedefs

Name Type Remarks Include Path
FOnAnimatorPropertyUpdated TMulticastDelegate_TwoParams< void, UPropertyAnimatorCoreBase *, const FPropertyAnimatorCoreData & >   Animators/PropertyAnimatorCoreBase.h
FOnAnimatorUpdated TMulticastDelegate_ThreeParams< void, UPropertyAnimatorCoreComponent *, UPropertyAnimatorCoreBase *, EPropertyAnimatorCoreUpdateEvent >   Animators/PropertyAnimatorCoreBase.h

Constants

Name Type Remarks Include Path
AlphaParameterName const TCHAR *   Animators/PropertyAnimatorCoreBase.h
FrequencyParameterName const TCHAR *   Animators/PropertyAnimatorCoreBase.h
MagnitudeParameterName const TCHAR *   Animators/PropertyAnimatorCoreBase.h
OnAnimatorAddedDelegate FOnAnimatorUpdated Called when a Animator is created Animators/PropertyAnimatorCoreBase.h
OnAnimatorPropertyLinkedDelegate FOnAnimatorPropertyUpdated Called when a property is linked to a Animator Animators/PropertyAnimatorCoreBase.h
OnAnimatorPropertyUnlinkedDelegate FOnAnimatorPropertyUpdated Called when a property is unlinked to a Animator Animators/PropertyAnimatorCoreBase.h
OnAnimatorRemovedDelegate FOnAnimatorUpdated Called when a Animator is removed Animators/PropertyAnimatorCoreBase.h
OnAnimatorRenamedDelegate FOnAnimatorUpdated Called when a Animator is renamed Animators/PropertyAnimatorCoreBase.h
TimeElapsedParameterName const TCHAR *   Animators/PropertyAnimatorCoreBase.h

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
ActiveTimeSource TObjectPtr< UPropertyAnimatorCoreTimeSourceBase > Active time source with its options, determined by its name Animators/PropertyAnimatorCoreBase.h
  • VisibleInstanceOnly
  • Instanced
  • Transient
  • DuplicateTransient
  • Category="Animator"
  • Meta=(EditCondition="bOverrideTimeSource", EditConditionHides, HideEditConditionToggle)
AnimatorDisplayName FName Display name as title property for component array, hide it but must be visible to editor for array title property Animators/PropertyAnimatorCoreBase.h
  • VisibleInstanceOnly
  • Category="Animator"
  • Meta=(EditCondition="false", EditConditionHides)
bAnimatorEnabled bool Enable control of properties linked to this Animator Animators/PropertyAnimatorCoreBase.h
  • EditInstanceOnly
  • Getter="GetAnimatorEnabled"
  • Setter="SetAnimatorEnabled"
  • Category="Animator"
  • Meta=(DisplayPriority="0", AllowPrivateAccess="true")
bEvaluatingProperties bool Are we evaluating properties currently Animators/PropertyAnimatorCoreBase.h  
bOverrideTimeSource bool Use the global time source or override it on this animator Animators/PropertyAnimatorCoreBase.h
  • EditInstanceOnly
  • Setter="SetOverrideTimeSource"
  • Getter="GetOverrideTimeSource"
  • Category="Animator"
  • Meta=(InlineEditConditionToggle)
EvaluatedPropertyValues FInstancedPropertyBag Evaluated property container, reset on every update round Animators/PropertyAnimatorCoreBase.h
  • Transient
  • DuplicateTransient
  • NonTransactional
LinkedProperties TArray< TObjectPtr< UPropertyAnimatorCoreContext > > Context for properties linked to this Animator Animators/PropertyAnimatorCoreBase.h
  • EditInstanceOnly
  • NoClear
  • Export
  • Instanced
  • EditFixedSize
  • Category="Animator"
  • Meta=(EditFixedOrder)
Metadata TSharedPtr< FPropertyAnimatorCoreMetadata > Animator metadata, same for all instances of this class Animators/PropertyAnimatorCoreBase.h  
TimeSourceName FName The time source to use Animators/PropertyAnimatorCoreBase.h
  • EditInstanceOnly
  • Setter
  • Getter
  • Category="Animator"
  • Meta=(GetOptions="GetTimeSourceNames", EditCondition="bOverrideTimeSource", NoResetToDefault)
TimeSources TArray< TObjectPtr< UPropertyAnimatorCoreTimeSourceBase > > Cached time sources used by this animator Animators/PropertyAnimatorCoreBase.h  
TimeSourcesInstances TMap< FName, TObjectPtr< UPropertyAnimatorCoreTimeSourceBase > > The cached time source used by this Animator Animators/PropertyAnimatorCoreBase.h
  • Meta=(DeprecatedProperty, DeprecationMessage="Use TimeSources instead")

Functions

Public

Name Remarks Include Path Unreal Specifiers

bool ForEachLinkedProperty ( TFunctionRef< bool(InContextClass*, const FPropertyAnimatorCoreData&)> InFunction,
bool bInResolve
) const

 Use this to process each linked properties and resolve it, even virtual ones Animators/PropertyAnimatorCoreBase.h  

UPropertyAnimatorCoreTimeSourceBase * GetActiveTimeSource()

 Get the active time source Animators/PropertyAnimatorCoreBase.h  

AActor * GetAnimatorActor()

   Animators/PropertyAnimatorCoreBase.h  

UPropertyAnimatorCoreComponent * GetAnimatorComponent()

   Animators/PropertyAnimatorCoreBase.h  

FName GetAnimatorDisplayName()

   Animators/PropertyAnimatorCoreBase.h  

bool GetAnimatorEnabled()

   Animators/PropertyAnimatorCoreBase.h  

TSharedRef< const FPropertyAnimatorCoreMetadata > GetAnimatorMetadata()

 Gets the animator metadata Animators/PropertyAnimatorCoreBase.h  

TSet< FPropertyAnimatorCoreData > GetInnerPropertiesLinked ( const FPropertyAnimatorCoreData& InPropertyData
) const

 Returns all inner properties that are controlled by this Animator linked to member property Animators/PropertyAnimatorCoreBase.h  

TSet< FPropertyAnimatorCoreData > GetLinkedProperties()

 Get all linked properties within this animator Animators/PropertyAnimatorCoreBase.h  

TConstArrayView< UPropertyAnimatorCoreContext * > GetLinkedPropertiesContext()

   Animators/PropertyAnimatorCoreBase.h  

int32 GetLinkedPropertiesCount()

 Get linked properties count within this animator Animators/PropertyAnimatorCoreBase.h  
Get the context for the linked property Animators/PropertyAnimatorCoreBase.h  

InContextClass * GetLinkedPropertyContext ( const FPropertyAnimatorCoreData& InProperty
) const

 Get the casted context for the linked property Animators/PropertyAnimatorCoreBase.h  

bool GetOverrideTimeSource()

   Animators/PropertyAnimatorCoreBase.h  

bool GetPropertiesSupported ( const FPropertyAnimatorCoreData& InPropertyData,
TSet< FPropertyAnimatorCoreData >& OutProperties,
uint8 InSearchDepth,
EPropertyAnimatorPropertySupport InSupportExpected
) const

 Checks recursively for properties that are supported by this Animator, calls IsPropertySupported to check Stops when the InSearchDepth has been reached otherwise continues to gather supported properties Animators/PropertyAnimatorCoreBase.h  

EPropertyAnimatorPropertySupport GetPropertySupport ( const FPropertyAnimatorCoreData& InPropertyData
) const

 Retrieves the support level of a property Animators/PropertyAnimatorCoreBase.h  

FName GetTimeSourceName()

   Animators/PropertyAnimatorCoreBase.h  

bool HasPropertySupport ( const FPropertyAnimatorCoreData& InPropertyData,
EPropertyAnimatorPropertySupport InSupportExpected
) const

 Checks if a property support is available Animators/PropertyAnimatorCoreBase.h  

bool IsPropertiesLinked ( const TSet< FPropertyAnimatorCoreData >& InProperties
) const

 Checks if this animator is controlling all properties Animators/PropertyAnimatorCoreBase.h  

bool IsPropertyLinked ( const FPropertyAnimatorCoreData& InPropertyData
) const

 Checks if this Animator is controlling this property Animators/PropertyAnimatorCoreBase.h  

virtual EPropertyAnimatorPropertySupport IsPropertySupported ( const FPropertyAnimatorCoreData& InPropertyData
) const

 Override this to check if a property is supported by this animator Animators/PropertyAnimatorCoreBase.h  

virtual bool IsTimeSourceSupported ( UPropertyAnimatorCoreTimeSourceBase* InTimeSource
) const

 Checks whether a time source is supported on this animator Animators/PropertyAnimatorCoreBase.h  

UPropertyAnimatorCoreContext * LinkProperty ( const FPropertyAnimatorCoreData& InLinkProperty
)

 Link property to this Animator to be able to drive it Animators/PropertyAnimatorCoreBase.h  

void SetAnimatorDisplayName ( FName InName
)

 Set the display name of this animator Animators/PropertyAnimatorCoreBase.h  

void SetAnimatorEnabled ( bool bInIsEnabled
)

 Set the state of this animator Animators/PropertyAnimatorCoreBase.h  

void SetOverrideTimeSource ( bool bInOverride
)

   Animators/PropertyAnimatorCoreBase.h  

void SetTimeSourceName ( FName InTimeSourceName
)

 Set the time source name to use Animators/PropertyAnimatorCoreBase.h  

bool UnlinkProperty ( const FPropertyAnimatorCoreData& InUnlinkProperty
)

 Unlink property from this Animator Animators/PropertyAnimatorCoreBase.h  

Overridden from IPropertyAnimatorCorePresetable

Name Remarks Include Path Unreal Specifiers

virtual bool ExportPreset ( const UPropertyAnimatorCorePresetBase* InPreset,
TSharedPtr< FPropertyAnimatorCorePresetArchive >& OutValue
) const

 Export a specific preset Animators/PropertyAnimatorCoreBase.h  

virtual bool ImportPreset ( const UPropertyAnimatorCorePresetBase* InPreset,
const TSharedRef< FPropertyAnimatorCorePresetArchive >& InValue
)

 Import a specific preset Animators/PropertyAnimatorCoreBase.h  

Protected

Name Remarks Include Path Unreal Specifiers

void EvaluateEachLinkedProperty ( TFunctionRef< bool(UPropertyAnimatorCoreContext*, const FPropertyAnimatorCoreData&, FInstanced...
)

 Used to evaluate linked properties, assign the result in the property bag and return true on success to update property value Animators/PropertyAnimatorCoreBase.h  

virtual void EvaluateProperties ( FInstancedPropertyBag& InParameters
)

 Apply animators effect on linked properties Animators/PropertyAnimatorCoreBase.h  

virtual TSubclassOf< UPropertyAnimatorCoreContext > GetPropertyContextClass ( const FPropertyAnimatorCoreData& InProperty
)

 Returns the property context class to use Animators/PropertyAnimatorCoreBase.h  

virtual void OnAnimatorAdded ( EPropertyAnimatorCoreUpdateEvent InType
)

   Animators/PropertyAnimatorCoreBase.h  

virtual void OnAnimatorDisabled ( EPropertyAnimatorCoreUpdateEvent InType
)

   Animators/PropertyAnimatorCoreBase.h  

virtual void OnAnimatorDisplayNameChanged()

   Animators/PropertyAnimatorCoreBase.h  

virtual void OnAnimatorEnabled ( EPropertyAnimatorCoreUpdateEvent InType
)

   Animators/PropertyAnimatorCoreBase.h  

virtual void OnAnimatorRegistered ( FPropertyAnimatorCoreMetadata& InMetadata
)

   Animators/PropertyAnimatorCoreBase.h  

virtual void OnAnimatorRemoved ( EPropertyAnimatorCoreUpdateEvent InType
)

   Animators/PropertyAnimatorCoreBase.h  

virtual void OnPropertyLinked ( UPropertyAnimatorCoreContext* InLinkedProperty,
EPropertyAnimatorPropertySupport InSupport
)

   Animators/PropertyAnimatorCoreBase.h  

virtual void OnPropertyUnlinked ( UPropertyAnimatorCoreContext* InUnlinkedProperty
)

   Animators/PropertyAnimatorCoreBase.h  

virtual void OnTimeSourceChanged()

   Animators/PropertyAnimatorCoreBase.h  

void UpdateAnimatorDisplayName()

 Update display name based on linked properties Animators/PropertyAnimatorCoreBase.h  

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual void BeginDestroy()

   Animators/PropertyAnimatorCoreBase.h  

virtual void PostCDOContruct()

   Animators/PropertyAnimatorCoreBase.h  

virtual void PostDuplicate ( EDuplicateMode::Type InDuplicateMode
)

   Animators/PropertyAnimatorCoreBase.h  

virtual void PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

   Animators/PropertyAnimatorCoreBase.h  

virtual void PostEditImport()

   Animators/PropertyAnimatorCoreBase.h  

virtual void PostEditUndo()

   Animators/PropertyAnimatorCoreBase.h  

virtual void PostLoad()

   Animators/PropertyAnimatorCoreBase.h  

virtual void PreDuplicate ( FObjectDuplicationParameters& InDupParams
)

   Animators/PropertyAnimatorCoreBase.h  

virtual void PreEditChange ( FProperty* InPropertyAboutToChange
)

   Animators/PropertyAnimatorCoreBase.h  

virtual void PreEditUndo()

   Animators/PropertyAnimatorCoreBase.h  

Static

Name Remarks Include Path Unreal Specifiers

static FName GetAnimatorEnabledPropertyName()

   Animators/PropertyAnimatorCoreBase.h  

static FName GetLinkedPropertiesPropertyName()

   Animators/PropertyAnimatorCoreBase.h  

static FOnAnimatorUpdated::RegistrationType & OnPropertyAnimatorAdded()

   Animators/PropertyAnimatorCoreBase.h  

static FOnAnimatorPropertyUpdated::RegistrationType & OnPropertyAnimatorPropertyLinked()

   Animators/PropertyAnimatorCoreBase.h  

static FOnAnimatorPropertyUpdated::RegistrationType & OnPropertyAnimatorPropertyUnlinked()

   Animators/PropertyAnimatorCoreBase.h  

static FOnAnimatorUpdated::RegistrationType & OnPropertyAnimatorRemoved()

   Animators/PropertyAnimatorCoreBase.h  

static FOnAnimatorUpdated::RegistrationType & OnPropertyAnimatorRenamed()

   Animators/PropertyAnimatorCoreBase.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page