UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
TBlendableTokenStack< DataType > Struct Template Reference

#include <BlendableTokenStack.h>

+ Inheritance diagram for TBlendableTokenStack< DataType >:

Public Member Functions

 TBlendableTokenStack ()
 
void AddToken (const TBlendableToken< DataType > *TokenToAdd)
 
virtual void ComputeAndActuate (UObject *InObject, FMovieSceneBlendingAccumulator &Accumulator, FMovieSceneBlendingActuatorID InActuatorType, const FMovieSceneContext &Context, FPersistentEvaluationData &PersistentData, IMovieScenePlayer &Player) override final
 
virtual void Interrogate (UObject *AnimatedObject, FMovieSceneInterrogationData &InterrogationData, FMovieSceneBlendingAccumulator &Accumulator, FMovieSceneBlendingActuatorID ActuatorTypeID, const FMovieSceneContext &Context) override final
 
template<typename... T>
void SavePreAnimatedStateForAllEntities (IMovieScenePlayer &Player, T &&... Args) const
 
template<typename... T>
void SavePreAnimatedState (IMovieScenePlayer &Player, T &&... Args) const
 
- Public Member Functions inherited from IBlendableTokenStack
virtual ~IBlendableTokenStack ()
 

Public Attributes

TArray< const TBlendableToken< DataType > * > Tokens
 
int32 CurrentBias
 
- Public Attributes inherited from IBlendableTokenStack
FMovieSceneAnimTypeID DataTypeID
 

Additional Inherited Members

- Protected Member Functions inherited from IBlendableTokenStack
 IBlendableTokenStack (FMovieSceneAnimTypeID InDataTypeID)
 

Detailed Description

template<typename DataType>
struct TBlendableTokenStack< DataType >

Implementation of a blendable token stack for any given data type

Constructor & Destructor Documentation

◆ TBlendableTokenStack()

template<typename DataType >
TBlendableTokenStack< DataType >::TBlendableTokenStack ( )
inline

Member Function Documentation

◆ AddToken()

template<typename DataType >
void TBlendableTokenStack< DataType >::AddToken ( const TBlendableToken< DataType > *  TokenToAdd)
inline

Conditionally add a token to this stack if it has a >= hierarchical bias, removing anything of a lower bias

Parameters
TokenToAddThe token to add

◆ ComputeAndActuate()

template<typename DataType >
void TBlendableTokenStack< DataType >::ComputeAndActuate ( UObject InObject,
FMovieSceneBlendingAccumulator Accumulator,
FMovieSceneBlendingActuatorID  InActuatorType,
const FMovieSceneContext Context,
FPersistentEvaluationData PersistentData,
IMovieScenePlayer Player 
)
finaloverridevirtual

Implemented by typed stacks to compute the final blended value for its data, and apply that result to the specified object

Parameters
InObjectThe object to apply the result to. Nullptr for root track data.
AccumulatorThe accumulator that was used to gather and consolidate the blendable tokens
ActuatorTypeIDA unique identifier to the actuator that should be used to apply the result to the object
ContextRoot-level movie scene evaluation context for the current frame
PersistentDataPersistent data store for the evaluation
PlayerThe player that is responsible for playing back the sequence

Definition needs to exist after the definition of FMovieSceneBlendingAccumulator

Implements IBlendableTokenStack.

◆ Interrogate()

template<typename DataType >
void TBlendableTokenStack< DataType >::Interrogate ( UObject AnimatedObject,
FMovieSceneInterrogationData InterrogationData,
FMovieSceneBlendingAccumulator Accumulator,
FMovieSceneBlendingActuatorID  ActuatorTypeID,
const FMovieSceneContext Context 
)
finaloverridevirtual

Implemented by typed stacks to interrogate the final blended value for its data.

Parameters
AnimatedObjectThe object that the value should be interrogated for
InterrogationDataThe interrogation data to populate
AccumulatorThe accumulator that was used to gather and consolidate the blendable tokens
ActuatorTypeIDA unique identifier to the actuator that should be used to apply the result to the object
ContextRoot-level movie scene evaluation context for the current frame

Implements IBlendableTokenStack.

◆ SavePreAnimatedState()

template<typename DataType >
template<typename... T>
void TBlendableTokenStack< DataType >::SavePreAnimatedState ( IMovieScenePlayer Player,
T &&...  Args 
) const
inline

Helper function for saving pre-animated state for all entites that want RestoreState and relate to the current token stack.

Parameters
PlayerThe movie scene player that's playing back the sequence
ArgsVariable arguments that are forwarded to IMovieScenePlayer::SavePreAnimatedState

◆ SavePreAnimatedStateForAllEntities()

template<typename DataType >
template<typename... T>
void TBlendableTokenStack< DataType >::SavePreAnimatedStateForAllEntities ( IMovieScenePlayer Player,
T &&...  Args 
) const
inline

Helper function for saving pre-animated state for all entites that contributed to this stack, regardless of whether they want restore state or not

Parameters
PlayerThe movie scene player that's playing back the sequence
ArgsVariable arguments that are forwarded to IMovieScenePlayer::SavePreAnimatedState

Member Data Documentation

◆ CurrentBias

template<typename DataType >
int32 TBlendableTokenStack< DataType >::CurrentBias

The highest encountered hierarchical bias

◆ Tokens

template<typename DataType >
TArray<const TBlendableToken<DataType>*> TBlendableTokenStack< DataType >::Tokens

This stack's typed blendable tokens


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