FMovieSceneTimeWarpVariant

Numeric variant type that represents a 'time-warp' operation transforming a time into another time.

API > API/Runtime > API/Runtime/MovieScene > API/Runtime/MovieScene/Variants

References

   
Module MovieScene
Header /Engine/Source/Runtime/MovieScene/Public/Variants/MovieSceneTimeWarpVariant.h
Include #include "Variants/MovieSceneTimeWarpVariant.h"

Syntax

USTRUCT (BlueprintType )  
struct FMovieSceneTimeWarpVariant

Remarks

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

Constructors

  Type Name Description
Public function   Default construction: initializes this struct to a constant play rate of 1.0
Public function  

FMovieSceneTimeWarpVariant ( double InLiteralPlayRate
)

 Initialize this time-warp with a specific constant play rate
Public function   Initialize this time-warp with a specific fixed frame number
Public function   Initialize this time-warp with a looping time-warp
Public function   Initialize this time-warp with a time-warp that clamps the time to a specific range
Public function   Initialize this time-warp with custom time-warp getter
Public function   Copy construction that performs a shallow copy
Public function   Move-construction

Functions

  Type Name Description
Public function Const FMovieSceneTimeWarpClamp

AsClamp ()

 Cast this variant to a clamped range
Public function Const FMovieSceneTimeWarpClampFloat Cast this variant to a floating-point clamped range
Public function Const UMovieSceneTimeWarpGetter * Cast this variant to a custom time warp implementation
Public function Const double Retrieve this time-warp's constant play rate.
Public function Const float Retrieve this time-warp's constant play rate clampoed to the range of a float
Public function Const FMovieSceneTimeWarpFixedFrame Cast this variant to a fixed time.
Public function Const FMovieSceneTimeWarpFrameRate Cast this variant to a frame-rate conversion
Public function Const FMovieSceneTimeWarpLoop

AsLoop ()

 Cast this variant to a frame-based loop
Public function Const FMovieSceneTimeWarpLoopFloat Cast this variant to a floating-point loop
Public function Const TRange< FFrameTime >

ComputeTraversedHull ( const TRange< FFrameTime >& Range
)

 Given a continuous input range, compute the hull of warped times that are contained.
Public function Const FMovieSceneTimeWarpVariant

DeepCopy ( UObject* NewOuter
)

 Return a deep copy of this variant.
Public function Const bool

ExportTextItem ( FString& ValueStr,
const FMovieSceneTimeWarpVariant& DefaultValue,
UObject* Parent,
int32 PortFlags,
UObject* ExportRootScope
)

  
Public function Const EMovieSceneTimeWarpType

GetType ()

 Retrieve the type of this variant as an enumeration
Public function bool

ImportTextItem ( const TCHAR*& Buffer,
int32 PortFlags,
UObject* Parent,
FOutputDevice* ErrorText
)

  
Public function Const TOptional< FFrameTime >

InverseRemapTimeCycled ( FFrameTime WarpedTime,
FFrameTime UnwarpedTimeHint,
const UE::MovieScene::FInverseTransformTimeParams& Params
)

 Attempt to transform a time-warped time into its corresponding non-time-warped time.
Public function Const bool

InverseRemapTimeWithinRange ( FFrameTime InTime,
FFrameTime UnwarpedRangeStart,
FFrameTime UnwarpedRangeEnd,
const TFunctionRef< bool(FFrameTime)>& VisitorCallback
)

 Attempt to transform a time-warped time into its corresponding non-time-warped time within a specified unwarped range.
Public function Const FFrameTime

RemapTime ( FFrameTime InTime
)

 Remap the specified time using this time-warp
Public function void

ScaleBy ( double ScaleFactor
)

 Scale this time-warp by a factor
Public function bool

Serialize ( FArchive& Ar
)

  
Public function bool

SerializeFromMismatchedTag ( const FPropertyTag& Tag,
FStructuredArchive::FSlot Slot
)

  
Public function void

Set ( const FMovieSceneTimeWarpClampFloat& InValue
)

 Make this time-warp clamp to the specified bounds
Public function void

Set ( double InLiteralPlayRate
)

 Make this time-warp play at a constant play-rate
Public function void

Set ( const FMovieSceneTimeWarpFixedFrame& InValue
)

 Make this time-warp always return a fixed frame number
Public function void

Set ( const FMovieSceneTimeWarpFrameRate& InValue
)

 Make this time-warp transform from one frame rate to another
Public function void

Set ( const FMovieSceneTimeWarpLoop& InValue
)

 Make this time-warp loop within the specified bounds
Public function void

Set ( const FMovieSceneTimeWarpClamp& InValue
)

 Make this time-warp clamp to the specified bounds
Public function void

Set ( const FMovieSceneTimeWarpLoopFloat& InValue
)

 Make this time-warp loop within the specified bounds
Public function void

Set ( UMovieSceneTimeWarpGetter* InDynamicValue
)

 Make this time-warp a custom dynamic value
Public function Const FMovieSceneTimeWarpVariant Return a shallow copy of this variant via bit-wise copy.

Operators

  Type Name Description
Public function FMovieSceneTimeWarpVariant &

operator= ( double InLiteralPlayRate
)

 Assignment from a literal play rate
Public function FMovieSceneTimeWarpVariant & Move-assignment
Public function FMovieSceneTimeWarpVariant & Copy-assignment that performs a shallow copy

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page