kc3-lang/ftgl/include/FTGlyph.h

• Show log

  Commit

• Hash : 141112c4
  Author :
  Date : 2008-04-12T22:44:48
  

  * Add licensing information to all files in the library.

Download

• include/FTGlyph.h

• /*
   * FTGL - OpenGL font library
   *
   * Copyright (c) 2001-2004 Henry Maddocks <ftgl@opengl.geek.nz>
   *
   * 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.
   *
   * Alternatively, you can redistribute and/or modify this software under
   * the terms of the GNU Lesser General Public License as published by
   * the Free Software Foundation; either version 2.1 of the License,
   * or (at your option) any later version.
   *
   * You should have received a copy of the GNU Lesser General Public
   * License along with this software; if not, write to the Free Software
   * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA.
   */
  
  #ifndef     __FTGlyph__
  #define     __FTGlyph__
  
  #include <ft2build.h>
  #include FT_FREETYPE_H
  #include FT_GLYPH_H
  
  #include "FTBBox.h"
  #include "FTPoint.h"
  #include "FTGL.h"
  
  
  /**
   * FTGlyph is the base class for FTGL glyphs.
   *
   * It provides the interface between Freetype glyphs and their openGL
   * renderable counterparts. This is an abstract class and derived classes
   * must implement the <code>render</code> function. 
   * 
   * @see FTGlyphContainer
   * @see FTBBox
   * @see FTPoint
   *
   */
  class FTGL_EXPORT FTGlyph
  {
      public:
          /**
           * Constructor
           *
           * @param glyph The Freetype glyph to be processed
           * @param useDisplayList Enable or disable the use of Display Lists for this glyph
           *                       <code>true</code> turns ON display lists.
           *                       <code>false</code> turns OFF display lists.
           */
          FTGlyph( FT_GlyphSlot glyph, bool useDisplayList = true);
  
          /**
           * Destructor
           */
          virtual ~FTGlyph();
  
          /**
           * Renders this glyph at the current pen position.
           *
           * @param pen   The current pen position.
           * @return      The advance distance for this glyph.
           */
          virtual const FTPoint& Render( const FTPoint& pen) = 0;
          
          /**
           * Return the advance width for this glyph.
           *
           * @return  advance width.
           */
          const FTPoint& Advance() const { return advance;}
          
          /**
           * Return the bounding box for this glyph.
           *
           * @return  bounding box.
           */
          const FTBBox& BBox() const { return bBox;}
          
          /**
           * Queries for errors.
           *
           * @return  The current error code.
           */
          FT_Error Error() const { return err;}
          
      protected:
          /**
           * The advance distance for this glyph
           */
          FTPoint advance;
  
          /**
           * The bounding box of this glyph.
           */
          FTBBox bBox;
          
          /**
           * Flag to enable or disable the use of Display Lists inside FTGL
           * <code>true</code> turns ON display lists.
           * <code>false</code> turns OFF display lists.
           */
          bool useDisplayList;
          
          /**
           * Current error code. Zero means no error.
           */
          FT_Error err;
          
      private:
  
  };
  
  
  #endif  //  __FTGlyph__
  
  

Download