MovieSceneFrameMigration.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "Containers/Array.h"
#include "CoreTypes.h"
#include "Math/Range.h"
#include "Math/RangeBound.h"
#include "Misc/FrameNumber.h"
#include "MovieSceneFwd.h"
#include "Serialization/StructuredArchive.h"
#include "UObject/Class.h"
#include "UObject/ObjectMacros.h"
 
#include "MovieSceneFrameMigration.generated.h"
 
class FArchive;
class FOutputDevice;
class FString;
class UObject;
struct FPropertyTag;
 
USTRUCT()
struct FMovieSceneFrameRange
{
    GENERATED_BODY()
 
    
    TRange<FFrameNumber> Value;
 
#if WITH_EDITORONLY_DATA
 
    FFloatRange MigrationDefault;
 
#endif
 
    FMovieSceneFrameRange()
        : Value(TRange<FFrameNumber>::Empty())
    {}
 
    FMovieSceneFrameRange(const TRange<FFrameNumber>& InValue)
        : Value(InValue)
    {}
 
    MOVIESCENE_API static TRange<FFrameNumber> FromFloatRange(const TRange<float>& InFloatRange);
 
    MOVIESCENE_API bool Serialize(FArchive& Ar);
 
    MOVIESCENE_API bool SerializeFromMismatchedTag(FPropertyTag const& Tag, FStructuredArchive::FSlot Slot);
 
    TRangeBound<FFrameNumber> GetLowerBound() const
    {
        return Value.GetLowerBound();
    }
 
    TRangeBound<FFrameNumber> GetUpperBound() const
    {
        return Value.GetUpperBound();
    }
 
    //Needed for copy and pasting of tracks since that mechanism uses string export and import
    bool ExportTextItem(FString& ValueStr, FMovieSceneFrameRange const& DefaultValue, UObject* Parent, int32 PortFlags, UObject* ExportRootScope) const;
    bool ImportTextItem(const TCHAR*& Buffer, int32 PortFlags, UObject* Parent, FOutputDevice* ErrorText);
 
 
private:
 
    friend bool operator==(const FMovieSceneFrameRange& A, const FMovieSceneFrameRange& B)
    {
        return A.Value == B.Value;
    }
};
 
 
template<>
struct TStructOpsTypeTraits<FMovieSceneFrameRange> : public TStructOpsTypeTraitsBase2<FMovieSceneFrameRange>
{
    enum { WithStructuredSerializeFromMismatchedTag = true, WithSerializer = true, WithIdenticalViaEquality = true,
           WithExportTextItem = true, WithImportTextItem = true};
    static constexpr EPropertyObjectReferenceType WithSerializerObjectReferences = EPropertyObjectReferenceType::None;
};
 
template <typename T> inline void ConvertInsertAndSort(int32 IndexAt, FFrameNumber NewFrame, T& Value, TArray<FFrameNumber> &Times, TArray<T> &Values)
{
    if (IndexAt > 0)
    {
        int32 PrevWhich = IndexAt - 1;
        //this seems to happen 99% of the time, it is properly sorted.
        if (NewFrame >= Times[PrevWhich])
        {
            Times.Emplace(NewFrame);
            Values.Emplace(Value);
        }
        else
        {
            while (--PrevWhich >= 0)
            {
                if (NewFrame >= Times[PrevWhich])
                {
                    Times.Insert(NewFrame, PrevWhich + 1);
                    Values.Insert(Value, PrevWhich + 1);
                    break;
                }
            }
            if (PrevWhich < 0)
            {
                Times.Insert(NewFrame, 0);
                Values.Insert(Value, 0);
            }
        }
    }
    else
    {
        Times.Emplace(NewFrame);
        Values.Emplace(Value);
    }
}