Navigation
API > API/Runtime > API/Runtime/MovieScene > API/Runtime/MovieScene/Evaluation
References
| Module | MovieScene |
| Header | /Engine/Source/Runtime/MovieScene/Public/Evaluation/MovieSceneSequenceTransform.h |
| Include | #include "Evaluation/MovieSceneSequenceTransform.h" |
Syntax
USTRUCT ()
struct FMovieSceneSequenceTransform
Remarks
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.
Variables
| Type | Name | Description | |
|---|---|---|---|
| FMovieSceneTimeTransform | LinearTransform | The initial linear transformation represented as a 2D matrix. Always applied first. | |
| TArray< FMovieSceneNestedSequenceTransform > | NestedTransforms | Additional transformations that should be applied after LinearTransform. |
Constructors
| Type | Name | Description | |
|---|---|---|---|
| Default construction to the identity transform | |||
FMovieSceneSequenceTransform
(
FMovieSceneTimeTransform InLinearTransform |
Construction from a linear time transform. | ||
FMovieSceneSequenceTransform
(
FMovieSceneNestedSequenceTransform&& InNestedTransform |
Construction from a single nested sequence transform structure | ||
FMovieSceneSequenceTransform
(
FFrameTime InOffset, |
Construction from an offset, and a scale |
Functions
| Type | Name | Description | |
|---|---|---|---|
| void | Add
(
FFrameTime InOffset, |
Add the specified warping transform to the end of this transform stack with an offset (ie, applying it last) | |
| void | Add
(
FMovieSceneTimeTransform InTransform |
Add the specified linear transform to the end of this transform stack (ie, applying it last) | |
| void | AddLoop
(
FFrameNumber Start, |
Add an entry to this transform denoting it should loop between the specified start and end point | |
| void | Append
(
const FMovieSceneSequenceTransform& Tail |
Append another transform to this one, resulting in a transform that effectively goes from this -> Tail | |
| FMovieSceneTimeTransform | AsLinear () |
Convert this transform to its linear representation. | |
| TRange< FFrameTime > | ComputeTraversedHull
(
const TRange< FFrameNumber >& Range |
Given a range in untransformed space, compute the hull of times that this range encompass when transformed. | |
| TRange< FFrameTime > | ComputeTraversedHull
(
const TRange< FFrameTime >& Range |
Given a range in untransformed space, compute the hull of times that this range encompass when transformed. | |
| bool | ExtractBoundariesWithinRange
(
FFrameTime UntransformedStart, |
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. | |
| TOptional< UE::MovieScene::ETimeWarpChannelDomain > | Retrieve the first active timewarp domain that is present in this transform, if any is present at all | ||
| float | GetTimeScale () |
||
| FMovieSceneInverseSequenceTransform | Inverse () |
Compute the inverse of this transform, that is: the transform that goes from transformed to untransformed space. | |
| FMovieSceneSequenceTransform | |||
| FMovieSceneTimeTransform | |||
| FMovieSceneSequenceTransform | InverseFromLoop
(
const TArrayView< const uint32 >& LoopCounts |
||
| FMovieSceneSequenceTransform | InverseFromLoop
(
const FMovieSceneWarpCounter& LoopCounter |
||
| FMovieSceneSequenceTransform | InverseFromLoop
(
const TArrayView< const FFrameTime >& Breadcrumbs |
||
| FMovieSceneTimeTransform | InverseFromWarp
(
const TArrayView< const uint32 >& WarpCounts |
||
| FMovieSceneTimeTransform | InverseFromWarp
(
const FMovieSceneWarpCounter& WarpCounter |
||
| FMovieSceneTimeTransform | |||
| FMovieSceneSequenceTransform | |||
| bool | IsIdentity () |
Returns whether this sequence transform is an identity transform (i.e. it doesn't change anything). | |
| bool | IsLinear () |
Returns whether this sequence transform is purely linear (i.e. doesn't involve time warping). | |
| bool | IsLooping () |
||
| bool | Returns whether this sequence transform includes any time warping. | ||
| TRange< FFrameTime > | TransformRangeConstrained
(
const TRange< FFrameTime >& Range |
||
| TRange< FFrameNumber > | TransformRangeConstrained
(
const TRange< FFrameNumber >& Range |
||
| TRange< FFrameTime > | TransformRangePure
(
const TRange< FFrameTime >& Range |
||
| TRange< FFrameNumber > | TransformRangePure
(
const TRange< FFrameNumber >& Range |
||
| TRange< FFrameTime > | TransformRangeUnwarped
(
const TRange< FFrameTime >& Range |
||
| TRange< FFrameNumber > | TransformRangeUnwarped
(
const TRange< FFrameNumber >& Range |
||
| FFrameTime | TransformTime
(
FFrameTime InTime, |
Transform the specified time into the inner-most (transformed) space | |
| FFrameTime | TransformTime
(
FFrameTime Time |
Transform the specified time into the inner-most (transformed) space | |
| void | TransformTime
(
FFrameTime InTime, |
Operators
| Type | Name | Description | |
|---|---|---|---|
| FMovieSceneSequenceTransform | operator*
(
const FMovieSceneSequenceTransform& RHS |
Multiply this tranmsform with another transform, resulting in a single transform that gets from RHS parent to LHS space |