Struct re_space_view_spatial::spatial_topology::SubSpace

pub struct SubSpace {
    pub origin: EntityPath,
    pub entities: IntSet<EntityPath>,
    pub child_spaces: IntSet<EntityPath>,
    pub parent_space: EntityPathHash,
    pub connection_to_parent: SubSpaceConnectionFlags,
    pub heuristic_hints: IntMap<EntityPath, HeuristicHints>,
}

Spatial subspace within we typically expect a homogeneous dimensionality without any projections & disconnects.

Subspaces are separated by projections or explicit disconnects.

A subspace may contain internal transforms, but any such transforms must be invertible such that all data can be represented regardless of choice of origin.

Within the tree of all subspaces, every entity is contained in exactly one subspace. The subtree at (and including) the origin minus the subtrees of all child spaces are considered to be contained in a subspace.

Fields

origin: EntityPath

The transform root of this subspace.

This is also used to uniquely identify the space.

entities: IntSet<EntityPath>

All entities that were logged at any point in time and are part of this subspace.

Contains the origin entity as well, unless the origin is the EntityPath::root() and nothing was logged to it directly.

Note that we this is merely here to speed up queries. Instead, we could check if an entity is equal to or a descendent of the origin and not equal or descendent of any child space. The problem with that is that it’s common for a 3D space to have many 2D spaces as children, which would make this an expensive query.

child_spaces: IntSet<EntityPath>

Origin paths of child spaces.

This implies that there is a either an explicit disconnect or a projection at the origin of the child space. How it is connected is implied by connection_to_parent in the child space.

Any path in child_spaces is not contained in entities. This implies that the camera itself is not part of its 3D space even when it may still have a 3D transform.

parent_space: EntityPathHash

Origin of the parent space.

The root space has EntityPathHash::NONE as parent.

connection_to_parent: SubSpaceConnectionFlags

The connection to the parent space.

Note that since flags are derived from the presence of components at the origin, the root space still tracks this information.

heuristic_hints: IntMap<EntityPath, HeuristicHints>

Entities in this space that qualify for one or more heuristic hints.

Implementations

impl SubSpace

pub fn supports_3d_content(&self) -> bool

Whether 3D content in this subspace can be displayed.

pub fn supports_2d_content(&self) -> bool

Whether 2D content in this subspace can be displayed.

Trait Implementations

impl Debug for SubSpace

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

Formats the value using the given formatter.