UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
UE::MovieScene::TMultiChannelValue< T, N > Struct Template Reference

#include <MovieSceneMultiChannelBlending.h>

Public Member Functions

 TMultiChannelValue ()
 
template<typename OtherType >
 TMultiChannelValue (std::initializer_list< OtherType > InitList)
 
operator[] (uint8 Index) const
 
Get (uint8 Index, T Default) const
 
bool IsEmpty () const
 
bool IsFull () const
 
bool IsSet (uint8 Index) const
 
void Set (uint8 Index, T Value)
 
void Increment (uint8 Index, T Value)
 
void WeightedBlend (uint8 Index, T Value, float Weight)
 

Detailed Description

template<typename T, uint8 N>
struct UE::MovieScene::TMultiChannelValue< T, N >

Generic value type that supports a specific number of channels, optionally masked out. Used for blending types that can be represented as a contiguous set of numeric values. Relative, Weighted and Additive blending occurs on a per-channel basis

Constructor & Destructor Documentation

◆ TMultiChannelValue() [1/2]

template<typename T , uint8 N>
UE::MovieScene::TMultiChannelValue< T, N >::TMultiChannelValue ( )
inline

Default Constructor

◆ TMultiChannelValue() [2/2]

template<typename T , uint8 N>
template<typename OtherType >
UE::MovieScene::TMultiChannelValue< T, N >::TMultiChannelValue ( std::initializer_list< OtherType InitList)
inline

Construction from a set of values. List size must match the number of channels.

Member Function Documentation

◆ Get()

template<typename T , uint8 N>
T UE::MovieScene::TMultiChannelValue< T, N >::Get ( uint8  Index,
Default 
) const
inline

Access a value with a default

◆ Increment()

template<typename T , uint8 N>
void UE::MovieScene::TMultiChannelValue< T, N >::Increment ( uint8  Index,
Value 
)
inline

Increment the channel at the specified index by the specified amount

◆ IsEmpty()

template<typename T , uint8 N>
bool UE::MovieScene::TMultiChannelValue< T, N >::IsEmpty ( ) const
inline

Check if this value is empty

◆ IsFull()

template<typename T , uint8 N>
bool UE::MovieScene::TMultiChannelValue< T, N >::IsFull ( ) const
inline

Check if every channel in this value is valid

◆ IsSet()

template<typename T , uint8 N>
bool UE::MovieScene::TMultiChannelValue< T, N >::IsSet ( uint8  Index) const
inline

Check whether the specified channel index is enabled

◆ operator[]()

template<typename T , uint8 N>
T UE::MovieScene::TMultiChannelValue< T, N >::operator[] ( uint8  Index) const
inline

Array indexing operator - returns a channel value

◆ Set()

template<typename T , uint8 N>
void UE::MovieScene::TMultiChannelValue< T, N >::Set ( uint8  Index,
Value 
)
inline

Enable and apply a value to the specified channel

◆ WeightedBlend()

template<typename T , uint8 N>
void UE::MovieScene::TMultiChannelValue< T, N >::WeightedBlend ( uint8  Index,
Value,
float  Weight 
)
inline

Do weighted blend with current value, this is an override


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