Relationship.hpp

Go to the documentation of this file.

/**************************************************************************
 * Relationship v0.0.0
 *
 * Relationship is a software package, part of the Engine².
 *
 * This file is part of the EngineSquared project that is under GPL-3.0 License.
 * Copyright © 2024 by @EngineSquared, All rights reserved.
 *
 * EngineSquared is a free software: you can redistribute it and/or modify
 * it under the terms of the GPL-3.0 License as published by the
 * Free Software Foundation. See the GPL-3.0 License for more details.
 *
 * @file Relationship.hpp
 * @brief component to manage link between childs and parent
 *
 * This file contains the declaration of the Relationship component.
 *
 * @author @miou-zora
 * @version 0.0.0
 * @date 18-02-2024
 **************************************************************************/
 
#pragma once
 
#include "entity/Entity.hpp"
 
namespace Relationship::Component {
struct Relationship {
    // @brief number of children of the entity
    std::size_t children = 0;
    // @brief first child of the entity
    std::optional<Engine::Entity> first = std::nullopt;
    // @brief previous sibling of the entity
    std::optional<Engine::Entity> prev = std::nullopt;
    // @brief next sibling of the entity
    std::optional<Engine::Entity> next = std::nullopt;
    // @brief parent of the entity
    std::optional<Engine::Entity> parent = std::nullopt;
};
} // namespace Relationship::Component