1. Epic GamesDeveloper
  3. UPropertyAnimatorCoreComponent

UPropertyAnimatorCoreComponent

A container for controllers that holds properties in this actor

API > API/Plugins > API/Plugins/PropertyAnimatorCore

A container for controllers that holds properties in this actor

   
Name UPropertyAnimatorCoreComponent
Type class
Header File /Engine/Plugins/VirtualProduction/PropertyAnimatorCore/Source/PropertyAnimatorCore/Public/Components/PropertyAnimatorCoreComponent.h
Include Path #include "Components/PropertyAnimatorCoreComponent.h"

Syntax

UCLASS (MinimalAPI, ClassGroup=(Custom), AutoExpandCategories=("Animator"),  
       HideCategories=("Activation", "Cooking", "AssetUserData", "Collision", "Tags", "ComponentReplication", "Navigation", "Variable", "Replication"),  
       Meta=(BlueprintSpawnableComponent))  
class UPropertyAnimatorCoreComponent : public UActorComponent

Inheritance Hierarchy

Implements Interfaces

Constructors

Name Remarks Include Path Unreal Specifiers

UPropertyAnimatorCoreComponent()

   Components/PropertyAnimatorCoreComponent.h  

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
Animators TSet< TObjectPtr< UPropertyAnimatorCoreBase > > Deprecated property set, will be migrated to PropertyAnimators property on load Components/PropertyAnimatorCoreComponent.h  
PropertyAnimatorsInternal TArray< TObjectPtr< UPropertyAnimatorCoreBase > > Transient copy of property animators when changes are detected to see the diff only Components/PropertyAnimatorCoreComponent.h
  • Transient
  • DuplicateTransient
  • TextExportTransient
  • NonTransactional
TimeSources TArray< TObjectPtr< UPropertyAnimatorCoreTimeSourceBase > > Cached time sources used by this animator component Components/PropertyAnimatorCoreComponent.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void ForEachAnimator ( TFunctionRef< bool(UPropertyAnimatorCoreBase*)> InFunction
) const

 Process a function for each controller, stops when false is returned otherwise continue until the end Components/PropertyAnimatorCoreComponent.h  

TConstArrayView< TObjectPtr< UPropertyAnimatorCoreBase > > GetAnimators()

   Components/PropertyAnimatorCoreComponent.h  

UPropertyAnimatorCoreTimeSourceBase * GetAnimatorsActiveTimeSource()

   Components/PropertyAnimatorCoreComponent.h  

int32 GetAnimatorsCount()

   Components/PropertyAnimatorCoreComponent.h  

bool GetAnimatorsEnabled()

   Components/PropertyAnimatorCoreComponent.h  

float GetAnimatorsMagnitude()

   Components/PropertyAnimatorCoreComponent.h  

FName GetAnimatorsTimeSourceName()

   Components/PropertyAnimatorCoreComponent.h  

void SetAnimators ( const TArray< TObjectPtr< UPropertyAnimatorCoreBase > >& InAnimators
)

   Components/PropertyAnimatorCoreComponent.h  

void SetAnimatorsEnabled ( bool bInEnabled
)

 Set the state of all animators in this component Components/PropertyAnimatorCoreComponent.h  

void SetAnimatorsMagnitude ( float InMagnitude
)

 Set the magnitude for all animators in this component Components/PropertyAnimatorCoreComponent.h  

void SetAnimatorsTimeSourceName ( FName InTimeSourceName
)

   Components/PropertyAnimatorCoreComponent.h  

bool ShouldAnimate()

 Checks if this component animators should be active Components/PropertyAnimatorCoreComponent.h  

Protected

Name Remarks Include Path Unreal Specifiers

UPropertyAnimatorCoreBase * AddAnimator ( const UClass* InAnimatorClass
)

 Adds a new animator of that class Components/PropertyAnimatorCoreComponent.h  

InAnimatorClass * AddAnimator ()

 Adds a new controller and returns it casted Components/PropertyAnimatorCoreComponent.h  

UPropertyAnimatorCoreBase * CloneAnimator ( UPropertyAnimatorCoreBase* InAnimator
)

 Clones an existing animator Components/PropertyAnimatorCoreComponent.h  

bool EvaluateAnimators()

 Evaluate only specified animators Components/PropertyAnimatorCoreComponent.h  

UPropertyAnimatorCoreTimeSourceBase * FindOrAddTimeSource ( FName InTimeSourceName
)

 Finds a cached time source with this name or creates a new one Components/PropertyAnimatorCoreComponent.h  

TArray< FName > GetTimeSourceNames()

   Components/PropertyAnimatorCoreComponent.h  

void OnAnimatorsChanged ( EPropertyAnimatorCoreUpdateEvent InType
)

 Callback when PropertyAnimators changed Components/PropertyAnimatorCoreComponent.h  

void OnAnimatorsEnabledChanged ( EPropertyAnimatorCoreUpdateEvent InType
)

 Callback when global enabled state is changed Components/PropertyAnimatorCoreComponent.h  

void OnAnimatorsSetEnabled ( const UWorld* InWorld,
bool bInEnabled,
bool bInTransact
)

 Change global state for animators Components/PropertyAnimatorCoreComponent.h  

void OnTimeSourceNameChanged()

 Callback when global time source name is changed Components/PropertyAnimatorCoreComponent.h  

bool RemoveAnimator ( UPropertyAnimatorCoreBase* InAnimator
)

 Removes an existing animator Components/PropertyAnimatorCoreComponent.h  

Overridden from UActorComponent

Name Remarks Include Path Unreal Specifiers

virtual void OnComponentCreated()

   Components/PropertyAnimatorCoreComponent.h  

virtual void OnComponentDestroyed ( bool bInDestroyingHierarchy
)

   Components/PropertyAnimatorCoreComponent.h  

virtual void TickComponent ( float InDeltaTime,
ELevelTick InTickType,
FActorComponentTickFunction* InTickFunction
)

   Components/PropertyAnimatorCoreComponent.h  

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual void PostDuplicate ( EDuplicateMode::Type InMode
)

   Components/PropertyAnimatorCoreComponent.h  

virtual void PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

   Components/PropertyAnimatorCoreComponent.h  

virtual void PostEditImport()

   Components/PropertyAnimatorCoreComponent.h  

virtual void PostEditUndo()

   Components/PropertyAnimatorCoreComponent.h  

virtual void PostLoad()

   Components/PropertyAnimatorCoreComponent.h  

virtual void PreEditChange ( FProperty* PropertyAboutToChange
)

   Components/PropertyAnimatorCoreComponent.h  

virtual void PreEditUndo()

   Components/PropertyAnimatorCoreComponent.h  

Static

Name Remarks Include Path Unreal Specifiers

static UPropertyAnimatorCoreComponent * FindOrAdd ( AActor* InActor
)

 Create an instance of this component class and adds it to an actor Components/PropertyAnimatorCoreComponent.h  

static FName GetAnimatorName ( const UPropertyAnimatorCoreBase* InAnimator
)

   Components/PropertyAnimatorCoreComponent.h  

static FName GetAnimatorsEnabledPropertyName()

   Components/PropertyAnimatorCoreComponent.h  

static FName GetPropertyAnimatorsPropertyName()

   Components/PropertyAnimatorCoreComponent.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page