UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
FMovieSceneChannelValueHelper Struct Reference

#include <MovieSceneKeyStructHelper.h>

Classes

struct  IChannelValueHelper
 

Public Member Functions

template<typename ChannelType , typename ValueType >
 FMovieSceneChannelValueHelper (const TMovieSceneChannelHandle< ChannelType > &InChannel, ValueType *InUserValue, TArrayView< const FKeyHandle > AllKeyHandles)
 
template<typename ChannelType , typename ValueType >
 FMovieSceneChannelValueHelper (const TMovieSceneChannelHandle< ChannelType > &InChannel, ValueType *InUserValue, TOptional< TTuple< FKeyHandle, FFrameNumber > > InKeyHandleAndTime)
 
IChannelValueHelperoperator-> ()
 

Static Public Member Functions

template<typename ChannelType >
static TOptional< TTuple< FKeyHandle, FFrameNumber > > FindFirstKey (ChannelType *InChannel, TArrayView< const FKeyHandle > AllKeyHandles)
 

Detailed Description

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

Constructor & Destructor Documentation

◆ FMovieSceneChannelValueHelper() [1/2]

template<typename ChannelType , typename ValueType >
FMovieSceneChannelValueHelper::FMovieSceneChannelValueHelper ( const TMovieSceneChannelHandle< ChannelType > &  InChannel,
ValueType *  InUserValue,
TArrayView< const FKeyHandle AllKeyHandles 
)

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

Parameters
InChannelA handle to the channel that contains the key we're editing
InUserValuePointer to a user-facing value on an editable UStruct instance
AllKeyHandlesArray of all key handles that should be edited using this helper

◆ FMovieSceneChannelValueHelper() [2/2]

template<typename ChannelType , typename ValueType >
FMovieSceneChannelValueHelper::FMovieSceneChannelValueHelper ( const TMovieSceneChannelHandle< ChannelType > &  InChannel,
ValueType *  InUserValue,
TOptional< TTuple< FKeyHandle, FFrameNumber > >  InKeyHandleAndTime 
)

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

Parameters
InChannelA handle to the channel that contains the key we're editing
InUserValuePointer to a user-facing value on an editable UStruct instance
InKeyHandleAndTime(Optional) Specific key value and time that should be edited

Member Function Documentation

◆ FindFirstKey()

template<typename ChannelType >
TOptional< TTuple< FKeyHandle, FFrameNumber > > FMovieSceneChannelValueHelper::FindFirstKey ( ChannelType *  InChannel,
TArrayView< const FKeyHandle AllKeyHandles 
)
static

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

Parameters
InChannelThe channel to look on
AllKeyHandlesThe key handles to search for
Returns
(Optional) A key handle and time pair for the first valid key handle found

◆ operator->()

IChannelValueHelper * FMovieSceneChannelValueHelper::operator-> ( )
inline

Pointer operator overload that allows access to the underlying interface


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