ComponentRegistry.h File Reference

#include <initializer_list>
#include <map>
#include <string>
#include <type_traits>
#include <typeindex>
#include <typeinfo>
#include <variant>
#include <entt/entt.hpp>
#include <glm/fwd.hpp>
#include <ElevateEngine/Core/GameObject.h>
#include <ElevateEngine/Core/Data.h>
#include <ElevateEngine/Core/Log.h>
#include <ElevateEngine/Core/Component.h>
#include <ElevateEngine/Core/EEObject.h>
#include <ElevateEngine/Editor/Serialization/ComponentLayout.h>
#include "ComponentRegistry.inl"

Go to the source code of this file.

Classes
struct	Elevate::has_super< T, typename >
struct	Elevate::has_super< T, std::void_t< typename T::Super > >
struct	Elevate::ParentFieldsHelper< T, bool >
struct	Elevate::ParentFieldsHelper< T, true >
struct	Elevate::HideInInspectorTag
struct	Elevate::FlattenTag
struct	Elevate::DisplayNameTag
struct	Elevate::TooltipTag
struct	Elevate::ReadOnlyTag
struct	Elevate::ColorTag
struct	Elevate::EditorIconTag
struct	Elevate::FieldMeta
struct	Elevate::EngineDataTypeTrait< T >
struct	Elevate::EngineDataTypeTrait< float >
struct	Elevate::EngineDataTypeTrait< int >
struct	Elevate::EngineDataTypeTrait< bool >
struct	Elevate::EngineDataTypeTrait< glm::vec2 >
struct	Elevate::EngineDataTypeTrait< glm::vec3 >
struct	Elevate::EngineDataTypeTrait< glm::vec4 >
class	Elevate::ComponentRegistry
struct	Elevate::ComponentRegistry::Entry

Namespaces
namespace	Elevate

Macros
#define	HideInInspector   HideInInspectorTag{}
#define	Flatten   FlattenTag{}
#define	DisplayName(x)   DisplayNameTag{x}
#define	Tooltip(x)   TooltipTag{x}
#define	ReadOnly   ReadOnlyTag{}
#define	ColorPicker   ColorTag{}
#define	EditorIcon(path)   EditorIconTag{path}
#define	EECATEGORY(name)
#define	BEGIN_COMPONENT(T, ...)
#define	EXPOSE(param, ...)
#define	END_COMPONENT()
#define	DECLARE_BASE(BaseType)
#define	BEGIN_STRUCT(T)
#define	END_STRUCT()

Typedefs
using	Elevate::FieldOption = std::variant< HideInInspectorTag, EditorIconTag, FlattenTag, DisplayNameTag, TooltipTag, ReadOnlyTag, ColorTag >

Macro Definition Documentation

BEGIN_COMPONENT

#define BEGIN_COMPONENT	(		T,
			...
	)

Value:

private: \
using ThisType = T; \
public: \
inline static struct T##ClassEntry { \
    T##ClassEntry() { \
        FieldStartIndex = ::Elevate::ComponentRegistry::CompilationClassFieldStack().size(); \
        ::Elevate::ComponentRegistry::AddClassToStack(#T); \
        ClassName = ::Elevate::ComponentRegistry::GetCleanedName(#T); \
        HasBaseClass = false; \
        Options = { __VA_ARGS__ }; \
    } \
    std::vector<FieldOption> Options; \
    EECategory Category; \
    size_t FieldStartIndex = 0; \
    std::string ClassName; \
    std::vector<Elevate::ComponentField> ClassFieldStack; \
    bool HasBaseClass = false; \
} generated_classEntry; \
public: \
    virtual bool RemoveFromGameObject() override { \
        if (gameObject) { \
            gameObject->RemoveComponent<T>(); \
            return true; \
        } \
        return false; \
    }

Definition at line 187 of file ComponentRegistry.h.

       : \
using ThisType = T; \
public: \
inline static struct T##ClassEntry { \
    T##ClassEntry() { \
        FieldStartIndex = ::Elevate::ComponentRegistry::CompilationClassFieldStack().size(); \
        ::Elevate::ComponentRegistry::AddClassToStack(#T); \
        ClassName = ::Elevate::ComponentRegistry::GetCleanedName(#T); \
        HasBaseClass = false; \
        Options = { __VA_ARGS__ }; \
    } \
    std::vector<FieldOption> Options; \
    EECategory Category; \
    size_t FieldStartIndex = 0; \
    std::string ClassName; \
    std::vector<Elevate::ComponentField> ClassFieldStack; \
    bool HasBaseClass = false; \
} generated_classEntry; \
public: \
    virtual bool RemoveFromGameObject() override { \
        if (gameObject) { \
            gameObject->RemoveComponent<T>(); \
            return true; \
        } \
        return false; \
    }

BEGIN_STRUCT

#define BEGIN_STRUCT

(

T

)

Value:

    private: \
    using ThisType = T; \
    inline static struct T##StructEntry { \
        T##StructEntry() { \
            ::Elevate::ComponentRegistry::AddClassToStack(#T); \
            FieldStartIndex = ::Elevate::ComponentRegistry::CompilationClassFieldStack().size(); \
            StructName = ::Elevate::ComponentRegistry::GetCleanedName(#T); \
            StructTypeName = typeid(T).name(); \
        } \
        size_t FieldStartIndex = 0; \
        std::string StructName; \
        std::string StructTypeName; \
        std::vector<Elevate::ComponentField> StructFieldStack; \
    } generated_structEntry; \
    public:

Definition at line 331 of file ComponentRegistry.h.

           : \
    using ThisType = T; \
    inline static struct T##StructEntry { \
        T##StructEntry() { \
            ::Elevate::ComponentRegistry::AddClassToStack(#T); \
            FieldStartIndex = ::Elevate::ComponentRegistry::CompilationClassFieldStack().size(); \
            StructName = ::Elevate::ComponentRegistry::GetCleanedName(#T); \
            StructTypeName = typeid(T).name(); \
        } \
        size_t FieldStartIndex = 0; \
        std::string StructName; \
        std::string StructTypeName; \
        std::vector<Elevate::ComponentField> StructFieldStack; \
    } generated_structEntry; \
    public:

ColorPicker

#define ColorPicker   ColorTag{}

Definition at line 69 of file ComponentRegistry.h.

DECLARE_BASE

#define DECLARE_BASE

(

BaseType

)

Value:

using Super = BaseType; \
inline static struct BaseType##BaseClassDeclaration { \
    BaseType##BaseClassDeclaration() { \
        generated_classEntry.HasBaseClass = true; \
    } \
} generated_baseDeclaration;

Definition at line 319 of file ComponentRegistry.h.

                                                    { \
    BaseType##BaseClassDeclaration() { \
        generated_classEntry.HasBaseClass = true; \
    } \
} generated_baseDeclaration;

DisplayName

#define DisplayName

(

x

)

DisplayNameTag{x}

Definition at line 60 of file ComponentRegistry.h.

EditorIcon

#define EditorIcon

(

path

)

EditorIconTag{path}

Definition at line 75 of file ComponentRegistry.h.

EECATEGORY

#define EECATEGORY

(

name

)

Value:

    private: \
        inline static struct categoryRegistrar { \
            categoryRegistrar() { \
                generated_classEntry.Category = EECategory(name); \
            } \
        } generated_categoryRegistrar; \
        virtual EECategory GetCategory() const override { return generated_classEntry.Category; } \
    public:

Definition at line 172 of file ComponentRegistry.h.

           : \
        inline static struct categoryRegistrar { \
            categoryRegistrar() { \
                generated_classEntry.Category = EECategory(name); \
            } \
        } generated_categoryRegistrar; \
        virtual EECategory GetCategory() const override { return generated_classEntry.Category; } \
    public:

END_COMPONENT

#define END_COMPONENT

(

)

Definition at line 228 of file ComponentRegistry.h.

       : \
    inline static struct ClassEntryEnd { \
        ClassEntryEnd() { \
            ::Elevate::ComponentRegistry::Register<ThisType>( \
                    generated_classEntry.ClassName, \
                    generated_classEntry.Category, \
                    generated_classEntry.Options \
            ); \
            ::Elevate::ComponentRegistry::PopClassStack(); \
            auto& global = ::Elevate::ComponentRegistry::CompilationClassFieldStack(); \
            size_t start = generated_classEntry.FieldStartIndex; \
            for (size_t i = start; i < global.size(); ++i) { \
                generated_classEntry.ClassFieldStack.push_back(global[i]); \
            } \
            if (start < global.size()) { \
                global.erase(global.begin() + start, global.end()); \
            } \
        } \
    } generated_classEntryEnd; \
public: \
    inline virtual std::string GetName() const override { return generated_classEntry.ClassName; } \
    inline virtual Elevate::ComponentLayout GetLayout() const override { \
        std::vector<Elevate::ComponentField> instanceFields; \
        if (generated_classEntry.HasBaseClass) { \
            auto parentFields = ParentFieldsHelper<ThisType>::Get(); \
            for (const Elevate::ComponentField& field : parentFields) { \
                const void* fieldPtr = reinterpret_cast<const char*>(this) + field.offset; \
                instanceFields.push_back(Elevate::ComponentField( \
                    field, fieldPtr \
                )); \
            } \
        } \
        for (const Elevate::ComponentField& field : generated_classEntry.ClassFieldStack) { \
            const void* fieldPtr = reinterpret_cast<const char*>(this) + field.offset; \
            instanceFields.push_back(Elevate::ComponentField(field, fieldPtr)); \
        } \
        return Elevate::ComponentLayout(generated_classEntry.ClassName, instanceFields); \
    } \
    virtual Component* Clone() override { \
        ThisType* clone = new ThisType(); \
        for (auto& field : ComponentRegistry::GetCustomComponentFields()[typeid(ThisType).name()]) { \
            field.CopyValue(this, clone); \
        } \
        return clone; \
    } \
    virtual void CopyFrom(Component* other) override { \
        if (auto o = dynamic_cast<ThisType*>(other)) { \
            if (generated_classEntry.HasBaseClass) { \
                auto parentFields = ParentFieldsHelper<ThisType>::Get(); \
                for (const Elevate::ComponentField& field : parentFields) { \
                    field.CopyValue(o, this); \
                } \
            } \
            for (const Elevate::ComponentField& field : generated_classEntry.ClassFieldStack) { \
                field.CopyValue(o, this); \
            } \
        } \
        else { \
            EE_ERROR("Error: Tried setting a %s from a %s component in CopyFrom(Component*)", \
                this->GetName(), other ? other->GetName() : "null"); \
        } \
    } \
    virtual Elevate::GameObjectComponentFactory GetFactory() const override { \
        auto& entries = ComponentRegistry::GetEntries(); \
        auto it = entries.find(typeid(ThisType)); \
        if (it != entries.end()) { \
            return it->second.factory; \
        } \
        return nullptr; \
    } \
    virtual Elevate::GameObjectComponentDestructor GetDestructor() const override { \
        auto& entries = ComponentRegistry::GetEntries(); \
        auto it = entries.find(typeid(ThisType)); \
        if (it != entries.end()) { \
                return it->second.destructor; \
        } \
        return nullptr; \
    } \
    virtual const void* GetEditorIconHandle() const override { \
        auto& entries = ComponentRegistry::GetEntries(); \
        auto it = entries.find(typeid(ThisType)); \
        if (it != entries.end()) { \
            if(!it->second.editorIconPath.empty()) { \
                return Texture::CreateFromFile(it->second.editorIconPath)->GetNativeHandle(); \
            } \
        } \
        return nullptr; \
    } \
    virtual std::type_index GetTypeIndex() const override { return typeid(ThisType); }

END_STRUCT

#define END_STRUCT

(

)

Value:

    private: \
    inline static struct StructEntryEnd { \
        StructEntryEnd() { \
            auto& global = ::Elevate::ComponentRegistry::CompilationClassFieldStack(); \
            size_t start = generated_structEntry.FieldStartIndex; \
            for (size_t i = start; i < global.size(); ++i) { \
                generated_structEntry.StructFieldStack.push_back(global[i]); \
            } \
            if (start < global.size()) { \
                global.erase(global.begin() + start, global.end()); \
            } \
            ::Elevate::ComponentRegistry::GetCustomComponentFields()[generated_structEntry.StructTypeName] = generated_structEntry.StructFieldStack; \
        } \
    } generated_structEntryEnd;

Definition at line 348 of file ComponentRegistry.h.

           : \
    inline static struct StructEntryEnd { \
        StructEntryEnd() { \
            auto& global = ::Elevate::ComponentRegistry::CompilationClassFieldStack(); \
            size_t start = generated_structEntry.FieldStartIndex; \
            for (size_t i = start; i < global.size(); ++i) { \
                generated_structEntry.StructFieldStack.push_back(global[i]); \
            } \
            if (start < global.size()) { \
                global.erase(global.begin() + start, global.end()); \
            } \
            ::Elevate::ComponentRegistry::GetCustomComponentFields()[generated_structEntry.StructTypeName] = generated_structEntry.StructFieldStack; \
        } \
    } generated_structEntryEnd;

EXPOSE

#define EXPOSE	(		param,
			...
	)

Value:

public: \
inline static struct param##PropertyEntry { \
    param##PropertyEntry() { \
        using MemberT = decltype(ThisType::param); \
        ::Elevate::ComponentRegistry::AddProperty<ThisType, MemberT>( \
            &ThisType::param, \
            #param, \
            { __VA_ARGS__ } \
        ); \
    } \
} generated_##param##PropertyEntry;

Definition at line 215 of file ComponentRegistry.h.

      : \
inline static struct param##PropertyEntry { \
    param##PropertyEntry() { \
        using MemberT = decltype(ThisType::param); \
        ::Elevate::ComponentRegistry::AddProperty<ThisType, MemberT>( \
            &ThisType::param, \
            #param, \
            { __VA_ARGS__ } \
        ); \
    } \
} generated_##param##PropertyEntry;

Flatten

#define Flatten   FlattenTag{}

Definition at line 57 of file ComponentRegistry.h.

HideInInspector

#define HideInInspector   HideInInspectorTag{}

Definition at line 54 of file ComponentRegistry.h.

ReadOnly

#define ReadOnly   ReadOnlyTag{}

Definition at line 66 of file ComponentRegistry.h.

Tooltip

#define Tooltip

(

x

)

TooltipTag{x}

Definition at line 63 of file ComponentRegistry.h.