UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
FMovieSceneTimeTransform Struct Reference

#include <MovieSceneTimeTransform.h>

Public Member Functions

 FMovieSceneTimeTransform ()
 
 FMovieSceneTimeTransform (FFrameTime InOffset, float InTimeScale=1.f)
 
bool IsIdentity () const
 
FMovieSceneTimeTransform Inverse () const
 

Public Attributes

float TimeScale
 
FFrameTime Offset
 

Friends

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

Detailed Description

Movie scene sequence transform class that transforms from one time-space to another.

Note
The transform can be thought of as the top row of a 2x2 matrix, where the bottom row is the identity: | TimeScale Offset | | 0 1 |

As such, traditional matrix mathematics can be applied to transform between different sequence's time-spaces.

Transforms apply time scale first, and then offset.

Constructor & Destructor Documentation

◆ FMovieSceneTimeTransform() [1/2]

FMovieSceneTimeTransform::FMovieSceneTimeTransform ( )
inline

Default construction to the identity transform

◆ FMovieSceneTimeTransform() [2/2]

FMovieSceneTimeTransform::FMovieSceneTimeTransform ( FFrameTime  InOffset,
float  InTimeScale = 1.f 
)
inlineexplicit

Construction from an offset, and a scale

Parameters
InOffsetThe offset to translate by
InTimeScaleThe timescale. For instance, if a sequence is playing twice as fast, pass 2.f

Member Function Documentation

◆ Inverse()

FMovieSceneTimeTransform FMovieSceneTimeTransform::Inverse ( ) const
inline

Retrieve the inverse of this transform

◆ IsIdentity()

bool FMovieSceneTimeTransform::IsIdentity ( ) const
inline

Returns whether this transform is an identity transform.

Friends And Related Symbol Documentation

◆ operator!=

bool operator!= ( const FMovieSceneTimeTransform A,
const FMovieSceneTimeTransform B 
)
friend

◆ operator==

bool operator== ( const FMovieSceneTimeTransform A,
const FMovieSceneTimeTransform B 
)
friend

Member Data Documentation

◆ Offset

FFrameTime FMovieSceneTimeTransform::Offset

Scalar frame offset applied after the scale

◆ TimeScale

float FMovieSceneTimeTransform::TimeScale

The sequence's time scale (or play rate)


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