RE/RE_OGLBitmapFont.h

Go to the documentation of this file.

/*
 * PROPRIETARY INFORMATION.  This software is proprietary to
 * Side Effects Software Inc., and is not to be reproduced,
 * transmitted, or disclosed in any way without written permission.
 *
 * Produced by:
 *      Side Effects Software Inc
 *      123 Front Street West, Suite 1401
 *      Toronto, Ontario
 *      Canada   M5J 2M2
 *      416-504-9876
 *
 * NAME:        RE_OGLBitmapFont.h (RE Library, C++)
 *
 * COMMENTS:
 *      This class is the owner and renderer of bitmap fonts - that is, fonts
 *      which are rendered by calling glBitmap. This is as opposed to texture
 *      fonts, which are rendered by making textured quads.
 */

#ifndef __RE_OGLBitmapFont__
#define __RE_OGLBitmapFont__

#include "RE_API.h"
#include "RE_OGLFont.h"

class RE_OGLFontCache;
class RE_OGLBitmapFontGlyph;
class RE_Render;

class RE_API RE_OGLBitmapFont : public RE_OGLFont
{
public:

     RE_OGLBitmapFont(const char *name, float size, RE_OGLFontCache *cache);

    ~RE_OGLBitmapFont();

    /// These three are overridden from RE_Font. See RE_Font for a description.
    virtual void                 render(RE_Render *r, const char *s);
    virtual int                  getCharWidth(char c, char /* prev */);
    virtual int                  getStringWidth(const char *s);

protected:

    /// Overridden from RE_Font. See RE_Font for a description.
    virtual void                 loadFont();

    /// Overridden from RE_OGLFont. See RE_OGLFont for a description.
    virtual void                 genDisplayLists(RE_Render *r);

private: // functions

    /// Load the font named name (of the form basename.size, eg Screen.10) 
    /// and initialize this object using it. Returns true on success, false
    /// otherwise.
    bool                         loadFontFromFile(const char *name);

    // Helper functions for loadFont() - binary font files.
    /// Given an open file pointer to a binary font file, reads a file and
    /// initializes this font object. Returns the number of glyphs in the
    /// font, or 0 if none were found or an error occurred.
    int                          readBinaryFont(FILE *fp);

    /// Load the rasters from a binary font file. The file must already
    /// be at the rasters' position. n is the number of shorts to read,
    /// aka the raster size.
    /// Returns a pointer to the raster data, which the caller must free.
    unsigned short              *loadBinRasters(int n, FILE *fp);

    /// Load the characters from a binary font file. The file must already
    /// be at the character's position. nglyphs is the number of glyphs to
    /// load.
    /// Returns a pointer to the font character array, which the caller
    /// must free.
    RE_OGLBitmapFontGlyph       *loadBinFontchars(int nglyphs, FILE *fp);

    // Helper functions for loadFont() - text font files.
    /// Given an open file pointer to a text font file, reads a file and
    /// initializes this font object. Returns the number of glyphs in the
    /// font, or 0 if none were found or an error occurred.
    /// Also pass in the filename, for error reporting.
    int                          readTextFont(FILE *fp, const char *filename);

    /// Load the rasters from a text font file. The file must already
    /// be at the rasters' position. n is the number of shorts to read,
    /// aka the raster size.
    /// Also pass in the current line number and filename, for error reporting.
    /// Returns a pointer to the raster data, which the caller must free.
    unsigned short              *loadTextRasters(int n, FILE *fp, int *linep, 
                                                 const char *filename);

    /// Load the characters from a text font file. The file must already
    /// be at the character's position. nglyphs is the number of glyphs to
    /// load.
    /// Also pass in the current line number and filename, for error reporting.
    /// Returns a pointer to the font character array, which the caller
    /// must free.
    RE_OGLBitmapFontGlyph       *loadTextFontchars(int nglyphs, FILE *fp,
                                                   int *linep,
                                                   const char *filename);

private: // variables

    /// The information (width, height, etc) about every glyph in the font.
    RE_OGLBitmapFontGlyph       *myFontStats;

    /// The rasterized font. Font glyphs store their index into this array.
    unsigned short              *myFontRasters;

    /// The directory where all bitmap fonts are stored.
    static UT_String             ourFontDirectory;
};

#endif

---