MovieSceneComponentRegistry.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "Containers/SparseArray.h"
#include "Containers/UnrealString.h"
#include "EntitySystem/MovieSceneComponentTypeInfo.h"
#include "EntitySystem/MovieSceneEntityFactory.h"
#include "EntitySystem/MovieSceneEntityIDs.h"
#include "EntitySystem/MovieSceneEntitySystemTypes.h"
#include "HAL/Platform.h"
#include "Misc/GeneratedTypeName.h"
 
class UScriptStruct;
 
namespace UE
{
namespace MovieScene
{
 
template<typename> struct TPropertyComponents;
 
struct FNewComponentTypeParams
{
    FNewComponentTypeParams()
        : ReferenceCollectionCallback(nullptr)
        , Flags(EComponentTypeFlags::None)
    {}
 
    FNewComponentTypeParams(EComponentTypeFlags InFlags)
        : ReferenceCollectionCallback(nullptr)
        , Flags(InFlags)
    {}
 
    explicit FNewComponentTypeParams(FComponentReferenceCollectionPtr RefCollectionPtr, EComponentTypeFlags InFlags)
        : ReferenceCollectionCallback(RefCollectionPtr)
        , Flags(InFlags)
    {}
 
    FComponentReferenceCollectionPtr ReferenceCollectionCallback;
    EComponentTypeFlags Flags;
};
 
struct FComponentRegistry
{
public:
    FEntityFactories Factories;
 
    FComponentRegistry() = default;
 
    FComponentRegistry(const FComponentRegistry&) = delete;
    FComponentRegistry& operator=(const FComponentRegistry&) = delete;
 
    FComponentRegistry(FComponentRegistry&&) = delete;
    FComponentRegistry& operator=(FComponentRegistry&&) = delete;
 
public:
 
    MOVIESCENE_API FComponentTypeID NewTag(const TCHAR* const DebugName, EComponentTypeFlags Flags = EComponentTypeFlags::None);
 
 
    template<typename T>
    TComponentTypeID<T> NewComponentType(const TCHAR* const DebugName, const FNewComponentTypeParams& Params = FNewComponentTypeParams());
 
    template<typename T>
    TComponentTypeID<T> NewComponentTypeNoAddReferencedObjects(const TCHAR* const DebugName, const FNewComponentTypeParams& Params = FNewComponentTypeParams());
 
    template<typename T>
    void NewComponentType(TComponentTypeID<T>* Ref, const TCHAR* const DebugName, const FNewComponentTypeParams& Params = FNewComponentTypeParams())
    {
        *Ref = NewComponentType<T>(DebugName, Params);
    }
 
    template<typename T>
    void NewComponentTypeNoAddReferencedObjects(TComponentTypeID<T>* Ref, const TCHAR* const DebugName, const FNewComponentTypeParams& Params = FNewComponentTypeParams())
    {
        *Ref = NewComponentTypeNoAddReferencedObjects<T>(DebugName, Params);
    }
 
    template<typename PropertyTraits>
    void NewPropertyType(TPropertyComponents<PropertyTraits>& OutComponents, const TCHAR* DebugName)
    {
#if UE_MOVIESCENE_ENTITY_DEBUG
        FString InitialValueDebugName = FString(TEXT("Initial ")) + DebugName;
 
        OutComponents.PropertyTag = NewTag(DebugName, EComponentTypeFlags::CopyToChildren | EComponentTypeFlags::CopyToOutput);
        NewComponentType(&OutComponents.InitialValue, *InitialValueDebugName, EComponentTypeFlags::Preserved | EComponentTypeFlags::MigrateToOutput);
#else
        OutComponents.PropertyTag = NewTag(nullptr, EComponentTypeFlags::CopyToChildren | EComponentTypeFlags::CopyToOutput);
        NewComponentType(&OutComponents.InitialValue, nullptr, EComponentTypeFlags::Preserved | EComponentTypeFlags::MigrateToOutput);
#endif
    }
 
    MOVIESCENE_API const FComponentTypeInfo& GetComponentTypeChecked(FComponentTypeID ComponentTypeID) const;
 
public:
 
 
    MOVIESCENE_API void DestroyComponentTypeSafe(FComponentTypeID ComponentTypeID);
 
 
    MOVIESCENE_API void DestroyComponentUnsafeFast(FComponentTypeID ComponentTypeID);
 
public:
 
    const FComponentMask& GetDataComponentTypes() const
    {
        return NonTagComponentMask;
    }
 
    const FComponentMask& GetPreservationMask() const
    {
        return PreservationMask;
    }
 
    const FComponentMask& GetMigrationMask() const
    {
        return MigrationMask;
    }
 
    const FComponentMask& GetCopyAndMigrationMask() const
    {
        return CopyAndMigrationMask;
    }
 
private:
 
    MOVIESCENE_API FComponentTypeID NewComponentTypeInternal(FComponentTypeInfo&& TypeInfo);
 
    template<typename T>
    FComponentTypeInfo MakeComponentTypeInfoWithoutComponentOps(const TCHAR* const DebugName, const FNewComponentTypeParams& Params);
 
private:
 
    TSparseArray<FComponentTypeInfo> ComponentTypes;
    TSparseArray<UScriptStruct*>     ComponentStructs;
 
    FComponentMask NonTagComponentMask;
 
    FComponentMask PreservationMask;
 
    FComponentMask MigrationMask;
 
    FComponentMask CopyAndMigrationMask;
};
 
 
} // namespace MovieScene
} // namespace UE