MovieSceneScalingAnchors.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "Channels/MovieSceneTimeWarpChannel.h"
#include "Channels/MovieScenePiecewiseCurve.h"
#include "Decorations/IMovieSceneDecoration.h"
#include "Decorations/MovieSceneTimeWarpDecoration.h"
#include "Variants/MovieScenePlayRateCurve.h"
#include "MovieSceneScalingAnchors.generated.h"
 
 
 
USTRUCT()
struct FMovieSceneScalingAnchor
{
    GENERATED_BODY()
 
    
    UPROPERTY()
    FFrameNumber Position;
 
    UPROPERTY()
    int32 Duration = 0;
};
 
 
 
 
UINTERFACE(MinimalAPI)
class UMovieSceneScalingDriver : public UInterface
{
public:
    GENERATED_BODY()
};
 
 
class IMovieSceneScalingDriver
{
public:
    GENERATED_BODY()
 
    
    virtual void PopulateInitialAnchors(TMap<FGuid, FMovieSceneScalingAnchor>& OutAnchors)
    {
        PopulateAnchors(OutAnchors);
    }
 
    virtual void PopulateAnchors(TMap<FGuid, FMovieSceneScalingAnchor>& OutAnchors) = 0;
};
 
 
 
USTRUCT()
struct FMovieSceneAnchorsScalingGroup
{
    GENERATED_BODY()
 
    
    UPROPERTY()
    TSet<TObjectPtr<UMovieSceneSection>> Sections;
};
 
 
UCLASS(MinimalAPI, DisplayName="Anchors", meta=(Hidden))
class UMovieSceneScalingAnchors
    : public UMovieScenePlayRateCurve
    , public IMovieSceneDecoration
    , public IMovieSceneTimeWarpSource
{
public:
 
    GENERATED_BODY()
 
    UMovieSceneScalingAnchors();
 
#if 0
    static uint32 DefaultTimeWarpEntityID;
#endif
 
public:
 
    MOVIESCENE_API void AddScalingDriver(TScriptInterface<IMovieSceneScalingDriver> InScalingDriver);
 
 
    MOVIESCENE_API void RemoveScalingDriver(TScriptInterface<IMovieSceneScalingDriver> InScalingDriver);
 
    MOVIESCENE_API bool HasAnyScalingDrivers() const;
 
public:
 
    MOVIESCENE_API FMovieSceneAnchorsScalingGroup& GetOrCreateScalingGroup(const FGuid& Guid);
 
    MOVIESCENE_API FMovieSceneAnchorsScalingGroup* FindScalingGroup(const FGuid& Guid);
 
    MOVIESCENE_API void RemoveScalingGroup(const FGuid& Guid);
 
    MOVIESCENE_API const TMap<FGuid, FMovieSceneAnchorsScalingGroup>& GetScalingGroups() const;
 
public:
 
    MOVIESCENE_API const TMap<FGuid, FMovieSceneScalingAnchor>& GetInitialAnchors() const;
 
 
    MOVIESCENE_API const TMap<FGuid, FMovieSceneScalingAnchor>& GetCurrentAnchors() const;
 
public:
 
    /*~ Begin UObject Implementation */
    virtual void Serialize(FArchive& Ar) override;
    /*~ End UObject Implementation */
 
    /*~ Begin UMovieSceneTimeWarpGetter Implementation */
    virtual FFrameTime RemapTime(FFrameTime In) const override;
    virtual TOptional<FFrameTime> InverseRemapTimeCycled(FFrameTime InValue, FFrameTime InTimeHint, const UE::MovieScene::FInverseTransformTimeParams& Params) const override;
    virtual TRange<FFrameTime> ComputeTraversedHull(const TRange<FFrameTime>& Range) const override;
    virtual bool InverseRemapTimeWithinRange(FFrameTime InTime, FFrameTime RangeStart, FFrameTime RangeEnd, const TFunctionRef<bool(FFrameTime)>& VisitorCallback) const override;
    virtual EMovieSceneChannelProxyType PopulateChannelProxy(FMovieSceneChannelProxyData& OutProxyData, EAllowTopLevelChannels AllowTopLevel) override;
    virtual bool DeleteChannel(FMovieSceneTimeWarpVariant& OutVariant, FName ChannelName) override;
    virtual void ScaleBy(double UnwarpedScaleFactor) override;
    /* End UMovieSceneTimeWarpGetter Implementation */
 
    /*~ Begin IMovieSceneDecoration Implementation */
    virtual void OnDecorationAdded(UMovieScene* MovieScene) override;
    virtual void OnDecorationRemoved() override;
    virtual void OnPreDecorationCompiled() override;
    /*~ End IMovieSceneDecoration Implementation */
 
    /*~ Begin IMovieSceneTimeWarpSource Implementation */
    virtual FMovieSceneNestedSequenceTransform GenerateTimeWarpTransform() override;
    virtual bool IsTimeWarpActive() const override;
    virtual void SetIsTimeWarpActive(bool bInActive) override;
    virtual int32 GetTimeWarpSortOrder() const override;
    /*~ End IMovieSceneTimeWarpSource Implementation */
 
private:
 
    UMovieScenePlayRateCurve* Initialize(TSharedPtr<UE::MovieScene::FSharedPlaybackState> SharedPlaybackState) const;
 
    void UpdateCurve(UMovieScenePlayRateCurve* Curve) const;
 
    void UpdateFromSource() const;
 
    void ResetScaling();
 
private:
 
    UPROPERTY()
    TArray<TScriptInterface<IMovieSceneScalingDriver>> ScalingDrivers;
 
    UPROPERTY()
    TMap<FGuid, FMovieSceneScalingAnchor> InitialAnchors;
 
    UPROPERTY()
    TMap<FGuid, FMovieSceneAnchorsScalingGroup> ScalingGroups;
 
    mutable TMap<FGuid, FMovieSceneScalingAnchor> CurrentAnchors;
 
    mutable FFrameTime NewDuration;
    mutable bool bPlayRateCurveIsUpToDate = false;
};