/*
* Greenshot - a free and open source screenshot tool
* Copyright (C) 2007-2013 Thomas Braun, Jens Klingen, Robin Krom
*
* For more information see: http://getgreenshot.org/
* The Greenshot project is hosted on Sourceforge: http://sourceforge.net/projects/greenshot/
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 1 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see .
*/
using GreenshotPlugin.UnmanagedHelpers;
using System;
using System.Windows.Forms;
namespace GreenshotPlugin.Controls
{
///
/// Extend this Form to have the possibility for animations on your form
///
public class AnimatingForm : GreenshotForm
{
private const int DEFAULT_VREFRESH = 60;
private int vRefresh = 0;
private Timer timer = null;
///
/// This flag specifies if any animation is used
///
protected bool EnableAnimation
{
get;
set;
}
///
/// Vertical Refresh Rate
///
protected int VRefresh
{
get
{
if (vRefresh == 0)
{
// get te hDC of the desktop to get the VREFRESH
using (SafeWindowDCHandle desktopHandle = SafeWindowDCHandle.fromDesktop())
{
vRefresh = GDI32.GetDeviceCaps(desktopHandle, DeviceCaps.VREFRESH);
}
}
// A vertical refresh rate value of 0 or 1 represents the display hardware's default refresh rate.
// As there is currently no know way to get the default, we guess it.
if (vRefresh <= 1)
{
vRefresh = DEFAULT_VREFRESH;
}
return vRefresh;
}
}
///
/// Check if we are in a Terminal Server session OR need to optimize for RDP / remote desktop connections
///
protected bool isTerminalServerSession
{
get
{
return coreConfiguration.OptimizeForRDP || SystemInformation.TerminalServerSession;
}
}
///
/// Calculate the amount of frames that an animation takes
///
///
/// Number of frames, 1 if in Terminal Server Session
protected int FramesForMillis(int milliseconds)
{
// If we are in a Terminal Server Session we return 1
if (isTerminalServerSession)
{
return 1;
}
return milliseconds / VRefresh;
}
///
/// Initialize the animation
///
protected AnimatingForm()
{
Load += delegate
{
if (EnableAnimation)
{
timer = new Timer();
timer.Interval = 1000 / VRefresh;
timer.Tick += timer_Tick;
timer.Start();
}
};
// Unregister at close
FormClosing += delegate
{
if (timer != null)
{
timer.Stop();
}
};
}
///
/// The tick handler initiates the animation.
///
///
///
private void timer_Tick(object sender, EventArgs e)
{
Animate();
}
///
/// This method will be called every frame, so implement your animation/redraw logic here.
///
protected virtual void Animate()
{
throw new NotImplementedException();
}
}
}