StepEasingFunction StepEasingFunction StepEasingFunction StepEasingFunction Class

Definition

A step function for interpolating between animation key frames.

Advances animations in increments like steps which can be can be defined. Behaviors for initial and final steps can be customized.

public : sealed class StepEasingFunction : CompositionEasingFunction
struct winrt::Windows::UI::Composition::StepEasingFunction : CompositionEasingFunction
public sealed class StepEasingFunction : CompositionEasingFunction
Public NotInheritable Class StepEasingFunction Inherits CompositionEasingFunction
Inheritance
StepEasingFunctionStepEasingFunctionStepEasingFunctionStepEasingFunction
Attributes

Windows 10 requirements

Device family
Windows 10 Anniversary Edition (introduced v10.0.14393.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v3)

Examples


class StepsEasing 
{ 
  StepsEasing(Compositor compositor, SpriteVisual heroVisual) 
  { 
    // This step function makes the property offset change in 5 steps  
    // i.e. goes from (0,0,0) à (20,20,20) in 5 steps. 
    StepEasingFunction steps = compositor.CreateStepEasingFunction(5); 

    Vector3KeyFrameAnimation animation = compositor.CreateVector3KeyFrameAnimation(); 
    animation.InsertKeyFrame(0f, new Vector3(0f,0f,0f)); 
    animation.InsertKeyFrame(1f, new Vector3(20f,20f,0f), steps); 
    animation.Duration = TimeSpan.FromSeconds(2); 

    heroVisual.StartAnimation("Offset", animation); 
  } 
} 
         

Remarks

The step easing function gives more flexibility for animations to advance in increments. Increments are defined using StepCount property. Steps can be customized using InitialStep, and FinalStep. Behavior for initial step can be customized using IsInitialStepSingleFrame and final step using IsFinalStepSingleFrame.

Properties

Comment Comment Comment Comment

A string to associate with the CompositionObject.

(Inherited from CompositionObject)
Compositor Compositor Compositor Compositor

The Compositor used to create this CompositionObject.

(Inherited from CompositionObject)
Dispatcher Dispatcher Dispatcher Dispatcher

The dispatcher for the CompositionObject.

(Inherited from CompositionObject)
DispatcherQueue DispatcherQueue DispatcherQueue DispatcherQueue

Gets the DispatcherQueue for the CompostionObject.

(Inherited from CompositionObject)
FinalStep FinalStep FinalStep FinalStep

The step to end at.

ImplicitAnimations ImplicitAnimations ImplicitAnimations ImplicitAnimations

The collection of implicit animations attached to this object.

(Inherited from CompositionObject)
InitialStep InitialStep InitialStep InitialStep

The step to start at.

IsFinalStepSingleFrame IsFinalStepSingleFrame IsFinalStepSingleFrame IsFinalStepSingleFrame

Indicates whether the final step should last the smallest possible duration.

IsInitialStepSingleFrame IsInitialStepSingleFrame IsInitialStepSingleFrame IsInitialStepSingleFrame

Indicates whether the initial step should last the smallest possible duration.

Properties Properties Properties Properties

The collection of properties associated with the CompositionObject.

(Inherited from CompositionObject)
StepCount StepCount StepCount StepCount

The number of steps between the starting value and the end value.

Methods

Close Close Close Close

Closes the CompositionObject and releases system resources.

(Inherited from CompositionObject)
PopulatePropertyInfo(String,AnimationPropertyInfo) PopulatePropertyInfo(String,AnimationPropertyInfo) PopulatePropertyInfo(String,AnimationPropertyInfo) PopulatePropertyInfo(String,AnimationPropertyInfo)

Defines a property that can be animated.

(Inherited from CompositionObject)
StartAnimation(String,CompositionAnimation) StartAnimation(String,CompositionAnimation) StartAnimation(String,CompositionAnimation) StartAnimation(String,CompositionAnimation)

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

(Inherited from CompositionObject)
StartAnimationGroup(ICompositionAnimationBase) StartAnimationGroup(ICompositionAnimationBase) StartAnimationGroup(ICompositionAnimationBase) 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)
StartAnimationGroupWithIAnimationObject(IAnimationObject,ICompositionAnimationBase) StartAnimationGroupWithIAnimationObject(IAnimationObject,ICompositionAnimationBase) StartAnimationGroupWithIAnimationObject(IAnimationObject,ICompositionAnimationBase) StartAnimationGroupWithIAnimationObject(IAnimationObject,ICompositionAnimationBase)

Starts an animation group on the specified target.

(Inherited from CompositionObject)
StartAnimationWithIAnimationObject(IAnimationObject,String,CompositionAnimation) StartAnimationWithIAnimationObject(IAnimationObject,String,CompositionAnimation) StartAnimationWithIAnimationObject(IAnimationObject,String,CompositionAnimation) StartAnimationWithIAnimationObject(IAnimationObject,String,CompositionAnimation)

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

(Inherited from CompositionObject)
StopAnimation(String) StopAnimation(String) StopAnimation(String) StopAnimation(String)

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

(Inherited from CompositionObject)
StopAnimationGroup(ICompositionAnimationBase) StopAnimationGroup(ICompositionAnimationBase) StopAnimationGroup(ICompositionAnimationBase) StopAnimationGroup(ICompositionAnimationBase)

Stops an animation group.

(Inherited from CompositionObject)
TryGetAnimationController(String) TryGetAnimationController(String) TryGetAnimationController(String) TryGetAnimationController(String)

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

(Inherited from CompositionObject)

See also