Navigation
API > API/Runtime > API/Runtime/Slate > API/Runtime/Slate/Framework > API/Runtime/Slate/Framework/Animation
Inheritance Hierarchy
- TAttributeInterpolator
- TArriveAttributeInterpolator
- TEasingAttributeInterpolator
- TVerletAttributeInterpolator
References
| Module | Slate |
| Header | /Engine/Source/Runtime/Slate/Public/Framework/Animation/AttributeInterpolator.h |
| Include | #include "Framework/Animation/AttributeInterpolator.h" |
Syntax
template<typename NumericType>
class TAttributeInterpolator
Remarks
Attribute Interpolator Base Class
Variables
| Type | Name | Description | |
|---|---|---|---|
| bool | bEnabled | ||
| TOptional< float > | Delay | ||
| TOptional< NumericType > | DesiredValue | ||
| TOptional< NumericType > | InterpolatedValue | ||
| FInterpolatorEvent | InterpolationStarted | ||
| FInterpolatorEvent | InterpolationStopped | ||
| TOptional< NumericType > | LastValue | ||
| TOptional< float > | OverallDeltaTime | ||
| float | Tolerance |
Constructors
| Type | Name | Description | |
|---|---|---|---|
| Default constructor |
Destructors
| Type | Name | Description | |
|---|---|---|---|
| Default destructor |
Functions
| Type | Name | Description | |
|---|---|---|---|
| bool | Equals
(
const float& InA, |
||
| bool | Equals
(
const double& InA, |
||
| bool | Equals
(
const NumericType& InA, |
Helper function to compare to values - to allow to specialize per type as needed | |
| const NumericType & | Get () |
Returns the interpolated value | |
| double | Returns the delta time between the start of the animation and now | ||
| bool | IdenticalTo
(
const TAttributeInterpolator* InOther |
Compares this interpolator to another one | |
| void | Interpolate () |
Interpolates the internal value against the new value This method is expected to set the Value member | |
| bool | IsEnabled () |
Returns true if the interpolator is enabled | |
| bool | IsPlaying () |
Returns true if this interpolator is currently playing. | |
| bool | IsSet () |
Returns true if this interpolator's value has even been set | |
| bool | IsTypeOf
(
EAttributeInterpolatorType InType |
Returns true if the interpolator is of a given type | |
| FInterpolatorEvent & | Returns the delegate to react to the interpolator starting to interpolate | ||
| FInterpolatorEvent & | Returns the delegate to react to the interpolator ending to interpolate | ||
| bool | |||
| void | Reset () |
Resets the interpolator | |
| bool | Restart () |
Restart the animation | |
| void | SetDelayOneShot
(
float InDelay |
Sets the delay for the next shot - delays are consumed and only used once | |
| void | SetEnabled
(
bool InEnabled |
Enables (or disables) the interpolator | |
| void | SetTolerance
(
float InTolerance |
Sets the tolerance on this interpolator | |
| void | SetValue
(
const NumericType& InValue |
Set the internal state of the interpolator | |
| void | SetValueAndStop
(
const NumericType& InValue |
Set the internal state of the interpolator and disables animation | |
| bool | Start () |
Starts the animation and records time. | |
| bool | Stop () |
Stops the animation and stops recording time. | |
| void | Tick
(
float InDeltaTime |
Updates the interpolator |
Typedefs
| Name | Description |
|---|---|
| FInterpolatorEvent |