Scalar​Key​Frame​Animation Scalar​Key​Frame​Animation Scalar​Key​Frame​Animation Class

Definition

Namespace:
Windows.UI.Composition Windows.UI.Composition Windows.UI.Composition
Edit

A time-based animation that targets any Scalar-based property with one or more key frames.

public : sealed class ScalarKeyFrameAnimation : KeyFrameAnimation, IScalarKeyFrameAnimationpublic sealed class ScalarKeyFrameAnimation : KeyFrameAnimation, IScalarKeyFrameAnimationPublic NotInheritable Class ScalarKeyFrameAnimation Inherits KeyFrameAnimation Implements IScalarKeyFrameAnimation
Inheritance
CompositionObjectCompositionObjectCompositionObject
CompositionAnimationCompositionAnimationCompositionAnimation
KeyFrameAnimationKeyFrameAnimationKeyFrameAnimation
ScalarKeyFrameAnimationScalarKeyFrameAnimationScalarKeyFrameAnimation
Attributes
ContractVersionAttribute MarshalingBehaviorAttribute ThreadingAttribute WebHostHiddenAttribute
Windows 10 requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

Inherited Members

Inherited methods

ClearAllParametersClearAllParametersClearAllParameters
ClearParameter(String)ClearParameter(String)ClearParameter(String)
CloseCloseClose
InsertExpressionKeyFrame(Single,String)InsertExpressionKeyFrame(Single,String)InsertExpressionKeyFrame(Single,String)
InsertExpressionKeyFrame(Single,String,CompositionEasingFunction)InsertExpressionKeyFrame(Single,String,CompositionEasingFunction)InsertExpressionKeyFrame(Single,String,CompositionEasingFunction)
SetBooleanParameter(String,Boolean)SetBooleanParameter(String,Boolean)SetBooleanParameter(String,Boolean)
SetColorParameter(String,Color)SetColorParameter(String,Color)SetColorParameter(String,Color)
SetMatrix3x2Parameter(String,Matrix3x2)SetMatrix3x2Parameter(String,Matrix3x2)SetMatrix3x2Parameter(String,Matrix3x2)
SetMatrix4x4Parameter(String,Matrix4x4)SetMatrix4x4Parameter(String,Matrix4x4)SetMatrix4x4Parameter(String,Matrix4x4)
SetQuaternionParameter(String,Quaternion)SetQuaternionParameter(String,Quaternion)SetQuaternionParameter(String,Quaternion)
SetReferenceParameter(String,CompositionObject)SetReferenceParameter(String,CompositionObject)SetReferenceParameter(String,CompositionObject)
SetScalarParameter(String,Single)SetScalarParameter(String,Single)SetScalarParameter(String,Single)
SetVector2Parameter(String,Vector2)SetVector2Parameter(String,Vector2)SetVector2Parameter(String,Vector2)
SetVector3Parameter(String,Vector3)SetVector3Parameter(String,Vector3)SetVector3Parameter(String,Vector3)
SetVector4Parameter(String,Vector4)SetVector4Parameter(String,Vector4)SetVector4Parameter(String,Vector4)
StartAnimation(String,CompositionAnimation)StartAnimation(String,CompositionAnimation)StartAnimation(String,CompositionAnimation)
StartAnimationGroup(ICompositionAnimationBase)StartAnimationGroup(ICompositionAnimationBase)StartAnimationGroup(ICompositionAnimationBase)
StopAnimation(String)StopAnimation(String)StopAnimation(String)
StopAnimationGroup(ICompositionAnimationBase)StopAnimationGroup(ICompositionAnimationBase)StopAnimationGroup(ICompositionAnimationBase)

Inherited properties

CommentCommentComment
CompositorCompositorCompositor
DelayBehaviorDelayBehaviorDelayBehavior
DelayTimeDelayTimeDelayTime
DirectionDirectionDirection
DispatcherDispatcherDispatcher
DurationDurationDuration
ExpressionPropertiesExpressionPropertiesExpressionProperties
ImplicitAnimationsImplicitAnimationsImplicitAnimations
IterationBehaviorIterationBehaviorIterationBehavior
IterationCountIterationCountIterationCount
KeyFrameCountKeyFrameCountKeyFrameCount
PropertiesPropertiesProperties
StopBehaviorStopBehaviorStopBehavior
TargetTargetTarget

Remarks

An animation is associated with an object's property by calling CompositionObject::StartAnimation and specifying the property name and the animation. See the remarks section of CompositionObject::StartAnimation for a list of animatable properties.

Methods

InsertKeyFrame(Single, Single) InsertKeyFrame(Single, Single) InsertKeyFrame(Single, Single)

Edit

Inserts a key frame.

public : void InsertKeyFrame(float normalizedProgressKey, float value)public void InsertKeyFrame(Single normalizedProgressKey, Single value)Public Function InsertKeyFrame(normalizedProgressKey As Single, value As Single) As void
Parameters
normalizedProgressKey
float Single Single

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
float Single Single

The value of the key frame.

Attributes
OverloadAttribute
See Also
InsertKeyFrame(Single, Single, CompositionEasingFunction)InsertKeyFrame(Single, Single, CompositionEasingFunction)InsertKeyFrame(Single, Single, CompositionEasingFunction)

InsertKeyFrame(Single, Single, CompositionEasingFunction) InsertKeyFrame(Single, Single, CompositionEasingFunction) InsertKeyFrame(Single, Single, CompositionEasingFunction)

Edit

Inserts a keyframe.

public : void InsertKeyFrame(float normalizedProgressKey, float value, CompositionEasingFunction easingFunction)public void InsertKeyFrame(Single normalizedProgressKey, Single value, CompositionEasingFunction easingFunction)Public Function InsertKeyFrame(normalizedProgressKey As Single, value As Single, easingFunction As CompositionEasingFunction) As void
Parameters
normalizedProgressKey
float Single Single

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
float Single Single

The value of the key frame.

easingFunction
CompositionEasingFunction CompositionEasingFunction CompositionEasingFunction

The easing function to use to interpolate between key frames.

Attributes
OverloadAttribute
See Also
InsertKeyFrame(Single, Single)InsertKeyFrame(Single, Single)InsertKeyFrame(Single, Single)

See Also