MovieSceneBindingReferences.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "CoreTypes.h"
#include "UniversalObjectLocator.h"
#include "UniversalObjectLocatorResolveParams.h"
#include "MovieSceneSequenceID.h"
#include "Bindings/MovieSceneCustomBinding.h"
#include "MovieSceneBindingReferences.generated.h"
 
class UWorld;
struct FWorldPartitionResolveData;
class UMovieSceneSequence;
 
namespace UE::MovieScene
{
    struct FSharedPlaybackState;
}
 
 
USTRUCT()
struct FMovieSceneBindingReference
{
    GENERATED_BODY()
 
    UPROPERTY()
    FGuid ID;
 
    UPROPERTY()
    FUniversalObjectLocator Locator;
 
    UPROPERTY()
    ELocatorResolveFlags ResolveFlags = ELocatorResolveFlags::None;
 
    UPROPERTY(Instanced)
    TObjectPtr<UMovieSceneCustomBinding> CustomBinding;
 
    void InitializeLocatorResolveFlags();
};
 
USTRUCT()
struct FMovieSceneBindingResolveParams
{
    GENERATED_BODY()
 
    
    UPROPERTY()
    TObjectPtr<UMovieSceneSequence> Sequence;
 
    UPROPERTY()
    FGuid ObjectBindingID;
 
    UPROPERTY()
    FMovieSceneSequenceID SequenceID;
 
    /* The outer context with which to resolve this binding. May be the world, or may be an outer UObject.*/
    UPROPERTY()
    TObjectPtr<UObject> Context = nullptr;
};
 
USTRUCT()
struct FMovieSceneBindingReferences
{
    GENERATED_BODY()
 
    MOVIESCENE_API TArrayView<const FMovieSceneBindingReference> GetAllReferences() const;
 
    MOVIESCENE_API TArrayView<FMovieSceneBindingReference> GetAllReferences();
 
    MOVIESCENE_API TArrayView<const FMovieSceneBindingReference> GetReferences(const FGuid& ObjectId) const;
 
    MOVIESCENE_API const FMovieSceneBindingReference* GetReference(const FGuid& ObjectId, int32 BindingIndex) const;
 
    MOVIESCENE_API bool HasBinding(const FGuid& ObjectId) const;
 
    /*
    * @return If a custom binding exists at the given id and index, returns it.
    */
    MOVIESCENE_API UMovieSceneCustomBinding* GetCustomBinding(const FGuid& ObjectId, int32 BindingIndex);
 
    /*
    * @return If a custom binding exists at the given id and index, returns it.
    */
    MOVIESCENE_API const UMovieSceneCustomBinding* GetCustomBinding(const FGuid& ObjectId, int32 BindingIndex) const;
 
    MOVIESCENE_API void RemoveBinding(const FGuid& ObjectId);
 
    MOVIESCENE_API void RemoveObjects(const FGuid& ObjectId, const TArray<UObject*>& InObjects, UObject *InContext);
 
    MOVIESCENE_API void RemoveInvalidObjects(const FGuid& ObjectId, UObject *InContext);
 
    MOVIESCENE_API const FMovieSceneBindingReference* AddBinding(const FGuid& ObjectId, FUniversalObjectLocator&& NewLocator);
 
    const FMovieSceneBindingReference* AddBinding(const FGuid& ObjectId, UMovieSceneCustomBinding* CustomBinding) { return AddBinding(ObjectId, FUniversalObjectLocator(), ELocatorResolveFlags::None, CustomBinding); }
 
    MOVIESCENE_API const FMovieSceneBindingReference* AddBinding(const FGuid& ObjectId, FUniversalObjectLocator&& NewLocator, ELocatorResolveFlags InResolveFlags, UMovieSceneCustomBinding* CustomBinding=nullptr);
 
    MOVIESCENE_API const FMovieSceneBindingReference* AddOrReplaceBinding(const FGuid& ObjectId, UMovieSceneCustomBinding* NewCustomBinding, int32 BindingIndex);
 
    MOVIESCENE_API const FMovieSceneBindingReference* AddOrReplaceBinding(const FGuid& ObjectId, FUniversalObjectLocator&& NewLocator, int32 BindingIndex);
 
    MOVIESCENE_API void ResolveBinding(const FGuid& ObjectId, const UE::UniversalObjectLocator::FResolveParams& LocatorResolveParams, TArray<UObject*, TInlineAllocator<1>>& OutObjects) const;
 
    MOVIESCENE_API void ResolveBinding(const FMovieSceneBindingResolveParams& BindingResolveParams, const UE::UniversalObjectLocator::FResolveParams& LocatorResolveParams, TSharedPtr<const UE::MovieScene::FSharedPlaybackState> SharedPlaybackState, TArray<UObject*, TInlineAllocator<1>>& OutObjects) const;
 
    MOVIESCENE_API void ResolveSingleBinding(const FMovieSceneBindingResolveParams& BindingResolveParams, int32 BindingIndex, const UE::UniversalObjectLocator::FResolveParams& LocatorResolveParams, TSharedPtr<const UE::MovieScene::FSharedPlaybackState> SharedPlaybackState, TArray<UObject*, TInlineAllocator<1>>& OutObjects) const;
 
    UE_DEPRECATED(5.7, "This method has been deprecated. Please use ResolveSingleBinding which returns an array of bound objects.")
    MOVIESCENE_API UObject* ResolveSingleBinding(const FMovieSceneBindingResolveParams& BindingResolveParams, int32 BindingIndex, const UE::UniversalObjectLocator::FResolveParams& LocatorResolveParams, TSharedPtr<const UE::MovieScene::FSharedPlaybackState> SharedPlaybackState) const;
 
    UE_DEPRECATED(5.5, "This method has been deprecated as it produces errors for subobjects. Please call UMovieSceneSequence::FindBindingFromObject passing in a SharedPlaybackState")
    MOVIESCENE_API FGuid FindBindingFromObject(UObject* InObject, UObject* InContext) const;
 
    MOVIESCENE_API void RemoveInvalidBindings(const TSet<FGuid>& ValidBindingIDs);
 
    UE_DEPRECATED(5.5, "UnloadBoundObject no longer supported")
    void UnloadBoundObject(const UE::UniversalObjectLocator::FResolveParams& ResolveParams, const FGuid& ObjectId, int32 BindingIndex) {}
 
private:
 
    void ResolveBindingInternal(const FMovieSceneBindingResolveParams& BindingResolveParams, const UE::UniversalObjectLocator::FResolveParams& LocatorResolveParams, int32 BindingIndex, int32 InternalIndex, TSharedPtr<const UE::MovieScene::FSharedPlaybackState> SharedPlaybackState, TArray<UObject*, TInlineAllocator<1>>& OutObjects) const;
    UObject* ResolveBindingFromLocator(int32 Index, const UE::UniversalObjectLocator::FResolveParams& LocatorResolveParams) const;
 
    UPROPERTY()
    TArray<FMovieSceneBindingReference> SortedReferences;
};