Struct Animator 

pub struct Animator { /* private fields */ }

Animates the values of a chart’s series.

The animator keeps the values the chart showed last and the values it should show now, and interpolates between them. The chart’s layout is recomputed on every frame of the animation, so the shapes really move rather than jumping at the end.

The clock and the easing come from euv-engine: the chart’s motion is the framework’s motion, down to the delay and the pause. The engine’s tween counts in seconds and the chart’s API counts in milliseconds, and the conversion happens here and nowhere else.

Implementations

impl Animator

Inherent implementation of Animator.

pub fn new() -> Self

Returns an animator with the default settings.

pub fn duration(&self) -> f64

Returns the duration of one animation, in milliseconds.

Returns

• f64 - A 64-bit float.

pub fn set_duration(&mut self, duration: f64) -> &mut Self

Sets the duration of one animation, in milliseconds.

A duration of zero turns the animation off, which is what a server-side render or a benchmark wants. The new duration applies to the animation that starts next.

Arguments

• f64 - A 64-bit float (f64).

Returns

• &mut Self - A mut Self value.

pub fn delay(&self) -> f64

Returns the delay before the animation starts, in milliseconds.

Returns

• f64 - A 64-bit float.

pub fn set_delay(&mut self, delay: f64) -> &mut Self

Sets the delay before the animation starts, in milliseconds.

Arguments

• f64 - A 64-bit float (f64).

Returns

• &mut Self - A mut Self value.

pub fn easing(&self) -> Easing

Returns the easing of the animation.

Returns

• Easing - A Easing value.

pub fn set_easing(&mut self, easing: Easing) -> &mut Self

Sets the easing of the animation.

Arguments

• Easing - A Easing parameter.

Returns

• &mut Self - A mut Self value.

pub fn is_running(&self) -> bool

Returns true when an animation is running.

Returns

• bool - A boolean.

pub fn pause(&mut self) -> &mut Self

Pauses the animation.

The values stay where they are until the animation is resumed.

Returns

• &mut Self - A mut Self value.

pub fn resume(&mut self) -> &mut Self

Resumes a paused animation.

Returns

• &mut Self - A mut Self value.

pub fn reset(&mut self) -> &mut Self

Starts the animation over.

The values go back to where the animation started, and the animation runs again from there.

Returns

• &mut Self - A mut Self value.

pub fn remember_initial(&mut self, option: &ChartOption) -> &mut Self

Remembers the option the chart started with.

Arguments

• &ChartOption - Shared reference to a ChartOption.

Returns

• &mut Self - A mut Self value.

pub fn begin(&mut self, option: &ChartOption) -> &mut Self

Starts an animation towards the given option.

The values the chart shows now become the starting point of the animation; a series that is new grows from zero.

Arguments

• &ChartOption - Shared reference to a ChartOption.

Returns

• &mut Self - A mut Self value.

pub fn advance(&mut self, delta: f64) -> bool

Advances the animation by the given number of milliseconds.

Returns true when the animation is still running.

Arguments

• f64 - A 64-bit float (f64).

Returns

• bool - A boolean.

pub fn apply(&self, option: &mut ChartOption)

Writes the animated values into the option.

The option’s series data is replaced by the animated values, so that the layout — and therefore the picture — follows the animation.

Arguments

• &mut ChartOption - Mutable reference to a ChartOption (mutated in place).

Trait Implementations

impl Clone for Animator

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Animator

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Animator

Default construction for Animator.

fn default() -> Self

Constructs a default Animator value.