MovieSceneObjectBindingID.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "Containers/ArrayView.h"
#include "CoreMinimal.h"
#include "CoreTypes.h"
#include "Misc/AssertionMacros.h"
#include "Misc/Guid.h"
#include "MovieSceneFwd.h"
#include "MovieSceneSequenceID.h"
#include "Templates/TypeHash.h"
#include "UObject/Class.h"
#include "UObject/ObjectMacros.h"
#include "UObject/WeakObjectPtrTemplates.h"
 
#include "MovieSceneObjectBindingID.generated.h"
 
class FArchive;
class IMovieScenePlayer;
class UMovieSceneSequence;
struct FMovieSceneSequenceHierarchy;
 
 
namespace UE
{
namespace MovieScene
{
 
 
struct FSequenceInstance;
struct FSharedPlaybackState;
 
 
struct FRelativeObjectBindingID
{
    FRelativeObjectBindingID(const FGuid& InGuid)
        : Guid(InGuid)
        , SequenceID(MovieSceneSequenceID::Root)
        , ResolveParentIndex(0)
    {}
 
    FRelativeObjectBindingID(const FGuid& InGuid, FMovieSceneSequenceID InSequenceID)
        : Guid(InGuid)
        , SequenceID(InSequenceID)
        , ResolveParentIndex(0)
    {}
 
    FRelativeObjectBindingID(const FGuid& InGuid, FMovieSceneSequenceID InSequenceID, int32 InParentIndex)
        : Guid(InGuid)
        , SequenceID(InSequenceID)
        , ResolveParentIndex(InParentIndex)
    {}
 
    MOVIESCENE_API FRelativeObjectBindingID(FMovieSceneSequenceID SourceSequenceID, FMovieSceneSequenceID TargetSequenceID, const FGuid& TargetGuid, UMovieSceneSequence* RootSequence);
 
    MOVIESCENE_API FRelativeObjectBindingID(FMovieSceneSequenceID SourceSequenceID, FMovieSceneSequenceID TargetSequenceID, const FGuid& TargetGuid, const FMovieSceneSequenceHierarchy* Hierarchy);
 
    MOVIESCENE_API FRelativeObjectBindingID(FMovieSceneSequenceID SourceSequenceID, FMovieSceneSequenceID TargetSequenceID, const FGuid& TargetGuid, TSharedRef<const FSharedPlaybackState> SharedPlaybackState);
 
    MOVIESCENE_API FRelativeObjectBindingID(FMovieSceneSequenceID SourceSequenceID, FMovieSceneSequenceID TargetSequenceID, const FGuid& TargetGuid, IMovieScenePlayer& Player);
 
    FGuid Guid;
 
    FMovieSceneSequenceID SequenceID;
 
    int32 ResolveParentIndex;
 
private:
 
    void ConstructInternal(FMovieSceneSequenceID SourceSequenceID, FMovieSceneSequenceID TargetSequenceID, const FGuid& TargetGuid, const FMovieSceneSequenceHierarchy* Hierarchy);
};
 
 
struct FFixedObjectBindingID
{
    FFixedObjectBindingID()
    {}
 
    FFixedObjectBindingID(const FGuid& InGuid, FMovieSceneSequenceID InSequenceID)
        : Guid(InGuid)
        , SequenceID(InSequenceID)
    {}
 
public:
 
    friend uint32 GetTypeHash(const FFixedObjectBindingID& A)
    {
        return GetTypeHash(A.Guid) ^ GetTypeHash(A.SequenceID);
    }
 
    friend bool operator==(const FFixedObjectBindingID& A, const FFixedObjectBindingID& B)
    {
        return A.Guid == B.Guid && A.SequenceID == B.SequenceID;
    }
 
    friend bool operator!=(const FFixedObjectBindingID& A, const FFixedObjectBindingID& B)
    {
        return A.Guid != B.Guid || A.SequenceID != B.SequenceID;
    }
 
public:
 
    MOVIESCENE_API FRelativeObjectBindingID ConvertToRelative(FMovieSceneSequenceID SourceSequenceID, TSharedRef<const FSharedPlaybackState> SharedPlaybackState) const;
 
    MOVIESCENE_API FRelativeObjectBindingID ConvertToRelative(FMovieSceneSequenceID SourceSequenceID, IMovieScenePlayer& InPlayer) const;
 
    MOVIESCENE_API FRelativeObjectBindingID ConvertToRelative(FMovieSceneSequenceID SourceSequenceID, const FMovieSceneSequenceHierarchy* Hierarchy) const;
 
public:
 
    FGuid Guid;
 
    FMovieSceneSequenceID SequenceID;
};
 
 
} // namespace MovieScene
} // namespace UE
 
 
 
UENUM()
enum class EMovieSceneObjectBindingSpace : uint8
{
    Local,
    Root,
 
    Unused UMETA(Hidden),
};
 
 
USTRUCT(BlueprintType, meta=(HasNativeMake))
struct FMovieSceneObjectBindingID
{
    using FSharedPlaybackState = UE::MovieScene::FSharedPlaybackState;
 
    GENERATED_BODY()
 
    
    FMovieSceneObjectBindingID()
        // Defaults purposefully match the equivalent of a legacy root binding
        // such that any pre-existing ::Root space binding upgrades to ResolveParentIndex = -1
        // and ::Local space bindings will get upgraded in PostSerialize
        : SequenceID(int32(MovieSceneSequenceID::Root.GetInternalValue()))
        , ResolveParentIndex(FixedRootSequenceParentIndex)
    {
        LegacyInit();
    }
 
    FMovieSceneObjectBindingID(const UE::MovieScene::FRelativeObjectBindingID& InID)
        : Guid(InID.Guid)
        , SequenceID(InID.SequenceID.GetInternalValue())
        , ResolveParentIndex(InID.ResolveParentIndex)
    {
        LegacyInit();
    }
 
    FMovieSceneObjectBindingID(const UE::MovieScene::FFixedObjectBindingID& InID)
        : Guid(InID.Guid)
        , SequenceID(InID.SequenceID.GetInternalValue())
        , ResolveParentIndex(FixedRootSequenceParentIndex)
    {
        LegacyInit();
    }
 
 
public:
 
 
    FMovieSceneObjectBindingID& operator=(const UE::MovieScene::FRelativeObjectBindingID& InID)
    {
        Guid = InID.Guid;
        SequenceID = InID.SequenceID.GetInternalValue();
        ResolveParentIndex = InID.ResolveParentIndex;
        return *this;
    }
 
    FMovieSceneObjectBindingID& operator=(const UE::MovieScene::FFixedObjectBindingID& InID)
    {
        Guid = InID.Guid;
        SequenceID = InID.SequenceID.GetInternalValue();
        ResolveParentIndex = FixedRootSequenceParentIndex;
        return *this;
    }
 
public:
 
    friend uint32 GetTypeHash(const FMovieSceneObjectBindingID& A)
    {
        return GetTypeHash(A.Guid) ^ GetTypeHash(A.SequenceID);
    }
 
    friend bool operator==(const FMovieSceneObjectBindingID& A, const FMovieSceneObjectBindingID& B)
    {
        return A.Guid == B.Guid && A.SequenceID == B.SequenceID && A.ResolveParentIndex == B.ResolveParentIndex;
    }
 
    friend bool operator!=(const FMovieSceneObjectBindingID& A, const FMovieSceneObjectBindingID& B)
    {
        return A.Guid != B.Guid || A.SequenceID != B.SequenceID ||  A.ResolveParentIndex != B.ResolveParentIndex;
    }
 
 
public:
 
    bool IsValid() const
    {
        return Guid.IsValid();
    }
 
    bool IsFixedBinding() const
    {
        return Guid.IsValid() && ResolveParentIndex == FixedRootSequenceParentIndex;
    }
 
    const FGuid& GetGuid() const
    {
        return Guid;
    }
 
    void SetGuid(const FGuid& InGuid)
    {
#if WITH_EDITORONLY_DATA
        ensureMsgf(Space_DEPRECATED == EMovieSceneObjectBindingSpace::Unused, TEXT("Assigning a GUID for a binding which has no type specifier - consider using Local / External / Fixed instead"));
#endif
        Guid = InGuid;
    }
 
    FMovieSceneSequenceID GetRelativeSequenceID() const
    {
        return FMovieSceneSequenceID(SequenceID);
    }
 
    MOVIESCENE_API UE::MovieScene::FFixedObjectBindingID ResolveToFixed(FMovieSceneSequenceID SourceSequenceID, TSharedRef<const FSharedPlaybackState> SharedPlaybackState) const;
 
    MOVIESCENE_API UE::MovieScene::FFixedObjectBindingID ResolveToFixed(FMovieSceneSequenceID SourceSequenceID, IMovieScenePlayer& Player) const;
 
    MOVIESCENE_API FMovieSceneSequenceID ResolveSequenceID(FMovieSceneSequenceID SourceSequenceID, TSharedRef<const FSharedPlaybackState> SharedPlaybackState) const;
 
    MOVIESCENE_API FMovieSceneSequenceID ResolveSequenceID(FMovieSceneSequenceID SourceSequenceID, IMovieScenePlayer& Player) const;
 
    MOVIESCENE_API FMovieSceneSequenceID ResolveSequenceID(FMovieSceneSequenceID SourceSequenceID, const FMovieSceneSequenceHierarchy* Hierarchy) const;
 
    MOVIESCENE_API TArrayView<TWeakObjectPtr<>> ResolveBoundObjects(FMovieSceneSequenceID SourceSequenceID, TSharedRef<const FSharedPlaybackState> SharedPlaybackState) const;
 
    MOVIESCENE_API TArrayView<TWeakObjectPtr<>> ResolveBoundObjects(FMovieSceneSequenceID SourceSequenceID, IMovieScenePlayer& Player) const;
 
    MOVIESCENE_API TArrayView<TWeakObjectPtr<>> ResolveBoundObjects(const UE::MovieScene::FSequenceInstance& SequenceInstance) const;
 
 
    UE::MovieScene::FFixedObjectBindingID ReinterpretAsFixed() const
    {
        return UE::MovieScene::FFixedObjectBindingID(Guid, FMovieSceneSequenceID(SequenceID));
    }
 
public:
 
#if WITH_EDITORONLY_DATA
    void PostSerialize(const FArchive& Ar);
#endif
 
private:
 
    static constexpr int32 FixedRootSequenceParentIndex = -1;
 
    UPROPERTY(EditAnywhere, Category="Binding")
    FGuid Guid;
 
    UPROPERTY()
    int32 SequenceID;
 
    UPROPERTY()
    int32 ResolveParentIndex;
 
private:
    void LegacyInit()
    {
#if WITH_EDITORONLY_DATA
        Space_DEPRECATED = EMovieSceneObjectBindingSpace::Unused;
#endif
    }
 
 
#if WITH_EDITORONLY_DATA
 
    UPROPERTY()
    EMovieSceneObjectBindingSpace Space_DEPRECATED;
 
#endif // WITH_EDITORONLY_DATA
};
 
 
template<> struct TStructOpsTypeTraits<FMovieSceneObjectBindingID> : public TStructOpsTypeTraitsBase2<FMovieSceneObjectBindingID>
{
#if WITH_EDITORONLY_DATA
    enum 
    {
        WithPostSerialize = true,
    };
#endif
};