Struct conrod::widget::primitive::shape::oval::Oval

pub struct Oval<S> {
    pub common: CommonBuilder,
    pub style: Style,
    pub resolution: usize,
    pub section: S,
}

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

Fields

common: CommonBuilder

Data necessary and common for all widget builder types.

style: Style

Unique styling.

resolution: usize

The number of lines used to draw the edge.

section: S

A type describing the section of the Oval that is to be drawn.

Methods

impl Oval<Full>

fn styled(dim: Dimensions, style: Style) -> Self

Build an Oval with the given dimensions and style.

fn fill(dim: Dimensions) -> Self

Build a new Filled Oval.

fn fill_with(dim: Dimensions, color: Color) -> Self

Build a new Oval Filled with the given color.

fn outline(dim: Dimensions) -> Self

Build a new Outlined Oval widget.

fn outline_styled(dim: Dimensions, line_style: Style) -> Self

Build a new Oval Outlined with the given style.

impl<S> Oval<S>

fn resolution(self, resolution: usize) -> Self

The number of lines used to draw the edge.

By default, DEFAULT_RESOLUTION is used.

fn section(self, radians: Scalar) -> Oval<Section>

Produces an Oval where only a section is drawn.

The given radians describes the angle occuppied by the section's circumference.

impl Oval<Section>

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

The radians at which the section will begin.

A value of 0.0 will begin at the rightmost point of the oval.

Trait Implementations

impl<S: Copy> Copy for Oval<S>

impl<S: Clone> Clone for Oval<S>

fn clone(&self) -> Oval<S>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<S: Debug> Debug for Oval<S>

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

Formats the value using the given formatter.

impl<S> Widget for Oval<S> where
    S: OvalSection, 

type State = State<S>

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

impl<S> Colorable for Oval<S>

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.