Navigation
API > API/Plugins > API/Plugins/PropertyAnimatorCore
Abstract base class for time source used by property animators Can be transient or saved to disk if contains user set data
| Name | UPropertyAnimatorCoreTimeSourceBase |
| Type | class |
| Header File | /Engine/Plugins/VirtualProduction/PropertyAnimatorCore/Source/PropertyAnimatorCore/Public/TimeSources/PropertyAnimatorCoreTimeSourceBase.h |
| Include Path | #include "TimeSources/PropertyAnimatorCoreTimeSourceBase.h" |
Syntax
UCLASS (MinimalAPI, Abstract)
class UPropertyAnimatorCoreTimeSourceBase :
public UObject ,
public IPropertyAnimatorCorePresetable
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UPropertyAnimatorCoreTimeSourceBase
Implements Interfaces
Derived Classes
- UPropertyAnimatorCoreManualTimeSource
- UPropertyAnimatorCoreSequencerTimeSource
- UPropertyAnimatorCoreSystemTimeSource
- UPropertyAnimatorCoreWorldTimeSource
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
| TimeSources/PropertyAnimatorCoreTimeSourceBase.h | |||
UPropertyAnimatorCoreTimeSourceBase
(
const FName& InSourceName |
TimeSources/PropertyAnimatorCoreTimeSourceBase.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bTimeSourceActive | bool | Is this time source active on the animator | TimeSources/PropertyAnimatorCoreTimeSourceBase.h | |
| bUseFrameRate | bool | Use a specific framerate | TimeSources/PropertyAnimatorCoreTimeSourceBase.h |
|
| FrameRate | float | The frame rate to target for the animator effect | TimeSources/PropertyAnimatorCoreTimeSourceBase.h |
|
| LastTimeElapsed | double | Cached time elapsed | TimeSources/PropertyAnimatorCoreTimeSourceBase.h | |
| TimeSourceName | FName | Name used to display this time source to the user | TimeSources/PropertyAnimatorCoreTimeSourceBase.h |
|
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void ActivateTimeSource() |
TimeSources/PropertyAnimatorCoreTimeSourceBase.h | ||
void DeactivateTimeSource() |
TimeSources/PropertyAnimatorCoreTimeSourceBase.h | ||
EPropertyAnimatorCoreTimeSourceResult FetchEvaluationData
(
FPropertyAnimatorCoreTimeSourceEvaluationData& OutEvaluationData |
TimeSources/PropertyAnimatorCoreTimeSourceBase.h | ||
float GetFrameRate() |
TimeSources/PropertyAnimatorCoreTimeSourceBase.h | ||
double GetLastTimeElapsed() |
TimeSources/PropertyAnimatorCoreTimeSourceBase.h | ||
FName GetTimeSourceName() |
TimeSources/PropertyAnimatorCoreTimeSourceBase.h | ||
bool GetUseFrameRate() |
TimeSources/PropertyAnimatorCoreTimeSourceBase.h | ||
bool IsTimeSourceActive() |
TimeSources/PropertyAnimatorCoreTimeSourceBase.h | ||
void SetFrameRate
(
float InFrameRate |
TimeSources/PropertyAnimatorCoreTimeSourceBase.h | ||
void SetUseFrameRate
(
bool bInUseFrameRate |
TimeSources/PropertyAnimatorCoreTimeSourceBase.h |
Overridden from IPropertyAnimatorCorePresetable
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual bool ExportPreset
(
const UPropertyAnimatorCorePresetBase* InPreset, |
Export a specific preset | TimeSources/PropertyAnimatorCoreTimeSourceBase.h | |
virtual bool ImportPreset
(
const UPropertyAnimatorCorePresetBase* InPreset, |
Import a specific preset | TimeSources/PropertyAnimatorCoreTimeSourceBase.h |
Protected
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void OnTimeSourceActive() |
Time source is active on the animator | TimeSources/PropertyAnimatorCoreTimeSourceBase.h | |
virtual void OnTimeSourceInactive() |
Time source is inactive on the animator | TimeSources/PropertyAnimatorCoreTimeSourceBase.h | |
virtual void OnTimeSourceRegistered() |
Time source CDO is registered by subsystem | TimeSources/PropertyAnimatorCoreTimeSourceBase.h | |
virtual void OnTimeSourceUnregistered() |
Time source CDO is unregistered by subsystem | TimeSources/PropertyAnimatorCoreTimeSourceBase.h | |
virtual bool UpdateEvaluationData
(
FPropertyAnimatorCoreTimeSourceEvaluationData& OutData |
Retrieve evaluation data to provide animators, return true if data is valid, false otherwise | TimeSources/PropertyAnimatorCoreTimeSourceBase.h |