Struct iced_audio::native::knob::Knob

pub struct Knob<'a, Message, Renderer: Renderer, ID> where
    ID: Debug + Copy + Clone,  { /* fields omitted */ }

A rotating knob GUI widget that controls a Param

Implementations

impl<'a, Message, Renderer: Renderer, ID> Knob<'a, Message, Renderer, ID> where
    ID: Debug + Copy + Clone, 

pub fn new<F>(
    state: &'a mut State,
    param: &impl Param<ID = ID>,
    on_change: F
) -> Self where
    F: 'static + Fn((ID, Normal)) -> Message, 

Creates a new Knob.

It expects:

• the local State of the Knob
• a Param with the current and default values
• a function that will be called when the Knob is turned. It receives the parameter's ID and the new Normal of the Knob. ID is a user supplied type. It can be an enum, u32, i32, String, etc. Each parameter must have a unique ID value!

pub fn size(self, size: Length) -> Self

Sets the diameter of the Knob. The default size is Length::from(Length::Units(31)).

pub fn style(self, style: impl Into<Renderer::Style>) -> Self

Sets the style of the Knob.

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

Sets how much the Normal value will change for the Knob per y pixel movement of the mouse.

The default value is 0.008

pub fn modifier_keys(self, modifier_keys: ModifiersState) -> Self

Sets the modifier keys of the Knob.

The default modifier key is Ctrl.

pub fn modifier_scalar(self, scalar: f32) -> Self

Sets the scalar to use when the user drags the knobs while holding down the modifier key. This is multiplied to the value set by Knob::scalar() (which the default is 0.008).

For example, a modifier_scalar of 0.5 will cause the knob to turn half as fast when the modifier key is down.

The default modifier_scalar is 0.02, and the default modifier key is Ctrl.

pub fn tick_marks(self, tick_marks: &'a TickMarkGroup) -> Self

Sets the TickMarkGroup to display. Note your StyleSheet must also implement tick_mark_style(&self) -> Option<TickMarkStyle> for them to display (which the default style does).

Trait Implementations

impl<'a, Message, Renderer, ID> From<Knob<'a, Message, Renderer, ID>> for Element<'a, Message, Renderer> where
    Renderer: 'a + Renderer,
    Message: 'a,
    ID: 'a + Debug + Copy + Clone, 

fn from(
    v_slider: Knob<'a, Message, Renderer, ID>
) -> Element<'a, Message, Renderer>

Performs the conversion.

impl<'a, Message, Renderer, ID> Widget<Message, Renderer> for Knob<'a, Message, Renderer, ID> where
    Renderer: Renderer,
    ID: Debug + Copy + Clone, 

fn width(&self) -> Length

Returns the width of the [Widget].

fn height(&self) -> Length

Returns the height of the [Widget].

fn layout(&self, _renderer: &Renderer, limits: &Limits) -> Node

Returns the [Node] of the [Widget].

fn on_event(
    &mut self,
    event: Event,
    layout: Layout,
    cursor_position: Point,
    messages: &mut Vec<Message>,
    _renderer: &Renderer,
    _clipboard: Option<&dyn Clipboard>
)

Processes a runtime [Event].

fn draw(
    &self,
    renderer: &mut Renderer,
    _defaults: &Renderer::Defaults,
    layout: Layout,
    cursor_position: Point
) -> Renderer::Output

Draws the [Widget] using the associated Renderer.

fn hash_layout(&self, state: &mut Hasher)

Computes the layout hash of the [Widget].