Struct conrod::graph::Graph

pub struct Graph { /* fields omitted */ }

Stores the dynamic state of a UI tree of Widgets.

Methods

impl Graph

fn new() -> Self

A new empty Graph.

fn with_node_capacity(n_nodes: usize) -> Self

A new Graph with the given node capacity.

We know that there can be no more than three parents per node as the public API enforces a maximum of one Depth, Position and Graphic parent each. Thus, we can assume an edge capacity of exactly three times the given node capacity.

fn clear(&mut self)

Removes all Nodes and Edges from the Graph.

fn node_count(&self) -> usize

The total number of Nodes in the Graph.

fn widget_count(&self) -> usize

The total number of Node::Widgets in the Graph.

fn edge_count(&self) -> usize

The total number of Edges in the Graph.

fn node_capacity(&self) -> usize

The current capacity for the Graph's internal node Vec.

fn add_placeholder(&mut self) -> Id

Add a new placeholder node and return it's widget::Id into the Graph.

This method is used by the widget::set_widget function when some internal widget does not yet have it's own widget::Id.

fn node(&self, idx: Id) -> Option<&Node>

Borrow the node at the given widget::Id if there is one.

fn node_mut(&mut self, idx: Id) -> Option<&mut Node>

Mutably borrow the node at the given widget::Id if there is one.

fn edge(&self, idx: EdgeIndex) -> Option<&Edge>

Borrow the edge at the given EdgeIndex if there is one.

fn edge_mut(&mut self, idx: EdgeIndex) -> Option<&mut Edge>

Mutably borrow the edge at the given EdgeIndex if there is one.

fn edge_endpoints(&self, idx: EdgeIndex) -> Option<(Id, Id)>

Return the parent and child nodes on either end of the Edge at the given index.

fn widget(&self, idx: Id) -> Option<&Container>

If there is a Widget for the given index, return a reference to it.

fn widget_mut(&mut self, idx: Id) -> Option<&mut Container>

If there is a Widget for the given Id, return a mutable reference to it.

fn parents(&self, child: Id) -> Parents

A Walker type that may be used to step through the parents of the given child node.

fn recursive_walk<F>(&self, start: Id, recursive_fn: F) -> RecursiveWalk<F> where
    F: FnMut(&Self, Id) -> Option<(EdgeIndex, Id)>, 

A Walker type that recursively walks the Graph using the given recursive_fn.

Panics If the given start index does not exist within the Graph.

fn edge_parent(&self, idx: Id, edge: Edge) -> Option<Id>

If the widget at the given index has some parent along an Edge of the given variant, return an index to it.

fn depth_parent(&self, idx: Id) -> Option<Id>

Return the index of the parent along the given widget's Depth Edge.

fn x_position_parent(&self, idx: Id) -> Option<Id>

Return the index of the parent along the given widget's Position Edge.

fn y_position_parent(&self, idx: Id) -> Option<Id>

Return the index of the parent along the given widget's Position Edge.

fn position_parents(&self, idx: Id) -> PositionParents

Produces an iterator yielding the parents along both the X and Y Position Edges respectively.

fn graphic_parent(&self, idx: Id) -> Option<Id>

Return the index of the parent along the given widget's Graphic Edge.

fn depth_parent_recursion(
    &self,
    idx: Id
) -> RecursiveWalk<fn(_: &Graph, _: Id) -> Option<IndexPair>>

A Walker type that recursively walks Depth parents starting from the given node.

fn x_position_parent_recursion(
    &self,
    idx: Id
) -> RecursiveWalk<fn(_: &Graph, _: Id) -> Option<IndexPair>>

A Walker type that recursively walks X Position parents starting from the given node.

fn y_position_parent_recursion(
    &self,
    idx: Id
) -> RecursiveWalk<fn(_: &Graph, _: Id) -> Option<IndexPair>>

A Walker type that recursively walks Y Position parents starting from the given node.

fn graphic_parent_recursion(
    &self,
    idx: Id
) -> RecursiveWalk<fn(_: &Graph, _: Id) -> Option<IndexPair>>

A Walker type that recursively walks Graphic parents starting from the given node.

fn scrollable_y_parent_recursion(
    &self,
    idx: Id
) -> RecursiveWalk<fn(_: &Graph, _: Id) -> Option<IndexPair>>

A Walker type that recursively walks Depth parents that are scrollable along the y axis for the given node.

fn scrollable_x_parent_recursion(
    &self,
    idx: Id
) -> RecursiveWalk<fn(_: &Graph, _: Id) -> Option<IndexPair>>

A Walker type that recursively walks Depth parents that are scrollable along the x axis for the given node.

fn children(&self, parent: Id) -> Children

A Walker type that may be used to step through the children of the given parent node.

fn depth_children(&self, idx: Id) -> DepthChildren

For walking the Depth children of the given parent node.

fn x_position_children(&self, idx: Id) -> XPositionChildren

For walking the Position(X) children of the given parent node.

fn y_position_children(&self, idx: Id) -> YPositionChildren

For walking the Position(Y) children of the given parent node.

fn position_children(&self, idx: Id) -> PositionChildren

For walking the Position children of the given parent node.

This first walks the Axis::X children, before walking the Axis::Y children.

fn graphic_children(&self, idx: Id) -> GraphicChildren

For walking the Graphic children of the given parent node.

fn does_edge_exist<F>(&self, parent: Id, child: Id, is_edge: F) -> bool where
    F: Fn(Edge) -> bool, 

Does the given edge type exist between the nodes parent -> child.

Returns false if either of the given node indices do not exist.

fn does_depth_edge_exist(&self, parent: Id, child: Id) -> bool

Does a Edge::Depth exist between the nodes parent -> child.

Returns false if either of the given node indices do not exist.

fn does_position_edge_exist(&self, parent: Id, child: Id) -> bool

Does a Edge::Position exist between the nodes parent -> child.

Returns false if either of the given node indices do not exist.

fn does_graphic_edge_exist(&self, parent: Id, child: Id) -> bool

Does a Edge::Graphic exist between the nodes parent -> child.

Returns false if either of the given node indices do not exist.

fn does_recursive_edge_exist<F>(
    &self,
    parent: Id,
    child: Id,
    is_edge: F
) -> bool where
    F: Fn(Edge) -> bool, 

Are the given parent and child nodes connected by a single chain of edges of the given kind?

i.e. parent -> x -> y -> child.

Returns false if either of the given node indices do not exist.

fn does_recursive_depth_edge_exist(&self, parent: Id, child: Id) -> bool

Are the given parent and child nodes connected by a single chain of Depth edges?

i.e. parent -> x -> y -> child.

Returns false if either of the given node indices do not exist.

fn does_recursive_graphic_edge_exist(&self, parent: Id, child: Id) -> bool

Are the given parent and child nodes connected by a single chain of Graphic edges?

i.e. parent -> x -> y -> child.

Returns false if either of the given node indices do not exist.

fn pre_update_cache(
    &mut self,
    root: Id,
    widget: PreUpdateCache,
    instantiation_order_idx: usize
)

Cache some PreUpdateCache widget data into the graph.

This is called (via the ui module) from within the widget::set_widget function prior to the Widget::update method being called.

This is done so that if this Widget were to internally set some other Widgets within its own update method, this Widgets positioning and dimension data already exists within the Graph for reference.

fn post_update_cache<W>(&mut self, widget: PostUpdateCache<W>) where
    W: Widget,
    W::State: 'static,
    W::Style: 'static, 

Cache some PostUpdateCache widget data into the graph.

This is called (via the ui module) from within the widget::set_widget function after the Widget::update method is called and some new state is returned.

Trait Implementations

impl Debug for Graph

fn fmt(&self, __arg_0: &mut Formatter) -> Result

Formats the value using the given formatter.

impl Index<Id> for Graph

type Output = Node

The returned type after indexing.

fn index<'a>(&'a self, id: Id) -> &'a Node

Performs the indexing (container[index]) operation.

impl IndexMut<Id> for Graph

fn index_mut<'a>(&'a mut self, id: Id) -> &'a mut Node

Performs the mutable indexing (container[index]) operation.

impl Index<EdgeIndex> for Graph

type Output = Edge

The returned type after indexing.

fn index<'a>(&'a self, idx: EdgeIndex) -> &'a Edge

Performs the indexing (container[index]) operation.

impl IndexMut<EdgeIndex> for Graph

fn index_mut<'a>(&'a mut self, idx: EdgeIndex) -> &'a mut Edge

Performs the mutable indexing (container[index]) operation.