death-socket/DeathSocket/GridPainter.fs

namespace DeathSocket

    open System.IO

    /// Provides functions which help draw gridded overlays onto images.
    /// Grid Painter, and all of Death Socket, uses the System.Drawing brushes/colours.
    /// If you are using System.Media brushes and colour, you will need to convert them.
    module GridPainter =

        open Validation
        open ImageServices

        /// <summary>
        /// Uses the information included in spec and creates a gridded image.
        /// It then asynchronously saves it.
        /// Please stick to .bmp, .jpg or .png files.
        /// The others (image) file types have not been tested.
        /// </summary>
        /// <param name="spec">
        /// The specification used to generate the new gridded image
        /// </param>
        /// <exeption cref="System.IO.FileNotFoundException">
        /// If the file the grid is being applied to cannot be found,
        /// a FileNotFoundException will be thrown.
        /// </exception>
        /// <remarks
        /// Make sure the image, which is having the overlay added to it,
        /// is not in use or needed by another program/process.
        /// This is because it is locked whilst in this function.
        /// </remarks>
        let applyGridAsync spec =
            async {
                try
                    validateFilePath |> ignore
                    drawGrid spec |> ignore
                with
                | :? FileNotFoundException as ex ->
                        printfn "File could not be found at %s" ex.Message
            }

        /// <summary>
        /// Determines the (Pen) points needed to draw the appropriate number of horizontal lines (I.E. rows). 
        /// Each item in the array includes a start and end co-ordinate (point) for each line.
        /// </summary>
        /// <param name="width">The width of the image.</param>
        /// <param name="height">The height of the image.</param>
        /// <param name="rows">The number of rows the grid should have.</param>
        /// <remarks>You will probably only need these when dealing with GUI's.</remarks>
        let determineHorizontalLines width height rows =
            createHorizontalLines width height rows

        /// <summary>
        /// Determines the (Pen) points needed to draw the appropriate number of vertical lines (I.E. columns).
        /// Each item in the array includes a start and end co-ordinate (point) for each line.
        /// </summary>
        /// <param name="width">The width of the image.</param>
        /// <param name="height">The height of the image.</param>
        /// <param name="columns">The number of columns the grid should have.</param>
        /// <remarks>You will probably only need these when dealing with GUI's.</remarks>
        let determineVerticalLines width height columns =
            createVerticalLines width height columns