IMovieScenePropertyComponentHandler.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "Templates/SharedPointer.h"
#include "EntitySystem/MovieSceneEntityIDs.h"
#include "EntitySystem/MovieSceneVariantPropertyTypeIndex.h"
#include "EntitySystem/MovieSceneIntermediatePropertyValue.h"
 
 
class UMovieSceneSection;
class UMovieSceneBlenderSystem;
class UMovieSceneEntitySystemLinker;
 
namespace UE
{
namespace MovieScene
{
 
struct FPropertyStats;
struct FEntityAllocation;
struct FInitialValueCache;
struct FPropertyDefinition;
struct IPreAnimatedStorage;
struct FEntityComponentFilter;
struct FUnpackedChannelValues;
struct FSystemSubsequentTasks;
struct FSystemTaskPrerequisites;
struct FVariantPropertyTypeIndex;
struct FValueDecompositionParams;
struct FPreAnimatedStateExtension;
struct FPropertyCompositeDefinition;
 
class IEntitySystemScheduler;
 
struct FPropertyComponentView
{
    template<typename T>
    FPropertyComponentView(T& InData) : Data(&InData), DataSizeof(sizeof(T)) {}
 
    FPropertyComponentView(void* InData, int32 InDataSizeof) : Data(InData), DataSizeof(InDataSizeof) {}
 
    int32 Sizeof() const { return DataSizeof; }
 
    template<typename T>
    T& ReinterpretCast() const { check(sizeof(T) <= DataSizeof); return *static_cast<T*>(Data); }
 
private:
    void* Data;
    int32 DataSizeof;
};
 
struct FConstPropertyComponentView
{
    template<typename T>
    FConstPropertyComponentView(const T& InData) : Data(&InData), DataSizeof(sizeof(T)) {}
 
    FConstPropertyComponentView(const void* InData, int32 InDataSizeof) : Data(InData), DataSizeof(InDataSizeof) {}
 
    int32 Sizeof() const { return DataSizeof; }
 
    template<typename T>
    const T& ReinterpretCast() const { check(sizeof(T) <= DataSizeof); return *static_cast<const T*>(Data); }
 
private:
    const void* Data;
    int32 DataSizeof;
};
 
 
struct FPropertyComponentArrayView
{
    template<typename T, typename Allocator>
    FPropertyComponentArrayView(TArray<T, Allocator>& InRange)
        : Data(InRange.GetData())
        , DataSizeof(sizeof(T))
        , ArrayNum(InRange.Num())
    {}
 
    int32 Num() const
    {
        return ArrayNum;
    }
 
    int32 Sizeof() const
    {
        return DataSizeof;
    }
 
    template<typename T>
    TArrayView<T> ReinterpretCast() const
    {
        check(sizeof(T) == DataSizeof);
        return MakeArrayView(static_cast<T*>(Data), ArrayNum);
    }
 
    FPropertyComponentView operator[](int32 Index)
    {
        check(Index < ArrayNum);
        return FPropertyComponentView(static_cast<uint8*>(Data) + DataSizeof*Index, DataSizeof);
    }
 
    FConstPropertyComponentView operator[](int32 Index) const
    {
        check(Index < ArrayNum);
        return FConstPropertyComponentView(static_cast<uint8*>(Data) + DataSizeof*Index, DataSizeof);
    }
 
private:
    void* Data;
    int32 DataSizeof;
    int32 ArrayNum;
};
 
struct IInitialValueProcessor
{
    virtual ~IInitialValueProcessor(){}
 
    virtual void Initialize(UMovieSceneEntitySystemLinker* Linker, FInitialValueCache* InitialValueCache) = 0;
    virtual void PopulateFilter(FEntityComponentFilter& OutFilter) const = 0;
    virtual void Process(const FEntityAllocation* Allocation, const FComponentMask& AllocationType) = 0;
    virtual void Finalize() = 0;
};
 
struct IPropertyComponentHandler
{
    virtual ~IPropertyComponentHandler(){}
 
    virtual bool SupportsProperty(const FPropertyDefinition& Definition, const FProperty& InProperty) const = 0;
    virtual FIntermediatePropertyValue CoercePropertyValue(const FPropertyDefinition& Definition, const FProperty& InProperty, const FSourcePropertyValue& InPropertyValue) const = 0;
    virtual void UnpackChannels(const FPropertyDefinition& Definition, const FProperty& Property, const FIntermediatePropertyValueConstRef& Value, FUnpackedChannelValues& OutUnpackedValues) const = 0;
 
    virtual void ScheduleSetterTasks(const FPropertyDefinition& Definition, TArrayView<const FPropertyCompositeDefinition> Composites, const FPropertyStats& Stats, IEntitySystemScheduler* TaskScheduler, UMovieSceneEntitySystemLinker* Linker) = 0;
    virtual void DispatchSetterTasks(const FPropertyDefinition& Definition, TArrayView<const FPropertyCompositeDefinition> Composites, const FPropertyStats& Stats, FSystemTaskPrerequisites& InPrerequisites, FSystemSubsequentTasks& Subsequents, UMovieSceneEntitySystemLinker* Linker) = 0;
 
    virtual void DispatchInitializePropertyMetaDataTasks(const FPropertyDefinition& Definition, FSystemTaskPrerequisites& InPrerequisites, FSystemSubsequentTasks& Subsequents, UMovieSceneEntitySystemLinker* Linker) {}
 
    virtual TSharedPtr<IPreAnimatedStorage> GetPreAnimatedStateStorage(const FPropertyDefinition& Definition, FPreAnimatedStateExtension* Container) { return nullptr; }
 
    virtual void RecomposeBlendOperational(const FPropertyDefinition& Definition, TArrayView<const FPropertyCompositeDefinition> Composites, const FValueDecompositionParams& Params, UMovieSceneBlenderSystem* Blender, const FIntermediatePropertyValueConstRef& InCurrentValue, TArrayView<FIntermediatePropertyValue> OutResult) = 0;
 
    virtual void RecomposeBlendChannel(const FPropertyDefinition& Definition, TArrayView<const FPropertyCompositeDefinition> Composites, int32 CompositeIndex, const FValueDecompositionParams& Params, UMovieSceneBlenderSystem* Blender, double InCurrentValue, TArrayView<double> OutResults) = 0;
 
    virtual void RebuildOperational(const FPropertyDefinition& Definition, TArrayView<const FPropertyCompositeDefinition> Composites, const TArrayView<FMovieSceneEntityID>& EntityIDs, UMovieSceneEntitySystemLinker* Linker, FPropertyComponentArrayView OutResult) = 0;
 
    virtual TSharedPtr<IInitialValueProcessor> MakeInitialValueProcessor(const FPropertyDefinition& Definition) = 0;
};
 
 
} // namespace MovieScene
} // namespace UE