Struct Transition 

pub struct Transition<'a, Message, Theme, Renderer, P>
where
    P: Program,
{ /* private fields */ }

A widget that can be used to animate its contents.

Implementations

impl<'a, Message, Theme, Renderer, P> Transition<'a, Message, Theme, Renderer, P>

where Renderer: Renderer, P: Program,

pub fn new<E>( init: impl Fn() -> P + 'a, value: P::Value, view: impl Fn(&P, Instant) -> E + 'a, ) -> Self

where E: Into<Element<'a, Message, Theme, Renderer>>,

Creates a new Transition.

The init closure will be used to initialize an animation.

The view closure will receive the animation and an Instant, which can be used for interpolating values. This will be called every frame until the given value is reached.

pub fn id(self, id: impl Into<Id>) -> Self

Sets the widget::Id of the Transition.

The widget::Id can subsequently be used to reset the [Animation] via reset.

pub fn key(self, key: impl Hash) -> Self

Sets the key of the Transition widget for continuity.

Changing the key will reset the [Animation].

pub fn on_finish(self, on_finish: Message) -> Self

where Message: Clone + 'a,

Sets the message that will be produced when the Transition has finished animating.

Note that if an [Animation] is set to loop forever, the message will never be produced!

pub fn on_finish_maybe(self, on_finish: impl Into<Option<Message>>) -> Self

where Message: Clone + 'a,

Sets the message that will be produced when the Transition has finished animating, if Some.

Note that if an [Animation] is set to loop forever, the message will never be produced!

pub fn on_finish_with(self, on_finish: impl Fn() -> Message + 'a) -> Self

Sets the message that will be produced when the Transition has finished animating.

This is analogous to Transition::on_finish, but using a closure to produce the message.

This closure will only be called when the Transition has actually finished animating and, therefore, this method is useful to reduce overhead if creating the resulting message is slow.

Note that if an [Animation] is set to loop forever, the message will never be produced!

Trait Implementations

impl<'a, Message, Theme, Renderer, P> From<Transition<'a, Message, Theme, Renderer, P>> for Element<'a, Message, Theme, Renderer>

where Message: 'a, Theme: 'a, Renderer: Renderer + 'a, P: Program,

fn from(transition: Transition<'a, Message, Theme, Renderer, P>) -> Self

Converts to this type from the input type.

impl<Message, Theme, Renderer, P> Widget<Message, Theme, Renderer> for Transition<'_, Message, Theme, Renderer, P>

where Renderer: Renderer, P: Program,

fn size(&self) -> Size<Length>

Returns the [Size] of the [Widget] in lengths.

fn tag(&self) -> Tag

Returns the Tag of the [Widget].

fn state(&self) -> State

Returns the State of the [Widget].

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

Reconciles the [Widget] with the provided [Tree].

fn layout( &mut self, tree: &mut Tree, renderer: &Renderer, limits: &Limits, ) -> Node

Returns the [layout::Node] of the [Widget].

fn update( &mut self, tree: &mut Tree, event: &Event, layout: Layout<'_>, cursor: Cursor, renderer: &Renderer, shell: &mut Shell<'_, Message>, viewport: &Rectangle, )

Processes a runtime Event.

fn draw( &self, tree: &Tree, renderer: &mut Renderer, theme: &Theme, style: &Style, layout: Layout<'_>, cursor: Cursor, viewport: &Rectangle, )

Draws the [Widget] using the associated Renderer.

fn mouse_interaction( &self, tree: &Tree, layout: Layout<'_>, cursor: Cursor, viewport: &Rectangle, renderer: &Renderer, ) -> Interaction

Returns the current [mouse::Interaction] of the [Widget].

fn operate( &mut self, tree: &mut Tree, layout: Layout<'_>, renderer: &Renderer, operation: &mut dyn Operation, )

Applies an [Operation] to the [Widget].

fn overlay<'a>( &'a mut self, tree: &'a mut Tree, layout: Layout<'a>, renderer: &Renderer, viewport: &Rectangle, translation: Vector, ) -> Option<Element<'a, Message, Theme, Renderer>>

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