ScalarKeyFrameAnimation ScalarKeyFrameAnimation ScalarKeyFrameAnimation Class

Definition

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

public : sealed class ScalarKeyFrameAnimation : KeyFrameAnimation, IScalarKeyFrameAnimation
public sealed class ScalarKeyFrameAnimation : KeyFrameAnimation, IScalarKeyFrameAnimation
Public NotInheritable Class ScalarKeyFrameAnimation Inherits KeyFrameAnimation Implements IScalarKeyFrameAnimation
Inheritance
Attributes
Windows 10 requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

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

ClearAllParameters ClearAllParameters ClearAllParameters

Inherited from CompositionAnimation

ClearParameter(String) ClearParameter(String) ClearParameter(String)

Inherited from CompositionAnimation

Close Close Close

Inherited from CompositionObject

InsertExpressionKeyFrame(Single,String) InsertExpressionKeyFrame(Single,String) InsertExpressionKeyFrame(Single,String)

Inherited from KeyFrameAnimation

InsertExpressionKeyFrame(Single,String,CompositionEasingFunction) InsertExpressionKeyFrame(Single,String,CompositionEasingFunction) InsertExpressionKeyFrame(Single,String,CompositionEasingFunction)

Inherited from KeyFrameAnimation

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

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.

See Also

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

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.

See Also

SetBooleanParameter(String,Boolean) SetBooleanParameter(String,Boolean) SetBooleanParameter(String,Boolean)

Inherited from CompositionAnimation

SetColorParameter(String,Color) SetColorParameter(String,Color) SetColorParameter(String,Color)

Inherited from CompositionAnimation

SetMatrix3x2Parameter(String,Matrix3x2) SetMatrix3x2Parameter(String,Matrix3x2) SetMatrix3x2Parameter(String,Matrix3x2)

Inherited from CompositionAnimation

SetMatrix4x4Parameter(String,Matrix4x4) SetMatrix4x4Parameter(String,Matrix4x4) SetMatrix4x4Parameter(String,Matrix4x4)

Inherited from CompositionAnimation

SetQuaternionParameter(String,Quaternion) SetQuaternionParameter(String,Quaternion) SetQuaternionParameter(String,Quaternion)

Inherited from CompositionAnimation

SetReferenceParameter(String,CompositionObject) SetReferenceParameter(String,CompositionObject) SetReferenceParameter(String,CompositionObject)

Inherited from CompositionAnimation

SetScalarParameter(String,Single) SetScalarParameter(String,Single) SetScalarParameter(String,Single)

Inherited from CompositionAnimation

SetVector2Parameter(String,Vector2) SetVector2Parameter(String,Vector2) SetVector2Parameter(String,Vector2)

Inherited from CompositionAnimation

SetVector3Parameter(String,Vector3) SetVector3Parameter(String,Vector3) SetVector3Parameter(String,Vector3)

Inherited from CompositionAnimation

SetVector4Parameter(String,Vector4) SetVector4Parameter(String,Vector4) SetVector4Parameter(String,Vector4)

Inherited from CompositionAnimation

StartAnimation(String,CompositionAnimation) StartAnimation(String,CompositionAnimation) StartAnimation(String,CompositionAnimation)

Inherited from CompositionObject

StartAnimationGroup(ICompositionAnimationBase) StartAnimationGroup(ICompositionAnimationBase) StartAnimationGroup(ICompositionAnimationBase)

Inherited from CompositionObject

StopAnimation(String) StopAnimation(String) StopAnimation(String)

Inherited from CompositionObject

StopAnimationGroup(ICompositionAnimationBase) StopAnimationGroup(ICompositionAnimationBase) StopAnimationGroup(ICompositionAnimationBase)

Inherited from CompositionObject

Properties

Comment Comment Comment

Inherited from CompositionObject

Compositor Compositor Compositor

Inherited from CompositionObject

DelayBehavior DelayBehavior DelayBehavior

Inherited from KeyFrameAnimation

DelayTime DelayTime DelayTime

Inherited from KeyFrameAnimation

Direction Direction Direction

Inherited from KeyFrameAnimation

Dispatcher Dispatcher Dispatcher

Inherited from CompositionObject

DispatcherQueue DispatcherQueue DispatcherQueue

Inherited from CompositionObject

Duration Duration Duration

Inherited from KeyFrameAnimation

ImplicitAnimations ImplicitAnimations ImplicitAnimations

Inherited from CompositionObject

InitialValueExpressions InitialValueExpressions InitialValueExpressions

Inherited from CompositionAnimation

IterationBehavior IterationBehavior IterationBehavior

Inherited from KeyFrameAnimation

IterationCount IterationCount IterationCount

Inherited from KeyFrameAnimation

KeyFrameCount KeyFrameCount KeyFrameCount

Inherited from KeyFrameAnimation

Properties Properties Properties

Inherited from CompositionObject

StopBehavior StopBehavior StopBehavior

Inherited from KeyFrameAnimation

Target Target Target

Inherited from CompositionAnimation

See Also