FMovieSceneTimeWarping

Transform time by warping it around from end to start. This is mostly useful for looping things.

Windows
MacOS
Linux

References

Module

MovieScene

Header

/Engine/Source/Runtime/MovieScene/Public/Evaluation/MovieSceneTimeWarping.h

Include

#include "Evaluation/MovieSceneTimeWarping.h"

Syntax

struct FMovieSceneTimeWarping

Remarks

Transform time by warping it around from end to start. This is mostly useful for looping things.

Variables

Name Description

Public variable

FFrameNumber

 

End

Public variable

FFrameNumber

 

Start

Constructors

Name Description

Public function

FMovieSceneTimeWarping()

Public function

FMovieSceneTimeWarping

(
    FFrameNumber InStart,
    FFrameNumber InEnd
)

Functions

Name Description

Public function Const

TRange< FFra...

 

GetRange()

Returns a range that encompasses the whole warping time span.

Public function Const

FMovieSceneT...

 

InverseFromWarp

(
    uint32 WarpCount
)

Returns a transformation that takes us from a local time into a given loop back to the root time.

Public function Const

bool

 

IsValid()

Returns whether this warping transform is doing anything.

Public function Const

FFrameNumber

 

Length()

Returns the length of the warping.

Public function Const

void

 

TransformFrame

(
    FFrameNumber InFrame,
    FFrameNumber& OutFrame,
    uint32& OutWarpIndex
)

Transforms the given frame and returns the warped frame time along with the warp index we ended up in.

Public function Const

TRange< FFra...

 

TransformRangeConstrained

(
    const TRange< FFrameTime >& Range
)

Transforms the given range by time-warping it and figuring out if it "covered" a full loop or not.

Public function Const

TRange< FFra...

 

TransformRangePure

(
    const TRange< FFrameTime >& Range
)

Transforms the given range in a "naive" way, i.e. its lower and upper bounds are transformed independently by this time warping.

Public function Const

TRange< FFra...

 

TransformRangeUnwarped

(
    const TRange< FFrameTime >& Range
)

Transforms the given range by time-warping its lower bound, and computing an upper bound so that the size of the input range is preserved.

Public function Const

void

 

TransformTime

(
    FFrameTime InTime,
    FFrameTime& OutTime,
    uint32& OutWarpIndex
)

Transforms the given time and returns the warped time along with the warp index we ended up in.

Public function Const

void

 

TransformTimeSpecific

(
    FFrameTime InTime,
    uint32 WarpCount,
    FFrameTime& OutTime
)

Transforms the given time by warping it by a specific warp count, regardless of how many warps are needed in theory to stay in the warping range.

Constants

Name

Description

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