Navigation
API > API/Runtime > API/Runtime/MovieScene
A key in the clipboard representing a time and a value of a specific type Client code must define MovieSceneClipboard::GetKeyTypeName<> in order to use a type with this class. In general, keys are stored relaative to the minumum key-time in the clipboard, or some arbitrary time. This cardinal time is stored with the clipboard environment.
| Name | FMovieSceneClipboardKey |
| Type | class |
| Header File | /Engine/Source/Runtime/MovieScene/Public/MovieSceneClipboard.h |
| Include Path | #include "MovieSceneClipboard.h" |
Syntax
class FMovieSceneClipboardKey
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FMovieSceneClipboardKey
(
const FMovieSceneClipboardKey& In |
Copy construction/assignment | MovieSceneClipboard.h | |
FMovieSceneClipboardKey
(
FFrameNumber InTime, |
Templated constructor accepting a specific value type | MovieSceneClipboard.h |
Structs
Typedefs
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| FConversionFunction | TFunction< FMovieSceneClipboardKey(const FMovieSceneClipboardKey &)> | MovieSceneClipboard.h |
Constants
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| ConversionMap | TMap< FName, TMap< FName, FConversionFunction > > | Static map of conversions between types | MovieSceneClipboard.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| Data | TInlineValue< IKey, 64 > | Type-erased bytes containing the key's value | MovieSceneClipboard.h | |
| Time | FFrameNumber | The time that this key is defined at | MovieSceneClipboard.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FFrameNumber GetTime() |
Get the time at which this key is defined | MovieSceneClipboard.h | |
T GetValue() |
Get the value of this key as the specified type. | MovieSceneClipboard.h | |
void SetTime
(
FFrameNumber InTime |
Set the time at which this key is defined | MovieSceneClipboard.h | |
bool TryGetValue
(
T& Value |
Attempt to get the value of this key as the specified type. | MovieSceneClipboard.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static void DefineConversion
(
TFunction< ToType(const FromType&)> InFunction |
Define a conversion from one type to another type | MovieSceneClipboard.h |
Operators
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FMovieSceneClipboardKey & operator=
(
const FMovieSceneClipboardKey& In |
MovieSceneClipboard.h |