FTFont.h

Go to the documentation of this file.

/*
 * FTGL - OpenGL font library
 *
 * Copyright (c) 2001-2004 Henry Maddocks <ftgl@opengl.geek.nz>
 * Copyright (c) 2008 Sam Hocevar <sam@hocevar.net>
 * Copyright (c) 2008 Sean Morrison <learner@brlcad.org>
 *
 * 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.
 */
 
#ifndef __ftgl__
#   warning This header is deprecated. Please use <FTGL/ftgl.h> from now.
#   include <FTGL/ftgl.h>
#endif
 
#ifndef __FTFont__
#define __FTFont__
 
#ifdef __cplusplus
 
class FTFontImpl;
 
class FTGL_EXPORT FTFont
{
    protected:
        FTFont(char const *fontFilePath);
 
        FTFont(const unsigned char *pBufferBytes, size_t bufferSizeInBytes);
 
    private:
        /* Allow our internal subclasses to access the private constructor */
        friend class FTBitmapFont;
        friend class FTBufferFont;
        friend class FTExtrudeFont;
        friend class FTOutlineFont;
        friend class FTPixmapFont;
        friend class FTPolygonFont;
        friend class FTTextureFont;
        friend class FTTriangleExtractorFont;
 
        FTFont(FTFontImpl *pImpl);
 
    public:
        virtual ~FTFont();
 
        virtual bool Attach(const char* fontFilePath);
 
        virtual bool Attach(const unsigned char *pBufferBytes,
                            size_t bufferSizeInBytes);
 
        virtual void GlyphLoadFlags(FT_Int flags);
 
        virtual bool CharMap(FT_Encoding encoding);
 
        virtual unsigned int CharMapCount() const;
 
        virtual FT_Encoding* CharMapList();
 
        virtual bool FaceSize(const unsigned int size,
                              const unsigned int res = 72);
 
        virtual unsigned int FaceSize() const;
 
        virtual void Depth(float depth);
 
        virtual void Outset(float outset);
 
        virtual void Outset(float front, float back);
 
        virtual void UseDisplayList(bool useList);
 
        virtual float Ascender() const;
 
        virtual float Descender() const;
 
        virtual float LineHeight() const;
 
        virtual FTBBox BBox(const char *string, const int len = -1,
                            FTPoint position = FTPoint(),
                            FTPoint spacing = FTPoint());
 
        void BBox(const char* string, float& llx, float& lly, float& llz,
                  float& urx, float& ury, float& urz)
        {
            FTBBox b = BBox(string);
            llx = b.Lower().Xf(); lly = b.Lower().Yf(); llz = b.Lower().Zf();
            urx = b.Upper().Xf(); ury = b.Upper().Yf(); urz = b.Upper().Zf();
        }
 
        virtual FTBBox BBox(const wchar_t *string, const int len = -1,
                            FTPoint position = FTPoint(),
                            FTPoint spacing = FTPoint());
 
        void BBox(const wchar_t* string, float& llx, float& lly, float& llz,
                  float& urx, float& ury, float& urz)
        {
            FTBBox b = BBox(string);
            llx = b.Lower().Xf(); lly = b.Lower().Yf(); llz = b.Lower().Zf();
            urx = b.Upper().Xf(); ury = b.Upper().Yf(); urz = b.Upper().Zf();
        }
 
        virtual float Advance(const char* string, const int len = -1,
                              FTPoint spacing = FTPoint());
 
        virtual float Advance(const wchar_t* string, const int len = -1,
                              FTPoint spacing = FTPoint());
 
        virtual FTPoint Render(const char* string, const int len = -1,
                               FTPoint position = FTPoint(),
                               FTPoint spacing = FTPoint(),
                               int renderMode = FTGL::RENDER_ALL);
 
        virtual FTPoint Render(const wchar_t *string, const int len = -1,
                               FTPoint position = FTPoint(),
                               FTPoint spacing = FTPoint(),
                               int renderMode = FTGL::RENDER_ALL);
 
        virtual FT_Error Error() const;
 
    protected:
        /* Allow impl to access MakeGlyph */
        friend class FTFontImpl;
 
        virtual FTGlyph* MakeGlyph(FT_GlyphSlot slot) = 0;
 
    private:
        FTFontImpl *impl;
};
 
#endif //__cplusplus
 
FTGL_BEGIN_C_DECLS
 
struct _FTGLFont;
typedef struct _FTGLfont FTGLfont;
 
FTGL_EXPORT FTGLfont *ftglCreateCustomFont(char const *fontFilePath,
                                           void *data,
                   FTGLglyph * (*makeglyphCallback) (FT_GlyphSlot, void *));
 
FTGL_EXPORT FTGLfont *ftglCreateCustomFontFromMem(const unsigned char *bytes,
                                                  size_t len, void *data,
                   FTGLglyph * (*makeglyphCallback) (FT_GlyphSlot, void *));
 
FTGL_EXPORT void ftglDestroyFont(FTGLfont* font);
 
FTGL_EXPORT int ftglAttachFile(FTGLfont* font, const char* path);
 
FTGL_EXPORT int ftglAttachData(FTGLfont* font, const unsigned char * data,
                               size_t size);
 
FTGL_EXPORT void ftglSetFontGlyphLoadFlags(FTGLfont* font, FT_Int flags);
 
FTGL_EXPORT int ftglSetFontCharMap(FTGLfont* font, FT_Encoding encoding);
 
FTGL_EXPORT unsigned int ftglGetFontCharMapCount(FTGLfont* font);
 
FTGL_EXPORT FT_Encoding* ftglGetFontCharMapList(FTGLfont* font);
 
FTGL_EXPORT int ftglSetFontFaceSize(FTGLfont* font, unsigned int size,
                                    unsigned int res);
 
FTGL_EXPORT unsigned int ftglGetFontFaceSize(FTGLfont* font);
 
FTGL_EXPORT void ftglSetFontDepth(FTGLfont* font, float depth);
 
FTGL_EXPORT void ftglSetFontOutset(FTGLfont* font, float front, float back);
 
FTGL_EXPORT void ftglSetFontDisplayList(FTGLfont* font, int useList);
 
FTGL_EXPORT float ftglGetFontAscender(FTGLfont* font);
 
FTGL_EXPORT float ftglGetFontDescender(FTGLfont* font);
 
FTGL_EXPORT float ftglGetFontLineHeight(FTGLfont* font);
 
FTGL_EXPORT void ftglGetFontBBox(FTGLfont* font, const char *string,
                                 int len, float bounds[6]);
 
FTGL_EXPORT float ftglGetFontAdvance(FTGLfont* font, const char *string);
 
FTGL_EXPORT void ftglRenderFont(FTGLfont* font, const char *string, int mode);
 
FTGL_EXPORT FT_Error ftglGetFontError(FTGLfont* font);
 
FTGL_END_C_DECLS
 
#endif  //  __FTFont__