Struct conrod::widget::primitive::shape::polygon::Polygon[][src]

pub struct Polygon<I> {
    pub common: CommonBuilder,
    pub points: I,
    pub style: Style,
    pub maybe_shift_to_centre_from: Option<Point>,
}

A basic, non-interactive, arbitrary Polygon widget.

The Polygon is described by specifying its corners in order.

Polygon will automatically close all shapes, so the given list of points does not need to start and end with the same position.

Fields

Data necessary and common for all widget builder types.

The points describing the corners of the Polygon.

Unique styling for the Polygon.

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

Methods

impl<I> Polygon<I>
[src]

Build a polygon with the given points and style.

Build a Polygon with the default Fill style.

Build a Polygon Filled with the given Color.

Build a Polygon with the default Outline style.

Build a Polygon Outlineed with the given line style.

Build a new filled Polygon whose bounding box is fit to the absolute co-ordinates of the points.

This requires that the points iterator is Clone so that we may iterate through and determine the bounding box of the points.

If you would rather centre the points to the middle of the bounding box, use the Polygon::centred methods instead.

The same as Polygon::abs_styled but builds the Polygon with the default Fill style.

The same as Polygon::abs_styled but builds the Polygon Filled with the given Color.

The same as Polygon::abs_styled but builds the Polygon with the default Outline style.

The same as Polygon::abs_styled but builds the Polygon with the given Outline styling.

Build a new Polygon and shift the location of the points so that the centre of their bounding rectangle lies at the position determined for the Polygon widget.

This is useful if your points simply describe a shape and you want to position them using conrod's auto-layout and/or Positionable methods.

If you would rather centre the bounding box to the points, use the Polygon::abs constructor method instead.

The same as Polygon::centred_styled but constructs the Polygon with the default Fill style.

The same as Polygon::centred_styled but constructs the Polygon Filled with the given color.

The same as Polygon::centred_styled but constructs the Polygon with the default Outline style.

The same as Polygon::centred_styled but constructs the Polygon Outlined with the given styling.

Trait Implementations

impl<I: Copy> Copy for Polygon<I>
[src]

impl<I: Clone> Clone for Polygon<I>
[src]

Returns a copy of the value. Read more

Performs copy-assignment from source. Read more

impl<I: Debug> Debug for Polygon<I>
[src]

Formats the value using the given formatter. Read more

impl<I> Widget for Polygon<I> where
    I: IntoIterator<Item = Point>, 
[src]

State to be stored within the Uis widget cache. Read more

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

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

Return the initial State of the Widget. Read more

Return the styling of the widget. Read more

Returns either of the following: Read more

Update the state of the Polygon.

The default Position for the widget along the x axis. Read more

The default Position for the widget along the y axis. Read more

The default width for the Widget. Read more

The default height of the widget. Read more

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

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

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

Specify that this widget has no parent widgets.

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

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

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

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

Makes the widget's KidArea scrollable. Read more

Makes the widget's KidArea scrollable. Read more

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

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

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

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

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

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

impl<I> Colorable for Polygon<I>
[src]

Set the color of the widget.

Set the color of the widget from rgba values.

Set the color of the widget from rgb values.

Set the color of the widget from hsla values.

Set the color of the widget from hsl values.

Auto Trait Implementations

impl<I> Send for Polygon<I> where
    I: Send

impl<I> Sync for Polygon<I> where
    I: Sync