1. Epic GamesDeveloper
  3. TAnimatedAttribute

TAnimatedAttribute

Animated Attribute object

API > API/Runtime > API/Runtime/Slate > API/Runtime/Slate/Framework > API/Runtime/Slate/Framework/Animation

Inheritance Hierarchy

References

   
Module Slate
Header /Engine/Source/Runtime/Slate/Public/Framework/Animation/AnimatedAttribute.h
Include #include "Framework/Animation/AnimatedAttribute.h"

Syntax

template<typename NumericType>  
class TAnimatedAttribute : public TAnimatedAttributeBase

Remarks

Animated Attribute object

Constructors

  Type Name Description
Protected function   Default constructor.
Public function  

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.

Functions

  Type Name Description
Public function Static TSharedRef< TAnimatedAttribute >

Create ( const InterpolatorSettings& InSettings,
OtherType&& InInitialValue
)

 Static: Creates an animated attribute implicitly from an initial value
Public function 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
Public function 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
Public function void Disables the interpolator and returns values in immediate mode
Public function void

EnableInterpolation ( bool bEnabled
)

 Enables (or disables) the interpolator and returns values in interpolated or immediate mode
Public function Const const NumericType &

Get ( const NumericType& DefaultValue
)

 Gets the attribute's current value.
Public function Const const NumericType &

Get ()

 Gets the attribute's current value. Assumes that the attribute is set.
Public function Const TOptional< NumericType > Returns the currently set delay on the interpolator
Public function Const const NumericType & Returns the desired value this attribute is trying to reach.
Public function Const double Returns the overall deltatime of the interpolator
Public function Const bool

IdenticalTo ( const TAnimatedAttribute& InOther
)

 Is this attribute identical to another TAnimationAttribute.
Public function Const bool

IsBound ()

 Checks to see if this attribute has a 'getter' function bound
Public function Const bool Returns true if the attribute is currently animating
Public function Const bool

IsSet ()

 Was this TAnimatedAttribute ever assigned?
Public function TAttributeInterpolator< NumericType >::FInterpolatorEvent & Returns the delegate to react to the interpolator starting to interpolate
Public function TAttributeInterpolator< NumericType >::FInterpolatorEvent & Returns the delegate to react to the interpolator ending to interpolate
Public function void

Set ( const OtherType& InNewValue
)

 Sets the attribute's value while keeping a running interpolation going.
Public function void

Set ( NumericType&& InNewValue
)

 Sets the attribute's value while keeping a running interpolation going.
Public function void

SetDelayOneShot ( double InDelay
)

 Sets the attribute's delay as a one shot
Public function void

SetTolerance ( double Tolerance
)

 Sets the tolerance of this interpolator
Public function void

SetValueAndStop ( const NumericType& InNewValue
)

 Sets the attribute's value and disables animation.
Public function void

SetValueAndStop ( NumericType&& InNewValue
)

 Sets the attribute's value and disables animation.

Classes

  Type Name Description
Protected struct FPrivateToken    

Typedefs

Name Description
FGetter Attribute 'getter' delegateNumericType GetValue() const

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page