Struct SpringScalarNaturalMotionAnimation 

pub struct SpringScalarNaturalMotionAnimation { /* private fields */ }

A spring animation of scalar values (WinUI SpringScalarNaturalMotionAnimation): each component moves on a damped harmonic oscillator of the given damping ratio and period.

Implementations

impl SpringScalarNaturalMotionAnimation

pub fn new( compositor: &Rc<Compositor>, ) -> Rc<SpringScalarNaturalMotionAnimation>

pub fn damping_ratio(&self) -> f32

The damping ratio of the spring: 1 (the default) comes to rest as fast as possible without overshooting, less overshoots and oscillates, more comes to rest slower; 0 oscillates forever.

pub fn set_damping_ratio(&self, value: f32)

Sets the damping ratio. Panics when it is negative or not a number.

pub fn period(&self) -> Duration

The period of the oscillation of the spring without damping; a shorter period is a stiffer spring.

pub fn set_period(&self, value: Duration)

Sets the period. Panics when it is zero.

Methods from Deref<Target = ScalarNaturalMotionAnimation>

pub fn final_value(&self) -> Option<f32>

The value the motion comes to rest at. When None, an implicit animation moves to the new value of the property (this.FinalValue), and an explicit one to the current value.

pub fn set_final_value(&self, value: Option<f32>)

pub fn initial_value(&self) -> Option<f32>

The value the motion starts from; the current value of the property when None.

pub fn set_initial_value(&self, value: Option<f32>)

pub fn initial_velocity(&self) -> f32

The velocity the motion starts with, in units of the property per second.

pub fn set_initial_velocity(&self, value: f32)

Methods from Deref<Target = NaturalMotionAnimation>

pub fn delay_behavior(&self) -> AnimationDelayBehavior

Whether the property takes the initial value before the delay (SetInitialValueBeforeDelay) or when the motion starts.

pub fn set_delay_behavior(&self, value: AnimationDelayBehavior)

pub fn delay_time(&self) -> Duration

The delay between the start of the animation and the start of the motion.

pub fn set_delay_time(&self, value: Duration)

pub fn stop_behavior(&self) -> AnimationStopBehavior

The value the property is set to when the animation is stopped with StopAnimation.

pub fn set_stop_behavior(&self, value: AnimationStopBehavior)

Methods from Deref<Target = CompositionAnimation>

pub fn object(&self) -> &CompositionObject

The embedded CompositionObject.

pub fn compositor(&self) -> &Rc<Compositor>

The associated compositor.

pub fn clear_all_parameters(&self)

Clears all of the parameters of the animation.

pub fn clear_parameter(&self, key: &str)

Clears a parameter from the animation.

pub fn set_boolean_parameter(&self, key: &str, value: bool)

Sets a boolean value parameter for use with an expression animation or an expression key frame.

pub fn set_color_parameter(&self, key: &str, value: Color)

pub fn set_expression_reference_parameter( &self, key: &str, animation_object: Rc<dyn AsCompositionObject>, )

Sets an object as a reference parameter of an expression: the expression reads its properties (key.Offset) every time it is evaluated, as with set_reference_parameter.

pub fn set_matrix3x2_parameter(&self, key: &str, value: Matrix3x2)

pub fn set_matrix4x4_parameter(&self, key: &str, value: Matrix4x4)

pub fn set_quaternion_parameter(&self, key: &str, value: Quaternion)

pub fn set_reference_parameter( &self, key: &str, composition_object: Rc<dyn AsCompositionObject>, )

pub fn set_scalar_parameter(&self, key: &str, value: f32)

pub fn set_vector2_parameter(&self, key: &str, value: Vector2)

pub fn set_vector3_parameter(&self, key: &str, value: Vector3)

pub fn set_vector4_parameter(&self, key: &str, value: Vector4)

pub fn target(&self) -> Option<String>

The name of the property the animation targets.

pub fn set_target(&self, value: Option<String>)

pub fn initial_value_expressions(&self) -> &InitialValueExpressionCollection

The initial values of the animation: for a property of the target object, the expression that gives the property its value when the animation starts.

Trait Implementations

impl AsCompositionObject for SpringScalarNaturalMotionAnimation

fn as_composition_object(&self) -> &CompositionObject

The embedded CompositionObject.

fn composition_type_name(&self) -> &'static str

The name of the class of the object, for messages.

fn as_property_set(self: Rc<Self>) -> Option<Rc<CompositionPropertySet>>

The object as a property set, if it is one (the is CompositionPropertySet test of upstream).

impl Deref for SpringScalarNaturalMotionAnimation

type Target = ScalarNaturalMotionAnimation

The resulting type after dereferencing.

fn deref(&self) -> &ScalarNaturalMotionAnimation

Dereferences the value.

impl ICompositionAnimation for SpringScalarNaturalMotionAnimation

fn target(&self) -> Option<String>

The name of the property the animation targets, if set.

fn create_instance( &self, target_object: ServerObjectId, implicit_final_value: Option<ExpressionVariant>, ) -> AnimationInstanceFactory

Creates the server-side instance of the animation for a property of target_object, as the factory that is sent to the server. final_value is the value the property was just set to when the animation is implicit.

fn composition_animation(&self) -> Option<&CompositionAnimation>

The CompositionAnimation part of the animation, through which its parameters are set (SetScalarParameter, …); None for an animation without one.

impl ICompositionAnimationBase for SpringScalarNaturalMotionAnimation

fn as_composition_animation(&self) -> Option<&dyn ICompositionAnimation>

The animation when it is a single animation rather than a group.

fn as_composition_animation_group(&self) -> Option<&CompositionAnimationGroup>

The group when it is a group of animations.