MovieSceneBinding.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "Containers/Array.h"
#include "Containers/UnrealString.h"
#include "CoreTypes.h"
#include "Decorations/MovieSceneDecorationContainer.h"
#include "Misc/Guid.h"
#include "MovieSceneTrack.h"
#include "UObject/ObjectMacros.h"
#include "UObject/ObjectPtr.h"
 
#include "MovieSceneBinding.generated.h"
 
class UMovieScene;
class UMovieSceneTrack;
 
USTRUCT()
struct FMovieSceneBinding 
    : public FMovieSceneDecorationContainer
{
    GENERATED_USTRUCT_BODY()
 
    
    FMovieSceneBinding()
#if WITH_EDITORONLY_DATA
        : SortingOrder(-1)
#endif
    { }
 
private:
 
    FMovieSceneBinding(const FGuid& InObjectGuid, const TArray<UMovieSceneTrack*>& InTracks)
        : ObjectGuid(InObjectGuid)
        , Tracks(InTracks)
#if WITH_EDITORONLY_DATA
        , SortingOrder(-1)
#endif
    { }
 
    FMovieSceneBinding(const FGuid& InObjectGuid)
        : ObjectGuid(InObjectGuid)
#if WITH_EDITORONLY_DATA
        , SortingOrder(-1)
#endif
    { }
 
    void SetObjectGuid_Private(const FGuid& InObjectGuid)
    {
        ObjectGuid = InObjectGuid;
    }
 
public:
 
    UE_DEPRECATED(5.7, "SetObjectGuid is deprecated because guids can no longer be set directly.")
    void SetObjectGuid(const FGuid& InObjectGuid)
    {
        ObjectGuid = InObjectGuid;
    }
 
    const FGuid& GetObjectGuid() const
    {
        return ObjectGuid;
    }
 
    UE_DEPRECATED(5.7, "SetName is deprecated. Use SetName on FMovieScenePossessable or FMovieSceneSpawnable")
    void SetName(const FString& InBindingName) { } 
 
    UE_DEPRECATED(5.7, "GetName is deprecated. Use GetName on FMovieScenePossessable or FMovieSceneSpawnable")
    const FString& GetName() const { return BindingName_DEPRECATED; }
 
    MOVIESCENE_API void AddTrack(UMovieSceneTrack& NewTrack, UMovieScene* Owner);
 
    MOVIESCENE_API bool RemoveTrack(UMovieSceneTrack& Track, UMovieScene* Owner);
 
    MOVIESCENE_API void RemoveNullTracks();
 
    const TArray<UMovieSceneTrack*>& GetTracks() const
    {
        return Tracks;
    }
 
    MOVIESCENE_API TArray<UMovieSceneTrack*> StealTracks(UMovieScene* Owner);
 
    MOVIESCENE_API void SetTracks(TArray<UMovieSceneTrack*>&& InTracks, UMovieScene* Owner);
 
    /* For sorts so we can search quickly by Guid */
    inline bool operator<(const FMovieSceneBinding& RHS) const { return ObjectGuid < RHS.ObjectGuid; }
    inline bool operator<(const FGuid& InGuid) const { return ObjectGuid < InGuid; }
    inline friend bool operator<(const FGuid& InGuid, const FMovieSceneBinding& RHS) { return InGuid < RHS.GetObjectGuid(); }
 
#if WITH_EDITORONLY_DATA
    int32 GetSortingOrder() const
    {
        return SortingOrder;
    }
 
    void SetSortingOrder(const int32 InSortingOrder)
    {
        SortingOrder = InSortingOrder;
    }
#endif
 
    friend class UMovieScene;
 
private:
 
    UPROPERTY()
    FGuid ObjectGuid;
    
    UPROPERTY()
    FString BindingName_DEPRECATED;
 
    UPROPERTY(Instanced)
    TArray<TObjectPtr<UMovieSceneTrack>> Tracks;
 
#if WITH_EDITORONLY_DATA
    UPROPERTY()
    int32 SortingOrder;
#endif
};