SpringScalarNaturalMotionAnimation Class

Definition

A spring physics-based animation that targets any Scalar-based property.

Equivalent WinUI class: Microsoft.UI.Composition.SpringScalarNaturalMotionAnimation.

public ref class SpringScalarNaturalMotionAnimation sealed : ScalarNaturalMotionAnimation
/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 327680)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
/// [Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
class SpringScalarNaturalMotionAnimation final : ScalarNaturalMotionAnimation
[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 327680)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
[Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
public sealed class SpringScalarNaturalMotionAnimation : ScalarNaturalMotionAnimation
Public NotInheritable Class SpringScalarNaturalMotionAnimation
Inherits ScalarNaturalMotionAnimation
Inheritance
Attributes

Windows requirements

Device family
Windows 10 Fall Creators Update (introduced in 10.0.16299.0)
API contract
Windows.Foundation.UniversalApiContract (introduced in v5.0)

Properties

Comment

A string to associate with the CompositionObject.

Equivalent WinUI property: Microsoft.UI.Composition.CompositionObject.Comment.

(Inherited from CompositionObject)
Compositor

The Compositor used to create this CompositionObject.

Equivalent WinUI property: Microsoft.UI.Composition.CompositionObject.Compositor.

(Inherited from CompositionObject)
DampingRatio

Gets or sets a value that indicates how much damping is applied to the spring.

Equivalent WinUI property: Microsoft.UI.Composition.SpringScalarNaturalMotionAnimation.DampingRatio.

DelayBehavior

The delay behavior of the NaturalMotionAnimation.

Equivalent WinUI property: Microsoft.UI.Composition.NaturalMotionAnimation.DelayBehavior.

(Inherited from NaturalMotionAnimation)
DelayTime

Delay before the animation starts after CompositionObject.StartAnimation is called.

Equivalent WinUI property: Microsoft.UI.Composition.NaturalMotionAnimation.DelayTime.

(Inherited from NaturalMotionAnimation)
Dispatcher

The dispatcher for the CompositionObject.

(Inherited from CompositionObject)
DispatcherQueue

Gets the DispatcherQueue for the CompostionObject.

Equivalent WinUI property: Microsoft.UI.Composition.CompositionObject.DispatcherQueue.

(Inherited from CompositionObject)
FinalValue

Gets or sets a value that indicates where the animation ends.

Equivalent WinUI property: Microsoft.UI.Composition.ScalarNaturalMotionAnimation.FinalValue.

(Inherited from ScalarNaturalMotionAnimation)
ImplicitAnimations

The collection of implicit animations attached to this object.

Equivalent WinUI property: Microsoft.UI.Composition.CompositionObject.ImplicitAnimations.

(Inherited from CompositionObject)
InitialValue

Gets or sets a value that indicates where the animation starts.

Equivalent WinUI property: Microsoft.UI.Composition.ScalarNaturalMotionAnimation.InitialValue.

(Inherited from ScalarNaturalMotionAnimation)
InitialValueExpressions

Gets the initial values for the animation.

Equivalent WinUI property: Microsoft.UI.Composition.CompositionAnimation.InitialValueExpressions.

(Inherited from CompositionAnimation)
InitialVelocity

Gets or sets the velocity that the animation starts with.

Equivalent WinUI property: Microsoft.UI.Composition.ScalarNaturalMotionAnimation.InitialVelocity.

(Inherited from ScalarNaturalMotionAnimation)
Period

Gets or sets the time for the Spring to complete a single oscillation.

Equivalent WinUI property: Microsoft.UI.Composition.SpringScalarNaturalMotionAnimation.Period.

Properties

The collection of properties associated with the CompositionObject.

Equivalent WinUI property: Microsoft.UI.Composition.CompositionObject.Properties.

(Inherited from CompositionObject)
StopBehavior

Specifies how to set the property value when StopAnimation is called.

Equivalent WinUI property: Microsoft.UI.Composition.NaturalMotionAnimation.StopBehavior.

(Inherited from NaturalMotionAnimation)
Target

The target of the animation.

Equivalent WinUI property: Microsoft.UI.Composition.CompositionAnimation.Target.

(Inherited from CompositionAnimation)

Methods

ClearAllParameters()

Clears all of the parameters of the animation.

Equivalent WinUI method: Microsoft.UI.Composition.CompositionAnimation.ClearAllParameters.

(Inherited from CompositionAnimation)
ClearParameter(String)

Clears a parameter from the animation.

Equivalent WinUI method: Microsoft.UI.Composition.CompositionAnimation.ClearParameter.

(Inherited from CompositionAnimation)
Close()

Closes the CompositionObject and releases system resources.

Equivalent WinUI method: Microsoft.UI.Composition.CompositionObject.Close.

(Inherited from CompositionObject)
ConnectAnimation(String, CompositionAnimation)

Connects and animation.

(Inherited from CompositionObject)
DisconnectAnimation(String)

Disconnects an animation.

(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.

Equivalent WinUI method: Microsoft.UI.Composition.CompositionObject.PopulatePropertyInfo.

(Inherited from CompositionObject)
SetBooleanParameter(String, Boolean)

Sets a boolean value parameter for use with an ExpressionAnimation or an expression keyframe.

Equivalent WinUI method: Microsoft.UI.Composition.CompositionAnimation.SetBooleanParameter.

(Inherited from CompositionAnimation)
SetColorParameter(String, Color)

Sets a Color value parameter for use with an ExpressionAnimation or an expression keyframe.

Equivalent WinUI method: Microsoft.UI.Composition.CompositionAnimation.SetColorParameter.

(Inherited from CompositionAnimation)
SetExpressionReferenceParameter(String, IAnimationObject)

Sets an IAnimationObject value parameter for use with an ExpressionAnimation or an expression keyframe.

Equivalent WinUI method: Microsoft.UI.Composition.CompositionAnimation.SetExpressionReferenceParameter.

(Inherited from CompositionAnimation)
SetMatrix3x2Parameter(String, Matrix3x2)

Sets a Matrix3x2 value parameter for use with an ExpressionAnimation or an expression keyframe.

Equivalent WinUI method: Microsoft.UI.Composition.CompositionAnimation.SetMatrix3x2Parameter.

(Inherited from CompositionAnimation)
SetMatrix4x4Parameter(String, Matrix4x4)

Sets a Matrix4x4 value parameter for use with an ExpressionAnimation or an expression keyframe.

Equivalent WinUI method: Microsoft.UI.Composition.CompositionAnimation.SetMatrix4x4Parameter.

(Inherited from CompositionAnimation)
SetQuaternionParameter(String, Quaternion)

Sets a Quaternion value for use with an ExpressionAnimation or an expression keyframe.

Equivalent WinUI method: Microsoft.UI.Composition.CompositionAnimation.SetQuaternionParameter.

(Inherited from CompositionAnimation)
SetReferenceParameter(String, CompositionObject)

Sets a reference to a Composition object for use with an ExpressionAnimation or an expression keyframe.

Equivalent WinUI method: Microsoft.UI.Composition.CompositionAnimation.SetReferenceParameter.

(Inherited from CompositionAnimation)
SetScalarParameter(String, Single)

Sets a Scalar value parameter for use with an ExpressionAnimation or an expression keyframe.

Equivalent WinUI method: Microsoft.UI.Composition.CompositionAnimation.SetScalarParameter.

(Inherited from CompositionAnimation)
SetVector2Parameter(String, Vector2)

Sets a Vector2 value parameter for use with an ExpressionAnimation or an expression keyframe.

Equivalent WinUI method: Microsoft.UI.Composition.CompositionAnimation.SetVector2Parameter.

(Inherited from CompositionAnimation)
SetVector3Parameter(String, Vector3)

Sets a Vector3 value parameter for use with an ExpressionAnimation or an expression keyframe.

Equivalent WinUI method: Microsoft.UI.Composition.CompositionAnimation.SetVector3Parameter.

(Inherited from CompositionAnimation)
SetVector4Parameter(String, Vector4)

Sets a Vector4 value parameter for use with an ExpressionAnimation or an expression keyframe.

Equivalent WinUI method: Microsoft.UI.Composition.CompositionAnimation.SetVector4Parameter.

(Inherited from CompositionAnimation)
StartAnimation(String, CompositionAnimation)

Connects an animation with the specified property of the object and starts the animation.

Equivalent WinUI method: Microsoft.UI.Composition.CompositionObject.StartAnimation.

(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.

Equivalent WinUI method: Microsoft.UI.Composition.CompositionObject.StartAnimationGroup.

(Inherited from CompositionObject)
StopAnimation(String)

Disconnects an animation from the specified property and stops the animation.

Equivalent WinUI method: Microsoft.UI.Composition.CompositionObject.StopAnimation.

(Inherited from CompositionObject)
StopAnimationGroup(ICompositionAnimationBase)

Stops an animation group.

Equivalent WinUI method: Microsoft.UI.Composition.CompositionObject.StopAnimationGroup.

(Inherited from CompositionObject)
TryGetAnimationController(String)

Returns an AnimationController for the animation running on the specified property.

Equivalent WinUI method: Microsoft.UI.Composition.CompositionObject.TryGetAnimationController.

(Inherited from CompositionObject)

Applies to