aboutsummaryrefslogtreecommitdiffstats
path: root/Software/Visual_Studio/Tango.RemoteDesktop/ScreenCaptureFrame.cs
blob: 75e7a961f4f48d4c3674f516eebdbc1bfe8a65b1 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
using System;
using System.Collections.Generic;
using System.Drawing;
using System.IO;
using System.Linq;
using System.Text;
using System.Threading.Tasks;
using System.Windows.Media.Imaging;
using Tango.RemoteDesktop.Frames;

namespace Tango.RemoteDesktop
{
    /// <summary>
    /// Represents a screen capture frame for holding the original bitmap and difference frame.
    /// </summary>
    /// <typeparam name="TFrame">The type of the frame.</typeparam>
    /// <seealso cref="Tango.RemoteDesktop.Frames.RasterFrame" />
    /// <seealso cref="System.IDisposable" />
    public class ScreenCaptureFrame<TFrame> : RasterFrame, IDisposable where TFrame : IFrame
    {
        private TFrame _diffFrame;

        /// <summary>
        /// Initializes a new instance of the <see cref="ScreenCaptureFrame{TFrame}"/> class.
        /// </summary>
        /// <param name="bitmap">The bitmap.</param>
        public ScreenCaptureFrame(Bitmap bitmap) : base(bitmap)
        {

        }

        /// <summary>
        /// Initializes a new instance of the <see cref="ScreenCaptureFrame{TFrame}"/> class.
        /// </summary>
        /// <param name="bitmap">The bitmap.</param>
        /// <param name="diffFrame">The difference frame.</param>
        public ScreenCaptureFrame(Bitmap bitmap, TFrame diffFrame) : this(bitmap)
        {
            _diffFrame = diffFrame;
        }

        /// <summary>
        /// Gets a value indicating whether a difference frame is available.
        /// </summary>
        public bool DifferenceAvailable
        {
            get { return _diffFrame != null; }
        }

        /// <summary>
        /// Gets or sets a value indicating whether the difference frame is available and contains any differences.
        /// </summary>
        private bool _hasDifference;
        public bool HasDifference
        {
            get
            {
                return DifferenceAvailable && _hasDifference;
            }
            set { _hasDifference = value; }
        }

        /// <summary>
        /// Returns the difference frame.
        /// </summary>
        /// <returns></returns>
        /// <exception cref="InvalidOperationException">No difference is available at this point. Please use the 'DifferenceAvailable' property before attempting to get the difference.</exception>
        public TFrame ToDifference()
        {
            if (!DifferenceAvailable)
            {
                throw new InvalidOperationException("No difference is available at this point. Please use the 'DifferenceAvailable' property before attempting to get the difference.");
            }

            return _diffFrame;
        }

        /// <summary>
        /// Releases unmanaged and - optionally - managed resources.
        /// </summary>
        public override void Dispose()
        {
            base.Dispose();

            if (_diffFrame != null)
            {
                _diffFrame.Dispose();
            }
        }
    }
}