A fast 2D and 3D game engine — TypeScript SDK, C++/WebAssembly core, visual editor. Ship one project to web, desktop, WeChat MiniGames, playable ads, and native Android / iOS.
TypeScript 2d-game-engine3d3d-game-engineandroidcppecsgame-editorgame-enginegamedeviostypescriptwebassemblywebglwebgpuwechat-minigame
// SPDX-License-Identifier: Apache-2.0
// SPDX-FileCopyrightText: Copyright (c) 2024-present ESEngine Team
/**
* @file Hierarchy.hpp
* @brief Hierarchy components for parent-child relationships
* @details Provides Parent and Children components for building scene graphs.
*
* @author ESEngine Team
* @date 2026
*
* @copyright Copyright (c) 2026 ESEngine Team
* Licensed under the Apache License, Version 2.0.
*/
#pragma once
// =============================================================================
// Includes
// =============================================================================
#include "../../core/Types.hpp"
#include "../../core/Reflection.hpp"
#include <vector>
namespace esengine::ecs {
// =============================================================================
// Parent Component
// =============================================================================
/**
* @brief Parent reference component
*
* @details Links an entity to its parent in the scene hierarchy.
* Used together with Children component to form a tree structure.
*
* @code
* Entity parent = registry.create();
* Entity child = registry.create();
*
* registry.emplace<Parent>(child, parent);
* registry.get<Children>(parent).entities.push_back(child);
* @endcode
*/
ES_COMPONENT(stability=public)
struct Parent {
/** @brief Parent entity ID */
ES_PROPERTY(entity_ref)
Entity entity = INVALID_ENTITY;
Parent() = default;
explicit Parent(Entity e) : entity(e) {}
};
// =============================================================================
// Children Component
// =============================================================================
/**
* @brief Children list component
*
* @details Stores references to all child entities. Maintained in sync
* with Parent components by the hierarchy management system.
*/
ES_COMPONENT(stability=public)
struct Children {
/** @brief List of child entity IDs */
ES_PROPERTY(entity_ref)
std::vector<Entity> entities;
Children() = default;
/**
* @brief Check if entity has any children
* @return true if has children
*/
[[nodiscard]] bool empty() const { return entities.empty(); }
/**
* @brief Get number of children
* @return Child count
*/
[[nodiscard]] usize count() const { return entities.size(); }
/// Compared member by member: what the change audit checks a write of this component against (Registry::auditChanges).
bool operator==(const Children&) const = default;
};
// =============================================================================
// Hierarchy Depth Component
// =============================================================================
/**
* @brief Cached hierarchy depth for sorting
*
* @details Used by TransformSystem to process transforms in correct order
* (parents before children). Updated when hierarchy changes.
*/
struct HierarchyDepth {
/** @brief Depth level (0 = root, 1 = first level child, etc.) */
u32 depth = 0;
HierarchyDepth() = default;
explicit HierarchyDepth(u32 d) : depth(d) {}
};
} // namespace esengine::ecs