UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
MovieSceneSectionTimingParameters.h
Go to the documentation of this file.
1// Copyright Epic Games, Inc. All Rights Reserved.
2
3#pragma once
4
5#include "CoreTypes.h"
6#include "Variants/MovieSceneTimeWarpVariant.h"
7#include "Misc/FrameNumber.h"
8#include "MovieSceneSectionTimingParameters.generated.h"
9
10
11struct FMovieSceneSequenceTransform;
12class UMovieScene;
13
26USTRUCT(BlueprintType)
27struct FMovieSceneSectionTimingParametersSeconds
28{
29 GENERATED_BODY()
30
31
34 UPROPERTY(BlueprintReadWrite, EditAnywhere, Category="Timing")
35 FMovieSceneTimeWarpVariant PlayRate;
36
40 UPROPERTY(BlueprintReadWrite, EditAnywhere, Category="Timing", meta=(Units=s))
41 float InnerStartOffset = 0.f;
42
46 UPROPERTY(BlueprintReadWrite, EditAnywhere, Category="Timing", meta=(Units=s))
47 float InnerEndOffset = 0.f;
48
52 UPROPERTY(BlueprintReadWrite, EditAnywhere, Category="Timing", meta=(Units=s))
53 float FirstLoopStartOffset = 0.f;
54
58 UPROPERTY(BlueprintReadWrite, EditAnywhere, Category="Timing")
59 uint8 bLoop : 1 = 0;
60
64 UPROPERTY(BlueprintReadWrite, EditAnywhere, Category="Timing")
65 uint8 bClampToInnerRange : 1 = 0;
66
70 UPROPERTY(BlueprintReadWrite, EditAnywhere, Category="Timing")
71 uint8 bReverse : 1 = 0;
72
76 UPROPERTY(BlueprintReadWrite, EditAnywhere, Category="Timing")
77 uint8 bClampToOuterRange : 1 = 0;
78
82 MOVIESCENE_API FMovieSceneSequenceTransform MakeTransform(const FFrameRate& OuterFrameRate, const TRange<FFrameNumber>& OuterRange, double SourceDuration, double InnerPlayRate) const;
83
87 MOVIESCENE_API void AddOffset(FMovieSceneSequenceTransform& Transform, const FFrameTime& Offset) const;
88
89 MOVIESCENE_API void AddPositionInOuterAsOffset(FMovieSceneSequenceTransform& Transform, const TRange<FFrameNumber>& OuterRange) const;
90
91 MOVIESCENE_API void AddPlayRate(FMovieSceneSequenceTransform& Transform) const;
92
93 MOVIESCENE_API void AddFrameRateConversion(FMovieSceneSequenceTransform& Transform, const FFrameRate& OuterFrameRate, const FFrameRate& InnerFrameRate) const;
94
95 MOVIESCENE_API void AddInnerStartOffset(FMovieSceneSequenceTransform& Transform, const FFrameTime& Offset) const;
96
97 MOVIESCENE_API void AddLoopingOrClampingAndReverse(FMovieSceneSequenceTransform& Result, const double Duration, const double Offset) const;
98
102 UE_DEPRECATED(5.7, "Please use AddOffset, or the version of AddPositionInOuterAsOffset that takes an outer range")
103 void AddPositionInOuterAsOffset(FMovieSceneSequenceTransform& Transform, const FFrameTime& Offset) const { AddOffset(Transform, Offset); }
104};
105
106
119USTRUCT(BlueprintType)
120struct FMovieSceneSectionTimingParametersFrames
121{
122 GENERATED_BODY()
123
124
127 UPROPERTY(BlueprintReadWrite, EditAnywhere, Category="Timing")
128 FMovieSceneTimeWarpVariant PlayRate;
129
133 UPROPERTY(BlueprintReadWrite, EditAnywhere, Category="Timing")
134 FFrameNumber InnerStartOffset = 0;
135
139 UPROPERTY(BlueprintReadWrite, EditAnywhere, Category="Timing")
140 FFrameNumber InnerEndOffset = 0;
141
145 UPROPERTY(BlueprintReadWrite, EditAnywhere, Category="Timing")
146 FFrameNumber FirstLoopStartOffset = 0;
147
151 UPROPERTY(BlueprintReadWrite, EditAnywhere, Category="Timing")
152 uint8 bLoop : 1 = 0;
153
157 UPROPERTY(BlueprintReadWrite, EditAnywhere, Category="Timing")
158 uint8 bClampToInnerRange : 1 = 0;
159
163 UPROPERTY(BlueprintReadWrite, EditAnywhere, Category="Timing")
164 uint8 bReverse : 1 = 0;
165
169 UPROPERTY(BlueprintReadWrite, EditAnywhere, Category="Timing")
170 uint8 bClampToOuterRange : 1 = 0;
171
175 MOVIESCENE_API FMovieSceneSequenceTransform MakeTransform(const FFrameRate& OuterFrameRate, const TRange<FFrameNumber>& OuterRange, const FFrameRate& InnerFrameRate, const TRange<FFrameNumber>& InnerRange) const;
176
180 MOVIESCENE_API void AddOffset(FMovieSceneSequenceTransform& Transform, const FFrameTime& Offset) const;
181
182 MOVIESCENE_API void AddPositionInOuterAsOffset(FMovieSceneSequenceTransform& Transform, const TRange<FFrameNumber>& OuterRange) const;
183
184 MOVIESCENE_API void AddPlayRate(FMovieSceneSequenceTransform& Transform) const;
185
186 MOVIESCENE_API void AddFrameRateConversion(FMovieSceneSequenceTransform& Transform, const FFrameRate& OuterFrameRate, const FFrameRate& InnerFrameRate) const;
187
188 MOVIESCENE_API void AddInnerStartOffset(FMovieSceneSequenceTransform& Transform, const FFrameTime& Offset) const;
189
190 MOVIESCENE_API void AddLoopingOrClampingAndReverse(FMovieSceneSequenceTransform& Result, const FFrameNumber& Duration, const FFrameNumber& Offset) const;
191
195 UE_DEPRECATED(5.7, "Please use AddOffset, or the version of AddPositionInOuterAsOffset that takes an outer range")
196 void AddPositionInOuterAsOffset(FMovieSceneSequenceTransform& Transform, const FFrameTime& Offset) const { AddOffset(Transform, Offset); }
197};
198
199namespace UE::MovieScene
200{
201
202
203
204} // namespace UE::MovieScene
UE_DEPRECATED
#define UE_DEPRECATED(Version, Message)
Definition CoreMiscDefines.h:302
StaticCastSharedRef
UE_FORCEINLINE_HINT TSharedRef< CastToType, Mode > StaticCastSharedRef(TSharedRef< CastFromType, Mode > const &InSharedRef)
Definition SharedPointer.h:127
UPROPERTY
#define UPROPERTY(...)
UObject definition macros.
Definition ObjectMacros.h:744
GENERATED_BODY
#define GENERATED_BODY(...)
Definition ObjectMacros.h:765
USTRUCT
#define USTRUCT(...)
Definition ObjectMacros.h:746
Offset
uint32 Offset
Definition VulkanMemory.cpp:4033
uint8
uint8_t uint8
Definition binka_ue_file_header.h:8
TRange
Definition Range.h:50
UMovieScene
Definition MovieScene.h:358
UE::MovieScene
Definition ConstraintsManager.h:14
FFrameNumber
Definition FrameNumber.h:18
FFrameRate
Definition FrameRate.h:21
FFrameTime
Definition FrameTime.h:16
FMovieSceneSectionTimingParametersFrames
Definition MovieSceneSectionTimingParameters.h:121
FMovieSceneSectionTimingParametersSeconds
Definition MovieSceneSectionTimingParameters.h:28
FMovieSceneSequenceTransform
Definition MovieSceneSequenceTransform.h:625
FMovieSceneTimeWarpVariant
Definition MovieSceneTimeWarpVariant.h:51