Navigation
API > API/Plugins > API/Plugins/PropertyAnimator > API/Plugins/PropertyAnimator/Animators
Inheritance Hierarchy
- UObject
- IPropertyAnimatorCorePresetable
- UPropertyAnimatorCoreBase
- UPropertyAnimatorNumericBase
- UPropertyAnimatorBounce
- UPropertyAnimatorCurve
- UPropertyAnimatorOscillate
- UPropertyAnimatorPulse
- UPropertyAnimatorSoundWave
- UPropertyAnimatorTime
- UPropertyAnimatorWiggle
References
| Module | PropertyAnimator |
| Header | /Engine/Plugins/Experimental/PropertyAnimator/Source/PropertyAnimator/Public/Animators/PropertyAnimatorNumericBase.h |
| Include | #include "Animators/PropertyAnimatorNumericBase.h" |
Syntax
UCLASS (MinimalAPI, Abstract, AutoExpandCategories=("Animator"))
class UPropertyAnimatorNumericBase : public UPropertyAnimatorCoreBase
Remarks
Animate supported numeric properties with various options
Variables
| Type | Name | Description | |
|---|---|---|---|
| bool | bRandomTimeOffset | Use random time offset to add variation in animation | |
| float | CycleDuration | Duration of one cycle for the effect = period of the effect | |
| float | CycleGapDuration | Time gap between each cycle | |
| EPropertyAnimatorCycleMode | CycleMode | Cycle mode for the effect | |
| float | Magnitude | Magnitude for the effect on all properties | |
| int32 | Seed | Seed to generate per property time offset |
Functions
| Type | Name | Description | |
|---|---|---|---|
| bool | EvaluateProperty
(
const FPropertyAnimatorCoreData& InPropertyData, |
Evaluate and return float value for a property | |
| float | |||
| float | |||
| EPropertyAnimatorCycleMode | GetCycleMode () |
||
| float | GetMagnitude () |
||
| bool | |||
| int32 | GetSeed () |
||
| void | |||
| void | |||
| void | |||
| void | |||
| void | SetCycleDuration
(
float InCycleDuration |
||
| void | SetCycleGapDuration
(
float InCycleGap |
||
| void | SetCycleMode
(
EPropertyAnimatorCycleMode InMode |
||
| void | SetMagnitude
(
float InMagnitude |
||
| void | SetRandomTimeOffset
(
bool bInOffset |
||
| void |
Overridden from UPropertyAnimatorCoreBase
| Type | Name | Description | |
|---|---|---|---|
| void | EvaluateProperties
(
FInstancedPropertyBag& InParameters |
Apply animators effect on linked properties | |
| TSubclassOf< UPropertyAnimatorCoreContext > | GetPropertyContextClass
(
const FPropertyAnimatorCoreData& InProperty |
Returns the property context class to use | |
| EPropertyAnimatorPropertySupport | IsPropertySupported
(
const FPropertyAnimatorCoreData& InPropertyData |
Override this to check if a property is supported by this animator | |
| bool | IsTimeSourceSupported
(
UPropertyAnimatorCoreTimeSourceBase* InTimeSource |
Checks whether a time source is supported on this animator | |
| void | OnAnimatorRegistered
(
FPropertyAnimatorCoreMetadata& InMetadata |
||
| void | OnPropertyLinked
(
UPropertyAnimatorCoreContext* InLinkedProperty, |
||
| void | PostEditChangeProperty
(
FPropertyChangedEvent& InPropertyChangedEvent |
Overridden from IPropertyAnimatorCorePresetable
| Type | Name | Description | |
|---|---|---|---|
| bool | ExportPreset
(
const UPropertyAnimatorCorePresetBase* InPreset, |
Export a specific preset | |
| bool | ImportPreset
(
const UPropertyAnimatorCorePresetBase* InPreset, |
Import a specific preset |