Navigation
API > API/Runtime > API/Runtime/MovieScene
Helper class that marshals user-facing data from an edit UI into particluar keys on various underlying channels
| Name | FMovieSceneKeyStructHelper |
| Type | struct |
| Header File | /Engine/Source/Runtime/MovieScene/Public/MovieSceneKeyStructHelper.h |
| Include Path | #include "MovieSceneKeyStructHelper.h" |
Syntax
struct FMovieSceneKeyStructHelper
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
| Default construction | MovieSceneKeyStructHelper.h | ||
| Non-copyable | MovieSceneKeyStructHelper.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| Helpers | TArray< FMovieSceneChannelValueHelper > | Array of value accessors that are being shown on the edit UI | MovieSceneKeyStructHelper.h | |
| UnifiedKeyTime | TOptional< FFrameNumber > | Unified key time that represents all the keys | MovieSceneKeyStructHelper.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void Add
(
FMovieSceneChannelValueHelper&& InHelper |
Add a particular key value to this helper that should be applied when the edit UI is committed | MovieSceneKeyStructHelper.h | |
void Apply
(
FFrameNumber InUnifiedTime |
Propagate the user-facing UI values to the keys that are being represented in this class | MovieSceneKeyStructHelper.h | |
TOptional< FFrameNumber > GetUnifiedKeyTime() |
Get unified starting time that should be shown on the UI | MovieSceneKeyStructHelper.h | |
void SetStartingValues() |
Set the user facing values on the UI based on the unified starting time | MovieSceneKeyStructHelper.h |
Operators
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FMovieSceneKeyStructHelper & operator=
(
const FMovieSceneKeyStructHelper& |
MovieSceneKeyStructHelper.h |