Struct conrod_core::widget::graph::node::Node

pub struct Node<W> {
    pub common: CommonBuilder,
    pub style: Style,
    pub widget: W,
    pub inputs: usize,
    pub outputs: usize,
}

A widget that acts as a convenience container for some Node's unique widgets.

Fields

common: CommonBuilder

Data necessary and common for all widget builder types.

style: Style

Unique styling for the Node.

widget: W

The widget wrapped by this node container.

inputs: usize

The number of input sockets on the node.

outputs: usize

The number of output sockets on the node.

Implementations

impl<W> Node<W>

pub fn new(widget: W) -> Self

Begin building a new Node widget.

pub fn inputs(self, inputs: usize) -> Self

Specify the number of input sockets for the node.

pub fn outputs(self, outputs: usize) -> Self

Specify the number of output sockets for the node.

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

Specify the color for the node's inner rectangle.

pub fn border_thickness(self, thickness: Scalar) -> Self

The thickness of the border around the inner widget.

This must always be a positive value in order for sockets to remain visible.

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

Specify the color for the node's border.

pub fn border_radius(self, radius: Scalar) -> Self

Specify the radius for the node's border.

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

Specify the color for the node's sockets.

pub fn input_socket_layout(self, layout: SocketLayout) -> Self

Specify the layout of the input sockets.

pub fn output_socket_layout(self, layout: SocketLayout) -> Self

Specify the layout of the input sockets.

Trait Implementations

impl<W: Clone> Clone for Node<W>

fn clone(&self) -> Node<W>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<W> Common for Node<W>

fn common(&self) -> &CommonBuilder

Borrows the CommonBuilder field.

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

Mutably borrows the CommonBuilder field.

impl<W: Debug> Debug for Node<W>

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

Formats the value using the given formatter.

impl<W> Widget for Node<W> where
    W: Widget, 

type State = State

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 = Event<W::Event>

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.