EffectAnimation<TEffect,TValue,TKeyFrame> Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
A custom animation targeting a property on an IPipelineEffect instance.
public abstract class EffectAnimation<TEffect,TValue,TKeyFrame> : Microsoft.Toolkit.Uwp.UI.Animations.Animation<TValue,TKeyFrame> where TEffect : class, IPipelineEffect where TKeyFrame : structtype EffectAnimation<'Effect, 'Value, 'KeyFrame (requires 'Effect : null and 'Effect :> IPipelineEffect and 'KeyFrame : struct)> = class
inherit Animation<'Value, 'KeyFrame (requires 'KeyFrame : struct)>Public MustInherit Class EffectAnimation(Of TEffect, TValue, TKeyFrame)
Inherits Animation(Of TValue, TKeyFrame)Type Parameters
- TEffect
The type of effect to animate.
- TValue
The type to use for the public To and From
properties. This can differ from TKeyFrame to facilitate XAML parsing.
- TKeyFrame
The actual type of keyframe values in use.
- Inheritance
-
Windows.UI.Xaml.DependencyObjectEffectAnimation<TEffect,TValue,TKeyFrame>
- Derived
Constructors
| EffectAnimation<TEffect,TValue,TKeyFrame>() |
Fields
| TargetProperty |
Identifies the dependency property. |
Properties
| Delay |
Gets or sets the optional initial delay for the animation. (Inherited from Animation) |
| DelayBehavior |
Gets or sets the delay behavior for the animation. The default value is set to Windows.UI.Composition.AnimationDelayBehavior.SetInitialValueBeforeDelay. This value is applicable when the current animation is used as either an implicit composition animation, or an explicit composition animation. If the current animation is instead running on the XAML layer (if used through CustomAnimation<TValue,TKeyFrame>), it will be ignored. (Inherited from Animation) |
| Duration |
Gets or sets the animation duration. (Inherited from Animation) |
| EasingMode |
Gets or sets the optional easing function mode for the animation. (Inherited from Animation) |
| EasingType |
Gets or sets the optional easing function type for the animation. (Inherited from Animation) |
| ExplicitTarget |
Gets the explicit target for the animation. This is the primary target property that is animated. (Inherited from Animation<TValue,TKeyFrame>) |
| From |
Gets or sets the optional starting value for the animation. (Inherited from Animation<TValue,TKeyFrame>) |
| KeyFrames |
Gets or sets the optional keyframe collection for the current animation. Setting this will overwrite the To and From values. (Inherited from Animation<TValue,TKeyFrame>) |
| Repeat |
Gets or sets the repeat option for the animation. (Inherited from Animation) |
| Target |
Gets or sets the linked |
| To |
Gets or sets the final value for the animation. (Inherited from Animation<TValue,TKeyFrame>) |
Methods
| AppendToBuilder(AnimationBuilder, Nullable<TimeSpan>, Nullable<TimeSpan>, Nullable<EasingType>, Nullable<EasingMode>) | |
| AppendToBuilder(INormalizedKeyFrameAnimationBuilder<TKeyFrame>, Nullable<EasingType>, Nullable<EasingMode>) |
Appends the current keyframe values to a target INormalizedKeyFrameAnimationBuilder<T> instance. This method will also automatically generate keyframes for To and From. (Inherited from Animation<TValue,TKeyFrame>) |
| GetParsedValues() |
Gets the parsed |