ElasticEasingFunction Class

Definition

Namespace:

Microsoft.UI.Composition

Represents an easing function that creates an animation that resembles a spring oscillating back and forth until it comes to rest.

public ref class ElasticEasingFunction sealed : CompositionEasingFunction

/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
/// [Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
/// [Windows.Foundation.Metadata.ContractVersion(Microsoft.Foundation.WindowsAppSDKContract, 65536)]
class ElasticEasingFunction final : CompositionEasingFunction

[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
[Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
[Windows.Foundation.Metadata.ContractVersion(typeof(Microsoft.Foundation.WindowsAppSDKContract), 65536)]
public sealed class ElasticEasingFunction : CompositionEasingFunction

Public NotInheritable Class ElasticEasingFunction
Inherits CompositionEasingFunction

Inheritance

Object Platform::Object IInspectable CompositionObject CompositionEasingFunction ElasticEasingFunction

Attributes

ContractVersionAttribute MarshalingBehaviorAttribute ThreadingAttribute

Remarks

You can control when in the "spring" behavior occurs in an animation by specifying the Mode property value on an animation. The following graph demonstrates the different values of Mode, where f(t) represents the animation progress and t represents time.

You can specify how many times the animation oscillates back and forth using the Oscillations property and how tight the springiness of the oscillations are using the Springiness property.

Note

Because this animation causes values to oscillate back and forth, the animation might interpolate into negative numbers unexpectedly. This can cause errors when animating properties that do not allow negative numbers. For example, if you apply this animation to the Height of an object (e.g. from 0 to 200 with a Mode of EaseIn), the animation will attempt to interpolate through negative numbers for Height which will throw an error.

There are several other easing functions besides ElasticEasingFunction. In addition to using the easing functions included in the run-time, you can create your own custom easing functions by inheriting from CompositionEasingFunction.

Properties

Comment	A string to associate with the CompositionObject. (Inherited from CompositionObject)
Compositor	The Compositor used to create this CompositionObject. (Inherited from CompositionObject)
DispatcherQueue	Gets the DispatcherQueue for the CompositionObject. (Inherited from CompositionObject)
ImplicitAnimations	The collection of implicit animations attached to this object. (Inherited from CompositionObject)
Mode	Gets or sets a value that specifies how the animation interpolates.
Oscillations	Gets or sets the number of times the target slides back and forth over the animation destination.
Properties	The collection of properties associated with the CompositionObject. (Inherited from CompositionObject)
Springiness	Gets or sets the stiffness of the spring. The smaller the Springiness value is, the stiffer the spring and the faster the elasticity decreases in intensity over each oscillation.

Methods

Close()	Closes the CompositionObject and releases system resources. (Inherited from CompositionObject)
Dispose()	Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. (Inherited from CompositionObject)
PopulatePropertyInfo(String, AnimationPropertyInfo)	Defines a property that can be animated. (Inherited from CompositionObject)
StartAnimation(String, CompositionAnimation)	Connects an animation with the specified property of the object and starts the animation. (Inherited from CompositionObject)
StartAnimation(String, CompositionAnimation, AnimationController)	Connects an animation with the specified property of the object and starts the animation. (Inherited from CompositionObject)
StartAnimationGroup(ICompositionAnimationBase)	Starts an animation group. The StartAnimationGroup method on CompositionObject lets you start CompositionAnimationGroup. All the animations in the group will be started at the same time on the object. (Inherited from CompositionObject)
StopAnimation(String)	Disconnects an animation from the specified property and stops the animation. (Inherited from CompositionObject)
StopAnimationGroup(ICompositionAnimationBase)	Stops an animation group. (Inherited from CompositionObject)
TryGetAnimationController(String)	Returns an AnimationController for the animation running on the specified property. (Inherited from CompositionObject)