source: branches/HeuristicLab.Problems.GaussianProcessTuning/ILNumerics.2.14.4735.573/Drawing/Interfaces/IILTextRenderer.cs @ 11826

///
///    This file is part of ILNumerics Community Edition.
///
///    ILNumerics Community Edition - high performance computing for applications.
///    Copyright (C) 2006 - 2012 Haymo Kutschbach, http://ilnumerics.net
///
///    ILNumerics Community Edition is free software: you can redistribute it and/or modify
///    it under the terms of the GNU General Public License version 3 as published by
///    the Free Software Foundation.
///
///    ILNumerics Community Edition 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 ILNumerics Community Edition. See the file License.txt in the root
///    of your distribution package. If not, see <http://www.gnu.org/licenses/>.
///
///    In addition this software uses the following components and/or licenses: 
///
///    =================================================================================
///    The Open Toolkit Library License
///    
///    Copyright (c) 2006 - 2009 the Open Toolkit library.
///    
///    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.
///
///    =================================================================================
///    

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

namespace ILNumerics.Drawing.Interfaces {
    /// <summary>
    /// interface for all classes capable of renderung (device 
    /// dependend) texts into plot panels 
    /// </summary>
    /// <remarks>class definitions should also implement the ILRendererAttribute. See <see cref="ILNumerics.Drawing.Platform.OpenGL.ILOGLRenderer"/> for an example.</remarks>
    /// <seealso cref="ILNumerics.Drawing.Platform.OpenGL.ILOGLRenderer"/>
    public interface IILTextRenderer {
        /// <summary>
        /// The name of the TextRenderer instance (implementation dependent)
        /// </summary>
        string Name { get; }
        /// <summary>
        /// A more descriptive name to be displayed into GUI's (implementation dependent)
        /// </summary>
        string NameLong { get; } 
        /// <summary>
        /// Get the graphics device type this TextRenderer instance 
        /// is capable to use for drawing 
        /// </summary>
        GraphicDeviceType DeviceType { get; }
        /// <summary>
        /// Determine, if the text is to be drawn after the rendering 
        /// backbuffer has been swapped and presented to the screen. (implementation dependent)
        /// </summary>
        bool DrawAfterBufferSwapped { get; } 
        /// <summary>
        /// Determine, if this renderer chaches the output (implementation dependent) 
        /// </summary>
        bool Cached { get; }
        /// <summary>
        /// Determine the coord system this renderer is specialized to draw in
        /// </summary>
        CoordSystem CoordSystem { get; }
        /// <summary>
        /// begins drawing, to be called before Draw()!
        /// </summary>
        /// <param name="p">extended render properties</param>
        void Begin (ILRenderProperties p);
        /// <summary>
        /// begins drawing and queries current model view matrix also
        /// </summary>
        /// <param name="p">extended render properties</param>
        /// <param name="modelview">current modelviewmatrix</param>
        void Begin (ILRenderProperties p, ref double[] modelview);
        /// <summary>
        /// Draw the text (screen coords)
        /// </summary>
        /// <param name="renderQueue">contains items to be drawn</param>
        /// <param name="position">position relative to surface, starting point for drawing</param>
        /// <param name="orientation">orientation for item</param>
        /// <param name="color">initial or default color</param>
        /// <remarks>
        ///   <para>Before calling Draw(), the TextRenderer must have been initialized with Begin(g)!</para>
        ///   <para>use this function if drawing in screen coords, the size for render
        /// output will be taken from the Size member of the render queue (pixels).</para>
        /// </remarks>
        /// <exception cref="InvalidOperationException">on attempt to draw any text without previous initialization</exception>
        void Draw (ILRenderQueue renderQueue, System.Drawing.Point position, TextOrientation orientation, Color color); 
        /// <summary>
        /// Draws the text in world coords 
        /// </summary>
        /// <param name="renderQueue">contains items to be drawn</param>
        /// <param name="x1">x1-position</param>
        /// <param name="y1">y1-position</param>
        /// <param name="z1">z1-position</param>
        /// <param name="x2">x2-position</param>
        /// <param name="y2">y2-position</param>
        /// <param name="z2">z2-position</param>
        /// <param name="color">base color for items not containing individual colors</param>
        /// <remarks>
        /// <para>Before calling Draw(), the TextRenderer must have been initialized with Begin(g)!</para>
        /// <para>Use this function to draw the render queue in world coords. The position parameters mark the upper left 
        /// and lower right corner of the quads to contain the render queue content.</para>
        /// </remarks>
        /// <exception cref="InvalidOperationException">on attempt to draw any text without previous initialization</exception>
        void Draw (ILRenderQueue renderQueue, float x1, float y1, float z1, float x2, float y2, float z2, Color color); 
        /// <summary>
        /// finalizes the drawing (must prepare it again before drawing!)
        /// </summary>
        void End(ILRenderProperties p); 
        /// <summary>
        /// Cache single item into the renderer cache. 
        /// </summary>
        /// <param name="key">key used to uniquely identify the item in cache</param>
        /// <param name="bmp">item bitmap data</param>
        /// <param name="rect">section in bmp to be transfered into the cache</param>
        void Cache(string key, Bitmap bmp, RectangleF rect); 
        /// <summary>
        /// test if an item for a specific key is already cached
        /// </summary>
        /// <param name="key"></param>
        /// <returns></returns>
        bool ExistsKey(string key); 
        /// <summary>
        /// test if the key exists and return the size of corresponding item on success
        /// </summary>
        /// <param name="key">key identifying the item</param>
        /// <param name="size">if the key was found: the size of the corresponding item</param>
        /// <returns>true, if the key exist, false otherwise</returns>
        bool TryGetSize(string key, ref Size size);
        /// <summary>
        /// if set to a color (not Color.Empty), that color will be used for all renderings. 
        /// The color contained in the rendering queue is ignored than.
        /// </summary>
        Color ColorOverride {
            get;
            set; 
        }

        /// <summary>
        /// for cached renderers, fires if the internal cache was cleared
        /// </summary>
        event EventHandler CacheCleared; 

    }
}