Repository navigation
feat(scene): keep linked Revit placements and split them into models - #242
Conversation
HierarchyParser no longer throws for a repeated element under another parent: the node is kept, marked NwcNode.IsLinkPlacement, and points at the first placement. NwcSceneReader starts a new SceneModel for each linked placement, uses the placement as the model root, preserves its geometry and SourceId, and gives its descendants the link model id. Update docs and the old throw-based tests; add parser and scene regressions with SceneDocument.Validate().
Код-ревью — feat(scene): keep linked Revit placements and split them into models (стек на #241)Вердикт: approve-with-comments Резюме ревьюеров
Подтверждённые замечания (4)1. [СРЕДНЯЯ] Квадратичная уникализация ключей и неограниченное число SceneModel на недоверенном входе — Для каждого узла IsLinkPlacement вызывается UniqueModelKey, который при каждом вызове заново строит HashSet из ключей всех уже созданных моделей, а при совпадении имён перебирает суффиксы #2, #3, ... Число link-моделей ничем не ограничено. До PR любой элемент в общем поддереве приводил к NotSupportedException, и это была единственная защита от размножения элементов через DAG; README прямо заявляет, что читатель ограничивает crafted-вход (8 388 608 узлов), а теперь все эти узлы могут стать моделями. Уточнение проверяющего: Уточнение: квадратичность есть всегда (перестройка HashSet на каждый link-узел, NwcSceneReader.cs:174), а дополнительный перебор суффиксов добавляется только при совпадающих именах узлов. Утверждение, что раньше «любой элемент в общем поддереве приводил к NotSupportedException», верно только для общего поддерева с X>0 под разными родителями. Остальные детали (отсутствие лимита на число link-моделей, рост SceneModel до миллионов при крупных DAG) соответствуют коду. Сценарий: Небольшой NWC: общий (back-referenced) узел S с листом X=1 (в таблице GUID одна запись, проверяется только X <= guids.Count) и 100 000 родителей, ссылающихся на S. HierarchyParser укладывается в лимит 2^23 узлов и помечает 99 999 повторов как IsLinkPlacement. NwcSceneReader.Read делает 99 999 вызовов UniqueModelKey: i-й вызов строит множество из i ключей и, при одинаковом имени листа, перебирает i суффиксов. Это порядка 10^10 операций и аллокаций строк, то есть чтение зависает на минуты и раздувает память SceneModel (до миллионов при большем числе ссылок). Тестов на большое число link-моделей нет. Исправление: Держать один HashSet ключей на весь ConvertInto, а не пересоздавать его, и счётчик суффиксов на базовое имя. Добавить явный лимит числа link-моделей (по аналогии с MaxExpandedNodes) и диагностику или исключение при превышении. Добавить тест на тысячи повторов одного имени. 2. [СРЕДНЯЯ] Модель создаётся на каждый повторный элемент, а не на каждую связанную модель — HierarchyParser помечает IsLinkPlacement любой узел с X, уже встречавшимся под другим родителем, а сканер создаёт SceneModel на каждый такой узел. Корня ссылки в иерархии нет, поэтому общее поддерево S (или скопированная иерархия) с N элементами порождает N моделей из одного элемента, а не одну модель ссылки. Вложенные элементы (X>0 внутри элемента) становятся вложенными моделями. Группы вроде S' остаются в основной модели без детей: их дети ушли в другие модели с ParentId=null. Заявление PR «каждое размещение связанной модели становится отдельной SceneModel» этим кодом не выполняется. Уточнение проверяющего: Для общего поддерева S из N элементов, размещённого под двумя родителями, NwcSceneReader создаёт N моделей по одному корню-элементу (ParentId=null) вместо одной модели на размещение. Группа S под вторым родителем остаётся пустой в основной модели. Причина в том, что HierarchyParser помечает IsLinkPlacement каждый повторный X и не отмечает корень повторно размещённого поддерева. Реальную частоту такого паттерна в корпусе по коду определить нельзя, а тесты покрывают только один лист-элемент. Сценарий: Иерархия: A -> S -> [E1(X=1), E2(X=2), ... E500(X=500)] и B -> S (тот же общий узел, это именно случай теста Open_ElementInASharedSubtree). Для B все 500 элементов оказываются повторами и получают IsLinkPlacement. В результате SceneDocument содержит 1 + 500 моделей, каждая с одним элементом (ключи по именам элементов, например «Basic Wall#2», «Basic Wall#3»), а группа S под B остаётся пустой в модели 1. Сценовый тест Read_LinkedPlacement_BecomesItsOwnSceneModel покрывает один лист-элемент и не показывает этого. Исправление: Определять границу ссылки детерминированно (корень повторно размещённого поддерева, а не каждый повторный X) и создавать модель один раз на такой корень. Либо оставить NotSupportedException для случаев, где корень ссылки не определяется однозначно. Добавить тест с поддеревом из нескольких элементов под двумя родителями. 3. [СРЕДНЯЯ] UniqueModelKey на каждую ссылку заново строит HashSet всех ключей: квадратичное время на недоверенном входе — Раньше ключи собирались в общий usedKeys за O(1) на документ. Теперь UniqueModelKey создаёт new HashSet по всем scene.Models при каждом вызове, а он вызывается на каждый IsLinkPlacement (строка 284). Цикл суффиксов #2, #3, … каждый раз начинается заново. Число размещений определяется входным NWC (см. предыдущую находку: по одному на повторный элемент), а лимит чтения — 8,388,608 узлов. Уточнение проверяющего: Находка верна по механизму: UniqueModelKey пересоздаёт HashSet всех ключей моделей на каждое link-размещение, поэтому чтение сцены с M размещениями стоит O(M^2), а при повторяющихся именах цикл суффиксов добавляет ещё O(k) на вызов. На обычных файлах (единицы или десятки связей) это незаметно. Проблема проявляется только на специально собранных или патологических NWC с десятками тысяч повторных размещений, поэтому severity medium (DoS-замедление), а не high. Тестов на много размещений и на повторяющиеся имена нет. Сценарий: Файл с общим поддеревом на 200 000 элементов, названных одинаково (например, «Basic Wall»), даёт 200 000 моделей. Каждый вызов строит множество до 200 000 строк, а цикл подбирает суффикс до k попыток с выделением строки на каждой. Это порядка 10^10 операций: NwcSceneReader.Read практически зависает и выделяет сотни тысяч SceneModel. Тестов на много ссылок или на повторяющиеся имена нет. Исправление: Хранить HashSet ключей и словарь «имя → следующий суффикс» на время ConvertInto (или на сцену), а не пересоздавать их на каждый вызов. Добавить тест на несколько размещений с одним именем и проверку ключей #2, #3. 4. [НИЗКАЯ] Заявленный учёт геометрии ссылки не проверяется тестом и неполон для потомков размещения — PR заявляет, что «геометрия ссылки учитывается». Тест Read_LinkedPlacement_BecomesItsOwnSceneModel не проверяет ни ElementCount, ни ElementsWithGeometry: если удалить placed.Add(node), он всё равно пройдёт, потому что инстансы добавляются независимо от placed. Исправление покрывает только случай, когда меш висит на самом узле-размещении. Потомки размещения получают Element = first (HierarchyParser.cs:162 при X == 0), и для меша на потомке в placed попадает first, а не узел-размещение. В реальных Revit-файлах меши лежат на листьях внутри элемента (инвариант leaf-in-element в RealFileInvariantTests), а тест кладёт меш прямо на узел. Уточнение проверяющего: Исправление Сценарий: Элемент E (first) имеет дочерний лист C1 с мешем, размещение L (X равен X у E) имеет дочерний лист C2 с мешем. После AddGeometry placed = {E, C1, C2}, L в нём нет. В обходе elementCount увеличивается для E и L, а elementsWithGeometry — только для E. Результат ElementsWithGeometry = 1 вместо 2, при том что в модели ссылки есть инстанс C2. Если у E геометрии нет, а есть только у L, E ошибочно считается имеющим геометрию. Тест такого не ловит: он не утверждает счётчики и не имеет потомков у ссылки. Исправление: Отмечать как размещённое ближайшее размещение-предок меша (с учётом IsLinkPlacement), а не только node.Element. В тест добавить Assert на ElementCount/ElementsWithGeometry, потомка-лист с мешем под ссылкой и проверку, что инстанс принадлежит элементу модели 2. |
Share one key set and suffix map per conversion, cap linked models, and create one model per top-level link placement so repeat elements inside a linked subtree stay in that model.
HierarchyParser now marks the highest group below a linking element (or the element itself) as IsLinkRoot; NwcSceneReader creates one model for that root and reuses it for every repeated element inside. Cover a shared subtree with three elements and a single linked group.
…tal and document the shared-subtree model root
Partially fixes #182. Stacked on #241 (
fix/scene-multi-model). This adds linked Revit model handling.What changed
HierarchyParserno longer throws when one element index appears under different parents or in a shared subtree. It keeps the placement, pointsElementat the first placement, and marks the node with the newNwcNode.IsLinkPlacement.NwcSceneReadercreates a separateSceneModelfor every linked placement:Kind = Model,ParentId = null);SourceIdare preserved, so the same source element can appear once per model;scene.Models.Count + 1and use unique keys from the node name (Link_Nfallback);SceneDocument.Validate()passes for the synthetic link scene.node.Element, so link geometry is counted and attached to the link model.NotSupportedException; added parser and scene regressions..nwdpartition trees remain the unsupported case.Files
src/NwcIO/Model/NwcNode.cssrc/NwcIO/Internal/Parsing/HierarchyParser.cssrc/NwcIO/NwcDocument.cssrc/NwcIO.Scene/NwcSceneReader.cssrc/NwcIO.Scene/NwcSceneReader.Geometry.cstests/NwcIO.Tests/HierarchyParserTests.cstests/NwcIO.Tests/ElementIdentityTests.cstests/NwcIO.Scene.Tests/NwcSceneReaderTests.csdocs/scene.md,docs/format-notes.md,docs/public-api.md,docs/getting-started.md,CHANGELOG.mdTests
dotnet build NwcIO.slnx -c Release— success, 0 warnings, 0 errors.dotnet test NwcIO.slnx -c Release --no-build— full suite passes (exit 0).ElementIdentityTests: 24 passed.Read_DuplicateElementUnderDifferentParents_KeepsBothAsLinkedPlacement.Read_LinkedPlacement_BecomesItsOwnSceneModel, including two models, two instances, distinct model ids, preservedSourceId, andSceneDocument.Validate().Remaining limitations
LevelId = nullrather than a level from the main model.SceneModels..nwdpartition trees remain unsupported; the saved-view FOV/height and far distance remain undecoded.