Struct conrod::XYPad

pub struct XYPad<'a, X, Y, F> {
    // some fields omitted
}

Used for displaying and controlling a 2D point on a cartesian plane within a given range.

Its reaction is triggered when the value is updated or if the mouse button is released while the cursor is above the rectangle.

Methods

impl<'a, X, Y, F> XYPad<'a, X, Y, F>

fn new(x_val: X, min_x: X, max_x: X, y_val: Y, min_y: Y, max_y: Y) -> Self

Build a new XYPad widget.

fn line_thickness(self, width: f64) -> Self

Set the width of the XYPad's crosshair lines.

fn value_font_size(self, size: FontSize) -> Self

Set the font size for the displayed crosshair value.

fn react(self, reaction: F) -> Self

Set the reaction for the XYPad.

It will be triggered when the value is updated or if the mouse button is released while the cursor is above the rectangle.

fn enabled(self, flag: bool) -> Self

If true, will allow user inputs. If false, will disallow user inputs.

Trait Implementations

impl<'a, X, Y, F> Widget for XYPad<'a, X, Y, F> where X: Float + ToString + Debug + Any, Y: Float + ToString + Debug + Any, F: FnOnce(X, Y)

type State = State<X, Y>

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<X, Y>

Return the initial State of the Widget.

fn style(&self) -> Style

Return the styling of the widget.

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 update<C: CharacterCache>(self, args: UpdateArgs<Self, C>)

Update the XYPad's cached state.

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 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<'a, X, Y, F> Colorable for XYPad<'a, X, Y, F>

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<'a, X, Y, F> Frameable for XYPad<'a, X, Y, F>

fn frame(self, width: f64) -> Self

Set the width of the widget's frame.

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

Set the color of the widget's frame.

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

Set the color of the widget's frame with rgba values.

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

Set the color of the widget's frame with rgb values.

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

Set the color of the widget's frame with hsla values.

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

Set the color of the widget's frame with hsl values.

impl<'a, X, Y, F> Labelable<'a> for XYPad<'a, X, Y, F>

fn label(self, text: &'a str) -> Self

Set the label for the widget.

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

Set the color of the widget's label.

fn label_font_size(self, size: FontSize) -> Self

Set the font size for the widget's label.

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

Set the color of the widget's label from rgba values.

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

Set the color of the widget's label from rgb values.

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

Set the color of the widget's label from hsla values.

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

Set the color of the widget's label from hsl values.

fn small_font<C>(self, ui: &Ui<C>) -> Self

Set a "small" font size for the widget's label.

fn medium_font<C>(self, ui: &Ui<C>) -> Self

Set a "medium" font size for the widget's label.

fn large_font<C>(self, ui: &Ui<C>) -> Self

Set a "large" font size for the widget's label.