RGB.NET/RGB.NET.Core/Positioning/IPlaceable.cs

// ReSharper disable EventNeverSubscribedTo.Global

using System;

namespace RGB.NET.Core;

/// <summary>
/// Represents a generic placeable element.
/// </summary>
public interface IPlaceable
{
    #region Properties & Fields

    /// <summary>
    /// Gets or sets the location of the <see cref="IPlaceable"/>.
    /// </summary>
    Point Location { get; set; }

    /// <summary>
    /// Gets the size of the <see cref="IPlaceable"/>.
    /// </summary>
    Size Size { get; set; }

    /// <summary>
    /// Gets or sets the scale of the <see cref="IPlaceable"/>.
    /// </summary>
    Scale Scale { get; set; }

    /// <summary>
    /// Gets or sets the rotation of the <see cref="IPlaceable"/>.
    /// </summary>
    Rotation Rotation { get; set; }

    /// <summary>
    /// Gets  the actual location of the <see cref="IPlaceable"/>.
    /// This includes the <see cref="Rotation"/>.
    /// </summary>
    Point ActualLocation { get; }

    /// <summary>
    /// Gets the actual <see cref="Size"/> of the <see cref="IPlaceable"/>.
    /// This includes the <see cref="Scale"/>.
    /// </summary>
    Size ActualSize { get; }

    /// <summary>
    /// Gets a rectangle containing the whole <see cref="IPlaceable"/>.
    /// This includes <see cref="Location"/>, <see cref="Size"/>, <see cref="Scale"/> and <see cref="Rotation"/>.
    /// </summary>
    Rectangle Boundary { get; }

    #endregion

    #region Events

    /// <summary>
    /// Occurs when the <see cref="Location"/> property was changed.
    /// </summary>
    event EventHandler<EventArgs> LocationChanged;

    /// <summary>
    /// Occurs when the <see cref="Size"/> property was changed.
    /// </summary>
    event EventHandler<EventArgs> SizeChanged;

    /// <summary>
    /// Occurs when the <see cref="Scale"/> property was changed.
    /// </summary>
    event EventHandler<EventArgs> ScaleChanged;

    /// <summary>
    /// Occurs when the <see cref="Rotation"/> property was changed.
    /// </summary>
    event EventHandler<EventArgs> RotationChanged;

    /// <summary>
    /// Occurs when the <see cref="ActualLocation"/> property was changed.
    /// </summary>
    event EventHandler<EventArgs> ActualLocationChanged;

    /// <summary>
    /// Occurs when the <see cref="ActualSize"/> property was changed.
    /// </summary>
    event EventHandler<EventArgs> ActualSizeChanged;

    /// <summary>
    /// Occurs when the <see cref="Boundary"/> property was changed.
    /// </summary>
    event EventHandler<EventArgs> BoundaryChanged;

    #endregion
}