//
// BasePaintBrush.cs
//  
// Author:
//       Aaron Bockover <abockover@novell.com>
// 
// Copyright (c) 2010 Novell, Inc.
// 
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
// 
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
// 
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
// THE SOFTWARE.

using System;
using Cairo;

namespace Pinta.Core;

/// <summary>
/// The base class for all brushes.
/// </summary>
[Mono.Addins.TypeExtensionPoint]
public abstract class BasePaintBrush
{
	/// <summary>
	/// The name of the brush.
	/// </summary>
	public abstract string Name { get; }

	/// <summary>
	/// Priority value for ordering brushes. If the priority is zero, then
	/// alphabetical ordering is used.
	/// </summary>
	public virtual int Priority => 0;

	/// <summary>
	/// Used to multiply the alpha value of the stroke color by a
	/// constant factor.
	/// </summary>
	public virtual double StrokeAlphaMultiplier => 1;

	/// <summary>
	/// If nonzero, brush will be reapplied after given amount of
	/// milliseconds.
	/// </summary>
	public virtual uint MillisecondsBeforeReapply => 0;

	public void DoMouseUp ()
	{
		OnMouseUp ();
	}

	public void DoMouseDown ()
	{
		OnMouseDown ();
	}

	public RectangleI DoMouseMove (
		Context g,
		ImageSurface surface,
		BrushStrokeArgs strokeArgs)
	{
		return OnMouseMove (g, surface, strokeArgs);
	}

	/// <summary>
	/// Event handler called when the mouse is released.
	/// </summary>
	protected virtual void OnMouseUp ()
	{
	}

	/// <summary>
	/// Event handler called when the mouse is pressed down.
	/// </summary>
	protected virtual void OnMouseDown ()
	{
	}

	/// <summary>
	/// Event handler called when the mouse is moved. This method is where
	/// the brush should perform its drawing.
	/// </summary>
	/// <param name="g">The current Cairo drawing context.</param>
	/// <param name="surface">Image surface to draw on.</param>
	/// <param name="strokeArgs">Information about the current stroke and mouse movement.</param>
	/// <returns>A rectangle containing the area of the canvas that should be redrawn.</returns>
	protected abstract RectangleI OnMouseMove (
		Context g,
		ImageSurface surface,
		BrushStrokeArgs strokeArgs);
}
