Skip to main content

Interaction

Struct Interaction 

Source
pub struct Interaction<Message: Clone, Tag = ()> { /* private fields */ }
Expand description

An interactable plot-area

§Examples

use iced_aksel::{Interaction, PlotPoint, Measure};
use iced_aksel::shape::Rectangle;
use iced_aksel::interaction::IntoArea;

#[derive(Debug, Clone)]
enum Message {
    RectPressed,
}

// Create a shape
let shape = Rectangle::centered(
    PlotPoint::new(50.0, 50.0),
    Measure::Plot(20.0),
    Measure::Plot(10.0),
);

// Convert shape to area and create interaction
let area = shape.resolve_area(plot);
let interaction = Interaction::new(area)
    .on_press(Message::RectPressed);

plot.render(shape);

Implementations§

Source§

impl<Message: Clone, Tag: Hash + Eq + Clone> Interaction<Message, Tag>

Source

pub const fn new(area: Area) -> Self

Creates a new Interaction

Source

pub const fn priority(self, prio: u16) -> Self

Sets the priority of the interaction.

0 = highest priority. 255 = lowest priority.

Defaults to 255.

Source

pub fn cursor<F, Mk>(self, f: F) -> Self

Sets a dynamic cursor for this interaction based on its current status.

Source

pub fn on_enter<H, Marker>(self, h: H) -> Self
where H: IntoHandler<Message, (Id<Tag>, EnterEvent), Marker>,

Sets the event handler for when the cursor enters the interaction

Source

pub fn on_exit<H, Marker>(self, h: H) -> Self
where H: IntoHandler<Message, (Id<Tag>, ExitEvent), Marker>,

Sets the event handler for when the cursor enters the interaction

Source

pub fn on_drag<H, Marker>(self, h: H) -> Self
where H: IntoHandler<Message, (Id<Tag>, DragEvent<Delta>), Marker>,

Sets the event handler for interaction dragging

Source

pub fn on_press<H, Marker>(self, h: H) -> Self
where H: IntoHandler<Message, (Id<Tag>, PressEvent<Point>), Marker>,

Sets the event handler for interaction mouse presses

Source

pub fn on_release<H, Marker>(self, h: H) -> Self
where H: IntoHandler<Message, (Id<Tag>, ReleaseEvent<Point>), Marker>,

Sets the event handler for interaction mouse releases

Auto Trait Implementations§

§

impl<Message, Tag> Freeze for Interaction<Message, Tag>
where Message: Freeze,

§

impl<Message, Tag = ()> !RefUnwindSafe for Interaction<Message, Tag>

§

impl<Message, Tag = ()> !Send for Interaction<Message, Tag>

§

impl<Message, Tag = ()> !Sync for Interaction<Message, Tag>

§

impl<Message, Tag> Unpin for Interaction<Message, Tag>
where Message: Unpin,

§

impl<Message, Tag> UnsafeUnpin for Interaction<Message, Tag>
where Message: UnsafeUnpin,

§

impl<Message, Tag = ()> !UnwindSafe for Interaction<Message, Tag>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> Downcast<T> for T

Source§

fn downcast(&self) -> &T

Source§

impl<T> Downcast for T
where T: Any,

Source§

fn into_any(self: Box<T>) -> Box<dyn Any>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.
Source§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
Source§

fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
Source§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> Upcast<T> for T

Source§

fn upcast(&self) -> Option<&T>

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more