|
// Licensed to the .NET Foundation under one or more agreements.
// The .NET Foundation licenses this file to you under the MIT license.
// See the LICENSE file in the project root for more information.
// This file was generated, please do not edit it directly.
//
// This file was generated from the codegen template located at:
// wpf\src\Graphics\codegen\mcg\generators\AnimatableTemplate.cs
//
// Please see MilCodeGen.html for more information.
// Allow suppression of certain presharp messages
#pragma warning disable 1634, 1691
namespace System.Windows.Media.Animation
{
/// <summary>
/// This class derives from Freezable and adds the ability to animate properties.
/// </summary>
public abstract partial class Animatable : IAnimatable
{
#region IAnimatable
/// <summary>
/// Applies an AnimationClock to a DepencencyProperty which will
/// replace the current animations on the property using the snapshot
/// and replace HandoffBehavior.
/// </summary>
/// <param name="dp">
/// The DependencyProperty to animate.
/// </param>
/// <param name="clock">
/// The AnimationClock that will animate the property. If this is null
/// then all animations will be removed from the property.
/// </param>
public void ApplyAnimationClock(
DependencyProperty dp,
AnimationClock clock)
{
ApplyAnimationClock(dp, clock, HandoffBehavior.SnapshotAndReplace);
}
/// <summary>
/// Applies an AnimationClock to a DependencyProperty. The effect of
/// the new AnimationClock on any current animations will be determined by
/// the value of the handoffBehavior parameter.
/// </summary>
/// <param name="dp">
/// The DependencyProperty to animate.
/// </param>
/// <param name="clock">
/// The AnimationClock that will animate the property. If parameter is null
/// then animations will be removed from the property if handoffBehavior is
/// SnapshotAndReplace; otherwise the method call will have no result.
/// </param>
/// <param name="handoffBehavior">
/// Determines how the new AnimationClock will transition from or
/// affect any current animations on the property.
/// </param>
public void ApplyAnimationClock(
DependencyProperty dp,
AnimationClock clock,
HandoffBehavior handoffBehavior)
{
ArgumentNullException.ThrowIfNull(dp);
if (!AnimationStorage.IsPropertyAnimatable(this, dp))
{
#pragma warning disable 56506 // Suppress presharp warning: Parameter 'dp' to this public method must be validated: A null-dereference can occur here.
throw new ArgumentException(SR.Format(SR.Animation_DependencyPropertyIsNotAnimatable, dp.Name, this.GetType()), "dp");
#pragma warning restore 56506
}
if (clock != null
&& !AnimationStorage.IsAnimationValid(dp, clock.Timeline))
{
#pragma warning disable 56506 // Suppress presharp warning: Parameter 'dp' to this public method must be validated: A null-dereference can occur here.
throw new ArgumentException(SR.Format(SR.Animation_AnimationTimelineTypeMismatch, clock.Timeline.GetType(), dp.Name, dp.PropertyType), "clock");
#pragma warning restore 56506
}
if (!HandoffBehaviorEnum.IsDefined(handoffBehavior))
{
throw new ArgumentException(SR.Animation_UnrecognizedHandoffBehavior);
}
if (IsSealed)
{
throw new InvalidOperationException(SR.Format(SR.IAnimatable_CantAnimateSealedDO, dp, this.GetType()));
}
AnimationStorage.ApplyAnimationClock(this, dp, clock, handoffBehavior);
}
/// <summary>
/// Starts an animation for a DependencyProperty. The animation will
/// begin when the next frame is rendered.
/// </summary>
/// <param name="dp">
/// The DependencyProperty to animate.
/// </param>
/// <param name="animation">
/// <para>The AnimationTimeline to used to animate the property.</para>
/// <para>If the AnimationTimeline's BeginTime is null, any current animations
/// will be removed and the current value of the property will be held.</para>
/// <para>If this value is null, all animations will be removed from the property
/// and the property value will revert back to its base value.</para>
/// </param>
public void BeginAnimation(DependencyProperty dp, AnimationTimeline animation)
{
BeginAnimation(dp, animation, HandoffBehavior.SnapshotAndReplace);
}
/// <summary>
/// Starts an animation for a DependencyProperty. The animation will
/// begin when the next frame is rendered.
/// </summary>
/// <param name="dp">
/// The DependencyProperty to animate.
/// </param>
/// <param name="animation">
/// <para>The AnimationTimeline to used to animate the property.</para>
/// <para>If the AnimationTimeline's BeginTime is null, any current animations
/// will be removed and the current value of the property will be held.</para>
/// <para>If this value is null, all animations will be removed from the property
/// and the property value will revert back to its base value.</para>
/// </param>
/// <param name="handoffBehavior">
/// Specifies how the new animation should interact with any current
/// animations already affecting the property value.
/// </param>
public void BeginAnimation(DependencyProperty dp, AnimationTimeline animation, HandoffBehavior handoffBehavior)
{
ArgumentNullException.ThrowIfNull(dp);
if (!AnimationStorage.IsPropertyAnimatable(this, dp))
{
#pragma warning disable 56506 // Suppress presharp warning: Parameter 'dp' to this public method must be validated: A null-dereference can occur here.
throw new ArgumentException(SR.Format(SR.Animation_DependencyPropertyIsNotAnimatable, dp.Name, this.GetType()), "dp");
#pragma warning restore 56506
}
if ( animation != null
&& !AnimationStorage.IsAnimationValid(dp, animation))
{
throw new ArgumentException(SR.Format(SR.Animation_AnimationTimelineTypeMismatch, animation.GetType(), dp.Name, dp.PropertyType), "animation");
}
if (!HandoffBehaviorEnum.IsDefined(handoffBehavior))
{
throw new ArgumentException(SR.Animation_UnrecognizedHandoffBehavior);
}
if (IsSealed)
{
throw new InvalidOperationException(SR.Format(SR.IAnimatable_CantAnimateSealedDO, dp, this.GetType()));
}
AnimationStorage.BeginAnimation(this, dp, animation, handoffBehavior);
}
/// <summary>
/// Returns true if any properties on this DependencyObject have a
/// persistent animation or the object has one or more clocks associated
/// with any of its properties.
/// </summary>
public bool HasAnimatedProperties
{
get
{
VerifyAccess();
return IAnimatable_HasAnimatedProperties;
}
}
/// <summary>
/// If the dependency property is animated this method will
/// give you the value as if it was not animated.
/// </summary>
/// <param name="dp">The DependencyProperty</param>
/// <returns>
/// The value that would be returned if there were no
/// animations attached. If there aren't any attached, then
/// the result will be the same as that returned from
/// GetValue.
/// </returns>
public object GetAnimationBaseValue(DependencyProperty dp)
{
ArgumentNullException.ThrowIfNull(dp);
return this.GetValueEntry(
LookupEntry(dp.GlobalIndex),
dp,
null,
RequestFlags.AnimationBaseValue).Value;
}
#endregion IAnimatable
#region Animation
/// <summary>
/// Allows subclasses to participate in property animated value computation
/// </summary>
/// <param name="dp"></param>
/// <param name="metadata"></param>
/// <param name="entry">EffectiveValueEntry computed by base</param>
internal sealed override void EvaluateAnimatedValueCore(
DependencyProperty dp,
PropertyMetadata metadata,
ref EffectiveValueEntry entry)
{
if (IAnimatable_HasAnimatedProperties)
{
AnimationStorage storage = AnimationStorage.GetStorage(this, dp);
if (storage != null)
{
storage.EvaluateAnimatedValue(metadata, ref entry);
}
}
}
#endregion Animation
}
}
|