Struct iced_audio::native::ramp::Ramp

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

A ramp GUI widget that controls a Param. It is usually used to represent the easing of a parameter between two points in time.

Implementations

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

pub fn new<F>(
    state: &'a mut State<ID>,
    on_change: F,
    direction: RampDirection
) -> Self where
    F: 'static + Fn(ID) -> Message, 

Creates a new Ramp.

It expects:

• the local State of the Ramp
• a function that will be called when the Ramp is dragged.
• the RampDirection of the Ramp, which tells if the ramp line should point Up (from bottom-left to top-right), or Down (from top-left to bottom-right)

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

Sets the width of the Ramp. The default width is Length::from(Length::Units(30)).

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

Sets the height of the Ramp. The default height is Length::from(Length::Units(20)).

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

Sets the style of the Ramp.

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

Sets how much the Normal value will change for the Ramp 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 Ramp.

The default modifier key is Ctrl.

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

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

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

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

Trait Implementations

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

fn from(ramp: Ramp<'a, Message, Renderer, ID>) -> Element<'a, Message, Renderer>

Performs the conversion.

impl<'a, Message, Renderer, ID> Widget<Message, Renderer> for Ramp<'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].