MovieSceneTimeWarpVariant.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "MovieSceneNumericVariant.h"
#include "MovieSceneTimeWarpVariant.generated.h"
 
 
struct FFrameRate;
struct FMovieSceneTimeWarpLoop;
struct FMovieSceneTimeWarpClamp;
struct FMovieSceneTimeWarpLoopFloat;
struct FMovieSceneTimeWarpFrameRate;
struct FMovieSceneTimeWarpFixedFrame;
struct FMovieSceneTimeWarpClampFloat;
 
class UMovieSceneTimeWarpGetter;
 
namespace UE::MovieScene
{
    struct FInverseTransformTimeParams;
}
 
 
UENUM()
enum class EMovieSceneTimeWarpType : uint8
{
    FixedPlayRate  = 0x0,   // FMovieSceneNumericVariant is a fixed double
    Custom         = 0x1,   // PAYLOAD_Bits is a UMovieSceneTimeWarpGetter* - matches FMovieSceneNumericVariant::TYPE_CustomPtr - 1
    FixedTime      = 0x2,   // PAYLOAD_Bits is a FMovieSceneTimeWarpFixedFrame (explicitly fixed time or zero timescale)
    FrameRate      = 0x3,   // PAYLOAD_Bits is a FMovieSceneTimeWarpFrameRate defining a frame rate from outer to inner space
    Loop           = 0x4,   // PAYLOAD_Bits is a FMovieSceneTimeWarpLoop
    Clamp          = 0x5,   // PAYLOAD_Bits is a FMovieSceneTimeWarpClamp
 
    LoopFloat      = 0x6,   // PAYLOAD_Bits is a FMovieSceneTimeWarpLoopFloat
    ClampFloat     = 0x7,   // PAYLOAD_Bits is a FMovieSceneTimeWarpClampFloat
 
    // Max of 8 types supported
};
 
 
USTRUCT(BlueprintType, meta=(HasNativeBreak="/Script/SequencerScripting.MovieSceneTimeWarpExtensions.BreakTimeWarp", HasNativeMake="/Script/SequencerScripting.MovieSceneTimeWarpExtensions.MakeTimeWarp"))
struct FMovieSceneTimeWarpVariant
{
    GENERATED_BODY()
 
    
    FMovieSceneTimeWarpVariant()
        : Variant(1.0)
    {
    }
 
 
    explicit FMovieSceneTimeWarpVariant(double InLiteralPlayRate)
    {
        Set(InLiteralPlayRate);
    }
 
 
    explicit FMovieSceneTimeWarpVariant(const FMovieSceneTimeWarpFixedFrame& In)
        : Variant(NoInit)
    {
        Set(In);
    }
 
 
    explicit FMovieSceneTimeWarpVariant(const FMovieSceneTimeWarpLoop& In)
        : Variant(NoInit)
    {
        Set(In);
    }
 
 
    explicit FMovieSceneTimeWarpVariant(const FMovieSceneTimeWarpClamp& In)
        : Variant(NoInit)
    {
        Set(In);
    }
 
 
    explicit FMovieSceneTimeWarpVariant(UMovieSceneTimeWarpGetter* In)
        : Variant(NoInit)
    {
        Set(In);
    }
 
 
    FMovieSceneTimeWarpVariant(const FMovieSceneTimeWarpVariant& Other)
        : Variant(Other.Variant.ShallowCopy())
    {
    }
 
 
    FMovieSceneTimeWarpVariant& operator=(const FMovieSceneTimeWarpVariant& Other)
    {
        Variant = Other.Variant.ShallowCopy();
        return *this;
    }
 
 
    FMovieSceneTimeWarpVariant(FMovieSceneTimeWarpVariant&&) = default;
 
 
    FMovieSceneTimeWarpVariant& operator=(FMovieSceneTimeWarpVariant&&) = default;
 
 
    FMovieSceneTimeWarpVariant& operator=(double InLiteralPlayRate)
    {
        Set(InLiteralPlayRate);
        return *this;
    }
 
 
    friend bool operator==(const FMovieSceneTimeWarpVariant& A, const FMovieSceneTimeWarpVariant& B)
    {
        return A.Variant == B.Variant;
    }
 
 
    friend bool operator!=(const FMovieSceneTimeWarpVariant& A, const FMovieSceneTimeWarpVariant& B)
    {
        return A.Variant != B.Variant;
    }
 
 
    FMovieSceneTimeWarpVariant ShallowCopy() const
    {
        return FMovieSceneTimeWarpVariant(Variant.ShallowCopy());
    }
 
 
    FMovieSceneTimeWarpVariant DeepCopy(UObject* NewOuter) const
    {
        if (GetType() == EMovieSceneTimeWarpType::Custom)
        {
            return FMovieSceneTimeWarpVariant(Variant.DeepCopy(NewOuter));
        }
 
        return ShallowCopy();
    }
 
 
    void MakeWeakUnsafe()
    {
        Variant.MakeWeakUnsafe();
    }
 
public:
 
 
    MOVIESCENE_API FFrameTime RemapTime(FFrameTime InTime) const;
 
 
public:
 
 
    EMovieSceneTimeWarpType GetType() const;
 
 
    /*
     * Retrieve this time-warp's constant play rate.
     * @note: Only valid where GetType() == EMovieSceneTimeWarpType::FixedPlayRate
     */
    MOVIESCENE_API double AsFixedPlayRate() const;
 
 
    /*
     * Retrieve this time-warp's constant play rate clampoed to the range of a float
     * @note: Only valid where GetType() == EMovieSceneTimeWarpType::FixedPlayRate
     */
    MOVIESCENE_API float AsFixedPlayRateFloat() const;
 
 
    /*
     * Cast this variant to a fixed time.
     * @note: Only valid where GetType() == EMovieSceneTimeWarpType::FixedTime
     */
    MOVIESCENE_API FMovieSceneTimeWarpFixedFrame AsFixedTime() const;
 
 
    /*
     * Cast this variant to a frame-rate conversion
     * @note: Only valid where GetType() == EMovieSceneTimeWarpType::FrameRate
     */
    MOVIESCENE_API FMovieSceneTimeWarpFrameRate AsFrameRate() const;
 
 
    /*
     * Cast this variant to a frame-based loop
     * @note: Only valid where GetType() == EMovieSceneTimeWarpType::Loop
     */
    MOVIESCENE_API FMovieSceneTimeWarpLoop AsLoop() const;
 
 
    /*
     * Cast this variant to a clamped range
     * @note: Only valid where GetType() == EMovieSceneTimeWarpType::Clamp
     */
    MOVIESCENE_API FMovieSceneTimeWarpClamp AsClamp() const;
 
 
    /*
     * Cast this variant to a floating-point loop
     * @note: Only valid where GetType() == EMovieSceneTimeWarpType::LoopFloat
     */
    MOVIESCENE_API FMovieSceneTimeWarpLoopFloat AsLoopFloat() const;
 
 
    /*
     * Cast this variant to a floating-point clamped range
     * @note: Only valid where GetType() == EMovieSceneTimeWarpType::ClampFloat
     */
    MOVIESCENE_API FMovieSceneTimeWarpClampFloat AsClampFloat() const;
 
 
    /*
     * Cast this variant to a custom time warp implementation
     * @note: Only valid where GetType() == EMovieSceneTimeWarpType::Custom
     */
    MOVIESCENE_API UMovieSceneTimeWarpGetter* AsCustom() const;
 
 
public:
 
 
    MOVIESCENE_API void Set(double InLiteralPlayRate);
 
 
    MOVIESCENE_API void Set(const FMovieSceneTimeWarpFixedFrame& InValue);
 
 
    MOVIESCENE_API void Set(const FMovieSceneTimeWarpFrameRate& InValue);
 
 
    MOVIESCENE_API void Set(const FMovieSceneTimeWarpLoop& InValue);
 
 
    MOVIESCENE_API void Set(const FMovieSceneTimeWarpClamp& InValue);
 
 
    MOVIESCENE_API void Set(const FMovieSceneTimeWarpLoopFloat& InValue);
 
 
    MOVIESCENE_API void Set(const FMovieSceneTimeWarpClampFloat& InValue);
 
 
    MOVIESCENE_API void Set(UMovieSceneTimeWarpGetter* InDynamicValue);
 
 
    MOVIESCENE_API void ScaleBy(double ScaleFactor);
 
public:
 
    /*~ For TStructOpsTypeTraits */
    bool Serialize(FArchive& Ar);
    bool SerializeFromMismatchedTag(const FPropertyTag& Tag, FStructuredArchive::FSlot Slot);
    bool ExportTextItem(FString& ValueStr, const FMovieSceneTimeWarpVariant& DefaultValue, UObject* Parent, int32 PortFlags, UObject* ExportRootScope) const;
    bool ImportTextItem(const TCHAR*& Buffer, int32 PortFlags, UObject* Parent, FOutputDevice* ErrorText);
 
    FMovieSceneTimeWarpVariant(FMovieSceneNumericVariant&& Other)
        : Variant(MoveTemp(Other))
    {
    }
 
private:
 
    static_assert(PLATFORM_LITTLE_ENDIAN, "This class has not been written with big-endian support.");
 
    UPROPERTY()
    FMovieSceneNumericVariant Variant;
};
 
template<>
struct TStructOpsTypeTraits<FMovieSceneTimeWarpVariant> : public TStructOpsTypeTraitsBase2<FMovieSceneTimeWarpVariant>
{
    enum
    {
        WithCopy                                 = true,
        WithSerializer                           = true,
        WithExportTextItem                       = true,
        WithImportTextItem                       = true,
        WithIdenticalViaEquality                 = true,
        WithStructuredSerializeFromMismatchedTag = true,
    };
};
 
 
inline EMovieSceneTimeWarpType FMovieSceneTimeWarpVariant::GetType() const
{
    return Variant.IsLiteral() ? EMovieSceneTimeWarpType::FixedPlayRate : static_cast<EMovieSceneTimeWarpType>(Variant.GetTypeBits() + 1);
}