// -----------------------------------------------------------------------
// <copyright file="AnimationExtensions.cs" company="Steven Kirk">
// Copyright 2014 MIT Licence. See licence.md for more information.
// </copyright>
// -----------------------------------------------------------------------

namespace Perspex.Animation
{
    using System;

    /// <summary>
    /// Defines animation extension methods.
    /// </summary>
    public static class AnimationExtensions
    {
        /// <summary>
        /// Returns a new <see cref="PropertyTransition"/> for the specified
        /// <see cref="PerspexProperty"/> using linear easing.
        /// </summary>
        /// <typeparam name="T">The type of the <see cref="PerspexProperty"/>.</typeparam>
        /// <param name="property">The property to animate.</param>
        /// <param name="milliseconds">The animation duration in milliseconds.</param>
        /// <returns>
        /// A <see cref="PropertyTransition"/> that can be added to the
        /// <see cref="Animatable.PropertyTransitions"/> collection.
        /// </returns>
        public static PropertyTransition Transition<T>(this PerspexProperty<T> property, int milliseconds)
        {
            return Transition(property, TimeSpan.FromMilliseconds(milliseconds));
        }

        /// <summary>
        /// Returns a new <see cref="PropertyTransition"/> for the specified
        /// <see cref="PerspexProperty"/> using linear easing.
        /// </summary>
        /// <typeparam name="T">The type of the <see cref="PerspexProperty"/>.</typeparam>
        /// <param name="property">The property to animate.</param>
        /// <param name="duration">The animation duration.</param>
        /// <returns>
        /// A <see cref="PropertyTransition"/> that can be added to the
        /// <see cref="Animatable.PropertyTransitions"/> collection.
        /// </returns>
        public static PropertyTransition Transition<T>(this PerspexProperty<T> property, TimeSpan duration)
        {
            return new PropertyTransition(property, duration, LinearEasing.For<T>());
        }
    }
}