Navigation
API > API/Runtime > API/Runtime/MovieScene
Numeric variant type that represents a 'time-warp' operation transforming a time into another time.
By default this variant is a literal value that represents a play rate of 1.0 (ie, a 1:1 mapping), but it can be customized to provide a wide range of different transformations such as looping, clamping and custom curves
| Name | FMovieSceneTimeWarpVariant |
| Type | struct |
| Header File | /Engine/Source/Runtime/MovieScene/Public/Variants/MovieSceneTimeWarpVariant.h |
| Include Path | #include "Variants/MovieSceneTimeWarpVariant.h" |
Syntax
USTRUCT (BlueprintType ,
Meta=(HasNativeBreak="/Script/SequencerScripting.MovieSceneTimeWarpExtensions.BreakTimeWarp", HasNativeMake="/Script/SequencerScripting.MovieSceneTimeWarpExtensions.MakeTimeWarp"))
struct FMovieSceneTimeWarpVariant
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FMovieSceneTimeWarpVariant
(
FMovieSceneNumericVariant&& Other |
Variants/MovieSceneTimeWarpVariant.h | ||
| Move-construction | Variants/MovieSceneTimeWarpVariant.h | ||
FMovieSceneTimeWarpVariant
(
const FMovieSceneTimeWarpVariant& Other |
Copy construction that performs a shallow copy | Variants/MovieSceneTimeWarpVariant.h | |
| Initialize this time-warp with custom time-warp getter | Variants/MovieSceneTimeWarpVariant.h | ||
FMovieSceneTimeWarpVariant
(
const FMovieSceneTimeWarpClamp& In |
Initialize this time-warp with a time-warp that clamps the time to a specific range | Variants/MovieSceneTimeWarpVariant.h | |
FMovieSceneTimeWarpVariant
(
const FMovieSceneTimeWarpLoop& In |
Initialize this time-warp with a looping time-warp | Variants/MovieSceneTimeWarpVariant.h | |
FMovieSceneTimeWarpVariant
(
const FMovieSceneTimeWarpFixedFrame& In |
Initialize this time-warp with a specific fixed frame number | Variants/MovieSceneTimeWarpVariant.h | |
FMovieSceneTimeWarpVariant
(
double InLiteralPlayRate |
Initialize this time-warp with a specific constant play rate | Variants/MovieSceneTimeWarpVariant.h | |
| Default construction: initializes this struct to a constant play rate of 1.0 | Variants/MovieSceneTimeWarpVariant.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| Variant | FMovieSceneNumericVariant | Variants/MovieSceneTimeWarpVariant.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
| Cast this variant to a clamped range | Variants/MovieSceneTimeWarpVariant.h | ||
| Cast this variant to a floating-point clamped range | Variants/MovieSceneTimeWarpVariant.h | ||
| Cast this variant to a custom time warp implementation | Variants/MovieSceneTimeWarpVariant.h | ||
double AsFixedPlayRate () |
Retrieve this time-warp's constant play rate. | Variants/MovieSceneTimeWarpVariant.h | |
float AsFixedPlayRateFloat () |
Retrieve this time-warp's constant play rate clampoed to the range of a float | Variants/MovieSceneTimeWarpVariant.h | |
| Cast this variant to a fixed time. | Variants/MovieSceneTimeWarpVariant.h | ||
| Cast this variant to a frame-rate conversion | Variants/MovieSceneTimeWarpVariant.h | ||
| Cast this variant to a frame-based loop | Variants/MovieSceneTimeWarpVariant.h | ||
| Cast this variant to a floating-point loop | Variants/MovieSceneTimeWarpVariant.h | ||
FMovieSceneTimeWarpVariant DeepCopy
(
UObject* NewOuter |
Return a deep copy of this variant. | Variants/MovieSceneTimeWarpVariant.h | |
bool ExportTextItem
(
FString& ValueStr, |
Variants/MovieSceneTimeWarpVariant.h | ||
EMovieSceneTimeWarpType GetType() |
Retrieve the type of this variant as an enumeration | Variants/MovieSceneTimeWarpVariant.h | |
bool ImportTextItem
(
const TCHAR*& Buffer, |
Variants/MovieSceneTimeWarpVariant.h | ||
void MakeWeakUnsafe () |
If this variant wraps a UMovieSceneTimeWarpGetter, turn it into an unsafe weak reference. | Variants/MovieSceneTimeWarpVariant.h | |
FFrameTime RemapTime
(
FFrameTime InTime |
Remap the specified time using this time-warp | Variants/MovieSceneTimeWarpVariant.h | |
void ScaleBy
(
double ScaleFactor |
Scale this time-warp by a factor | Variants/MovieSceneTimeWarpVariant.h | |
bool Serialize
(
FArchive& Ar |
Variants/MovieSceneTimeWarpVariant.h | ||
bool SerializeFromMismatchedTag
(
const FPropertyTag& Tag, |
Variants/MovieSceneTimeWarpVariant.h | ||
void Set
(
const FMovieSceneTimeWarpLoopFloat& InValue |
Make this time-warp loop within the specified bounds | Variants/MovieSceneTimeWarpVariant.h | |
void Set
(
const FMovieSceneTimeWarpClamp& InValue |
Make this time-warp clamp to the specified bounds | Variants/MovieSceneTimeWarpVariant.h | |
void Set
(
const FMovieSceneTimeWarpLoop& InValue |
Make this time-warp loop within the specified bounds | Variants/MovieSceneTimeWarpVariant.h | |
void Set
(
UMovieSceneTimeWarpGetter* InDynamicValue |
Make this time-warp a custom dynamic value | Variants/MovieSceneTimeWarpVariant.h | |
void Set
(
const FMovieSceneTimeWarpFixedFrame& InValue |
Make this time-warp always return a fixed frame number | Variants/MovieSceneTimeWarpVariant.h | |
void Set
(
double InLiteralPlayRate |
Make this time-warp play at a constant play-rate | Variants/MovieSceneTimeWarpVariant.h | |
void Set
(
const FMovieSceneTimeWarpClampFloat& InValue |
Make this time-warp clamp to the specified bounds | Variants/MovieSceneTimeWarpVariant.h | |
void Set
(
const FMovieSceneTimeWarpFrameRate& InValue |
Make this time-warp transform from one frame rate to another | Variants/MovieSceneTimeWarpVariant.h | |
| Return a shallow copy of this variant via bit-wise copy. | Variants/MovieSceneTimeWarpVariant.h |
Operators
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
| Move-assignment | Variants/MovieSceneTimeWarpVariant.h | ||
FMovieSceneTimeWarpVariant & operator=
(
const FMovieSceneTimeWarpVariant& Other |
Copy-assignment that performs a shallow copy | Variants/MovieSceneTimeWarpVariant.h | |
FMovieSceneTimeWarpVariant & operator=
(
double InLiteralPlayRate |
Assignment from a literal play rate | Variants/MovieSceneTimeWarpVariant.h |