FMovieSceneSectionTimingParametersFrames Struct Reference

#include <MovieSceneSectionTimingParameters.h>

Public Member Functions
MOVIESCENE_API FMovieSceneSequenceTransform	MakeTransform (const FFrameRate &OuterFrameRate, const TRange< FFrameNumber > &OuterRange, const FFrameRate &InnerFrameRate, const TRange< FFrameNumber > &InnerRange) const
MOVIESCENE_API void	AddOffset (FMovieSceneSequenceTransform &Transform, const FFrameTime &Offset) const
MOVIESCENE_API void	AddPositionInOuterAsOffset (FMovieSceneSequenceTransform &Transform, const TRange< FFrameNumber > &OuterRange) const
MOVIESCENE_API void	AddPlayRate (FMovieSceneSequenceTransform &Transform) const
MOVIESCENE_API void	AddFrameRateConversion (FMovieSceneSequenceTransform &Transform, const FFrameRate &OuterFrameRate, const FFrameRate &InnerFrameRate) const
MOVIESCENE_API void	AddInnerStartOffset (FMovieSceneSequenceTransform &Transform, const FFrameTime &Offset) const
MOVIESCENE_API void	AddLoopingOrClampingAndReverse (FMovieSceneSequenceTransform &Result, const FFrameNumber &Duration, const FFrameNumber &Offset) const
void	AddPositionInOuterAsOffset (FMovieSceneSequenceTransform &Transform, const FFrameTime &Offset) const

Public Attributes
FMovieSceneTimeWarpVariant	PlayRate
FFrameNumber	InnerStartOffset = 0
FFrameNumber	InnerEndOffset = 0
FFrameNumber	FirstLoopStartOffset = 0
uint8	bLoop: 1 = 0
uint8	bClampToInnerRange: 1 = 0
uint8	bReverse: 1 = 0
uint8	bClampToOuterRange: 1 = 0

Detailed Description

Parameter utility that converts section timing parameters to a transform using inner frame values.

Transformation happens in the following order:

InputTime (relative to section start) >> Play Rate / Time Warp >> FrameRate conversion >> +StartTimeOffset >> Loop (% duration) >> Reverse

Member Function Documentation

AddFrameRateConversion()

void FMovieSceneSectionTimingParametersFrames::AddFrameRateConversion	(	FMovieSceneSequenceTransform &	Transform,
		const FFrameRate &	OuterFrameRate,
		const FFrameRate &	InnerFrameRate
	)		const

AddInnerStartOffset()

void FMovieSceneSectionTimingParametersFrames::AddInnerStartOffset	(	FMovieSceneSequenceTransform &	Transform,
		const FFrameTime &	Offset
	)		const

AddLoopingOrClampingAndReverse()

void FMovieSceneSectionTimingParametersFrames::AddLoopingOrClampingAndReverse	(	FMovieSceneSequenceTransform &	Result,
		const FFrameNumber &	Duration,
		const FFrameNumber &	Offset
	)		const

AddOffset()

void FMovieSceneSectionTimingParametersFrames::AddOffset	(	FMovieSceneSequenceTransform &	Transform,
		const FFrameTime &	Offset
	)		const

Helpers

AddPlayRate()

void FMovieSceneSectionTimingParametersFrames::AddPlayRate

(

FMovieSceneSequenceTransform &

Transform

)

const

AddPositionInOuterAsOffset() [1/2]

void FMovieSceneSectionTimingParametersFrames::AddPositionInOuterAsOffset ( FMovieSceneSequenceTransform &  Transform, const FFrameTime &  Offset  ) const

inline

Deprecated

AddPositionInOuterAsOffset() [2/2]

void FMovieSceneSectionTimingParametersFrames::AddPositionInOuterAsOffset	(	FMovieSceneSequenceTransform &	Transform,
		const TRange< FFrameNumber > &	OuterRange
	)		const

MakeTransform()

FMovieSceneSequenceTransform FMovieSceneSectionTimingParametersFrames::MakeTransform	(	const FFrameRate &	OuterFrameRate,
		const TRange< FFrameNumber > &	OuterRange,
		const FFrameRate &	InnerFrameRate,
		const TRange< FFrameNumber > &	InnerRange
	)		const

Make a transform out of these parameters

Member Data Documentation

bClampToInnerRange

uint8 FMovieSceneSectionTimingParametersFrames::bClampToInnerRange

When true, apply clamping to the inner range. Mutually exclusive with bLoop.

bClampToOuterRange

uint8 FMovieSceneSectionTimingParametersFrames::bClampToOuterRange

When true, apply clamping to the outer range before anything else.

bLoop

uint8 FMovieSceneSectionTimingParametersFrames::bLoop

When true, apply looping to the inner range. Mutually exclusive with bClampToInnerRange.

bReverse

uint8 FMovieSceneSectionTimingParametersFrames::bReverse

When true, reverses the play direction. Applied after all other transformations

FirstLoopStartOffset

FFrameNumber FMovieSceneSectionTimingParametersFrames::FirstLoopStartOffset = 0

Start offset to apply only to the first loop

InnerEndOffset

FFrameNumber FMovieSceneSectionTimingParametersFrames::InnerEndOffset = 0

End offset (in inner framerate frames) to apply to all loops ie, loop_range=[0 + InnerStartOffset, End- InnerEndOffset)

InnerStartOffset

FFrameNumber FMovieSceneSectionTimingParametersFrames::InnerStartOffset = 0

Start offset (in inner framerate frames) to apply to all loops

PlayRate

FMovieSceneTimeWarpVariant FMovieSceneSectionTimingParametersFrames::PlayRate

Playrate optionally implemented as time-warp

---

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

• Engine/Source/Runtime/MovieScene/Public/Sections/MovieSceneSectionTimingParameters.h
• Engine/Source/Runtime/MovieScene/Private/Sections/MovieSceneSectionTimingParameters.cpp