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

#include <MovieSceneKeyStructHelper.h>

Public Member Functions

 FMovieSceneKeyStructHelper ()=default
 
 FMovieSceneKeyStructHelper (const FMovieSceneKeyStructHelper &)=delete
 
FMovieSceneKeyStructHelperoperator= (const FMovieSceneKeyStructHelper &)=delete
 
MOVIESCENE_API void Add (FMovieSceneChannelValueHelper &&InHelper)
 
MOVIESCENE_API void SetStartingValues ()
 
MOVIESCENE_API TOptional< FFrameNumberGetUnifiedKeyTime () const
 
MOVIESCENE_API void Apply (FFrameNumber InUnifiedTime)
 

Detailed Description

Helper class that marshals user-facing data from an edit UI into particluar keys on various underlying channels

Constructor & Destructor Documentation

◆ FMovieSceneKeyStructHelper() [1/2]

FMovieSceneKeyStructHelper::FMovieSceneKeyStructHelper ( )
default

Default construction

◆ FMovieSceneKeyStructHelper() [2/2]

FMovieSceneKeyStructHelper::FMovieSceneKeyStructHelper ( const FMovieSceneKeyStructHelper )
delete

Non-copyable

Member Function Documentation

◆ Add()

void FMovieSceneKeyStructHelper::Add ( FMovieSceneChannelValueHelper &&  InHelper)

Add a particular key value to this helper that should be applied when the edit UI is committed

Parameters
InHelperThe utility class to add, bound to the key handle it wants to edit

◆ Apply()

void FMovieSceneKeyStructHelper::Apply ( FFrameNumber  InUnifiedTime)

Propagate the user-facing UI values to the keys that are being represented in this class

Parameters
InUnifiedTimeA time to set all keys to

◆ GetUnifiedKeyTime()

TOptional< FFrameNumber > FMovieSceneKeyStructHelper::GetUnifiedKeyTime ( ) const

Get unified starting time that should be shown on the UI

◆ operator=()

FMovieSceneKeyStructHelper & FMovieSceneKeyStructHelper::operator= ( const FMovieSceneKeyStructHelper )
delete

◆ SetStartingValues()

void FMovieSceneKeyStructHelper::SetStartingValues ( )

Set the user facing values on the UI based on the unified starting time


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