Struct zng_var::VARS

pub struct VARS;

Variable updates and animation service.

Implementations

impl VARS

pub fn update_id(&self) -> VarUpdateId

Id of the current vars update in the app scope.

Variable with AnyVar::last_update equal to this are new.

pub fn animations_enabled(&self) -> ArcCowVar<bool, ArcVar<bool>>

Read-write that defines if animations are enabled on the app.

The value is the same as sys_animations_enabled, if set the variable disconnects from system config.

pub fn sys_animations_enabled(&self) -> ReadOnlyArcVar<bool>

Read-only that tracks if animations are enabled in the operating system.

This is true by default, it updates when the operating system config changes.

pub fn frame_duration(&self) -> ArcVar<Duration>

Variable that defines the global frame duration, the default is 60fps (1.0 / 60.0).secs().

pub fn animation_time_scale(&self) -> ArcVar<Factor>

Variable that defines a global scale for the elapsed time of animations.

pub fn current_modify(&self) -> ModifyInfo

Info about the current context when requesting variable modification.

If is currently inside a VARS.animate closure, or inside a Var::modify closure requested by an animation, or inside an AnimationController, returns the info that was collected at the moment the animation was requested. Outside of animations gets an info with importance guaranteed to override the modify_importance.

pub fn animate<A>(&self, animation: A) -> AnimationHandle

where A: FnMut(&Animation) + Send + 'static,

Adds an animation closure that is called every frame to update captured variables, starting after next frame.

This is used to implement all Var<T> animations, it enables any kind of variable animation, including multiple variables.

Returns an AnimationHandle that can be used to monitor the animation status and to stop or to make the animation perm.

Variable Control

Animations assume control of a variable on the first time they cause its value to be new, after this moment the AnyVar::is_animating value is true and AnyVar::modify_importance is the animation’s importance, until the animation stops. Only one animation can control a variable at a time, if an animation loses control of a variable all attempts to modify it from inside the animation are ignored.

Later started animations steal control from previous animations, update, modify or set calls also remove the variable from being affected by a running animation, even if just set to an equal value, that is, not actually updated.

Nested Animations

Other animations can be started from inside the animation closure, these nested animations have the same importance as the parent animation, the animation handle is different and AnyVar::is_animating is false if the nested animation is dropped before the parent animation. But because the animations share the same importance the parent animation can set the variable again.

Examples

The example animates a text variable from "Animation at 0%" to "Animation at 100%", when the animation stops the completed variable is set to true.

fn animate_text(text: &impl Var<Txt>, completed: &impl Var<bool>) {
    let transition = animation::Transition::new(0u8, 100);
    let mut prev_value = 101;
    VARS.animate(clmv!(text, completed, |animation| {
        let step = easing::expo(animation.elapsed_stop(1.secs()));
        let value = transition.sample(step);
        if value != prev_value {
            if value == 100 {
                animation.stop();
                let _ = completed.set(true);
            }
            let _ = text.set(formatx!("Animation at {value}%"));
            prev_value = value;
        }
    }))
    .perm()
}

Note that the animation can be stopped from the inside, the closure parameter is an Animation. In the example this is the only way to stop the animation, because perm was called. Animations hold a clone of the variables they affect and exist for the duration of the app if not stopped, causing the app to wake and call the animation closure for every frame.

This method is the most basic animation interface, used to build all other animations, its rare that you will need to use it directly, most of the time animation effects can be composted using the Var easing and mapping methods.

let value = var(0u8);
let text = value.map(|v| formatx!("Animation at {v}%"));
value.ease(100, 1.secs(), easing::expo);

Optimization Tips

When no animation is running the app sleeps awaiting for an external event, update request or timer elapse, when at least one animation is running the app awakes every VARS.frame_duration. You can use Animation::sleep to pause the animation for a duration, if all animations are sleeping the app is also sleeping.

Animations lose control over a variable permanently when a newer animation modifies the var or the var is modified directly, but even if the animation can’t control any variables it keeps running. This happens because the system has no insight of all side effects caused by the animation closure. You can use the VARS.current_modify and AnyVar::modify_importance to detect when the animation no longer affects any variables and stop the animation to avoid awaking the app for no reason.

These optimizations are already implemented by the animations provided as methods of Var<T>.

External Controller

The animation can be controlled from the inside using the Animation reference, it can be stopped using the returned AnimationHandle, and it can also be controlled by a registered AnimationController that can manage multiple animations at the same time, see with_animation_controller for more details.

pub fn with_animation_controller<R>( &self, controller: impl AnimationController, animate: impl FnOnce() -> R, ) -> R

Calls animate while controller is registered as the animation controller.

The controller is notified of animation events for each animation spawned by animate and can affect then with the same level of access as VARS.animate. Only one controller can affect animations at a time.

This can be used to manage multiple animations at the same time, or to get VARS.animate level of access to an animation that is not implemented to allow such access. Note that animation implementers are not required to support the full Animation API, for example, there is no guarantee that a restart requested by the controller will repeat the same animation.

The controller can start new animations, these animations will have the same controller if not overridden, you can use this method and the () controller to avoid this behavior.

pub fn perm(&self, value: impl Any + Send)

Keep the value alive for the app lifetime.