Navigation
API > API/Runtime > API/Runtime/MovieScene
A time-warp defined as a play rate curve. Time remapping is computed using the integral of the play rate curve.
| Name | UMovieScenePlayRateCurve |
| Type | class |
| Header File | /Engine/Source/Runtime/MovieScene/Public/Variants/MovieScenePlayRateCurve.h |
| Include Path | #include "Variants/MovieScenePlayRateCurve.h" |
Syntax
UCLASS (MinimalAPI, DisplayName="Play Rate Curve")
class UMovieScenePlayRateCurve : public UMovieSceneTimeWarpGetter
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UMovieSceneSignedObject → UMovieSceneNumericVariantGetter → UMovieSceneTimeWarpGetter → UMovieScenePlayRateCurve
Implements Interfaces
Derived Classes
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
UMovieScenePlayRateCurve() |
Variants/MovieScenePlayRateCurve.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bManualPlaybackStart | bool | Variants/MovieScenePlayRateCurve.h |
|
|
| bUpToDate | bool | False when IntegratedTimeWarp needs to be udpated | Variants/MovieScenePlayRateCurve.h | |
| PlaybackStartFrame | FFrameNumber | Variants/MovieScenePlayRateCurve.h |
|
|
| PlayRate | FMovieSceneTimeWarpChannel | Curve defined in play-rate space. Does not support cycling. | Variants/MovieScenePlayRateCurve.h |
|
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| IntegratedTimeWarp | UE::MovieScene::FPiecewiseCurve | Curve defined in time-warp space as an integral of the PlayRate curve | Variants/MovieScenePlayRateCurve.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
const UE::MovieScene::FPiecewiseCurve & GetTimeWarpCurve() |
Variants/MovieScenePlayRateCurve.h |
Overridden from UMovieSceneTimeWarpGetter
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual TRange< FFrameTime > ComputeTraversedHull
(
const TRange< FFrameTime >& Range |
Given a continuous unwarped time range, compute the hull of warped times that are contained. | Variants/MovieScenePlayRateCurve.h | |
virtual bool DeleteChannel
(
FMovieSceneTimeWarpVariant& OutVariant, |
Attempt to delete this time-warp from a channel proxy if it matches the specified name | Variants/MovieScenePlayRateCurve.h | |
virtual UE::MovieScene::ETimeWarpChannelDomain GetDomain() |
Retrieve the time domain that this time warp getter operates within | Variants/MovieScenePlayRateCurve.h | |
virtual void InitializeDefaults() |
Called to initialize the defaults for this time-warp based on its outer Unimplemented by default | Variants/MovieScenePlayRateCurve.h | |
virtual TOptional< FFrameTime > InverseRemapTimeCycled
(
FFrameTime InValue, |
Attempt to transform a time-warped time into its corresponding non-time-warped time. | Variants/MovieScenePlayRateCurve.h | |
virtual bool InverseRemapTimeWithinRange
(
FFrameTime InTime, |
Attempt to transform a time-warped time into its corresponding non-time-warped time within a specified unwarped range. | Variants/MovieScenePlayRateCurve.h | |
virtual EMovieSceneChannelProxyType PopulateChannelProxy
(
FMovieSceneChannelProxyData& OutProxyData, |
Populate a channel proxy with this time-warp if possible | Variants/MovieScenePlayRateCurve.h | |
virtual FFrameTime RemapTime
(
FFrameTime In |
Begin UMovieSceneTimeWarpGetter Implementation | Variants/MovieScenePlayRateCurve.h | |
virtual void ScaleBy
(
double UnwarpedScaleFactor |
Scale this time-warping in its time-domain based on the specified unwarped scale factor | Variants/MovieScenePlayRateCurve.h |
Overridden from UObject
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual bool Modify
(
bool bAlwaysMarkDirty |
Variants/MovieScenePlayRateCurve.h |
Protected
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void InvalidateTimeWarp() |
Variants/MovieScenePlayRateCurve.h |