UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
UE::MovieScene::FTransformTimeParams Struct Reference

#include <MovieSceneTransformTypes.h>

Public Member Functions

 FTransformTimeParams ()
 
MOVIESCENE_API FTransformTimeParamsHarvestBreadcrumbs (FMovieSceneTransformBreadcrumbs &OutBreadcrumbs)
 
MOVIESCENE_API FTransformTimeParamsAppendBreadcrumbs (FMovieSceneTransformBreadcrumbs &OutBreadcrumbs)
 
MOVIESCENE_API FTransformTimeParamsTrackCycleCounts (TOptional< int32 > *OutCycleCounter)
 
MOVIESCENE_API FTransformTimeParamsIgnoreClamps ()
 

Public Attributes

FMovieSceneTransformBreadcrumbsBreadcrumbs
 
TOptional< int32 > * CycleCount
 
uint8 bIgnoreClamps: 1
 

Detailed Description

Parameter structure that controls time-transformation operations in MovieScene code

Constructor & Destructor Documentation

◆ FTransformTimeParams()

UE::MovieScene::FTransformTimeParams::FTransformTimeParams ( )
inline

Member Function Documentation

◆ AppendBreadcrumbs()

FTransformTimeParams & UE::MovieScene::FTransformTimeParams::AppendBreadcrumbs ( FMovieSceneTransformBreadcrumbs OutBreadcrumbs)

Instruct the algorithm to add breadcrumbs to the specified container as it performs the transformation

Note
: this function will not empty the breadcrumbs, allowing the callsite to append paths of breadcrumbs together

◆ HarvestBreadcrumbs()

FTransformTimeParams & UE::MovieScene::FTransformTimeParams::HarvestBreadcrumbs ( FMovieSceneTransformBreadcrumbs OutBreadcrumbs)

Instruct the algorithm to add breadcrumbs to the specified container as it performs the transformation

Note
: this function will empty the breadcrumbs

◆ IgnoreClamps()

FTransformTimeParams & UE::MovieScene::FTransformTimeParams::IgnoreClamps ( )

Ignore clamping operations while transforming the time.

◆ TrackCycleCounts()

FTransformTimeParams & UE::MovieScene::FTransformTimeParams::TrackCycleCounts ( TOptional< int32 > *  OutCycleCounter)

Instruct the algorithm to track the cycle counts

Member Data Documentation

◆ bIgnoreClamps

uint8 UE::MovieScene::FTransformTimeParams::bIgnoreClamps

Whether to ignore clamp operations or not

◆ Breadcrumbs

FMovieSceneTransformBreadcrumbs* UE::MovieScene::FTransformTimeParams::Breadcrumbs

Breadcrumbs structure. When non-null, breadcrumbs will be added according to its FMovieSceneTransformBreadcrumbs::Mode

◆ CycleCount

TOptional<int32>* UE::MovieScene::FTransformTimeParams::CycleCount

Pointer that receives the last encountered cycle count


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