kc3-lang/ftgl/include/FTFont.h

Branch : - branch - master - tag -

• Show log

  Commit

• Author : henry
  Date : 2002-01-25 22:48:45
  Hash : ba45ad6b
  Message : More comments

• include/FTFont.h

• #ifndef		__FTFont__
  #define		__FTFont__
  
  #include <string>
  
  #include <ft2build.h>
  #include FT_FREETYPE_H
  
  #include "FTGL.h"
  #include "FTFace.h"
  
  class FTGlyphContainer;
  class FTGlyph;
  
  using namespace std;
  
  
  /**
   * FTFont is the public interface for the FTGL library.
   *
   * Specific font classes are derived from this class. It uses the helper
   * classes FTFace and FTSize to access the Freetype library. This class
   * is abstract and deriving classes must implement the protected
   * <code>MakeGlyph</code> function to create glyphs of the
   * appropriate type.
   *
   * @see		FTFace
   * @see		FTSize
   * @see		FTGlyphContainer
   * @see		FTGlyph
   */
  class FTGL_EXPORT FTFont
  {
  	public:
  		/**
  		 * Default Constructor
  		 */
  		FTFont();
  		
  		/**
  		 * Destructor
  		 */
  		virtual ~FTFont();
  		
  		/**
  		 * Open and read a font file.
  		 *
  		 * @param fontname	font file name.
  		 * @param preCache	A flag to indicate whether or not to build
  		 * 					a complete set of glyphs at startup
  		 *					(<code>true</code>) or as required
  		 *					(<code>false</code>). Defaults to true.
  		 * @return			<code>true</code> if file has opened
  		 *					successfully.
  		 */
  		bool Open( const char* fontname, bool preCache = true);
  		
  		/**
  		 * Disposes of the font
  		 */
  		void Close();
  		
  		/**
  		 * Set the char size for the current face.
  		 *
  		 * @param size		the face size in points (1/72 inch)
  		 * @param res		the resolution of the target device.
  		 * @return			<code>true</code> if size was set correctly
  		 */
  		bool FaceSize( const unsigned int size, const unsigned int res = 72);
  		
  		/**
  		 * Set the extrusion distance for the font. Only availbale for
  		 * Extruded fonts
  		 *
  		 * @param d	 The extrusion distance.
  		 */
  		virtual void Depth( float d){}
  
  		
  		/**
  		 * Set the character map for the face.
  		 *
  		 * @param encoding		Freetype enumerate for char map code.
  		 * @return				<code>true</code> if charmap was valid and
  		 *						set correctly
  		 */
  		bool CharMap( FT_Encoding encoding );
  		
  		/**
  		 * Get the global ascender height for the face.
  		 *
  		 * @return	Ascender height
  		 */
  		int	Ascender() const;
  		
  		/**
  		 * Gets the global descender height for the face.
  		 *
  		 * @return	Descender height
  		 */
  		int	Descender() const;
  
  		/**
  		 * Get the bounding box for a string.
  		 *
  		 * @param string	a char string
  		 * @param llx		lower left near x coord
  		 * @param lly		lower left near y coord
  		 * @param llz		lower left near z coord
  		 * @param urx		upper right far x coord
  		 * @param ury		upper right far y coord
  		 * @param urz		upper right far z coord
  		 */
  		void BBox( const char* text, float& llx, float& lly, float& llz, float& urx, float& ury, float& urz);
  
  		/**
  		 * Get the bounding box for a string.
  		 *
  		 * @param string	a wchar_t string
  		 * @param llx		lower left near x coord
  		 * @param lly		lower left near y coord
  		 * @param llz		lower left near z coord
  		 * @param urx		upper right far x coord
  		 * @param ury		upper right far y coord
  		 * @param urz		upper right far z coord
  		 */
  		void BBox( const wchar_t* string, float& llx, float& lly, float& llz, float& urx, float& ury, float& urz);
  
  		/**
  		 * Get the advance width for a string.
  		 *
  		 * @param string	a wchar_t string
  		 * @return		advance width
  		 */
  		float Advance( const wchar_t* string);
  
  		/**
  		 * Get the advance width for a string.
  		 *
  		 * @param string	a char string
  		 * @return		advance width
  		 */
  		float Advance( const char* string);
  
  		/**
  		 * Render a string of characters
  		 * 
  		 * @param string	'C' style string to be output.	 
  		 */
  		virtual void render( const char* string );
  
  		/**
  		 * Render a string of characters
  		 * 
  		 * @param string	wchar_t string to be output.	 
  		 */
  		virtual void render( const wchar_t* string );
  
  		/**
  		 * Queries the Font for errors.
  		 *
  		 * @return	The current error code.
  		 */
  		FT_Error Error() const { return err;}
  
  
  	protected:
  		/**
  		 * Construct a glyph of the correct type.
  		 *
  		 * Clients must overide the function and return their specialised
  		 * FTGlyph.
  		 *
  		 * @param g	The glyph index NOT the char code.
  		 * @return	An FT****Glyph or <code>null</code> on failure.
  		 */
  		virtual FTGlyph* MakeGlyph( unsigned int g) = 0;
  		
  		/**
  		 * Construct the internal glyph cache.
  		 *
  		 * This a list of glyphs processed for openGL rendering NOT
  		 * freetype glyphs.
  		 *
  		 * @return	<code>true</code> on success.
  		 */
  		virtual bool MakeGlyphList();
  		
  		/**
  		 * Get the advance width for a character.
  		 *
  		 * @param chr		current character
  		 * @param nextChr	next character
  		 * @return			advance width
  		 */
  		float doAdvance( const unsigned int chr, const unsigned int nextChr);
  
  		/**
  		 * Render a character
  		 * 
  		 * @param chr		current character
  		 * @param nextChr	next character
  		 */
  		void doRender( const unsigned int chr, const unsigned int nextChr);
  		
  		/**
  		 * Current face object
  		 */
  		FTFace face;
  		
  		/**
  		 * Number of faces in this font
  		 */
  		unsigned int numFaces;
  		
  		/**
  		 * Current size object
  		 */
  		FTSize charSize;
  
  		/**
  		 * An object that holds a list of glyphs
  		 */
  		FTGlyphContainer*	glyphList;
  		
  		/**
  		 * The number of glyphs in this font
  		 */
  		unsigned int numGlyphs;
  		
  		/**
  		 * Have glyphs been pre-cached
  		 */
  		bool preCache;
  		
  		/**
  		 * Current pen or cursor position;
  		 */
  		FT_Vector pen;
  		
  		/**
  		 * Current error code. Zero means no error.
  		 */
  		FT_Error err;
  		
  	private:
  
  };
  
  
  #endif	//	__FTFont__