Struct ExpressionAnimation 

pub struct ExpressionAnimation { /* private fields */ }

A Composition Animation that uses a mathematical equation to calculate the value for an animating property every frame.

The core of ExpressionAnimations allows a developer to define a mathematical equation that can be used to calculate the value of a targeted animating property each frame. This contrasts KeyFrameAnimations, which use an interpolator to define how the animating property changes over time. The mathematical equation can be defined using references to properties of Composition objects, mathematical functions and operators and Input. Use the start_animation method of a composition object to start the animation.

Implementations

impl ExpressionAnimation

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

The mathematical equation specifying how the animated value is calculated each frame. The Expression is the core of an ExpressionAnimation and represents the equation the system will use to calculate the value of the animation property each frame. The equation is set on this property in the form of a string. Although expressions can be defined by simple mathematical equations such as “2+2”, the real power lies in creating mathematical relationships where the input values can change frame over frame.

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

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 ExpressionAnimation

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 ExpressionAnimation

type Target = CompositionAnimation

The resulting type after dereferencing.

fn deref(&self) -> &CompositionAnimation

Dereferences the value.

impl ICompositionAnimation for ExpressionAnimation

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 ExpressionAnimation

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.