MovieSceneEvaluationKey.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "CoreMinimal.h"
#include "MovieSceneSequenceID.h"
#include "Evaluation/MovieSceneTrackIdentifier.h"
#include "MovieSceneEvaluationKey.generated.h"
 
USTRUCT()
struct FMovieSceneEvaluationKey
{
    GENERATED_BODY()
 
    
    FMovieSceneEvaluationKey()
        : SequenceID(MovieSceneSequenceID::Invalid)
        , TrackIdentifier(FMovieSceneTrackIdentifier::Invalid())
        , SectionIndex(-1)
    {}
 
    FMovieSceneEvaluationKey(FMovieSceneSequenceIDRef InSequenceID, FMovieSceneTrackIdentifier InTrackIdentifier, uint32 InSectionIndex = uint32(-1))
        : SequenceID(InSequenceID)
        , TrackIdentifier(InTrackIdentifier)
        , SectionIndex(InSectionIndex)
    {}
 
    bool IsValid() const
    {
        return SequenceID != MovieSceneSequenceID::Invalid && TrackIdentifier != FMovieSceneTrackIdentifier::Invalid();
    }
 
    FMovieSceneEvaluationKey AsSection(uint32 InSectionIdentifier) const
    {
        FMovieSceneEvaluationKey NewKey = *this;
        NewKey.SectionIndex = InSectionIdentifier;
        return NewKey;
    }
 
    FMovieSceneEvaluationKey AsTrack() const
    {
        FMovieSceneEvaluationKey NewKey = *this;
        NewKey.SectionIndex = uint32(-1);
        return NewKey;
    }
 
    friend bool operator==(const FMovieSceneEvaluationKey& A, const FMovieSceneEvaluationKey& B)
    {
        return A.TrackIdentifier == B.TrackIdentifier && A.SequenceID == B.SequenceID && A.SectionIndex == B.SectionIndex;
    }
 
    friend bool operator<(const FMovieSceneEvaluationKey& A, const FMovieSceneEvaluationKey& B)
    {
        if (A.SequenceID < B.SequenceID)
        {
            return true;
        }
        else if (A.SequenceID > B.SequenceID)
        {
            return false;
        }
        else if (A.TrackIdentifier < B.TrackIdentifier)
        {
            return true;
        }
        else
        {
            return A.TrackIdentifier == B.TrackIdentifier && A.SectionIndex < B.SectionIndex;
        }
    }
 
    friend uint32 GetTypeHash(const FMovieSceneEvaluationKey& In)
    {
        return GetTypeHash(In.SequenceID) ^ (~GetTypeHash(In.TrackIdentifier)) ^ In.SectionIndex;
    }
 
    bool Serialize(FArchive& Ar)
    {
        Ar << SequenceID;
        Ar << TrackIdentifier;
        Ar << SectionIndex;
        return true;
    }
 
    friend FArchive& operator<<(FArchive& Ar, FMovieSceneEvaluationKey& Key)
    {
        Key.Serialize(Ar);
        return Ar;
    }
 
    UPROPERTY()
    FMovieSceneSequenceID SequenceID;
 
    UPROPERTY()
    FMovieSceneTrackIdentifier TrackIdentifier;
 
    UPROPERTY()
    uint32 SectionIndex;
};
 
template<>
struct TStructOpsTypeTraits<FMovieSceneEvaluationKey> : public TStructOpsTypeTraitsBase2<FMovieSceneEvaluationKey>
{
    enum
    {
        WithSerializer = true, WithIdenticalViaEquality = true
    };
    static constexpr EPropertyObjectReferenceType WithSerializerObjectReferences = EPropertyObjectReferenceType::None;
};