UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
Public Member Functions | Public Attributes | Friends | List of all members
FMovieSceneNestedSequenceTransform Struct Reference

#include <MovieSceneSequenceTransform.h>

Public Member Functions

MOVIESCENE_API FMovieSceneNestedSequenceTransform ()
 
MOVIESCENE_API FMovieSceneNestedSequenceTransform (const FMovieSceneNestedSequenceTransform &)
 
MOVIESCENE_API FMovieSceneNestedSequenceTransform & operator= (const FMovieSceneNestedSequenceTransform &)
 
MOVIESCENE_API FMovieSceneNestedSequenceTransform (FMovieSceneNestedSequenceTransform &&)
 
MOVIESCENE_API FMovieSceneNestedSequenceTransform & operator= (FMovieSceneNestedSequenceTransform &&)
 
MOVIESCENE_API ~FMovieSceneNestedSequenceTransform ()
 
 FMovieSceneNestedSequenceTransform (FMovieSceneTimeWarpVariant &&InVariant)
 
 FMovieSceneNestedSequenceTransform (const FMovieSceneTimeTransform &InLinearTransform)
 
 FMovieSceneNestedSequenceTransform (FFrameTime InOffset, double InTimeScale)
 
 FMovieSceneNestedSequenceTransform (FFrameTime InOffset, FMovieSceneTimeWarpVariant &&InTimeScale)
 
bool IsLinear () const
 
FMovieSceneTimeTransform AsLinear () const
 
bool NeedsBreadcrumb () const
 
bool IsIdentity () const
 
MOVIESCENE_API FFrameTime TransformTime (FFrameTime Time) const
 
MOVIESCENE_API FFrameTime TransformTime (FFrameTime Time, const UE::MovieScene::FTransformTimeParams &Params) const
 
MOVIESCENE_API FMovieSceneInverseNestedSequenceTransform Inverse () const
 
MOVIESCENE_API TRange< FFrameTime > ComputeTraversedHull (const TRange< FFrameTime > &Range) const
 
MOVIESCENE_API bool SupportsBoundaries () const
 
MOVIESCENE_API TOptional< UE::MovieScene::ETimeWarpChannelDomain > GetWarpDomain () const
 
MOVIESCENE_API bool ExtractBoundariesWithinRange (const TRange< FFrameTime > &UntransformedRange, const TFunctionRef< bool(FFrameTime)> &Visitor) const
 
MOVIESCENE_API void ToString (TStringBuilderBase< TCHAR > &OutBuilder) const
 
void PostSerialize (const FArchive &Ar)
 
 FMovieSceneNestedSequenceTransform (const FMovieSceneTimeWarping &InWarping)
 
 FMovieSceneNestedSequenceTransform (FMovieSceneTimeTransform InLinearTransform, const FMovieSceneTimeWarping &InWarping)
 
bool IsLooping () const
 
FMovieSceneNestedSequenceTransform InverseLinearOnly () const
 
FMovieSceneNestedSequenceTransform InverseFromWarp (uint32 WarpCount) const
 

Public Attributes

FMovieSceneTimeWarping Warping
 

Friends

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

Detailed Description

Structure used to represent a specific transformation (ie from untransformed to transformed space) that cannot be combined with another.

Stored as a stack inside FMovieSceneSequenceTransform to represent a complete transformation from inner time-space to outer time-space.

Constructor & Destructor Documentation

◆ FMovieSceneNestedSequenceTransform() [1/9]

PRAGMA_DISABLE_DEPRECATION_WARNINGS FMovieSceneNestedSequenceTransform::FMovieSceneNestedSequenceTransform ( )
default

Default construction to an identity linear transform

◆ FMovieSceneNestedSequenceTransform() [2/9]

FMovieSceneNestedSequenceTransform::FMovieSceneNestedSequenceTransform ( const FMovieSceneNestedSequenceTransform &  )
default

◆ FMovieSceneNestedSequenceTransform() [3/9]

FMovieSceneNestedSequenceTransform::FMovieSceneNestedSequenceTransform ( FMovieSceneNestedSequenceTransform &&  )
default

◆ ~FMovieSceneNestedSequenceTransform()

FMovieSceneNestedSequenceTransform::~FMovieSceneNestedSequenceTransform ( )
default

◆ FMovieSceneNestedSequenceTransform() [4/9]

FMovieSceneNestedSequenceTransform::FMovieSceneNestedSequenceTransform ( FMovieSceneTimeWarpVariant &&  InVariant)
inline

Construction from a time warp variant

◆ FMovieSceneNestedSequenceTransform() [5/9]

FMovieSceneNestedSequenceTransform::FMovieSceneNestedSequenceTransform ( const FMovieSceneTimeTransform &  InLinearTransform)
inline

Construction from a linear time transformation

◆ FMovieSceneNestedSequenceTransform() [6/9]

FMovieSceneNestedSequenceTransform::FMovieSceneNestedSequenceTransform ( FFrameTime  InOffset,
double  InTimeScale 
)
inline

Construction from a linear time transformation (scale applies first)

◆ FMovieSceneNestedSequenceTransform() [7/9]

FMovieSceneNestedSequenceTransform::FMovieSceneNestedSequenceTransform ( FFrameTime  InOffset,
FMovieSceneTimeWarpVariant &&  InTimeScale 
)
inline

Default construction to an identity linear transform

◆ FMovieSceneNestedSequenceTransform() [8/9]

FMovieSceneNestedSequenceTransform::FMovieSceneNestedSequenceTransform ( const FMovieSceneTimeWarping &  InWarping)
inline

◆ FMovieSceneNestedSequenceTransform() [9/9]

FMovieSceneNestedSequenceTransform::FMovieSceneNestedSequenceTransform ( FMovieSceneTimeTransform  InLinearTransform,
const FMovieSceneTimeWarping &  InWarping 
)
inline

Member Function Documentation

◆ AsLinear()

FMovieSceneTimeTransform FMovieSceneNestedSequenceTransform::AsLinear ( ) const
inline

Convert this transform to its linear form.

Note
This is only valid to call where IsLinear() is true

◆ ComputeTraversedHull()

TRange< FFrameTime > FMovieSceneNestedSequenceTransform::ComputeTraversedHull ( const TRange< FFrameTime > &  Range) const

Given a range in untransformed space, compute the hull of times that this range encompass when transformed. For instance, if this transform represents a loop of [0, 10) an input range of:

  • [15,19) would yield [5,9)
  • [5,25) would yield [0,10)
Note
Disjoint ranges are not supported by this function. An input of [5, 19) under the previous example would yield [0, 9) because we can only return a single range.

◆ ExtractBoundariesWithinRange()

bool FMovieSceneNestedSequenceTransform::ExtractBoundariesWithinRange ( const TRange< FFrameTime > &  UntransformedRange,
const TFunctionRef< bool(FFrameTime)> &  Visitor 
) const

Extract all the boundaries for this transform within the specified untransformed start and end time, invoking Visitor for every boundary that is present within the range. Iteration will continue until Visitor returns false, at which point this function itself will return false.

Parameters
UntransformedRangeThe range within which Visitor can be invoked in untransformed space
VisitorA functor to invoke for every boundary that is found within the range. Return value signifies whether iteration continues (true) or not (false)
Returns
(true) if there were no boundaries, or Visitor returned true for all encountered boundaries; false otherwise

◆ GetWarpDomain()

TOptional< UE::MovieScene::ETimeWarpChannelDomain > FMovieSceneNestedSequenceTransform::GetWarpDomain ( ) const

Retrieve this nested transform's time-warp domain, if it has one

◆ Inverse()

FMovieSceneInverseNestedSequenceTransform FMovieSceneNestedSequenceTransform::Inverse ( ) const

Generate the inverse of this transformation (ie a transform from transformed to untransformed space)

◆ InverseFromWarp()

FMovieSceneNestedSequenceTransform FMovieSceneNestedSequenceTransform::InverseFromWarp ( uint32  WarpCount) const
inline

◆ InverseLinearOnly()

FMovieSceneNestedSequenceTransform FMovieSceneNestedSequenceTransform::InverseLinearOnly ( ) const
inline

◆ IsIdentity()

bool FMovieSceneNestedSequenceTransform::IsIdentity ( ) const
inline

Returns whether this transform is an identity transformation (ie, a*T = a)

◆ IsLinear()

bool FMovieSceneNestedSequenceTransform::IsLinear ( ) const
inline

Check whether this transform is linear (true) or not (false)

◆ IsLooping()

bool FMovieSceneNestedSequenceTransform::IsLooping ( ) const
inline

◆ NeedsBreadcrumb()

bool FMovieSceneNestedSequenceTransform::NeedsBreadcrumb ( ) const
inline

Check whether this transformation requires a breadcrumb trail (true) or not (false)

Note
Breadcrumbs may still be added for dense trails

◆ operator=() [1/2]

FMovieSceneNestedSequenceTransform & FMovieSceneNestedSequenceTransform::operator= ( const FMovieSceneNestedSequenceTransform &  )
default

◆ operator=() [2/2]

FMovieSceneNestedSequenceTransform & FMovieSceneNestedSequenceTransform::operator= ( FMovieSceneNestedSequenceTransform &&  )
default

◆ PostSerialize()

PRAGMA_ENABLE_DEPRECATION_WARNINGS void FMovieSceneNestedSequenceTransform::PostSerialize ( const FArchive &  Ar)

◆ SupportsBoundaries()

bool FMovieSceneNestedSequenceTransform::SupportsBoundaries ( ) const

Check whether this transformation supports 'boundaries'. A boundary is implementation defined, but is generally a loop or cycle point.

◆ ToString()

void FMovieSceneNestedSequenceTransform::ToString ( TStringBuilderBase< TCHAR > &  OutBuilder) const

Convert this transformation to a string representation

◆ TransformTime() [1/2]

FFrameTime FMovieSceneNestedSequenceTransform::TransformTime ( FFrameTime  Time) const

Transform the specified time from untransformed to transformed space

Parameters
TimeThe untransformed time to transform
Returns
the transformed time

◆ TransformTime() [2/2]

FFrameTime FMovieSceneNestedSequenceTransform::TransformTime ( FFrameTime  Time,
const UE::MovieScene::FTransformTimeParams &  Params 
) const

Transform the specified time from untransformed to transformed space

Parameters
TimeThe untransformed time to transform
ParamsTransformation parameters, allowing control over the transformation, and gathering of breadcrumbs
Returns
the transformed time

Friends And Related Symbol Documentation

◆ operator!=

bool operator!= ( const FMovieSceneNestedSequenceTransform &  A,
const FMovieSceneNestedSequenceTransform &  B 
)
friend

Inequality comparison

◆ operator==

bool operator== ( const FMovieSceneNestedSequenceTransform &  A,
const FMovieSceneNestedSequenceTransform &  B 
)
friend

Equality comparison

Member Data Documentation

◆ Warping

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