Avalonia/src/Avalonia.Animation/Animation.cs

// Copyright (c) The Avalonia Project. All rights reserved.
// Licensed under the MIT license. See licence.md file in the project root for full license information.

using System;

namespace Avalonia.Animation
{
    /// <summary>
    /// Tracks the progress of an animation.
    /// </summary>
    public class Animation : IObservable<object>, IDisposable
    {
        /// <summary>
        /// The animation being tracked.
        /// </summary>
        private readonly IObservable<object> _inner;

        /// <summary>
        /// The disposable used to cancel the animation.
        /// </summary>
        private readonly IDisposable _subscription;

        /// <summary>
        /// Initializes a new instance of the <see cref="Animation"/> class.
        /// </summary>
        /// <param name="inner">The animation observable being tracked.</param>
        /// <param name="subscription">A disposable used to cancel the animation.</param>
        public Animation(IObservable<object> inner, IDisposable subscription)
        {
            _inner = inner;
            _subscription = subscription;
        }

        /// <summary>
        /// Cancels the animation.
        /// </summary>
        public void Dispose()
        {
            _subscription.Dispose();
        }

        /// <summary>
        /// Notifies the provider that an observer is to receive notifications.
        /// </summary>
        /// <param name="observer">The observer.</param>
        /// <returns>
        /// A reference to an interface that allows observers to stop receiving notifications
        /// before the provider has finished sending them.
        /// </returns>
        public IDisposable Subscribe(IObserver<object> observer)
        {
            return _inner.Subscribe(observer);
        }
    }
}