i_component.hpp

Go to the documentation of this file.

// i_component.hpp
/*
  neogfx C++ GUI Library
  Copyright (c) 2018 Leigh Johnston.  All Rights Reserved.
  
  This program is free software: you can redistribute it and / or modify
  it under the terms of the GNU General Public License as published by
  the Free Software Foundation, either version 3 of the License, or
  (at your option) any later version.
  
  This program is distributed in the hope that it will be useful,
  but WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  GNU General Public License for more details.
  
  You should have received a copy of the GNU General Public License
  along with this program.  If not, see <http://www.gnu.org/licenses/>.
*/
#pragma once

#include <neogfx/neogfx.hpp>
#include <neolib/string.hpp>
#include <neogfx/game/ecs_ids.hpp>
#include <neogfx/game/i_component_data.hpp>

namespace neogfx::game
{
    class i_ecs;

    class i_component_base
    {
    public:
        virtual ~i_component_base() = default;
    public:
        virtual game::i_ecs& ecs() const = 0;
        virtual const component_id& id() const = 0;
    public:
        virtual bool is_data_optional() const = 0;
        virtual const i_string& name() const = 0;
        virtual uint32_t field_count() const = 0;
        virtual component_data_field_type field_type(uint32_t aFieldIndex) const = 0;
        virtual neolib::uuid field_type_id(uint32_t aFieldIndex) const = 0;
        virtual const i_string& field_name(uint32_t aFieldIndex) const = 0;
    };

    class i_shared_component : public i_component_base
    {
    public:
        virtual void* populate(const std::string& aName, const void* aComponentData, std::size_t aComponentDataSize) = 0;
        template <typename ComponentData>
        void* populate(const std::string& aName, ComponentData&& aComponentData)
        {
            return populate(aName, &std::forward<ComponentData>(aComponentData), sizeof(ComponentData));
        }
    };

    class i_component : public i_component_base
    {
    public:
        virtual bool has_entity_record(entity_id aEntity) const = 0;
        virtual void destroy_entity_record(entity_id aEntity) = 0;
    public:
        virtual void* populate(entity_id aEntity, const void* aComponentData, std::size_t aComponentDataSize) = 0;
        template <typename ComponentData>
        void* populate(entity_id aEntity, ComponentData&& aComponentData)
        {
            return populate(aEntity, &std::forward<ComponentData>(aComponentData), sizeof(ComponentData));
        }
    };

    template <typename ComponentData>
    class static_component;

    template <typename ComponentData>
    class static_shared_component;
}