diff --git a/README-RU.md b/README-RU.md index 5cf9ea4..8c91efe 100644 --- a/README-RU.md +++ b/README-RU.md @@ -35,7 +35,7 @@
-Реализация связи сущностей в виде графа, где дугами выступают связывающие сущности. +Реализация отношений сущностей в виде графа. Связывающие ребра графа представлены в виде сущностей, что позволяет создавать отношения вида многие ко многим, а с помощью компонентной композиции можно настраивать вид этих отношений. > [!WARNING] > Проект в стадии разработки. API может меняться. @@ -70,4 +70,59 @@ https://github.com/DCFApixels/DragonECS-Graphs.git
-# Инициализация +# Граф +Для начала нужно создать граф реализованный классом `EntityGraph`. Графу требуется 2 мира: обычный мир и мир для сущностей-связей. Пример создания `EntityGraph`: +```c# +// Обычный мир. +_world = new EcsDefaultWorld(); +// EcsGraphWorld специальный тип мира для сущностей-связей, +// но может использоваться любой другой тип мира. +_graphWorld = new EcsGraphWorld(); +// Создание EntityGraph связывающий эти два мира. +EntityGraph graph = _world.CreateGraph(_graphWorld); + +_pipeline = EcsPipeline.New() + // ... + // Далее миры и граф можно внедрить в системы. + .Inject(_world, _graphWorld, graph) + // ... + .Build() +``` +Можно использовать один мир для обычных сущностей и для сущностей-связей. +```c# +_world = new EcsDefaultWorld(); +// Создание EntityGraph завязанный на одном мире. +EntityGraph graph = _world.CreateGraph(); +``` + +# Сущность-связь + +Как и обычная сущность, но управляется и создается в `EntityGraph` и предназначена для данных об отношении двух сущностей. + +> Отношения имеют направление, поэтому чтобы разделять сущности, далее будет использованы понятия: начальная сущность(`Start Entity`) от нее исходит сущность-связъ(`Relation Entity`) к конечной сущности(`End Entity`). +``` +(Start Entity) ─── (Relation Entity) ──► (End Entity) +``` +Пример работы с связями: +```c# + // Получаем или создаем новую сущность-связь от сущности `startE` к `endE`. + // Сущность создается в мире _graph.GraphWorld и регистрируется в графе. + var relE = _graph.GetOrNewRelation(startE, endE); + + // Кроме создания и удаления, в остальном сущности-свящи - это обычные сущности. + ref var someCmp = ref _somePool.Add(relE); + + // Вернет true если была создана через EntityGraph.GetOrNewRelation(startE, endE) + // и false если через EcsWorld.NewEntity(). + bool isRelation = _graph.IsRelation(relE); + + // Взять сущность-связь для отношения в обратном направлении, от `endE` к `startE`. + _graph.GetOrNewInverseRelation(relE); + + // Удаляем сущность связь. + _graph.DelRelation(relE); +``` + +# Запрос + +