1. Epic GamesDeveloper
  3. FMovieSceneSectionTimingParametersFrames

FMovieSceneSectionTimingParametersFrames

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

API > API/Runtime > API/Runtime/MovieScene

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

   
Name FMovieSceneSectionTimingParametersFrames
Type struct
Header File /Engine/Source/Runtime/MovieScene/Public/Sections/MovieSceneSectionTimingParameters.h
Include Path #include "Sections/MovieSceneSectionTimingParameters.h"

Syntax

USTRUCT (BlueprintType )  
struct FMovieSceneSectionTimingParametersFrames

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
bClampToInnerRange uint8 When true, apply clamping to the inner range. Mutually exclusive with bLoop. Sections/MovieSceneSectionTimingParameters.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category="Timing"
bClampToOuterRange uint8 When true, apply clamping to the outer range before anything else. Sections/MovieSceneSectionTimingParameters.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category="Timing"
bLoop uint8 When true, apply looping to the inner range. Mutually exclusive with bClampToInnerRange. Sections/MovieSceneSectionTimingParameters.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category="Timing"
bReverse uint8 When true, reverses the play direction. Applied after all other transformations Sections/MovieSceneSectionTimingParameters.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category="Timing"
FirstLoopStartOffset FFrameNumber Start offset to apply only to the first loop Sections/MovieSceneSectionTimingParameters.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category="Timing"
InnerEndOffset FFrameNumber End offset (in inner framerate frames) to apply to all loops ie, loop_range=[0 + InnerStartOffset, End- InnerEndOffset) Sections/MovieSceneSectionTimingParameters.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category="Timing"
InnerStartOffset FFrameNumber Start offset (in inner framerate frames) to apply to all loops Sections/MovieSceneSectionTimingParameters.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category="Timing"
PlayRate FMovieSceneTimeWarpVariant Playrate optionally implemented as time-warp Sections/MovieSceneSectionTimingParameters.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category="Timing"

Functions

Public

Name Remarks Include Path Unreal Specifiers

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

   Sections/MovieSceneSectionTimingParameters.h  

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

   Sections/MovieSceneSectionTimingParameters.h  

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

   Sections/MovieSceneSectionTimingParameters.h  

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

 Helpers Sections/MovieSceneSectionTimingParameters.h  

void AddPlayRate ( FMovieSceneSequenceTransform& Transform
) const

   Sections/MovieSceneSectionTimingParameters.h  

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

   Sections/MovieSceneSectionTimingParameters.h  

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

 Deprecated Sections/MovieSceneSectionTimingParameters.h  

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

 Make a transform out of these parameters Sections/MovieSceneSectionTimingParameters.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page