MovieSceneInterrogatedPropertyInstantiator.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "EntitySystem/MovieSceneEntityIDs.h"
#include "EntitySystem/MovieSceneEntityInstantiatorSystem.h"
#include "EntitySystem/BuiltInComponentTypes.h"
#include "EntitySystem/MovieSceneEntitySystemTypes.h"
#include "EntitySystem/MovieScenePropertyComponentHandler.h"
#include "EntitySystem/MovieSceneOverlappingEntityTracker.h"
 
#include "MovieSceneInterrogatedPropertyInstantiator.generated.h"
 
class UMovieSceneBlenderSystem;
 
UCLASS(MinimalAPI)
class UMovieSceneInterrogatedPropertyInstantiatorSystem
    : public UMovieSceneEntityInstantiatorSystem
{
public:
 
    using FMovieSceneEntityID = UE::MovieScene::FMovieSceneEntityID;
    using FValueRecompositionResult = UE::MovieScene::TRecompositionResult<double>;
 
    GENERATED_BODY()
 
    MOVIESCENETRACKS_API UMovieSceneInterrogatedPropertyInstantiatorSystem(const FObjectInitializer& ObjInit);
 
    MOVIESCENETRACKS_API FValueRecompositionResult RecomposeBlendChannel(const UE::MovieScene::FPropertyDefinition& PropertyDefinition, int32 ChannelCompositeIndex, const UE::MovieScene::FDecompositionQuery& InQuery, double InCurrentValue);
 
    template<typename PropertyTraits, typename ValueType>
    UE::MovieScene::TRecompositionResult<ValueType> RecomposeBlend(const UE::MovieScene::TPropertyComponents<PropertyTraits>& InComponents, const UE::MovieScene::FDecompositionQuery& InQuery, const ValueType& InCurrentValue)
    {
        typename PropertyTraits::StorageType WorkingValue{};
        ConvertOperationalProperty(InCurrentValue, WorkingValue);
 
        WorkingValue = RecomposeBlendOperational(InComponents, InQuery, WorkingValue);
 
        ValueType Result{};
        ConvertOperationalProperty(WorkingValue, Result);
        return Result;
    }
 
    template<typename PropertyTraits>
    UE::MovieScene::TRecompositionResult<typename PropertyTraits::StorageType> RecomposeBlendOperational(const UE::MovieScene::TPropertyComponents<PropertyTraits>& InComponents, const UE::MovieScene::FDecompositionQuery& InQuery, const typename PropertyTraits::StorageType& InCurrentValue);
 
public:
 
    struct FPropertyInfo
    {
        FPropertyInfo()
            : BlendChannel(INVALID_BLEND_CHANNEL)
        {}
        TWeakObjectPtr<UMovieSceneBlenderSystem> Blender;
        UE::MovieScene::FInterrogationChannel InterrogationChannel;
        UE::MovieScene::FMovieSceneEntityID PropertyEntityID;
        uint16 BlendChannel;
    };
 
    // TOverlappingEntityTracker handler interface
    MOVIESCENETRACKS_API void InitializeOutput(UE::MovieScene::FInterrogationKey Key, TArrayView<const FMovieSceneEntityID> Inputs, FPropertyInfo* Output, UE::MovieScene::FEntityOutputAggregate Aggregate);
    MOVIESCENETRACKS_API void UpdateOutput(UE::MovieScene::FInterrogationKey Key, TArrayView<const FMovieSceneEntityID> Inputs, FPropertyInfo* Output, UE::MovieScene::FEntityOutputAggregate Aggregate);
    MOVIESCENETRACKS_API void DestroyOutput(UE::MovieScene::FInterrogationKey Key, FPropertyInfo* Output, UE::MovieScene::FEntityOutputAggregate Aggregate);
 
    const FPropertyInfo* FindPropertyInfo(UE::MovieScene::FInterrogationKey Key) const
    {
        return PropertyTracker.FindOutput(Key);
    }
 
    void FindEntityIDs(UE::MovieScene::FInterrogationKey Key, TArray<FMovieSceneEntityID>& OutEntityIDs) const
    {
        PropertyTracker.FindEntityIDs(Key, OutEntityIDs);
    }
 
private:
 
    MOVIESCENETRACKS_API virtual void OnRun(FSystemTaskPrerequisites& InPrerequisites, FSystemSubsequentTasks& Subsequents) override;
    MOVIESCENETRACKS_API virtual bool IsRelevantImpl(UMovieSceneEntitySystemLinker* InLinker) const override;
 
    MOVIESCENETRACKS_API bool PropertySupportsFastPath(TArrayView<const FMovieSceneEntityID> Inputs, FPropertyInfo* Output) const;
    MOVIESCENETRACKS_API UClass* ResolveBlenderClass(const UE::MovieScene::FPropertyDefinition& PropertyDefinition, TArrayView<const FMovieSceneEntityID> Inputs) const;
    MOVIESCENETRACKS_API UE::MovieScene::FPropertyRecomposerPropertyInfo FindPropertyFromSource(FMovieSceneEntityID EntityID, UObject* Object) const;
 
private:
 
    static constexpr uint16 INVALID_BLEND_CHANNEL = uint16(-1);
 
    UE::MovieScene::TOverlappingEntityTracker<FPropertyInfo, UE::MovieScene::FInterrogationKey> PropertyTracker;
    UE::MovieScene::FComponentMask CleanFastPathMask;
    UE::MovieScene::FBuiltInComponentTypes* BuiltInComponents;
    UE::MovieScene::FPropertyRecomposerImpl RecomposerImpl;
};
 
template<typename PropertyTraits>
UE::MovieScene::TRecompositionResult<typename PropertyTraits::StorageType> UMovieSceneInterrogatedPropertyInstantiatorSystem::RecomposeBlendOperational(const UE::MovieScene::TPropertyComponents<PropertyTraits>& Components, const UE::MovieScene::FDecompositionQuery& InQuery, const typename PropertyTraits::StorageType& InCurrentValue)
{
    return RecomposerImpl.RecomposeBlendOperational<PropertyTraits>(Components, InQuery, InCurrentValue);
}