mirror of
https://git.code.sf.net/p/quake/quakeforge
synced 2025-02-24 20:51:35 +00:00
35eec0b2e5
The main goal of this change was to make it easier to tell when a hierarchy has been deleted, but as a side benefit, it got rid of the use of PR_RESMAP. Also, it's easy to track the number of hierarchies. Unfortunately, it showed how brittle the component side of the ECS is (scene and canvas registries assumed their components were the first (no long the case), thus the sweeping changes). Centerprint doesn't work (but it hasn't for a while).
95 lines
2.7 KiB
C
95 lines
2.7 KiB
C
/*
|
|
hierarchy.h
|
|
|
|
ECS Hierarchy management
|
|
|
|
Copyright (C) 2021 Bill Currie <bill@taniwha.org>
|
|
|
|
Author: Bill Currie <bill@taniwha.org>
|
|
Date: 2021/02/26
|
|
|
|
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 2
|
|
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, write to:
|
|
|
|
Free Software Foundation, Inc.
|
|
59 Temple Place - Suite 330
|
|
Boston, MA 02111-1307, USA
|
|
|
|
*/
|
|
|
|
#ifndef __QF_ecs_hierarchy_h
|
|
#define __QF_ecs_hierarchy_h
|
|
|
|
#include "QF/qtypes.h"
|
|
|
|
/** \defgroup entity Hierarchy management
|
|
\ingroup utils
|
|
*/
|
|
///@{
|
|
|
|
/** Descriptors for components attached to every entity in the hierarchy.
|
|
*/
|
|
typedef struct hierarchy_type_s {
|
|
uint32_t num_components;
|
|
const struct component_s *components;
|
|
} hierarchy_type_t;
|
|
|
|
typedef struct hierref_s {
|
|
uint32_t id; ///< entity holding hierarchy object
|
|
uint32_t index; ///< index in hierarchy
|
|
} hierref_t;
|
|
|
|
typedef struct hierarchy_s {
|
|
uint32_t num_objects;
|
|
uint32_t max_objects;
|
|
uint32_t *ent;
|
|
uint32_t *childCount;
|
|
uint32_t *childIndex;
|
|
uint32_t *parentIndex;
|
|
uint32_t *nextIndex;
|
|
uint32_t *lastIndex;
|
|
const hierarchy_type_t *type;
|
|
void **components;
|
|
struct ecs_registry_s *reg;
|
|
uint32_t href_comp;
|
|
bool tree_mode; // use for fast building
|
|
} hierarchy_t;
|
|
|
|
#define nullindex (~0u)
|
|
#define nullhref (hierref_t) { .id = nullent, .index = nullindex }
|
|
|
|
void Hierarchy_Create (hierarchy_t *hierarchy);
|
|
void Hierarchy_Destroy (hierarchy_t *hierarchy);
|
|
|
|
uint32_t Hierarchy_New (struct ecs_registry_s *reg, uint32_t href_comp,
|
|
const hierarchy_type_t *type, bool createRoot);
|
|
void Hierarchy_Delete (uint32_t hierarchy, struct ecs_registry_s *reg);
|
|
|
|
void Hierarchy_Reserve (hierarchy_t *hierarchy, uint32_t count);
|
|
uint32_t Hierarchy_Copy (struct ecs_registry_s *reg, uint32_t href_comp,
|
|
const hierarchy_t *src);
|
|
void Hierarchy_SetTreeMode (hierarchy_t *hierarchy, bool tree_mode);
|
|
|
|
hierref_t Hierarchy_InsertHierarchy (hierref_t dref, hierref_t sref,
|
|
struct ecs_registry_s *reg);
|
|
void Hierarchy_RemoveHierarchy (hierarchy_t *hierarchy, uint32_t index,
|
|
int delEntities);
|
|
|
|
hierref_t Hierarchy_SetParent (hierref_t dref, hierref_t sref,
|
|
struct ecs_registry_s *reg);
|
|
void Hierref_DestroyComponent (void *href);
|
|
|
|
///@}
|
|
|
|
#endif//__QF_ecs_hierarchy_h
|