1. Epic GamesDeveloper
  3. FMovieSceneSequenceTransform

FMovieSceneSequenceTransform

Movie scene sequence transform class that transforms from one time-space to another, represented as a linear transformation plus zero or more complex, non-linear transformations.

API > API/Runtime > API/Runtime/MovieScene

Movie scene sequence transform class that transforms from one time-space to another, represented as a linear transformation plus zero or more complex, non-linear transformations.

   
Name FMovieSceneSequenceTransform
Type struct
Header File /Engine/Source/Runtime/MovieScene/Public/Evaluation/MovieSceneSequenceTransform.h
Include Path #include "Evaluation/MovieSceneSequenceTransform.h"

Syntax

USTRUCT ()  
struct FMovieSceneSequenceTransform

Constructors

Name Remarks Include Path Unreal Specifiers
Construction from a single nested sequence transform structure Evaluation/MovieSceneSequenceTransform.h  

FMovieSceneSequenceTransform ( FFrameTime InOffset,
float InTimeScale
)

 Construction from an offset, and a scale Evaluation/MovieSceneSequenceTransform.h  
Construction from a linear time transform. Evaluation/MovieSceneSequenceTransform.h  
Default construction to the identity transform Evaluation/MovieSceneSequenceTransform.h  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
LinearTransform FMovieSceneTimeTransform The initial linear transformation represented as a 2D matrix. Always applied first. Evaluation/MovieSceneSequenceTransform.h  
NestedTransforms TArray< FMovieSceneNestedSequenceTransform > Additional transformations that should be applied after LinearTransform. Evaluation/MovieSceneSequenceTransform.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void Add ( FFrameTime InOffset,
FMovieSceneTimeWarpVariant&& InTimeWarp
)

 Add the specified warping transform to the end of this transform stack with an offset (ie, applying it last) Evaluation/MovieSceneSequenceTransform.h  
Add the specified nested transform to the end of this transform stack (ie, applying it last). Evaluation/MovieSceneSequenceTransform.h  

void Add ( FMovieSceneTimeTransform InTransform
)

 Add the specified linear transform to the end of this transform stack (ie, applying it last) Evaluation/MovieSceneSequenceTransform.h  

void AddLoop ( FFrameNumber Start,
FFrameNumber End
)

 Add an entry to this transform denoting it should loop between the specified start and end point Evaluation/MovieSceneSequenceTransform.h  

void Append ( const FMovieSceneSequenceTransform& Tail
)

 Append another transform to this one, resulting in a transform that effectively goes from this -> Tail Evaluation/MovieSceneSequenceTransform.h  
Convert this transform to its linear representation. Evaluation/MovieSceneSequenceTransform.h  
Given a range in untransformed space, compute the hull of times that this range encompass when transformed. Evaluation/MovieSceneSequenceTransform.h  

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

 Given a range in untransformed space, compute the hull of times that this range encompass when transformed. Evaluation/MovieSceneSequenceTransform.h  

bool ExtractBoundariesWithinRange ( FFrameTime UntransformedStart,
FFrameTime UntransformedEnd,
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. Evaluation/MovieSceneSequenceTransform.h  
Retrieve the first active timewarp domain that is present in this transform, if any is present at all Evaluation/MovieSceneSequenceTransform.h  

float GetTimeScale()

   Evaluation/MovieSceneSequenceTransform.h  
Compute the inverse of this transform, that is: the transform that goes from transformed to untransformed space. Evaluation/MovieSceneSequenceTransform.h  

FMovieSceneSequenceTransform InverseFromAllFirstLoops()

   Evaluation/MovieSceneSequenceTransform.h  

FMovieSceneTimeTransform InverseFromAllFirstWarps()

   Evaluation/MovieSceneSequenceTransform.h  
  Evaluation/MovieSceneSequenceTransform.h  

FMovieSceneSequenceTransform InverseFromLoop ( const TArrayView< const FFrameTime >& Breadcrumbs
) const

   Evaluation/MovieSceneSequenceTransform.h  

FMovieSceneSequenceTransform InverseFromLoop ( const TArrayView< const uint32 >& LoopCounts
) const

   Evaluation/MovieSceneSequenceTransform.h  
  Evaluation/MovieSceneSequenceTransform.h  

FMovieSceneTimeTransform InverseFromWarp ( const TArrayView< const uint32 >& WarpCounts
) const

   Evaluation/MovieSceneSequenceTransform.h  

FMovieSceneTimeTransform InverseLinearOnly()

   Evaluation/MovieSceneSequenceTransform.h  

FMovieSceneSequenceTransform InverseNoLooping()

   Evaluation/MovieSceneSequenceTransform.h  

bool IsIdentity()

 Returns whether this sequence transform is an identity transform (i.e. it doesn't change anything). Evaluation/MovieSceneSequenceTransform.h  

bool IsLinear()

 Returns whether this sequence transform is purely linear (i.e. doesn't involve time warping). Evaluation/MovieSceneSequenceTransform.h  

bool IsLooping()

   Evaluation/MovieSceneSequenceTransform.h  

bool NeedsBreadcrumbs()

 Returns whether this sequence transform includes any time warping. Evaluation/MovieSceneSequenceTransform.h  
  Evaluation/MovieSceneSequenceTransform.h  
  Evaluation/MovieSceneSequenceTransform.h  

TRange< FFrameTime > TransformRangePure ( const TRange< FFrameTime >& Range
) const

   Evaluation/MovieSceneSequenceTransform.h  
  Evaluation/MovieSceneSequenceTransform.h  
  Evaluation/MovieSceneSequenceTransform.h  
  Evaluation/MovieSceneSequenceTransform.h  
Transform the specified time into the inner-most (transformed) space Evaluation/MovieSceneSequenceTransform.h  
Transform the specified time into the inner-most (transformed) space Evaluation/MovieSceneSequenceTransform.h  

void TransformTime ( FFrameTime InTime,
FFrameTime& OutTime,
FMovieSceneWarpCounter& OutWarpCounter
) const

   Evaluation/MovieSceneSequenceTransform.h  

Operators

Name Remarks Include Path Unreal Specifiers
Multiply this tranmsform with another transform, resulting in a single transform that gets from RHS parent to LHS space Evaluation/MovieSceneSequenceTransform.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page