UMovieSceneScalingAnchors | Unreal Engine 5.7 Documentation

API > API/Runtime > API/Runtime/MovieScene

Decoration that is added to a UMovieScene in order to define dynamic scaling anchors to a the sequence. Anchors are defined by scaling 'drivers' which control both the initial (unscaled) position of their anchors, and their scaled position.


Name	UMovieSceneScalingAnchors
Type	class
Header File	/Engine/Source/Runtime/MovieScene/Public/Decorations/MovieSceneScalingAnchors.h
Include Path	#include "Decorations/MovieSceneScalingAnchors.h"

Syntax

UCLASS (MinimalAPI, DisplayName="Anchors", Meta=(Hidden))  
class UMovieSceneScalingAnchors :  
    public UMovieScenePlayRateCurve ,  
    public IMovieSceneDecoration ,  
    public IMovieSceneTimeWarpSource

Inheritance Hierarchy

UObjectBase → UObjectBaseUtility → UObject → UMovieSceneSignedObject → UMovieSceneNumericVariantGetter → UMovieSceneTimeWarpGetter → UMovieScenePlayRateCurve → UMovieSceneScalingAnchors

Implements Interfaces

Constructors

Name	Remarks	Include Path	Unreal Specifiers
UMovieSceneScalingAnchors()		Decorations/MovieSceneScalingAnchors.h

Variables

Protected

Name	Type	Include Path
bPlayRateCurveIsUpToDate	bool	Decorations/MovieSceneScalingAnchors.h
CurrentAnchors	TMap< FGuid, FMovieSceneScalingAnchor >	Decorations/MovieSceneScalingAnchors.h
InitialAnchors	TMap< FGuid, FMovieSceneScalingAnchor >	Decorations/MovieSceneScalingAnchors.h
NewDuration	FFrameTime	Decorations/MovieSceneScalingAnchors.h
ScalingDrivers	TArray< TScriptInterface< IMovieSceneScalingDriver > >	Decorations/MovieSceneScalingAnchors.h
ScalingGroups	TMap< FGuid, FMovieSceneAnchorsScalingGroup >	Decorations/MovieSceneScalingAnchors.h

Functions

Public

Name	Remarks	Include Path
void AddScalingDriver ( TScriptInterface< IMovieSceneScalingDriver > InScalingDriver )	Add a scaling driver to this anchor registry	Decorations/MovieSceneScalingAnchors.h
FMovieSceneAnchorsScalingGroup * FindScalingGroup ( const FGuid& Guid )	Retrieve a scaling group by its ID	Decorations/MovieSceneScalingAnchors.h
const TMap< FGuid, FMovieSceneScalingAnchor > & GetCurrentAnchors()	Retrieve the current, scaled anchors stored in this registry	Decorations/MovieSceneScalingAnchors.h
const TMap< FGuid, FMovieSceneScalingAnchor > & GetInitialAnchors()	Retrieve the initial anchors stored in this registry that act as the unscaled basis for the scaling	Decorations/MovieSceneScalingAnchors.h
FMovieSceneAnchorsScalingGroup & GetOrCreateScalingGroup ( const FGuid& Guid )	Retrieve a scaling group of the specified identifier, creating it if necessary	Decorations/MovieSceneScalingAnchors.h
const TMap< FGuid, FMovieSceneAnchorsScalingGroup > & GetScalingGroups()	Retrieve all scaling groups	Decorations/MovieSceneScalingAnchors.h
bool HasAnyScalingDrivers()		Decorations/MovieSceneScalingAnchors.h
void RemoveScalingDriver ( TScriptInterface< IMovieSceneScalingDriver > InScalingDriver )	Remove a scaling driver to this anchor registry	Decorations/MovieSceneScalingAnchors.h
void RemoveScalingGroup ( const FGuid& Guid )	Destroy a scaling group by its ID	Decorations/MovieSceneScalingAnchors.h

Overridden from UMovieSceneTimeWarpGetter

Name	Remarks	Include Path
virtual TRange< FFrameTime > ComputeTraversedHull ( const TRange< FFrameTime >& Range ) const	Given a continuous unwarped time range, compute the hull of warped times that are contained.	Decorations/MovieSceneScalingAnchors.h
virtual bool DeleteChannel ( FMovieSceneTimeWarpVariant& OutVariant, FName ChannelName )	Attempt to delete this time-warp from a channel proxy if it matches the specified name	Decorations/MovieSceneScalingAnchors.h
virtual TOptional< FFrameTime > InverseRemapTimeCycled ( FFrameTime InValue, FFrameTime InTimeHint, const UE::MovieScene::FInverseTransformTimeParams& Params ) const	Attempt to transform a time-warped time into its corresponding non-time-warped time.	Decorations/MovieSceneScalingAnchors.h
virtual bool InverseRemapTimeWithinRange ( FFrameTime InTime, FFrameTime RangeStart, FFrameTime RangeEnd, const TFunctionRef< bool(FFrameTime)>& VisitorCallback ) const	Attempt to transform a time-warped time into its corresponding non-time-warped time within a specified unwarped range.	Decorations/MovieSceneScalingAnchors.h
virtual EMovieSceneChannelProxyType PopulateChannelProxy ( FMovieSceneChannelProxyData& OutProxyData, EAllowTopLevelChannels AllowTopLevel )	Populate a channel proxy with this time-warp if possible	Decorations/MovieSceneScalingAnchors.h
virtual FFrameTime RemapTime ( FFrameTime In ) const	Begin UMovieSceneTimeWarpGetter Implementation	Decorations/MovieSceneScalingAnchors.h
virtual void ScaleBy ( double UnwarpedScaleFactor )	Scale this time-warping in its time-domain based on the specified unwarped scale factor	Decorations/MovieSceneScalingAnchors.h

Overridden from UObject

Name	Remarks	Include Path	Unreal Specifiers
virtual void Serialize ( FArchive& Ar )		Decorations/MovieSceneScalingAnchors.h

Overridden from IMovieSceneDecoration

Name	Remarks	Include Path
virtual void OnDecorationAdded ( UMovieScene* MovieScene )	Called when this decoration is first added directly to a UMovieScene	Decorations/MovieSceneScalingAnchors.h
virtual void OnDecorationRemoved()	Called when this decoration is removed from a UMovieScene	Decorations/MovieSceneScalingAnchors.h
virtual void OnPreDecorationCompiled()	Called before the movie scene this decoration exists on is compiled	Decorations/MovieSceneScalingAnchors.h

Overridden from IMovieSceneTimeWarpSource

Name	Remarks	Include Path	Unreal Specifiers
virtual FMovieSceneNestedSequenceTransform GenerateTimeWarpTransform()		Decorations/MovieSceneScalingAnchors.h
virtual int32 GetTimeWarpSortOrder()		Decorations/MovieSceneScalingAnchors.h
virtual bool IsTimeWarpActive()		Decorations/MovieSceneScalingAnchors.h
virtual void SetIsTimeWarpActive ( bool bInActive )		Decorations/MovieSceneScalingAnchors.h

Navigation