TMultiChannelValue

Generic value type that supports a specific number of channels, optionally masked out.

Windows
MacOS
Linux

References

Module

MovieScene

Header

/Engine/Source/Runtime/MovieScene/Public/Evaluation/Blending/MovieSceneMultiChannelBlending.h

Include

#include "Evaluation/Blending/MovieSceneMultiChannelBlending.h"

Syntax

template<typename T, uint8 N>
struct TMultiChannelValue

Remarks

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

Constructors

Name Description

Public function

TMultiChannelValue()

Default Constructor

Public function

TMultiChannelValue

(
    std::initializer_list< OtherType > ...
)

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

Functions

Name Description

Public function Const

T

 

Get

(
    uint8 Index,
    T Default
)

Access a value with a default

Public function

void

 

Increment

(
    uint8 Index,
    T Value
)

Increment the channel at the specified index by the specified amount

Public function Const

bool

 

IsEmpty()

Check if this value is empty

Public function Const

bool

 

IsFull()

Check if every channel in this value is valid

Public function Const

bool

 

IsSet

(
    uint8 Index
)

Check whether the specified channel index is enabled

Public function

void

 

Set

(
    uint8 Index,
    T Value
)

Enable and apply a value to the specified channel

Operators

Name Description

Public function Const

T

 

operator[]

(
    uint8 Index
)

Array indexing operator - returns a channel value
Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss