Struct iced_audio::native::knob::Knob

pub struct Knob<'a, Message, Renderer>where
    Renderer: Renderer,
    Renderer::Theme: StyleSheet,{ /* private fields */ }

A rotating knob GUI widget that controls a NormalParam

Implementations

impl<'a, Message, Renderer> Knob<'a, Message, Renderer>where Renderer: Renderer, Renderer::Theme: StyleSheet,

pub fn new<F>(normal_param: NormalParam, on_change: F) -> Selfwhere F: 'a + Fn(Normal) -> Message,

Creates a new Knob.

It expects:

• the NormalParam of the Knob
• a function that will be called when the Knob is turned.

pub fn on_grab(self, on_grab: impl 'a + FnMut() -> Option<Message>) -> Self

Sets the grab message of the Knob. This is called when the mouse grabs from the knob.

Typically, the user’s interaction with the knob starts when this message is produced. This is useful for some environments so that external changes, such as automation, don’t interfer with user’s changes.

pub fn on_release( self, on_release: impl 'a + FnMut() -> Option<Message> ) -> Self

Sets the release message of the Knob. This is called when the mouse is released from the knob.

Typically, the user’s interaction with the knob is finished when this message is produced. This is useful if you need to spawn a long-running task from the knob’s result, where the default on_change message could create too many events.

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

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

pub fn style( self, style: impl Into<<Renderer::Theme as StyleSheet>::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.00385

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

Sets how much the Normal value will change for the Knob per line scrolled by the mouse wheel.

This can be set to 0.0 to disable the scroll wheel from moving the parameter.

The default value is 0.01

pub fn modifier_keys(self, modifier_keys: Modifiers) -> 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.00385).

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 Group) -> Self

Sets the tick marks to display. Note your StyleSheet must also implement tick_marks_style(&self) -> Option<tick_marks::Style> for them to display (which the default style does).

pub fn text_marks(self, text_marks: &'a Group) -> Self

Sets the text marks to display. Note your StyleSheet must also implement text_marks_style(&self) -> Option<text_marks::Style> for them to display (which the default style does).

pub fn mod_range(self, mod_range: &'a ModulationRange) -> Self

Sets a ModulationRange to display. Note your StyleSheet must also implement mod_range_style(&self) -> Option<ModRangeStyle> for them to display.

pub fn mod_range_2(self, mod_range: &'a ModulationRange) -> Self

Sets a second ModulationRange to display. Note your StyleSheet must also implement mod_range_style_2(&self) -> Option<ModRangeStyle> for them to display.

pub fn bipolar_center(self, bipolar_center: Normal) -> Self

Sets the value to be considered the center of the Knob. Only has an effect when using ArcBipolarStyle.

Trait Implementations

impl<'a, Message, Renderer> From<Knob<'a, Message, Renderer>> for Element<'a, Message, Renderer>where Message: 'a, Renderer: 'a + Renderer, Renderer::Theme: 'a + StyleSheet,

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

Converts to this type from the input type.

impl<'a, Message, Renderer> Widget<Message, Renderer> for Knob<'a, Message, Renderer>where Renderer: Renderer, Renderer::Theme: StyleSheet,

fn tag(&self) -> Tag

Returns the Tag of the Widget.

fn state(&self) -> State

Returns the State of the Widget.

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 layout::Node of the Widget.

fn on_event( &mut self, state: &mut Tree, event: Event, layout: Layout<'_>, cursor_position: Point, _renderer: &Renderer, _clipboard: &mut dyn Clipboard, shell: &mut Shell<'_, Message> ) -> Status

Processes a runtime Event.

fn draw( &self, state: &Tree, renderer: &mut Renderer, theme: &Renderer::Theme, _style: &Style, layout: Layout<'_>, cursor_position: Point, _viewport: &Rectangle )

Draws the Widget using the associated Renderer.

fn children(&self) -> Vec<Tree, Global>

Returns the state Tree of the children of the Widget.

fn diff(&self, _tree: &mut Tree)

Reconciliates the Widget with the provided Tree.

fn operate( &self, _state: &mut Tree, _layout: Layout<'_>, _renderer: &Renderer, _operation: &mut dyn Operation<Message> )

Applies an Operation to the Widget.

fn mouse_interaction( &self, _state: &Tree, _layout: Layout<'_>, _cursor_position: Point, _viewport: &Rectangle<f32>, _renderer: &Renderer ) -> Interaction

Returns the current mouse::Interaction of the Widget.

fn overlay<'a>( &'a mut self, _state: &'a mut Tree, _layout: Layout<'_>, _renderer: &Renderer ) -> Option<Element<'a, Message, Renderer>>

Returns the overlay of the Widget, if there is any.