Struct kiss3d_conrod::widget::graph::Graph

pub struct Graph<'a, N, E> where
    N: Iterator,
    N::Item: NodeId,
    E: Iterator<Item = (NodeSocket<N::Item>, NodeSocket<N::Item>)>,  {
    pub common: CommonBuilder,
    pub style: Style,
    pub nodes: N,
    pub edges: E,
    pub layout: &'a Layout<N::Item>,
}

A widget used for visualising and manipulating Graph types.

Fields

common: CommonBuilder

Data necessary and common for all widget builder types.

style: Style

Unique styling for the Graph.

nodes: N

All nodes within the graph that the widget is to represent.

edges: E

All edges within the graph.

layout: &'a Layout<N::Item>

The position of each node within the graph.

Methods

impl<'a, N, E> Graph<'a, N, E> where
    N: Iterator,
    N::Item: NodeId,
    E: Iterator<Item = (NodeSocket<N::Item>, NodeSocket<N::Item>)>, 

pub fn new<NI, EI>(nodes: NI, edges: EI, layout: &'a Layout<NI::Item>) -> Self where
    NI: IntoIterator<IntoIter = N, Item = N::Item>,
    EI: IntoIterator<IntoIter = E, Item = (NodeSocket<N::Item>, NodeSocket<N::Item>)>, 

Begin building a new Graph widget.

pub fn background_color(self, color: Color) -> Self

Color the Graph's rectangular area with the given color.

Trait Implementations

impl<'a, N, E> Common for Graph<'a, N, E> where
    N: Iterator,
    N::Item: NodeId,
    E: Iterator<Item = (NodeSocket<N::Item>, NodeSocket<N::Item>)>, 

fn common(&self) -> &CommonBuilder

Borrows the CommonBuilder field.

fn common_mut(&mut self) -> &mut CommonBuilder

Mutably borrows the CommonBuilder field.

impl<'a, N, E> Widget for Graph<'a, N, E> where
    N: Iterator,
    N::Item: NodeId,
    E: Iterator<Item = (NodeSocket<N::Item>, NodeSocket<N::Item>)>, 

type State = State<N::Item>

State to be stored within the Uis widget cache.

type Style = Style

Every widget is required to have its own associated Style type. This type is intended to contain high-level styling information for the widget that can be optionally specified by a user of the widget.

type Event = SessionEvents<N::Item>

The type of event yielded by the widget, returned via the Widget::set function.

fn init_state(&self, id_gen: Generator) -> Self::State

Return the initial State of the Widget.

fn style(&self) -> Self::Style

Return the styling of the widget.

fn update(self, args: UpdateArgs<Self>) -> Self::Event

Update our Widget's unique Widget::State via the State wrapper type (the state field within the UpdateArgs).

fn default_x_position(&self, ui: &Ui) -> Position

The default Position for the widget along the x axis.

fn default_y_position(&self, ui: &Ui) -> Position

The default Position for the widget along the y axis.

fn default_x_dimension(&self, ui: &Ui) -> Dimension

The default width for the Widget.

fn default_y_dimension(&self, ui: &Ui) -> Dimension

The default height of the widget.

fn drag_area(
    &self,
    _dim: Dimensions,
    _style: &Self::Style,
    _theme: &Theme
) -> Option<Rect>

If the widget is draggable, implement this method and return the position and dimensions of the draggable space. The position should be relative to the center of the widget.

fn kid_area(&self, args: KidAreaArgs<Self>) -> KidArea

The area on which child widgets will be placed when using the Place Position methods.

fn is_over(&self) -> IsOverFn

Returns either of the following:

fn parent(self, parent_id: Id) -> Self

Set the parent widget for this Widget by passing the WidgetId of the parent.

fn no_parent(self) -> Self

Specify that this widget has no parent widgets.

fn place_on_kid_area(self, b: bool) -> Self

Set whether or not the Widget should be placed on the kid_area.

fn graphics_for(self, id: Id) -> Self

Indicates that the Widget is used as a non-interactive graphical element for some other widget.

fn floating(self, is_floating: bool) -> Self

Set whether or not the widget is floating (the default is false). A typical example of a floating widget would be a pop-up or alert window.

fn crop_kids(self) -> Self

Indicates that all widgets who are children of this widget should be cropped to the kid_area of this widget.

fn scroll_kids(self) -> Self

Makes the widget's KidArea scrollable.

fn scroll_kids_vertically(self) -> Self

Makes the widget's KidArea scrollable.

fn scroll_kids_horizontally(self) -> Self

Set whether or not the widget's KidArea is scrollable (the default is false).

fn and<F>(self, build: F) -> Self where
    F: FnOnce(Self) -> Self, 

A builder method that "lifts" the Widget through the given build function.

fn and_mut<F>(self, mutate: F) -> Self where
    F: FnOnce(&mut Self), 

A builder method that mutates the Widget with the given mutate function.

fn and_if<F>(self, cond: bool, build: F) -> Self where
    F: FnOnce(Self) -> Self, 

A method that conditionally builds the Widget with the given build function.

fn and_then<T, F>(self, maybe: Option<T>, build: F) -> Self where
    F: FnOnce(Self, T) -> Self, 

A method that optionally builds the Widget with the given build function.

fn set<'a, 'b>(self, id: Id, ui_cell: &'a mut UiCell<'b>) -> Self::Event

Note: There should be no need to override this method.

impl<'a, N: Clone, E: Clone> Clone for Graph<'a, N, E> where
    N: Iterator,
    N::Item: NodeId,
    E: Iterator<Item = (NodeSocket<N::Item>, NodeSocket<N::Item>)>,
    N::Item: Clone, 

fn clone(&self) -> Graph<'a, N, E>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a, N: Debug, E: Debug> Debug for Graph<'a, N, E> where
    N: Iterator,
    N::Item: NodeId,
    E: Iterator<Item = (NodeSocket<N::Item>, NodeSocket<N::Item>)>,
    N::Item: Debug, 

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

Formats the value using the given formatter.