Struct veloren_voxygen::ui::ImageSlider

pub struct ImageSlider<T, K> {
    common: CommonBuilder,
    value: T,
    min: T,
    max: T,
    soft_max: T,
    skew: f32,
    track: Track,
    slider: Slider,
    kind: PhantomData<K>,
}

Linear value selection.

If the slider’s width is greater than its height, it will automatically become a horizontal slider, otherwise it will be a vertical slider.

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

Fields

common: CommonBuilder

value: T

min: T

max: T

soft_max: T

skew: f32

The amount in which the slider’s display should be skewed.

Higher skew amounts (above 1.0) will weigh lower values.

Lower skew amounts (below 1.0) will weigh higher values.

All skew amounts should be greater than 0.0.

track: Track

slider: Slider

kind: PhantomData<K>

Implementations

impl<T, K> ImageSlider<T, K>

pub fn skew(self, skew: f32) -> Self

Build the type’s self.$($assignee).+ with the given $Type.

pub fn soft_max(self, soft_max: T) -> Self

Build the type’s self.$($assignee).+ with the given $Type.

pub fn pad_track(self, pad_track: (f32, f32)) -> Self

Build the type’s self.$($assignee).+ with the given $Type.

pub fn hover_image(self, hover_image: Id) -> Self

Build the type’s self.$($assignee).+ with the given $Type.

pub fn press_image(self, press_image: Id) -> Self

Build the type’s self.$($assignee).+ with the given $Type.

pub fn track_breadth(self, track_breadth: f32) -> Self

Build the type’s self.$($assignee).+ with the given $Type.

pub fn slider_length(self, slider_length: f32) -> Self

Build the type’s self.$($assignee).+ with the given $Type.

pub fn track_color(self, track_color: Color) -> Self

Build the type’s self.$($assignee).+ with the given $Type.

pub fn slider_color(self, slider_color: Color) -> Self

Build the type’s self.$($assignee).+ with the given $Type.

fn new( value: T, min: T, max: T, slider_image_id: Id, track_image_id: Id, ) -> Self

where T: Copy,

impl<T> ImageSlider<T, Continuous>

where T: Float,

pub fn continuous( value: T, min: T, max: T, slider_image_id: Id, track_image_id: Id, ) -> Self

impl<T> ImageSlider<T, Discrete>

where T: Integer + Copy,

pub fn discrete( value: T, min: T, max: T, slider_image_id: Id, track_image_id: Id, ) -> Self

Trait Implementations

impl<T, K> Colorable for ImageSlider<T, K>

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<T, K> Common for ImageSlider<T, K>

fn common(&self) -> &CommonBuilder

Borrows the CommonBuilder field.

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

Mutably borrows the CommonBuilder field.

impl<T, K> Widget for ImageSlider<T, K>

where T: NumCast + Num + Copy + PartialOrd, K: ValueFromPercent<T>,

fn update(self, args: UpdateArgs<'_, '_, '_, '_, Self>) -> Self::Event

Update the state of the Slider.

type Event = Option<T>

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

type State = State

State to be stored within the Uis widget cache.

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

fn init_state(&self, id_gen: Generator<'_>) -> Self::State

Return the initial State of the Widget.

fn style(&self) -> Self::Style

Return the styling of the widget.

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: [f64; 2], _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 is_over(&self) -> fn(_: &Container, _: [f64; 2], _: &Theme) -> IsOver

Returns either of the following:

fn parent(self, parent_id: NodeIndex) -> 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: NodeIndex) -> 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: NodeIndex, ui_cell: &'a mut UiCell<'b>) -> Self::Event

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