UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
Classes | Public Types | Public Member Functions | Public Attributes | List of all members
TBlendableToken< DataType > Struct Template Reference

#include <BlendableToken.h>

Public Types

typedef TBlendableTokenTraits< DataType >::WorkingDataType WorkingDataType
 

Public Member Functions

 TBlendableToken ()=default
 
template<typename T >
 TBlendableToken (T &&InValue, EMovieSceneBlendType InBlendType, float InWeight=1.f, int32 InBlendingOrder=INDEX_NONE)
 
template<typename T >
 TBlendableToken (T &&InValue, const FMovieSceneEvaluationScope &InCurrentScope, const FMovieSceneContext &InContext, EMovieSceneBlendType InBlendType, float InWeight=1.f, int32 InBlendingOrder=INDEX_NONE)
 
 TBlendableToken (const TBlendableToken &)=delete
 
TBlendableToken & operator= (const TBlendableToken &)=delete
 
 TBlendableToken (TBlendableToken &&)=default
 
TBlendableToken & operator= (TBlendableToken &&)=default
 
void AddTo (WorkingDataType &CumulativeBlend, TMovieSceneInitialValueStore< DataType > &InitialValueStore) const
 
bool operator< (const TBlendableToken &RHS) const
 

Public Attributes

FMovieSceneEvaluationScope AnimatingScope
 
int32 HierarchicalBias
 
float Weight
 
EMovieSceneBlendType BlendType
 
int32 BlendingOrder = INDEX_NONE
 

Detailed Description

template<typename DataType>
struct TBlendableToken< DataType >

Templated structure that encapsulates any blendable data type, and the information required to blend it

Member Typedef Documentation

◆ WorkingDataType

template<typename DataType >
typedef TBlendableTokenTraits<DataType>::WorkingDataType TBlendableToken< DataType >::WorkingDataType

Constructor & Destructor Documentation

◆ TBlendableToken() [1/5]

template<typename DataType >
TBlendableToken< DataType >::TBlendableToken ( )
default

Default construction

◆ TBlendableToken() [2/5]

template<typename DataType >
template<typename T >
TBlendableToken< DataType >::TBlendableToken ( T &&  InValue,
EMovieSceneBlendType  InBlendType,
float  InWeight = 1.f,
int32  InBlendingOrder = INDEX_NONE 
)
inline

Construction from a value, blend method, and a weight. Scope and bias to be populated later

◆ TBlendableToken() [3/5]

template<typename DataType >
template<typename T >
TBlendableToken< DataType >::TBlendableToken ( T &&  InValue,
const FMovieSceneEvaluationScope &  InCurrentScope,
const FMovieSceneContext &  InContext,
EMovieSceneBlendType  InBlendType,
float  InWeight = 1.f,
int32  InBlendingOrder = INDEX_NONE 
)
inline

Construction from a value, scope, context, blend method, and a weight

◆ TBlendableToken() [4/5]

template<typename DataType >
TBlendableToken< DataType >::TBlendableToken ( const TBlendableToken< DataType > &  )
delete

Copying is disabled

◆ TBlendableToken() [5/5]

template<typename DataType >
TBlendableToken< DataType >::TBlendableToken ( TBlendableToken< DataType > &&  )
default

Move construction/assignment

Member Function Documentation

◆ AddTo()

template<typename DataType >
void TBlendableToken< DataType >::AddTo ( WorkingDataType &  CumulativeBlend,
TMovieSceneInitialValueStore< DataType > &  InitialValueStore 
) const
inline

Add this value into the specified cumulative blend

Parameters
CumulativeBlendThe working structure to add our value onto

◆ operator<()

template<typename DataType >
bool TBlendableToken< DataType >::operator< ( const TBlendableToken< DataType > &  RHS) const
inline

◆ operator=() [1/2]

template<typename DataType >
TBlendableToken & TBlendableToken< DataType >::operator= ( const TBlendableToken< DataType > &  )
delete

◆ operator=() [2/2]

template<typename DataType >
TBlendableToken & TBlendableToken< DataType >::operator= ( TBlendableToken< DataType > &&  )
default

Member Data Documentation

◆ AnimatingScope

template<typename DataType >
FMovieSceneEvaluationScope TBlendableToken< DataType >::AnimatingScope

The scope from which this token was generated. Used for restoring pre-animated state where necessary.

◆ BlendingOrder

template<typename DataType >
int32 TBlendableToken< DataType >::BlendingOrder = INDEX_NONE

Opitonal Blending Order, if present will be used to sort additives and override blend types

◆ BlendType

template<typename DataType >
EMovieSceneBlendType TBlendableToken< DataType >::BlendType

Enumeration specifying how this token should be blended

◆ HierarchicalBias

template<typename DataType >
int32 TBlendableToken< DataType >::HierarchicalBias

The hierarchical bias for this template instance

◆ Weight

template<typename DataType >
float TBlendableToken< DataType >::Weight

Weight to apply to the value

The documentation for this struct was generated from the following file: