Struct conrod_core::widget::primitive::point_path::PointPath

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

A simple, non-interactive widget for drawing a series of lines and/or points.

Fields

points: I

Some iterator yielding a series of Points.

common: CommonBuilder

Data necessary and common for all widget builder types.

style: Style

Unique styling for the PointPath.

maybe_shift_to_centre_from: Option<Point>

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

Implementations

impl<I> PointPath<I>

pub fn styled(points: I, style: Style) -> Self

The same as PointPath::new but with th given style.

pub fn new(points: I) -> Self

Build a new default PointPath widget.

Note that this does not automatically set the position of the bounding box for the widget. It is recommended that you also see the abs and centred constructors for smart positioning and layout that automatically infer the position and size of the bounding box. This method should only be preferred if the user can also specify the correct bounding box position and size as this will be more efficient than the abs or centred methods.

pub fn abs(points: I) -> Self where
    I: IntoIterator<Item = Point> + Clone, 

Build a new PointPath 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 PointPath::centred instead.

pub fn abs_styled(points: I, style: Style) -> Self where
    I: IntoIterator<Item = Point> + Clone, 

The same as PointPath::abs but constructs the PointPath with the given style.

pub fn centred(points: I) -> Self where
    I: IntoIterator<Item = Point> + Clone, 

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

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

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

pub fn centred_styled(points: I, style: Style) -> Self where
    I: IntoIterator<Item = Point> + Clone, 

The same as PointPath::centred but constructs the PointPath with the given style.

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

The thickness or width of the PointPath's lines.

Use this instead of Positionable::width for the thickness of the Line, as width and height refer to the dimensions of the bounding rectangle.

pub fn solid(self) -> Self

Make a Solid line.

pub fn dashed(self) -> Self

Make a line with a Dashed pattern.

pub fn dotted(self) -> Self

Make a line with a Dotted pattern.

Trait Implementations

impl<I: Clone> Clone for PointPath<I>

fn clone(&self) -> PointPath<I>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<I> Colorable for PointPath<I>

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

Set the color of the widget.

fn rgba(self, r: f32, g: f32, b: f32, a: f32) -> Self

Set the color of the widget from rgba values.

fn rgb(self, r: f32, g: f32, b: f32) -> Self

Set the color of the widget from rgb values.

fn hsla(self, h: f32, s: f32, l: f32, a: f32) -> Self

Set the color of the widget from hsla values.

fn hsl(self, h: f32, s: f32, l: f32) -> Self

Set the color of the widget from hsl values.

impl<I> Common for PointPath<I>

fn common(&self) -> &CommonBuilder

Borrows the CommonBuilder field.

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

Mutably borrows the CommonBuilder field.

impl<I: Debug> Debug for PointPath<I>

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

Formats the value using the given formatter.

impl<I> Widget for PointPath<I> where
    I: IntoIterator<Item = Point>, 

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

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 the state of the Line.

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.