Struct ScalarKeyFrameAnimation 

pub struct ScalarKeyFrameAnimation { /* private fields */ }

A key frame animation of f32 values.

Implementations

impl ScalarKeyFrameAnimation

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

pub fn insert_key_frame_with_easing( &self, normalized_progress_key: f32, value: f32, easing_function: Rc<dyn IEasing>, )

pub fn insert_key_frame(&self, normalized_progress_key: f32, value: f32)

Methods from Deref<Target = KeyFrameAnimation>

pub fn delay_behavior(&self) -> AnimationDelayBehavior

The delay behavior of the key frame animation.

pub fn set_delay_behavior(&self, value: AnimationDelayBehavior)

pub fn delay_time(&self) -> Duration

Delay before the animation starts after start_animation is called.

pub fn set_delay_time(&self, value: Duration)

pub fn direction(&self) -> PlaybackDirection

The direction the animation is playing. The Direction property allows you to drive your animation from start to end or end to start or alternate between start and end or end to start if animation has an iteration_count greater than one. This gives an easy way for customizing animation definitions.

pub fn set_direction(&self, value: PlaybackDirection)

pub fn duration(&self) -> Duration

The duration of the animation. Minimum allowed value is 1ms and maximum allowed value is 24 days.

pub fn set_duration(&self, value: Duration)

Sets the duration. As upstream, the range check is made on the current value rather than on the new one.

pub fn iteration_behavior(&self) -> AnimationIterationBehavior

The iteration behavior for the key frame animation.

pub fn set_iteration_behavior(&self, value: AnimationIterationBehavior)

pub fn iteration_count(&self) -> i32

The number of times to repeat the key frame animation.

pub fn set_iteration_count(&self, value: i32)

pub fn stop_behavior(&self) -> AnimationStopBehavior

Specifies how to set the property value when animation is stopped

pub fn set_stop_behavior(&self, value: AnimationStopBehavior)

pub fn insert_expression_key_frame( &self, normalized_progress_key: f32, value: &str, easing_function: Option<Easing>, )

Inserts an expression keyframe.

normalized_progress_key is the time the key frame should occur at, expressed as a percentage of the animation Duration. Allowed value is from 0.0 to 1.0. value is the expression used to calculate the value of the key frame. easing_function is the easing function to use when interpolating between frames; the default easing of the compositor when None.

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_color_parameter(&self, key: &str, value: Color)

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>)

Trait Implementations

impl AsCompositionObject for ScalarKeyFrameAnimation

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 ScalarKeyFrameAnimation

type Target = KeyFrameAnimation

The resulting type after dereferencing.

fn deref(&self) -> &KeyFrameAnimation

Dereferences the value.

impl ICompositionAnimation for ScalarKeyFrameAnimation

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

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

fn create_instance( &self, target_object: ServerObjectId, 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.

impl ICompositionAnimationBase for ScalarKeyFrameAnimation

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.