FMovieSceneChannelValueHelper

Utility class that gets and sets a specific key value for a key struct

Windows
MacOS
Linux

References

Module

MovieScene

Header

/Engine/Source/Runtime/MovieScene/Public/MovieSceneKeyStructHelper.h

Include

#include "MovieSceneKeyStructHelper.h"

Syntax

struct FMovieSceneChannelValueHelper

Remarks

Utility class that gets and sets a specific key value for a key struct

Constructors

Name Description

Public function

FMovieSceneChannelValueHelper

(
    const TMovieSceneChannelHandle< Cha...,
    ValueType* InUserValue,
    TArrayView< const FKeyHandle > AllK...
)

Construction from a channel handle, a pointer to an external user-facing value on the key struct, and an array of handles

Public function

FMovieSceneChannelValueHelper

(
    const TMovieSceneChannelHandle< Cha...,
    ValueType* InUserValue,
    TOptional< TTuple< FKeyHandle, FFra...
)

Construction from a channel handle, a pointer to an external user-facing value on the key struct, and a specific key handle/time

Functions

Name Description

Public function Static

TOptional< T...

 

FindFirstKey

(
    ChannelType* InChannel,
    TArrayView< const FKeyHandle > AllK...
)

Attempt to find a single key handle that exists on the specified channel

Operators

Name Description

Public function

IChannelValu...

 

operator->()

Pointer operator overload that allows access to the underlying interface

Classes

Name

Description

Public struct

IChannelValueHelper

Underlying implementation interface

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss