UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
UE::MovieScene::FDecomposedValue Struct Reference

#include <MovieSceneDecompositionQuery.h>

Classes

struct  FResult
 

Public Member Functions

MOVIESCENE_API double Recompose (FMovieSceneEntityID EntityID, double CurrentValue, const double *InitialValue) const
 

Public Attributes

FResult Result
 
TArray< FWeightedValueAllDecomposedOverrides
 
TArray< TTuple< FMovieSceneEntityID, FWeightedValue > > DecomposedAbsolutes
 
TArray< TTuple< FMovieSceneEntityID, FWeightedValue > > DecomposedAdditives
 
TArray< TTuple< FMovieSceneEntityID, FWeightedValue > > DecomposedOverrides
 

Detailed Description

A structure for holding all the values of channels contributing to an animated property.

Some of these channels are "decomposed", i.e. their values are set aside and matched to the channel entity that produced them. The other channels are mixed together in a non-decomposed result.

Member Function Documentation

◆ Recompose()

double UE::MovieScene::FDecomposedValue::Recompose ( FMovieSceneEntityID  EntityID,
double  CurrentValue,
const double InitialValue 
) const

Get the value that the channel behind the given entity should have in order for the combined blended values of all known channels to produce the desired current value.

Parameters
EntityIDThe entity matching the channel we want to determine the value of
CurrentValueThe desired current value for the overall property animated by the channel (among other channels)
InitialValueAn optional pointer to the initial value of the property
Returns
The value that the entity's channel should have to produce the desired current value

Member Data Documentation

◆ AllDecomposedOverrides

TArray<FWeightedValue> UE::MovieScene::FDecomposedValue::AllDecomposedOverrides
mutable

values for non-decomposed overides, we leave it decomposed

◆ DecomposedAbsolutes

TArray<TTuple<FMovieSceneEntityID, FWeightedValue> > UE::MovieScene::FDecomposedValue::DecomposedAbsolutes

Decomposed values for channels we're interested in. Note that decomposed additives-from-base are lumped with decomposed additives

◆ DecomposedAdditives

TArray<TTuple<FMovieSceneEntityID, FWeightedValue> > UE::MovieScene::FDecomposedValue::DecomposedAdditives

◆ DecomposedOverrides

TArray<TTuple<FMovieSceneEntityID, FWeightedValue> > UE::MovieScene::FDecomposedValue::DecomposedOverrides

◆ Result

FResult UE::MovieScene::FDecomposedValue::Result

The absolute and additive values for all the non-decomposed channels


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