FMovieSceneTimeWarpVariant Struct Reference

#include <MovieSceneTimeWarpVariant.h>

Public Member Functions
	FMovieSceneTimeWarpVariant ()
	FMovieSceneTimeWarpVariant (double InLiteralPlayRate)
	FMovieSceneTimeWarpVariant (const FMovieSceneTimeWarpFixedFrame &In)
	FMovieSceneTimeWarpVariant (const FMovieSceneTimeWarpLoop &In)
	FMovieSceneTimeWarpVariant (const FMovieSceneTimeWarpClamp &In)
	FMovieSceneTimeWarpVariant (UMovieSceneTimeWarpGetter *In)
	FMovieSceneTimeWarpVariant (const FMovieSceneTimeWarpVariant &Other)
FMovieSceneTimeWarpVariant &	operator= (const FMovieSceneTimeWarpVariant &Other)
	FMovieSceneTimeWarpVariant (FMovieSceneTimeWarpVariant &&)=default
FMovieSceneTimeWarpVariant &	operator= (FMovieSceneTimeWarpVariant &&)=default
FMovieSceneTimeWarpVariant &	operator= (double InLiteralPlayRate)
FMovieSceneTimeWarpVariant	ShallowCopy () const
FMovieSceneTimeWarpVariant	DeepCopy (UObject *NewOuter) const
void	MakeWeakUnsafe ()
MOVIESCENE_API FFrameTime	RemapTime (FFrameTime InTime) const
EMovieSceneTimeWarpType	GetType () const
MOVIESCENE_API double	AsFixedPlayRate () const
MOVIESCENE_API float	AsFixedPlayRateFloat () const
MOVIESCENE_API FMovieSceneTimeWarpFixedFrame	AsFixedTime () const
MOVIESCENE_API FMovieSceneTimeWarpFrameRate	AsFrameRate () const
MOVIESCENE_API FMovieSceneTimeWarpLoop	AsLoop () const
MOVIESCENE_API FMovieSceneTimeWarpClamp	AsClamp () const
MOVIESCENE_API FMovieSceneTimeWarpLoopFloat	AsLoopFloat () const
MOVIESCENE_API FMovieSceneTimeWarpClampFloat	AsClampFloat () const
MOVIESCENE_API UMovieSceneTimeWarpGetter *	AsCustom () const
MOVIESCENE_API void	Set (double InLiteralPlayRate)
MOVIESCENE_API void	Set (const FMovieSceneTimeWarpFixedFrame &InValue)
MOVIESCENE_API void	Set (const FMovieSceneTimeWarpFrameRate &InValue)
MOVIESCENE_API void	Set (const FMovieSceneTimeWarpLoop &InValue)
MOVIESCENE_API void	Set (const FMovieSceneTimeWarpClamp &InValue)
MOVIESCENE_API void	Set (const FMovieSceneTimeWarpLoopFloat &InValue)
MOVIESCENE_API void	Set (const FMovieSceneTimeWarpClampFloat &InValue)
MOVIESCENE_API void	Set (UMovieSceneTimeWarpGetter *InDynamicValue)
MOVIESCENE_API void	ScaleBy (double ScaleFactor)
bool	Serialize (FArchive &Ar)
bool	SerializeFromMismatchedTag (const FPropertyTag &Tag, FStructuredArchive::FSlot Slot)
bool	ExportTextItem (FString &ValueStr, const FMovieSceneTimeWarpVariant &DefaultValue, UObject *Parent, int32 PortFlags, UObject *ExportRootScope) const
bool	ImportTextItem (const TCHAR *&Buffer, int32 PortFlags, UObject *Parent, FOutputDevice *ErrorText)
	FMovieSceneTimeWarpVariant (FMovieSceneNumericVariant &&Other)

Friends
bool	operator== (const FMovieSceneTimeWarpVariant &A, const FMovieSceneTimeWarpVariant &B)
bool	operator!= (const FMovieSceneTimeWarpVariant &A, const FMovieSceneTimeWarpVariant &B)

Detailed Description

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

Constructor & Destructor Documentation

FMovieSceneTimeWarpVariant() [1/9]

FMovieSceneTimeWarpVariant::FMovieSceneTimeWarpVariant ( )

inline

Default construction: initializes this struct to a constant play rate of 1.0

FMovieSceneTimeWarpVariant() [2/9]

FMovieSceneTimeWarpVariant::FMovieSceneTimeWarpVariant ( double  InLiteralPlayRate )

inlineexplicit

Initialize this time-warp with a specific constant play rate

FMovieSceneTimeWarpVariant() [3/9]

FMovieSceneTimeWarpVariant::FMovieSceneTimeWarpVariant ( const FMovieSceneTimeWarpFixedFrame &  In )

inlineexplicit

Initialize this time-warp with a specific fixed frame number

FMovieSceneTimeWarpVariant() [4/9]

FMovieSceneTimeWarpVariant::FMovieSceneTimeWarpVariant ( const FMovieSceneTimeWarpLoop &  In )

inlineexplicit

Initialize this time-warp with a looping time-warp

FMovieSceneTimeWarpVariant() [5/9]

FMovieSceneTimeWarpVariant::FMovieSceneTimeWarpVariant ( const FMovieSceneTimeWarpClamp &  In )

inlineexplicit

Initialize this time-warp with a time-warp that clamps the time to a specific range

FMovieSceneTimeWarpVariant() [6/9]

FMovieSceneTimeWarpVariant::FMovieSceneTimeWarpVariant ( UMovieSceneTimeWarpGetter *  In )

inlineexplicit

Initialize this time-warp with custom time-warp getter

FMovieSceneTimeWarpVariant() [7/9]

FMovieSceneTimeWarpVariant::FMovieSceneTimeWarpVariant ( const FMovieSceneTimeWarpVariant &  Other )

inline

Copy construction that performs a shallow copy

FMovieSceneTimeWarpVariant() [8/9]

FMovieSceneTimeWarpVariant::FMovieSceneTimeWarpVariant ( FMovieSceneTimeWarpVariant &&  )

default

Move-construction

FMovieSceneTimeWarpVariant() [9/9]

FMovieSceneTimeWarpVariant::FMovieSceneTimeWarpVariant ( FMovieSceneNumericVariant &&  Other )

inline

Member Function Documentation

AsClamp()

FMovieSceneTimeWarpClamp FMovieSceneTimeWarpVariant::AsClamp

(

)

const

AsClampFloat()

FMovieSceneTimeWarpClampFloat FMovieSceneTimeWarpVariant::AsClampFloat

(

)

const

AsCustom()

UMovieSceneTimeWarpGetter * FMovieSceneTimeWarpVariant::AsCustom

(

)

const

AsFixedPlayRate()

double FMovieSceneTimeWarpVariant::AsFixedPlayRate

(

)

const

AsFixedPlayRateFloat()

float FMovieSceneTimeWarpVariant::AsFixedPlayRateFloat

(

)

const

AsFixedTime()

FMovieSceneTimeWarpFixedFrame FMovieSceneTimeWarpVariant::AsFixedTime

(

)

const

AsFrameRate()

FMovieSceneTimeWarpFrameRate FMovieSceneTimeWarpVariant::AsFrameRate

(

)

const

AsLoop()

FMovieSceneTimeWarpLoop FMovieSceneTimeWarpVariant::AsLoop

(

)

const

AsLoopFloat()

FMovieSceneTimeWarpLoopFloat FMovieSceneTimeWarpVariant::AsLoopFloat

(

)

const

DeepCopy()

FMovieSceneTimeWarpVariant FMovieSceneTimeWarpVariant::DeepCopy ( UObject *  NewOuter ) const

inline

Return a deep copy of this variant. If the contained type is a custom object, the object will be duplicated into the new outer, otherwise a bitwise copy is performed.

ExportTextItem()

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

GetType()

EMovieSceneTimeWarpType FMovieSceneTimeWarpVariant::GetType ( ) const

inline

Retrieve the type of this variant as an enumeration

ImportTextItem()

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

MakeWeakUnsafe()

void FMovieSceneTimeWarpVariant::MakeWeakUnsafe ( )

inline

If this variant wraps a UMovieSceneTimeWarpGetter, turn it into an unsafe weak reference.

Warning

: This will result in a dangling pointer if it is not referenced strongly elsewhere. Use with caution.

operator=() [1/3]

FMovieSceneTimeWarpVariant & FMovieSceneTimeWarpVariant::operator= ( const FMovieSceneTimeWarpVariant &  Other )

inline

Copy-assignment that performs a shallow copy

operator=() [2/3]

FMovieSceneTimeWarpVariant & FMovieSceneTimeWarpVariant::operator= ( double  InLiteralPlayRate )

inline

Assignment from a literal play rate

operator=() [3/3]

FMovieSceneTimeWarpVariant & FMovieSceneTimeWarpVariant::operator= ( FMovieSceneTimeWarpVariant &&  )

default

Move-assignment

RemapTime()

FFrameTime FMovieSceneTimeWarpVariant::RemapTime

(

FFrameTime

InTime

)

const

Remap the specified time using this time-warp

Parameters

InTime

The time to remap

Returns

The time-warped time

ScaleBy()

void FMovieSceneTimeWarpVariant::ScaleBy

(

double

ScaleFactor

)

Scale this time-warp by a factor

Serialize()

bool FMovieSceneTimeWarpVariant::Serialize

(

FArchive &

Ar

)

SerializeFromMismatchedTag()

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

Set() [1/8]

void FMovieSceneTimeWarpVariant::Set

(

const FMovieSceneTimeWarpClamp &

InValue

)

Make this time-warp clamp to the specified bounds

Set() [2/8]

void FMovieSceneTimeWarpVariant::Set

(

const FMovieSceneTimeWarpClampFloat &

InValue

)

Make this time-warp clamp to the specified bounds

Set() [3/8]

void FMovieSceneTimeWarpVariant::Set

(

const FMovieSceneTimeWarpFixedFrame &

InValue

)

Make this time-warp always return a fixed frame number

Set() [4/8]

void FMovieSceneTimeWarpVariant::Set

(

const FMovieSceneTimeWarpFrameRate &

InValue

)

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

Set() [5/8]

void FMovieSceneTimeWarpVariant::Set

(

const FMovieSceneTimeWarpLoop &

InValue

)

Make this time-warp loop within the specified bounds

Set() [6/8]

void FMovieSceneTimeWarpVariant::Set

(

const FMovieSceneTimeWarpLoopFloat &

InValue

)

Make this time-warp loop within the specified bounds

Set() [7/8]

void FMovieSceneTimeWarpVariant::Set

(

double

InLiteralPlayRate

)

Make this time-warp play at a constant play-rate

Set() [8/8]

void FMovieSceneTimeWarpVariant::Set

(

UMovieSceneTimeWarpGetter *

InDynamicValue

)

Make this time-warp a custom dynamic value

ShallowCopy()

FMovieSceneTimeWarpVariant FMovieSceneTimeWarpVariant::ShallowCopy ( ) const

inline

Return a shallow copy of this variant via bit-wise copy. If the contained type is a custom object, the object ptr will be copied directly

Friends And Related Symbol Documentation

operator!=

bool operator!= ( const FMovieSceneTimeWarpVariant &  A, const FMovieSceneTimeWarpVariant &  B  )

friend

Inequality-comparison

operator==

bool operator== ( const FMovieSceneTimeWarpVariant &  A, const FMovieSceneTimeWarpVariant &  B  )

friend

Equality-comparison

---

The documentation for this struct was generated from the following files:

• Engine/Source/Runtime/MovieScene/Public/Variants/MovieSceneTimeWarpVariant.h
• Engine/Source/Runtime/MovieScene/Private/Variants/MovieSceneTimeWarpVariant.cpp