MovieSceneInterrogationLinker.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "CoreTypes.h"
#include "Containers/SparseArray.h"
#include "Containers/SortedMap.h"
#include "Evaluation/MovieSceneEvaluationField.h"
#include "MovieSceneTracksComponentTypes.h"
#include "UObject/GCObject.h"
#include "UObject/ObjectKey.h"
 
#include "EntitySystem/MovieSceneEntitySystemTypes.h"
#include "EntitySystem/MovieSceneEntitySystemLinkerExtension.h"
 
#include "EntitySystem/Interrogation/MovieSceneInterrogationExtension.h"
#include "Evaluation/MovieSceneSequenceHierarchy.h"
 
struct FGuid;
struct FMovieSceneBinding;
 
class UMovieSceneTrack;
class IMovieScenePlayer;
class UMovieSceneEntitySystemLinker;
 
namespace UE
{
namespace MovieScene
{
 
struct FInitialValueCache;
struct FSystemInterrogatorEntityTracker;
enum class EEntitySystemCategory : uint32;
 
struct FInterrogationParams
{
    FFrameTime Time;
 
    FInterrogationParams(FFrameTime InTime)
        : Time(InTime)
    {}
    FInterrogationParams(FFrameNumber InTime)
        : Time(InTime)
    {}
};
 
class FInterrogationChannels
{
public:
 
    MOVIESCENETRACKS_API FInterrogationChannels();
    MOVIESCENETRACKS_API ~FInterrogationChannels();
 
    MOVIESCENETRACKS_API void Reset();
 
    const FSparseInterrogationChannelInfo& GetSparseChannelInfo() const
    {
        return SparseChannelInfo;
    }
 
    MOVIESCENETRACKS_API FInterrogationChannel AllocateChannel(FInterrogationChannel ParentChannel, const FMovieScenePropertyBinding& PropertyBinding);
 
 
    MOVIESCENETRACKS_API FInterrogationChannel AllocateChannel(UObject* Object, const FMovieScenePropertyBinding& PropertyBinding);
 
 
    MOVIESCENETRACKS_API FInterrogationChannel AllocateChannel(UObject* Object, FInterrogationChannel ParentChannel, const FMovieScenePropertyBinding& PropertyBinding);
 
 
    MOVIESCENETRACKS_API FInterrogationChannel AllocateUnboundChannel(FInterrogationChannel ParentChannel, const FTransform& CurrentValueLocalSpace);
 
 
    MOVIESCENETRACKS_API FInterrogationChannel ImportTransformHierarchy(USceneComponent* SceneComponent);
 
 
    MOVIESCENETRACKS_API FInterrogationChannel FindChannel(UObject* Object);
 
 
    MOVIESCENETRACKS_API void ActivateChannel(FInterrogationChannel InChannel);
 
    MOVIESCENETRACKS_API void DeactivateChannel(FInterrogationChannel InChannel);
 
 
    MOVIESCENETRACKS_API int32 AddInterrogation(const FInterrogationParams& Params);
 
public:
 
 
    int32 GetNumChannels() const
    {
        return ActiveChannelBits.Num();
    }
 
 
    TArrayView<const FInterrogationParams> GetInterrogations() const
    {
        return Interrogations;
    }
 
public:
 
    MOVIESCENETRACKS_API void QueryLocalSpaceTransforms(UMovieSceneEntitySystemLinker* Linker, USceneComponent* SceneComponent, TArray<FIntermediate3DTransform>& OutTransforms) const;
 
    MOVIESCENETRACKS_API void QueryLocalSpaceTransforms(UMovieSceneEntitySystemLinker* Linker, FInterrogationChannel InChannel, TArray<FIntermediate3DTransform>& OutTransforms) const;
 
    MOVIESCENETRACKS_API void QueryLocalSpaceTransforms(UMovieSceneEntitySystemLinker* Linker, TSparseArray<TArray<FIntermediate3DTransform>>& OutTransformsByChannel) const;
 
    MOVIESCENETRACKS_API void QueryLocalSpaceTransforms(UMovieSceneEntitySystemLinker* Linker, const TBitArray<>& ChannelsToQuery, TSparseArray<TArray<FIntermediate3DTransform>>& OutTransformsByChannel) const;
 
public:
 
    MOVIESCENETRACKS_API void QueryWorldSpaceTransforms(UMovieSceneEntitySystemLinker* Linker, USceneComponent* SceneComponent, TArray<FTransform>& OutTransforms) const;
 
    MOVIESCENETRACKS_API void QueryWorldSpaceTransforms(UMovieSceneEntitySystemLinker* Linker, FInterrogationChannel InChannel, TArray<FTransform>& OutTransforms) const;
 
    MOVIESCENETRACKS_API void QueryWorldSpaceTransforms(UMovieSceneEntitySystemLinker* Linker, TSparseArray<TArray<FTransform>>& OutTransformsByChannel) const;
 
    MOVIESCENETRACKS_API void QueryWorldSpaceTransforms(UMovieSceneEntitySystemLinker* Linker, const TBitArray<>& ChannelsToQuery, TSparseArray<TArray<FTransform>>& OutTransformsByChannel) const;
 
    MOVIESCENETRACKS_API void QueryTransformOrigins(UMovieSceneEntitySystemLinker* Linker, const FMovieSceneSequenceHierarchy* Hierarchy, TArray<FTransform>& OutTransformOrigins, TArray<FMovieSceneSequenceID>& SubsequenceHierarchy, const UObject* InstanceData) const;
    
private:
 
    template<typename GetOutputForChannelType>
    void QueryWorldSpaceTransforms(UMovieSceneEntitySystemLinker* Linker, const TBitArray<>& ChannelsToQuery, GetOutputForChannelType&& OnGetOutputForChannel) const;
 
    template<typename GetOutputForChannelType>
    void QueryLocalSpaceTransforms(UMovieSceneEntitySystemLinker* Linker, const TBitArray<>& ChannelsToQuery, GetOutputForChannelType&& OnGetOutputForChannel) const;
 
protected:
 
    TMap<FObjectKey, FInterrogationChannel> ObjectToChannel;
 
    FSparseInterrogationChannelInfo SparseChannelInfo;
 
    TBitArray<> ActiveChannelBits;
 
    TArray<FInterrogationParams> Interrogations;
};
 
 
 
class FSystemInterrogator
    : FGCObject
    , IInterrogationExtension
{
public:
    MOVIESCENETRACKS_API FSystemInterrogator();
    MOVIESCENETRACKS_API ~FSystemInterrogator();
 
 
    static MOVIESCENETRACKS_API EEntitySystemCategory GetInterrogationCategory();
 
 
    static MOVIESCENETRACKS_API EEntitySystemCategory GetExcludedFromInterrogationCategory();
 
    
    FInterrogationChannel AllocateChannel(UObject* Object, const FMovieScenePropertyBinding& PropertyBinding)
    {
        return Channels.AllocateChannel(Object, PropertyBinding);
    }
 
 
    MOVIESCENETRACKS_API void ImportTrack(UMovieSceneTrack* Track, FInterrogationChannel InChannel, FMovieSceneSequenceID SequenceID = MovieSceneSequenceID::Invalid);
 
 
    MOVIESCENETRACKS_API void ImportTrack(UMovieSceneTrack* Track, const FGuid& ObjectBindingID, FInterrogationChannel InChannel, FMovieSceneSequenceID SequenceID = MovieSceneSequenceID::Invalid);
 
 
    MOVIESCENETRACKS_API FInterrogationChannel ImportTransformHierarchy(USceneComponent* SceneComponent, IMovieScenePlayer* InPlayer, FMovieSceneSequenceID SequenceID);
 
 
    MOVIESCENETRACKS_API FInterrogationChannel ImportLocalTransforms(USceneComponent* SceneComponent, IMovieScenePlayer* InPlayer, FMovieSceneSequenceID SequenceID);
 
 
    void ImportTracks(TArrayView<UMovieSceneTrack* const> Tracks, FInterrogationChannel InChannel)
    {
        for (UMovieSceneTrack* Track : Tracks)
        {
            ImportTrack(Track, InChannel);
        }
    }
 
 
    void ImportTracks(TArrayView<UMovieSceneTrack* const> Tracks, const FGuid& ObjectBindingID, FInterrogationChannel InChannel)
    {
        for (UMovieSceneTrack* Track : Tracks)
        {
            ImportTrack(Track, ObjectBindingID, InChannel);
        }
    }
 
 
    MOVIESCENETRACKS_API int32 AddInterrogation(const FInterrogationParams& Params);
 
 
    MOVIESCENETRACKS_API void Update();
 
 
    MOVIESCENETRACKS_API void Reset();
 
public:
 
    MOVIESCENETRACKS_API void TrackImportedEntities(bool bInTrackImportedEntities);
 
 
    MOVIESCENETRACKS_API FMovieSceneEntityID FindEntityFromOwner(FInterrogationKey InterrogationKey, UObject* Owner, uint32 EntityID) const;
 
 
    UMovieSceneEntitySystemLinker* GetLinker() const
    {
        return Linker;
    }
 
 
    int32 GetNumChannels() const
    {
        return Channels.GetNumChannels();
    }
 
 
    TArrayView<const FInterrogationParams> GetInterrogations() const
    {
        return Channels.GetInterrogations();
    }
 
private:
 
    MOVIESCENETRACKS_API void FindPropertyOutputEntityIDs(const FPropertyDefinition& PropertyDefinition, FInterrogationChannel Channel, TArray<FMovieSceneEntityID>& OutEntityIDs) const;
 
public:
 
    void QueryLocalSpaceTransforms(USceneComponent* SceneComponent, TArray<FIntermediate3DTransform>& OutTransforms) const
    {
        Channels.QueryLocalSpaceTransforms(Linker, SceneComponent, OutTransforms);
    }
 
    void QueryLocalSpaceTransforms(FInterrogationChannel InChannel, TArray<FIntermediate3DTransform>& OutTransforms) const
    {
        Channels.QueryLocalSpaceTransforms(Linker, InChannel, OutTransforms);
    }
 
    void QueryLocalSpaceTransforms(TSparseArray<TArray<FIntermediate3DTransform>>& OutTransformsByChannel) const
    {
        Channels.QueryLocalSpaceTransforms(Linker, OutTransformsByChannel);
    }
 
    void QueryLocalSpaceTransforms(const TBitArray<>& ChannelsToQuery, TSparseArray<TArray<FIntermediate3DTransform>>& OutTransformsByChannel) const
    {
        Channels.QueryLocalSpaceTransforms(Linker, ChannelsToQuery, OutTransformsByChannel);
    }
 
public:
 
    void QueryWorldSpaceTransforms(USceneComponent* SceneComponent, TArray<FTransform>& OutTransforms) const
    {
        Channels.QueryWorldSpaceTransforms(Linker, SceneComponent, OutTransforms);
    }
 
    void QueryWorldSpaceTransforms(FInterrogationChannel InChannel, TArray<FTransform>& OutTransforms) const
    {
        Channels.QueryWorldSpaceTransforms(Linker, InChannel, OutTransforms);
    }
 
    void QueryWorldSpaceTransforms(TSparseArray<TArray<FTransform>>& OutTransformsByChannel) const
    {
        Channels.QueryWorldSpaceTransforms(Linker, OutTransformsByChannel);
    }
 
    void QueryWorldSpaceTransforms(const TBitArray<>& ChannelsToQuery, TSparseArray<TArray<FTransform>>& OutTransformsByChannel) const
    {
        Channels.QueryWorldSpaceTransforms(Linker, ChannelsToQuery, OutTransformsByChannel);
    }
 
    template<typename PropertyTraits>
    void QueryPropertyValues(const TPropertyComponents<PropertyTraits>& InPropertyComponents, TArray<typename PropertyTraits::StorageType>& OutValues) const
    {
        return QueryPropertyValues(InPropertyComponents, FInterrogationChannel::Default(), OutValues);
    }
 
    template<typename PropertyTraits>
    void QueryPropertyValues(const TPropertyComponents<PropertyTraits>& InPropertyComponents, FInterrogationChannel InChannel, TArray<typename PropertyTraits::StorageType>& OutValues) const
    {
        FBuiltInComponentTypes* Components = FBuiltInComponentTypes::Get();
        const FPropertyDefinition& PropertyDefinition = Components->PropertyRegistry.GetDefinition(InPropertyComponents.CompositeID);
        TArrayView<const FPropertyCompositeDefinition> PropertyComposites = Components->PropertyRegistry.GetComposites(PropertyDefinition);
 
        TArray<FMovieSceneEntityID> ValueEntityIDs;
        FindPropertyOutputEntityIDs(PropertyDefinition, InChannel, ValueEntityIDs);
 
        const int32 NumPropertyValues = Channels.GetInterrogations().Num();
        check(ValueEntityIDs.Num() == NumPropertyValues);
        OutValues.SetNum(NumPropertyValues);
 
        PropertyDefinition.Handler->RebuildOperational(PropertyDefinition, PropertyComposites, ValueEntityIDs, Linker, OutValues);
    }
 
 
    void QueryTransformOrigins(TArray<FTransform>& OutTransformOrigins, TArray<FMovieSceneSequenceID>& SubsequenceHierarchy, const UObject* InstanceData) const
    {
        Channels.QueryTransformOrigins(Linker, Hierarchy, OutTransformOrigins, SubsequenceHierarchy, InstanceData);
    }
 
public:
 
    const FSparseInterrogationChannelInfo& GetSparseChannelInfo() const override
    {
        return Channels.GetSparseChannelInfo();
    }
 
    virtual const FMovieSceneSequenceHierarchy* GetHierarchy() const override
    {
        return Hierarchy;
    }
 
    void SetHierarchy(FMovieSceneSequenceHierarchy* InHierarchy)
    {
        Hierarchy = InHierarchy;
    }
 
private:
 
    MOVIESCENETRACKS_API void ImportTransformTracks(const FMovieSceneBinding& Binding, FInterrogationChannel Channel);
 
    MOVIESCENETRACKS_API void InterrogateEntity(int32 InterrogationIndex, const FMovieSceneEvaluationFieldEntityQuery& Query);
 
 
private:
 
    MOVIESCENETRACKS_API virtual void AddReferencedObjects(FReferenceCollector& Collector);
    MOVIESCENETRACKS_API virtual FString GetReferencerName() const;
 
protected:
 
    FInterrogationChannels Channels;
 
    FMovieSceneEvaluationFieldEntitySet EntitiesScratch;
 
    FMovieSceneEntityComponentField EntityComponentField;
 
    TUniquePtr<FSystemInterrogatorEntityTracker> EntityTracker;
 
    TObjectPtr<UMovieSceneEntitySystemLinker> Linker;
 
    TSharedPtr<FInitialValueCache> InitialValueCache;
 
    FMovieSceneSequenceHierarchy* Hierarchy;
 
    struct FExtraMetaData
    {
        UE::MovieScene::FInterrogationInstance InterrogationInstance;
        UE::MovieScene::FInterrogationChannel InterrogationChannel;
        FMovieSceneSequenceID InterrogationSequenceID;
    };
    TSparseArray<FExtraMetaData> ExtraMetaData;
};
 
 
} // namespace MovieScene
} // namespace UE