1. Epic GamesDeveloper
  3. TAnimatedAttribute

TAnimatedAttribute

Animated Attribute object

API > API/Runtime > API/Runtime/Slate

Animated Attribute object

   
Name TAnimatedAttribute
Type class
Header File /Engine/Source/Runtime/Slate/Public/Framework/Animation/AnimatedAttribute.h
Include Path #include "Framework/Animation/AnimatedAttribute.h"

Syntax

template<typename NumericType>  
class TAnimatedAttribute : public TAnimatedAttributeBase

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers
Default constructor. Framework/Animation/AnimatedAttribute.h  

TAnimatedAttribute ( FPrivateToken,
const InterpolatorSettings& InSettings
)

 Construct only from interpolator settings This is used only for the Create methods and only accessible from there due to the use of a protected FPrivateToken. Framework/Animation/AnimatedAttribute.h  

Structs

Name Remarks
FPrivateToken  

Typedefs

Name Type Remarks Include Path
FGetter TDelegate< NumericType()> Attribute 'getter' delegate  

NumericType GetValue() const | Framework/Animation/AnimatedAttribute.h |

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
DesiredValue TOptional< NumericType > Current value. Framework/Animation/AnimatedAttribute.h  
Getter FGetter Bound member function for this attribute (may be NULL if no function is bound.) When set, all attempts to read the attribute's value will instead call this delegate to generate the value. Framework/Animation/AnimatedAttribute.h  
Interpolator TUniquePtr< TAttributeInterpolator< NumericType > > The attribute's interpolator Framework/Animation/AnimatedAttribute.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void DisableInterpolation()

 Disables the interpolator and returns values in immediate mode Framework/Animation/AnimatedAttribute.h  

void EnableInterpolation ( bool bEnabled
)

 Enables (or disables) the interpolator and returns values in interpolated or immediate mode Framework/Animation/AnimatedAttribute.h  

const NumericType & Get ( const NumericType& DefaultValue
) const

 Gets the attribute's current value. Framework/Animation/AnimatedAttribute.h  

const NumericType & Get ()

 Gets the attribute's current value. Assumes that the attribute is set. Framework/Animation/AnimatedAttribute.h  

TOptional< NumericType > GetDelay()

 Returns the currently set delay on the interpolator Framework/Animation/AnimatedAttribute.h  

const NumericType & GetDesiredValue()

 Returns the desired value this attribute is trying to reach. Framework/Animation/AnimatedAttribute.h  

double GetOverAllDeltaTime()

 Returns the overall deltatime of the interpolator Framework/Animation/AnimatedAttribute.h  

bool IdenticalTo ( const TAnimatedAttribute& InOther
) const

 Is this attribute identical to another TAnimationAttribute. Framework/Animation/AnimatedAttribute.h  

bool IsBound()

 Checks to see if this attribute has a 'getter' function bound Framework/Animation/AnimatedAttribute.h  

bool IsPlaying()

 Returns true if the attribute is currently animating Framework/Animation/AnimatedAttribute.h  

bool IsSet()

 Was this TAnimatedAttribute ever assigned? Framework/Animation/AnimatedAttribute.h  

TAttributeInterpolator< NumericType >::FInterpolatorEvent & OnInterpolationStarted()

 Returns the delegate to react to the interpolator starting to interpolate Framework/Animation/AnimatedAttribute.h  

TAttributeInterpolator< NumericType >::FInterpolatorEvent & OnInterpolationStopped()

 Returns the delegate to react to the interpolator ending to interpolate Framework/Animation/AnimatedAttribute.h  

void Set ( NumericType&& InNewValue
)

 Sets the attribute's value while keeping a running interpolation going. Framework/Animation/AnimatedAttribute.h  

void Set ( const OtherType& InNewValue
)

 Sets the attribute's value while keeping a running interpolation going. Framework/Animation/AnimatedAttribute.h  

void SetDelayOneShot ( double InDelay
)

 Sets the attribute's delay as a one shot Framework/Animation/AnimatedAttribute.h  

void SetTolerance ( double Tolerance
)

 Sets the tolerance of this interpolator Framework/Animation/AnimatedAttribute.h  

void SetValueAndStop ( const NumericType& InNewValue
)

 Sets the attribute's value and disables animation. Framework/Animation/AnimatedAttribute.h  

void SetValueAndStop ( NumericType&& InNewValue
)

 Sets the attribute's value and disables animation. Framework/Animation/AnimatedAttribute.h  

Protected

Static

Name Remarks Include Path Unreal Specifiers

static TSharedRef< TAnimatedAttribute > Create ( const InterpolatorSettings& InSettings,
OtherType&& InInitialValue
)

 Static: Creates an animated attribute implicitly from an initial value Framework/Animation/AnimatedAttribute.h  

static TSharedRef< TAnimatedAttribute > CreateWithGetter ( const InterpolatorSettings& InSettings,
const FGetter& InGetter,
const TOptional< NumericType >& InDefaultValue
)

 Static: Creates an animated attribute that's pre-bound to the specified 'getter' delegate Framework/Animation/AnimatedAttribute.h  

static TSharedRef< TAnimatedAttribute > CreateWithGetter ( const InterpolatorSettings& InSettings,
FGetter&& InGetter,
const TOptional< NumericType >& InDefaultValue
)

 Static: Creates an animated attribute that's pre-bound to the specified 'getter' delegate Framework/Animation/AnimatedAttribute.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page