FMovieSceneClipboardKey

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.

Windows
MacOS
Linux

References

Module

MovieScene

Header

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

Include

#include "MovieSceneClipboard.h"

Syntax

class FMovieSceneClipboardKey

Remarks

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.

Constructors

Name Description

Public function

FMovieSceneClipboardKey

(
    const FMovieSceneClipboardKey& In
)

Copy construction/assignment

Public function

FMovieSceneClipboardKey

(
    FFrameNumber InTime,
    T InValue
)

Templated constructor accepting a specific value type

Functions

Name Description

Public function Static

void

 

DefineConversion

(
    TFunction< ToType(const FromType&)...
)

Define a conversion from one type to another type

Public function Const

FFrameNumber

 

GetTime()

Get the time at which this key is defined

Public function Const

T

 

GetValue()

Get the value of this key as the specified type.

Public function

void

 

SetTime

(
    FFrameNumber InTime
)

Set the time at which this key is defined

Public function Const

bool

 

TryGetValue

(
    T& Value
)

Attempt to get the value of this key as the specified type.

Operators

Name Description

Public function

FMovieSceneC...

 

operator=

(
    const FMovieSceneClipboardKey& In
)

Typedefs

Name

Description

FConversionFunction

Constants

Name

Description

ConversionMap

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