Struct conrod::Line

pub struct Line {
    pub start: Point,
    pub end: Point,
    pub common: CommonBuilder,
    pub style: Style,
    pub should_centre_points: bool,
}

A simple, non-interactive widget for drawing a single straight Line.

Fields

start: Point

The start of the line.

end: Point

The end of the line.

common: CommonBuilder

Data necessary and common for all widget builder types.

style: Style

Unique styling.

should_centre_points: bool

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

Methods

impl Line

fn styled(start: Point, end: Point, style: Style) -> Self

Build a new Line widget with the given style.

fn new(start: Point, end: Point) -> Self

Build a new default Line widget.

fn abs(start: Point, end: Point) -> Self

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

If you would rather centre the start and end to the middle of the bounding box, use Line::centred instead.

fn abs_styled(start: Point, end: Point, style: Style) -> Self

The same as Line::abs but with the given style.

fn centred(start: Point, end: Point) -> Self

Build a new Line and shift the location of the start and end points so that the centre of their bounding rectangle lies at the position determined by the layout for the Line widget.

This is useful if your points simply describe the line's angle and magnitude, 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 Line::abs instead.

fn centred_styled(start: Point, end: Point, style: Style) -> Self

The same as Line::centred but with the given style.

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

The thickness or width of the Line.

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

fn solid(self) -> Self

Make a solid line.

fn dashed(self) -> Self

Make a line with a Dashed pattern.

fn dotted(self) -> Self

Make a line with a Dotted pattern.

Trait Implementations

impl Debug for Line

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

Formats the value using the given formatter.

impl Clone for Line

fn clone(&self) -> Line

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for Line

impl Widget for Line

type State = State

State to be stored within the Uis widget cache.

type Style = Style

Styling used by the widget to draw its graphics.

fn common(&self) -> &CommonBuilder

Return a reference to a CommonBuilder struct owned by the Widget. This method allows us to do a blanket impl of Positionable and Sizeable for T: Widget.

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

Return a mutable reference to a CommonBuilder struct owned by the Widget. This method allows us to do a blanket impl of Positionable and Sizeable for T: Widget.

fn unique_kind(&self) -> &'static str

Return the kind of the widget as a &'static str.

fn init_state(&self) -> State

Return the initial State of the Widget.

fn style(&self) -> Style

Return the styling of the widget.

fn update<C: CharacterCache>(self, args: UpdateArgs<Self, C>)

Update the state of the Line.

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

The default Position for the widget along the x axis.

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

The default Position for the widget along the y axis.

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

The default width for the Widget.

fn default_y_dimension<C: CharacterCache>(&self, ui: &Ui<C>) -> 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 an dimensions of the draggable space. The position should be relative to the center of the widget.

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

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

fn parent<I: Into<Index>>(self, parent_idx: I) -> 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 picking_passthrough(self, passthrough: bool) -> Self

Whether or not the widget should be considered when picking the topmost widget at a position.

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<I: Into<Index>>(self, idx: I) -> 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 scrolling(self, scrollable: bool) -> Self

Set whether or not the widget's KidArea is scrollable (the default is false). If a widget is scrollable and it has children widgets that fall outside of its KidArea, the KidArea will become scrollable.

fn vertical_scrolling(self, scrollable: bool) -> Self

Set whether or not the widget's KidArea is scrollable (the default is false). If a widget is scrollable and it has children widgets that fall outside of its KidArea, the KidArea will become scrollable.

fn horizontal_scrolling(self, scrollable: bool) -> Self

Set whether or not the widget's KidArea is scrollable (the default is false). If a widget is scrollable and it has children widgets that fall outside of its KidArea, the KidArea will become scrollable.

fn set<I, U>(self, idx: I, ui: &mut U) where I: Into<Index>, U: UiRefMut

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

impl Colorable for Line

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.