Struct SpatialTree 

pub struct SpatialTree { /* private fields */ }

The containment tree of one model.

Implementations

impl SpatialTree

pub fn build(model: &Model) -> Self

Build the containment tree of model.

One pass over the aggregation and containment relationships. Cost is linear in the number of relationship entities, not in model size, because relationships are found through the type index.

impl SpatialTree

pub fn node(&self, id: EntityId) -> Option<&SpatialNode>

The node describing id, if it is a spatial container.

pub fn roots(&self) -> &[EntityId]

Containers with no parent, most-general kind first.

A conformant file yields exactly one root, the IfcProject. More than one means the file omits an aggregation relationship somewhere.

pub fn containers(&self) -> impl Iterator<Item = &SpatialNode>

Every spatial container in the model, ordered by entity id.

pub fn of_kind( &self, kind: SpatialKind, ) -> impl Iterator<Item = &SpatialNode> + '_

Containers of a given kind, ordered by entity id.

pub fn elements_of(&self, container: EntityId) -> &[EntityId]

Elements placed directly in container.

Direct only: an element in a space inside a storey is not returned for the storey. Use elements_recursive for the transitive set.

pub fn elements_recursive(&self, container: EntityId) -> Vec<EntityId>

Every element in container or any container beneath it.

Breadth-first, so a container’s own elements precede those of its children. Bounded by the tree’s depth, which is finite because each node holds at most one parent.

pub fn ancestors(&self, id: EntityId) -> Vec<EntityId>

The chain of containers above id, nearest first.

Empty for a root. Terminates even if the file contains a containment cycle, because the walk stops at the first repeated entity.

pub fn container_of(&self, element: EntityId) -> Option<EntityId>

The container holding element, if any relationship places it.

Answers the question a drawing or take-off actually asks: which storey is this wall on? Backed by a map built during assembly, so this is a lookup rather than a scan over every container.

pub fn dangling(&self) -> &[(EntityId, EntityId)]

Relationship/target pairs naming an entity the model does not contain.

pub fn orphans(&self) -> &[EntityId]

Containers that no relationship places under a parent, excluding the most-general root.

A conformant file has none: every site is aggregated into the project, every building into a site. Entries here mean the file omits an aggregation relationship, which a viewer would show as a detached branch.

Trait Implementations

impl Clone for SpatialTree

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for SpatialTree

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for SpatialTree

fn default() -> Self

Returns the “default value” for a type.