MovieSceneTimeWarpGetter.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
 
#include "CoreTypes.h"
#include "Math/Range.h"
#include "Misc/FrameTime.h"
#include "Misc/Optional.h"
#include "Channels/IMovieSceneChannelOwner.h"
#include "Channels/MovieSceneTimeWarpChannel.h"
#include "Variants/MovieSceneNumericVariantGetter.h"
#include "MovieSceneTimeWarpGetter.generated.h"
 
class FName;
 
struct FMovieSceneTimeWarpVariant;
struct FMovieSceneChannelProxyData;
 
enum class EMovieSceneChannelProxyType : uint8;
 
template<typename>
class TFunctionRef;
 
namespace UE::MovieScene
{
    struct FInverseTransformTimeParams;
}
 
UCLASS(Abstract, MinimalAPI)
class UMovieSceneTimeWarpGetter
    : public UMovieSceneNumericVariantGetter
    , public IMovieSceneChannelOwner
{
public:
 
    GENERATED_BODY()
 
    
    enum class EAllowTopLevelChannels
    {
        Yes, No
    };
    
 
    MOVIESCENE_API UMovieSceneTimeWarpGetter();
 
 
public:
    /*~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
     *            Begin abstract API
      ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~*/
 
    virtual void ScaleBy(double UnwarpedScaleFactor)
        PURE_VIRTUAL(UMovieSceneTimeWarpGetter::ScaleBy, )
 
 
    
    virtual FFrameTime RemapTime(FFrameTime In) const
        PURE_VIRTUAL(UMovieSceneTimeWarpGetter::RemapTime, return In; )
 
 
    virtual TRange<FFrameTime> ComputeTraversedHull(const TRange<FFrameTime>& Range) const
        PURE_VIRTUAL(UMovieSceneTimeWarpGetter::ComputeTraversedHull, return TRange<FFrameTime>(); )
 
 
 
    virtual TOptional<FFrameTime> InverseRemapTimeCycled(FFrameTime InValue, FFrameTime InTimeHint, const UE::MovieScene::FInverseTransformTimeParams& Params) const
        PURE_VIRTUAL(UMovieSceneTimeWarpGetter::InverseRemapTimeCycled, return TOptional<FFrameTime>(); )
 
 
 
    virtual bool InverseRemapTimeWithinRange(FFrameTime InTime, FFrameTime RangeStart, FFrameTime RangeEnd, const TFunctionRef<bool(FFrameTime)>& VisitorCallback) const
        PURE_VIRTUAL(UMovieSceneTimeWarpGetter::InverseRemapTimeWithinRange, return true; )
 
    virtual UE::MovieScene::ETimeWarpChannelDomain GetDomain() const
        PURE_VIRTUAL(UMovieSceneTimeWarpGetter::GetDomain, return UE::MovieScene::ETimeWarpChannelDomain::Time; )
 
    /*~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
     *            End abstract API
      ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~*/
 
    MOVIESCENE_API virtual UE::MovieScene::FChannelOwnerCapabilities GetCapabilities(FName ChannelName) const override;
    MOVIESCENE_API virtual bool IsMuted(FName ChannelName) const override;
    MOVIESCENE_API virtual void SetIsMuted(FName ChannelName, bool bIsMuted) override;
 
    MOVIESCENE_API bool IsMuted() const;
    MOVIESCENE_API void SetIsMuted(bool bIsMuted);
 
public:
 
    virtual void InitializeDefaults()
    {
    }
 
 
    MOVIESCENE_API virtual EMovieSceneChannelProxyType PopulateChannelProxy(FMovieSceneChannelProxyData& OutProxyData, EAllowTopLevelChannels AllowTopLevel);
 
 
    MOVIESCENE_API virtual bool DeleteChannel(FMovieSceneTimeWarpVariant& OutVariant, FName ChannelName);
 
protected:
 
    UPROPERTY()
    uint8 bMuted : 1;
};