Opentk/Source/Utilities/Graphics/TextExtents.cs

#region License
//
// The Open Toolkit Library License
//
// Copyright (c) 2006 - 2008 the Open Toolkit library, except where noted.
//
// 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.
//
#endregion

using System;
using System.Collections.Generic;
using System.Text;
using System.Drawing;

namespace OpenTK.Graphics
{
    /// <summary>
    /// Holds the results of a text measurement.
    /// </summary>
    public class TextExtents : IDisposable
    {
        #region Fields

        protected RectangleF text_extents;
        protected List<RectangleF> glyph_extents = new List<RectangleF>();

        public static readonly TextExtents Empty = new TextExtents();

        #endregion

        #region Constructors

        internal TextExtents()
        {
        }

        #endregion

        #region Public Members

        /// <summary>
        /// Gets the bounding box of the measured text.
        /// </summary>
        public RectangleF BoundingBox
        {
            get { return text_extents; }
            internal set { text_extents = value; }
        }

        /// <summary>
        /// Gets the extents of each glyph in the measured text.
        /// </summary>
        /// <param name="i">The index of the glyph.</param>
        /// <returns>The extents of the specified glyph.</returns>
        public RectangleF this[int i]
        {
            get { return glyph_extents[i]; }
            internal set { glyph_extents[i] = value; }
        }

        /// <summary>
        /// Gets the extents of each glyph in the measured text.
        /// </summary>
        public IEnumerable<RectangleF> GlyphExtents
        {
            get { return (IEnumerable<RectangleF>)glyph_extents; }
        }

        /// <summary>
        /// Gets the number of the measured glyphs.
        /// </summary>
        public int Count
        {
            get { return glyph_extents.Count; }
        }

        #endregion

        #region Internal Members

        internal void Add(RectangleF glyphExtent)
        {
            glyph_extents.Add(glyphExtent);
        }

        internal void AddRange(IEnumerable<RectangleF> glyphExtents)
        {
            glyph_extents.AddRange(glyphExtents);
        }

        internal void Clear()
        {
            BoundingBox = RectangleF.Empty;
            glyph_extents.Clear();
        }

        internal TextExtents Clone()
        {
            TextExtents extents = new TextExtents();
            extents.glyph_extents.AddRange(GlyphExtents);
            extents.BoundingBox = BoundingBox;
            return extents;
        }

        #endregion

        #region IDisposable Members

        /// <summary>
        /// Frees the resources consumed by this TextExtents instance.
        /// </summary>
        public virtual void Dispose()
        {
        }

        #endregion
    }
}