Struct SceneSpatialTree 

pub struct SceneSpatialTree {
    spatial_nodes: Vec<SceneSpatialNode>,
    root_reference_frame_index: SpatialNodeIndex,
    updates: SpatialTreeUpdates,
}

The representation of the spatial tree during scene building, which is mostly write-only, with a small number of queries for snapping, picture cache building.

Each SceneBuilder::build call calls reset() to start the tree fresh, then emits a complete list of SpatialTreeUpdate::Insert ops that the frame-side SpatialTree::apply_updates consumes verbatim.

Fields

spatial_nodes: Vec<SceneSpatialNode>

Nodes which determine the positions (offsets and transforms) for primitives and clips.

root_reference_frame_index: SpatialNodeIndex

updates: SpatialTreeUpdates

Implementations

impl SceneSpatialTree

pub fn new() -> Self

pub fn reset(&mut self)

Reset the tree to an empty state with just the root reference frame. Called at the start of each scene build.

fn add_root_reference_frame(&mut self)

pub fn is_root_coord_system(&self, index: SpatialNodeIndex) -> bool

pub fn end_frame_and_get_pending_updates(&mut self) -> SpatialTreeUpdates

Complete building this scene, return the updates to apply to the frame spatial tree

pub fn is_ancestor( &self, maybe_parent: SpatialNodeIndex, maybe_child: SpatialNodeIndex, ) -> bool

Check if a given spatial node is an ancestor of another spatial node.

pub fn find_scroll_root( &self, spatial_node_index: SpatialNodeIndex, allow_sticky_frames: bool, ) -> SpatialNodeIndex

Find the spatial node that is the scroll root for a given spatial node. A scroll root is the first spatial node when found travelling up the spatial node tree that is an explicit scroll frame.

pub fn root_reference_frame_index(&self) -> SpatialNodeIndex

The root reference frame, which is the true root of the SpatialTree.

fn add_spatial_node(&mut self, node: SceneSpatialNode) -> SpatialNodeIndex

pub fn add_reference_frame( &mut self, parent_index: SpatialNodeIndex, transform_style: TransformStyle, source_transform: PropertyBinding<LayoutTransform>, kind: ReferenceFrameKind, origin_in_parent_reference_frame: LayoutVector2D, pipeline_id: PipelineId, is_pipeline_root: bool, ) -> SpatialNodeIndex

pub fn add_scroll_frame( &mut self, parent_index: SpatialNodeIndex, external_id: ExternalScrollId, pipeline_id: PipelineId, frame_rect: &LayoutRect, content_size: &LayoutSize, frame_kind: ScrollFrameKind, external_scroll_offset: LayoutVector2D, scroll_offset_generation: APZScrollGeneration, has_scroll_linked_effect: HasScrollLinkedEffect, ) -> SpatialNodeIndex

pub fn add_sticky_frame( &mut self, parent_index: SpatialNodeIndex, sticky_frame_info: StickyFrameInfo, pipeline_id: PipelineId, ) -> SpatialNodeIndex

Trait Implementations

impl Serialize for SceneSpatialTree

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl SpatialNodeContainer for SceneSpatialTree

fn get_node_info(&self, index: SpatialNodeIndex) -> SpatialNodeInfo<'_>

Get the common information for a given spatial node

fn get_snapping_info( &self, parent_index: Option<SpatialNodeIndex>, ) -> Option<ScaleOffset>