1. Epic GamesDeveloper
  3. UPropertyAnimatorCoreSubsystem

UPropertyAnimatorCoreSubsystem

This subsystem handle all property animators

API > API/Plugins > API/Plugins/PropertyAnimatorCore

This subsystem handle all property animators

   
Name UPropertyAnimatorCoreSubsystem
Type class
Header File /Engine/Plugins/VirtualProduction/PropertyAnimatorCore/Source/PropertyAnimatorCore/Public/Subsystems/PropertyAnimatorCoreSubsystem.h
Include Path #include "Subsystems/PropertyAnimatorCoreSubsystem.h"

Syntax

UCLASS ()  
class UPropertyAnimatorCoreSubsystem : public UEngineSubsystem

Inheritance Hierarchy

Typedefs

Name Type Remarks Include Path
FOnAnimatorsSetEnabled TMulticastDelegate_ThreeParams< void, const UWorld *, bool, bool > Delegate to change state of animators in a world Subsystems/PropertyAnimatorCoreSubsystem.h

Constants

Name Type Remarks Include Path
OnAnimatorsSetEnabledDelegate FOnAnimatorsSetEnabled   Subsystems/PropertyAnimatorCoreSubsystem.h

Functions

Public

Name Remarks Include Path Unreal Specifiers

bool ApplyAnimatorPreset ( UPropertyAnimatorCoreBase* InAnimator,
UPropertyAnimatorCorePresetBase* InPreset,
bool bInTransact
)

 Apply a preset on an existing animator Subsystems/PropertyAnimatorCoreSubsystem.h  

TSet< UPropertyAnimatorCoreBase * > CloneAnimators ( const TSet< UPropertyAnimatorCoreBase* >& InAnimators,
AActor* InTargetActor,
bool bInTransact
) const

 Clone animators onto an actor Subsystems/PropertyAnimatorCoreSubsystem.h  

UPropertyAnimatorCoreBase * CreateAnimator ( AActor* InActor,
const UClass* InAnimatorClass,
UPropertyAnimatorCorePresetBase* InPreset,
bool bInTransact
) const

 Create an animator of specific class for an actor Subsystems/PropertyAnimatorCoreSubsystem.h  

TSet< UPropertyAnimatorCoreBase * > CreateAnimators ( const TSet< AActor* >& InActors,
const UClass* InAnimatorClass,
const TSet< UPropertyAnimatorCorePresetBase* >& InPresets,
bool bInTransact
) const

 Create animators of specific class for actors with presets Subsystems/PropertyAnimatorCoreSubsystem.h  

TSet< UPropertyAnimatorCoreBase * > CreateAnimators ( const TSet< AActor* >& InActors,
const UClass* InAnimatorClass,
UPropertyAnimatorCorePresetBase* InPreset,
bool bInTransact
) const

 Create animators of specific class for actors Subsystems/PropertyAnimatorCoreSubsystem.h  

UPropertyAnimatorCoreTimeSourceBase * CreateNewTimeSource ( FName InTimeSourceName,
UObject* InOwner
)

 Create a new time source for an animator Subsystems/PropertyAnimatorCoreSubsystem.h  

FString FindPropertyAlias ( const FString& InPropertyIdentifier
) const

 Finds a property alias registered or none Subsystems/PropertyAnimatorCoreSubsystem.h  

UPropertyAnimatorCoreResolver * FindResolverByClass ( const UClass* InResolverClass
)

   Subsystems/PropertyAnimatorCoreSubsystem.h  

UPropertyAnimatorCoreResolver * FindResolverByName ( FName InResolverName
)

   Subsystems/PropertyAnimatorCoreSubsystem.h  

UPropertyAnimatorCoreBase * GetAnimatorRegistered ( const UClass* InAnimatorClass
) const

 Gets the animator CDO registered from the class Subsystems/PropertyAnimatorCoreSubsystem.h  
Returns a set of property animator CDO that supports that property Subsystems/PropertyAnimatorCoreSubsystem.h  
  Subsystems/PropertyAnimatorCoreSubsystem.h  

TSet< UPropertyAnimatorCorePresetBase * > GetAvailablePresets ( TSubclassOf< UPropertyAnimatorCorePresetBase > InPresetClass
) const

 Get all registered preset available Subsystems/PropertyAnimatorCoreSubsystem.h  

TSet< UPropertyAnimatorCoreBase * > GetExistingAnimators ( const AActor* InActor
) const

   Subsystems/PropertyAnimatorCoreSubsystem.h  
Returns a set of existing property animator objects in owner that supports that property Subsystems/PropertyAnimatorCoreSubsystem.h  

UPropertyAnimatorCoreHandlerBase * GetHandler ( const FPropertyAnimatorCoreData& InPropertyData
) const

 Gets a property handler for this property Subsystems/PropertyAnimatorCoreSubsystem.h  

TSet< UPropertyAnimatorCoreBase * > GetPropertyLinkedAnimators ( const FPropertyAnimatorCoreData& InPropertyData
) const

 Find all animators linked to the property Subsystems/PropertyAnimatorCoreSubsystem.h  

TSet< UPropertyAnimatorCoreConverterBase * > GetSupportedConverters ( const FPropertyBagPropertyDesc& InFromProperty,
const FPropertyBagPropertyDesc& InToProperty
) const

 Finds suitable converters for a type conversion Subsystems/PropertyAnimatorCoreSubsystem.h  

TSet< UPropertyAnimatorCorePresetBase * > GetSupportedPresets ( const AActor* InActor,
const UPropertyAnimatorCoreBase* InAnimator,
TSubclassOf< UPropertyAnimatorCorePresetBase > InPresetClass
) const

 Gets all supported presets for a specific animator and actor Subsystems/PropertyAnimatorCoreSubsystem.h  

UPropertyAnimatorCoreTimeSourceBase * GetTimeSource ( FName InTimeSourceName
) const

 Get a registered time source using its name Subsystems/PropertyAnimatorCoreSubsystem.h  

TArray< FName > GetTimeSourceNames()

 Get all time source names available Subsystems/PropertyAnimatorCoreSubsystem.h  
Get all time sources available Subsystems/PropertyAnimatorCoreSubsystem.h  

bool IsAnimatorClassRegistered ( const UClass* InAnimatorClass
) const

 Checks if the property animator class is already registered Subsystems/PropertyAnimatorCoreSubsystem.h  

bool IsConversionSupported ( const FPropertyBagPropertyDesc& InFromProperty,
const FPropertyBagPropertyDesc& InToProperty
)

 Checks if any converter supports the type conversion Subsystems/PropertyAnimatorCoreSubsystem.h  

bool IsConverterClassRegistered ( const UClass* InConverterClass
)

 Is this converter class registered Subsystems/PropertyAnimatorCoreSubsystem.h  

bool IsHandlerClassRegistered ( const UClass* InHandlerClass
) const

 Checks if the property handler class is already registered Subsystems/PropertyAnimatorCoreSubsystem.h  

bool IsPresetClassRegistered ( const UClass* InPresetClass
) const

 Is this preset class registered Subsystems/PropertyAnimatorCoreSubsystem.h  

bool IsPropertySupported ( const FPropertyAnimatorCoreData& InPropertyData,
bool bInCheckNestedProperties
) const

 Returns true if any animator is able to control that property or nested otherwise false Subsystems/PropertyAnimatorCoreSubsystem.h  

bool IsResolverClassRegistered ( const UClass* InResolverClass
) const

 Is this resolver registered Subsystems/PropertyAnimatorCoreSubsystem.h  

bool IsSetterResolverRegistered ( FName InPropertyName
) const

   Subsystems/PropertyAnimatorCoreSubsystem.h  

bool IsTimeSourceClassRegistered ( UClass* InTimeSourceClass
) const

 Check time source class is registered Subsystems/PropertyAnimatorCoreSubsystem.h  

bool LinkAnimatorProperties ( UPropertyAnimatorCoreBase* InAnimator,
const TSet< FPropertyAnimatorCoreData >& InProperties,
bool bInTransact
)

   Subsystems/PropertyAnimatorCoreSubsystem.h  

bool LinkAnimatorProperty ( UPropertyAnimatorCoreBase* InAnimator,
FPropertyAnimatorCoreData& InProperty,
bool bInTransact
)

 Link a property to an existing animator Subsystems/PropertyAnimatorCoreSubsystem.h  

bool RegisterAnimatorClass ( const UClass* InAnimatorClass
)

 Register the property animator class to allow its usage Subsystems/PropertyAnimatorCoreSubsystem.h  

bool RegisterConverterClass ( const UClass* InConverterClass
)

 Register a converter class Subsystems/PropertyAnimatorCoreSubsystem.h  

bool RegisterHandlerClass ( const UClass* InHandlerClass
)

 Register the property handler class to allow its usage Subsystems/PropertyAnimatorCoreSubsystem.h  

bool RegisterPresetClass ( const UClass* InPresetClass
)

 Register a preset class Subsystems/PropertyAnimatorCoreSubsystem.h  

bool RegisterPropertyAlias ( const FString& InPropertyIdentifier,
const FString& InAliasPropertyName
)

 Registers a property alias by using a property identifier and property name, property identifier should be like Type.InnerType.PropertyName Subsystems/PropertyAnimatorCoreSubsystem.h  

bool RegisterResolverClass ( const UClass* InResolverClass
)

 Register a resolver for custom properties Subsystems/PropertyAnimatorCoreSubsystem.h  

bool RegisterSetterResolver ( FName InPropertyName,
TFunction< UFunction*(const UObject*)>&& InFunction
)

   Subsystems/PropertyAnimatorCoreSubsystem.h  

bool RegisterTimeSourceClass ( UClass* InTimeSourceClass
)

 Register a time source class to control clock for animators Subsystems/PropertyAnimatorCoreSubsystem.h  

bool RemoveAnimator ( UPropertyAnimatorCoreBase* InAnimator,
bool bInTransact
) const

 Removes a animator bound to an owner Subsystems/PropertyAnimatorCoreSubsystem.h  

bool RemoveAnimatorComponents ( const TSet< UPropertyAnimatorCoreComponent* >& InComponents,
bool bInTransact
) const

 Removes animator components from their actor Subsystems/PropertyAnimatorCoreSubsystem.h  

bool RemoveAnimators ( const TSet< UPropertyAnimatorCoreBase* >& InAnimators,
bool bInTransact
) const

 Removes animators from their owner Subsystems/PropertyAnimatorCoreSubsystem.h  

UFunction * ResolveSetter ( FName InPropertyName,
const UObject* InOwner
)

   Subsystems/PropertyAnimatorCoreSubsystem.h  

void SetActorAnimatorsEnabled ( const TSet< AActor* >& InActors,
bool bInEnabled,
bool bInTransact
)

 Set the enabled state of animators attached to actors, will disable state globally on the component Subsystems/PropertyAnimatorCoreSubsystem.h  

void SetAnimatorPropertiesEnabled ( const TSet< UPropertyAnimatorCoreContext* >& InPropertyContexts,
bool bInEnabled,
bool bInTransact
)

 Set the enabled state of animator property context Subsystems/PropertyAnimatorCoreSubsystem.h  

void SetAnimatorsEnabled ( const TSet< UPropertyAnimatorCoreBase* >& InAnimators,
bool bInEnabled,
bool bInTransact
)

 Set the enabled state of animators provided Subsystems/PropertyAnimatorCoreSubsystem.h  

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

 Set the enabled state of animators in a world, will disable state globally on the component Subsystems/PropertyAnimatorCoreSubsystem.h  

bool UnapplyAnimatorPreset ( UPropertyAnimatorCoreBase* InAnimator,
UPropertyAnimatorCorePresetBase* InPreset,
bool bInTransact
)

 Unapply a preset from an existing animator Subsystems/PropertyAnimatorCoreSubsystem.h  

bool UnlinkAnimatorProperties ( const TSet< UPropertyAnimatorCoreContext* >& InPropertyContexts,
bool bInTransact
)

   Subsystems/PropertyAnimatorCoreSubsystem.h  

bool UnlinkAnimatorProperties ( UPropertyAnimatorCoreBase* InAnimator,
const TSet< FPropertyAnimatorCoreData >& InProperties,
bool bInTransact
)

   Subsystems/PropertyAnimatorCoreSubsystem.h  

bool UnlinkAnimatorProperty ( UPropertyAnimatorCoreBase* InAnimator,
FPropertyAnimatorCoreData& InProperty,
bool bInTransact
)

 Unlink a property from an existing animator Subsystems/PropertyAnimatorCoreSubsystem.h  

bool UnregisterAnimatorClass ( const UClass* InAnimatorClass
)

 Unregister the property animator class to disallow its usage Subsystems/PropertyAnimatorCoreSubsystem.h  

bool UnregisterConverterClass ( const UClass* InConverterClass
)

 Unregister a converter class Subsystems/PropertyAnimatorCoreSubsystem.h  

bool UnregisterHandlerClass ( const UClass* InHandlerClass
)

 Unregister the property handler class to disallow its usage Subsystems/PropertyAnimatorCoreSubsystem.h  

bool UnregisterPresetClass ( const UClass* InPresetClass
)

 Unregister a preset class Subsystems/PropertyAnimatorCoreSubsystem.h  

bool UnregisterPropertyAlias ( const FString& InPropertyIdentifier
)

 Unregisters a property alias Subsystems/PropertyAnimatorCoreSubsystem.h  

bool UnregisterResolverClass ( const UClass* InResolverClass
)

 Unregister a resolver Subsystems/PropertyAnimatorCoreSubsystem.h  

bool UnregisterSetterResolver ( FName InPropertyName
)

   Subsystems/PropertyAnimatorCoreSubsystem.h  

bool UnregisterTimeSourceClass ( UClass* InTimeSourceClass
)

 Unregister a time source class Subsystems/PropertyAnimatorCoreSubsystem.h  

Overridden from USubsystem

Name Remarks Include Path Unreal Specifiers

virtual void Deinitialize()

   Subsystems/PropertyAnimatorCoreSubsystem.h  

virtual void Initialize ( FSubsystemCollectionBase& Collection
)

   Subsystems/PropertyAnimatorCoreSubsystem.h  

Protected

Name Remarks Include Path Unreal Specifiers

void OnAssetRegistryAssetAdded ( const FAssetData& InAssetData
)

   Subsystems/PropertyAnimatorCoreSubsystem.h  

void OnAssetRegistryAssetRemoved ( const FAssetData& InAssetData
)

   Subsystems/PropertyAnimatorCoreSubsystem.h  

void OnAssetRegistryAssetUpdated ( const FAssetData& InAssetData
)

   Subsystems/PropertyAnimatorCoreSubsystem.h  

void OnAssetRegistryFilesLoaded()

   Subsystems/PropertyAnimatorCoreSubsystem.h  
Scan for children of each of the following classes and registers their CDO: Subsystems/PropertyAnimatorCoreSubsystem.h  

void RegisterPresetAsset ( const FAssetData& InAssetData
)

   Subsystems/PropertyAnimatorCoreSubsystem.h  

void UnregisterPresetAsset ( const FAssetData& InAssetData
)

   Subsystems/PropertyAnimatorCoreSubsystem.h  

Static

Name Remarks Include Path Unreal Specifiers
Get this subsystem instance Subsystems/PropertyAnimatorCoreSubsystem.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page