1. Epic GamesDeveloper
  3. UPropertyAnimatorCoreContext

UPropertyAnimatorCoreContext

Context for properties linked to an animator

API > API/Plugins > API/Plugins/PropertyAnimatorCore

Context for properties linked to an animator

   
Name UPropertyAnimatorCoreContext
Type class
Header File /Engine/Plugins/VirtualProduction/PropertyAnimatorCore/Source/PropertyAnimatorCore/Public/Properties/PropertyAnimatorCoreContext.h
Include Path #include "Properties/PropertyAnimatorCoreContext.h"

Syntax

UCLASS (MinimalAPI, BlueprintType)  
class UPropertyAnimatorCoreContext :  
    public UObject ,  
    public IPropertyAnimatorCorePresetable

Inheritance Hierarchy

Implements Interfaces

Derived Classes

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
AnimatedProperty FPropertyAnimatorCoreData Animated property linked to this options Properties/PropertyAnimatorCoreContext.h  
bAnimated bool Animation is enabled for this property Properties/PropertyAnimatorCoreContext.h
  • EditInstanceOnly
  • Setter="SetAnimated"
  • Getter="IsAnimated"
  • Category="Animator"
  • Meta=(AllowPrivateAccess="true")
bEditConverterRule bool Edit condition for converter rule Properties/PropertyAnimatorCoreContext.h
  • Transient
bEditMagnitude bool Edit condition for Magnitude Properties/PropertyAnimatorCoreContext.h
  • Transient
bEditMode bool Edit condition for modes Properties/PropertyAnimatorCoreContext.h
  • Transient
bEditResolver bool Edit condition for property resolver Properties/PropertyAnimatorCoreContext.h
  • Transient
bEditTimeOffset bool Edit condition for TimeOffset Properties/PropertyAnimatorCoreContext.h
  • Transient
ConverterClass TSubclassOf< UPropertyAnimatorCoreConverterBase > Converter class used for this property Properties/PropertyAnimatorCoreContext.h  
ConverterRule TInstancedStruct< FPropertyAnimatorCoreConverterRuleBase > If a converter is used, rules may be used to convert the property Properties/PropertyAnimatorCoreContext.h
  • EditInstanceOnly
  • Category="Animator"
  • NoClear
  • Meta=(HideEditConditionToggle, EditCondition="bEditConverterRule", EditConditionHides, AllowPrivateAccess="true")
DeltaPropertyValues FInstancedPropertyBag Store delta property values for resolved properties Properties/PropertyAnimatorCoreContext.h
  • NonTransactional
HandlerWeak TWeakObjectPtr< UPropertyAnimatorCoreHandlerBase > Used to access property value and update it Properties/PropertyAnimatorCoreContext.h
  • Transient
Magnitude float Magnitude of the effect on this property Properties/PropertyAnimatorCoreContext.h
  • EditInstanceOnly
  • Setter
  • Getter
  • Category="Animator"
  • Meta=(ClampMin="0.0", ClampMax="1.0", HideEditConditionToggle, EditCondition="bEditMagnitude", EditConditionHides, AllowPrivateAccess="true")
Mode EPropertyAnimatorCoreMode Current mode used for this property Properties/PropertyAnimatorCoreContext.h
  • EditInstanceOnly
  • Setter
  • Getter
  • Category="Animator"
  • Meta=(HideEditConditionToggle, EditCondition="bEditMode", EditConditionHides, AllowPrivateAccess="true")
OriginalPropertyValues FInstancedPropertyBag Store original property values for resolved properties Properties/PropertyAnimatorCoreContext.h
  • NonTransactional
Resolver TObjectPtr< UPropertyAnimatorCoreResolver > Custom resolver for the property Properties/PropertyAnimatorCoreContext.h
  • VisibleInstanceOnly
  • NoClear
  • Export
  • Instanced
  • DisplayName="Range"
  • Category="Animator"
  • Meta=(EditCondition="bEditResolver", EditConditionHides, HideEditConditionToggle, AllowPrivateAccess="true")
TimeOffset double Time offset to evaluate this property Properties/PropertyAnimatorCoreContext.h
  • EditInstanceOnly
  • Setter
  • Getter
  • Category="Animator"
  • Meta=(Units=Seconds, HideEditConditionToggle, EditCondition="bEditTimeOffset", EditConditionHides, AllowPrivateAccess="true")

Functions

Public

Name Remarks Include Path Unreal Specifiers

virtual bool EvaluateProperty ( const FPropertyAnimatorCoreData& InProperty,
const FInstancedPropertyBag& InAnimatorResult,
FInstancedPropertyBag& OutEvaluatedValues
)

 Evaluates a property within this context based on animator result Properties/PropertyAnimatorCoreContext.h  

const FPropertyAnimatorCoreData & GetAnimatedProperty()

   Properties/PropertyAnimatorCoreContext.h  

UPropertyAnimatorCoreBase * GetAnimator()

   Properties/PropertyAnimatorCoreContext.h  
  Properties/PropertyAnimatorCoreContext.h  

InRuleType * GetConverterRule()

 Get converter rule if any Properties/PropertyAnimatorCoreContext.h  
Get the handler responsible for this property type Properties/PropertyAnimatorCoreContext.h  

float GetMagnitude()

   Properties/PropertyAnimatorCoreContext.h  
  Properties/PropertyAnimatorCoreContext.h  
Get the active resolver for this property if any Properties/PropertyAnimatorCoreContext.h  

double GetTimeOffset()

   Properties/PropertyAnimatorCoreContext.h  

bool IsAnimated()

   Properties/PropertyAnimatorCoreContext.h  

bool ResolvePropertyOwner ( AActor* InNewOwner
)

 Called when the owner has changed and we want to update the animated property Properties/PropertyAnimatorCoreContext.h  

void SetAnimated ( bool bInAnimated
)

   Properties/PropertyAnimatorCoreContext.h  

void SetConverterClass ( const TSubclassOf< UPropertyAnimatorCoreConverterBase >& InConverterClass
)

   Properties/PropertyAnimatorCoreContext.h  

void SetMagnitude ( float InMagnitude
)

   Properties/PropertyAnimatorCoreContext.h  

void SetMode ( EPropertyAnimatorCoreMode InMode
)

   Properties/PropertyAnimatorCoreContext.h  

void SetTimeOffset ( double InOffset
)

   Properties/PropertyAnimatorCoreContext.h  

Overridden from IPropertyAnimatorCorePresetable

Name Remarks Include Path Unreal Specifiers

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

 Export a specific preset Properties/PropertyAnimatorCoreContext.h  

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

 Import a specific preset Properties/PropertyAnimatorCoreContext.h  

Protected

Name Remarks Include Path Unreal Specifiers

virtual void OnAnimatedPropertyLinked()

 Called once, when the property is linked to this context Properties/PropertyAnimatorCoreContext.h  

virtual void OnAnimatedPropertyOwnerUpdated ( UObject* InPreviousOwner,
UObject* InNewOwner
)

 Called when the animated property owner is updated Properties/PropertyAnimatorCoreContext.h  

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual void PostEditChangeProperty ( FPropertyChangedEvent& InPropertyChangedEvent
)

   Properties/PropertyAnimatorCoreContext.h  

virtual void PostLoad()

   Properties/PropertyAnimatorCoreContext.h  

virtual void PreEditChange ( FProperty* InPropertyAboutToChange
)

   Properties/PropertyAnimatorCoreContext.h  

Static

Name Remarks Include Path Unreal Specifiers

static FName GetAnimatedPropertyName()

   Properties/PropertyAnimatorCoreContext.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page