Struct conrod_core::widget::primitive::shape::triangles::Triangles

pub struct Triangles<S, I> {
    pub common: CommonBuilder,
    pub style: S,
    pub triangles: I,
    pub maybe_shift_to_centre_from: Option<Point>,
}

A widget that allows for drawing a list of triangles.

Fields

common: CommonBuilder

Data necessary and common for all widget builder types.

style: S

Unique styling for the Triangles.

triangles: I

All the point in the triangle list.

maybe_shift_to_centre_from: Option<Point>

Whether or not the triangles should be automatically centred to the widget position.

Implementations

impl<I> Triangles<SingleColor, I> where
    I: IntoIterator<Item = Triangle<<SingleColor as Style>::Vertex>>, 

pub fn single_color<C>(
    color: C,
    points: I
) -> TrianglesUnpositioned<SingleColor, I> where
    C: Into<Rgba>, 

A list of triangles described by the given points.

All triangles are colored with the given Color.

impl<I> Triangles<MultiColor, I> where
    I: IntoIterator<Item = Triangle<<MultiColor as Style>::Vertex>>, 

pub fn multi_color(points: I) -> TrianglesUnpositioned<MultiColor, I>

A list of triangles described by the given points.

Every vertex specifies its own unique color.

Trait Implementations

impl<S: Clone, I: Clone> Clone for Triangles<S, I>

fn clone(&self) -> Triangles<S, I>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<S, I> Common for Triangles<S, I>

fn common(&self) -> &CommonBuilder

Borrows the CommonBuilder field.

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

Mutably borrows the CommonBuilder field.

impl<S: Copy, I: Copy> Copy for Triangles<S, I>

impl<S: Debug, I: Debug> Debug for Triangles<S, I>

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

Formats the value using the given formatter.

impl<S, I> Widget for Triangles<S, I> where
    S: Style,
    I: IntoIterator<Item = Triangle<S::Vertex>>, 

type State = State<Vec<Triangle<S::Vertex>>>

State to be stored within the Uis widget cache.

type Style = S

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 = ()

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

fn init_state(&self, _: Generator<'_>) -> Self::State

Return the initial State of the Widget.

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

Return the styling of the widget.

fn is_over(&self) -> IsOverFn

Returns either of the following:

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 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.