MeVis/Foundation/Sources/MLOpenGL/mlGL2DFont.h

Go to the documentation of this file.

//----------------------------------------------------------------------------------
// **InsertLicense** code
//----------------------------------------------------------------------------------

//----------------------------------------------------------------------------------
#ifndef __mlGL2DFont_H
#define __mlGL2DFont_H

#ifndef __mlOpenGLSystem_H
#include "mlOpenGLSystem.h"
#endif

#include "mlGLResources.h"
#include <string>

class FTFont;

ML_OPENGL_START_NAMESPACE

//-----------------------------------------------------------------------------
//-----------------------------------------------------------------------------
class MLOPENGL_EXPORT GL2DFont : public GLResource {

public:
  GL2DFont();
  ~GL2DFont();

  // currently the maximum internal font number is hardwired
  enum {
    MAX_FONTS = 32
  };

  //---------------------------------------------------------------------------
  //---------------------------------------------------------------------------
  bool   init();

  //---------------------------------------------------------------------------
  //---------------------------------------------------------------------------
  bool   init(const char* fontname);

  //---------------------------------------------------------------------------
  //---------------------------------------------------------------------------
  bool   init(const char* fontname,
              const int numFonts, const int* sizes);

  //---------------------------------------------------------------------------
  //---------------------------------------------------------------------------
  void   drawString(const float dx, const float dy,
                    const float fontSize, const float color[4],
                    const char* string, const size_t length = 0,
                    const bool overlay=false, const bool shadow=true);

  //---------------------------------------------------------------------------
  //---------------------------------------------------------------------------
  int    getStringWidth(const float fontSize,
                        const char* string, const size_t length) const;

  //---------------------------------------------------------------------------
  //---------------------------------------------------------------------------
  int    getFontHeight(const float fontSize) const;

  //---------------------------------------------------------------------------
  //---------------------------------------------------------------------------
  int    getFontAscender(const float fontSize) const;

  //---------------------------------------------------------------------------
  //---------------------------------------------------------------------------
  int    getFontDescender(const float fontSize) const;

  //---------------------------------------------------------------------------
  //---------------------------------------------------------------------------
  bool   isInitialized() const { return _init; };

  //---------------------------------------------------------------------------
  //---------------------------------------------------------------------------
  bool   isUnicodeRenderingPossible() const { return _unicodeRendering; };

  //---------------------------------------------------------------------------
  //---------------------------------------------------------------------------
  static GL2DFont* getDefaultSystemFont();

  //---------------------------------------------------------------------------
  //---------------------------------------------------------------------------
  virtual void contextDestroyed();

  //---------------------------------------------------------------------------
  //---------------------------------------------------------------------------
  bool debugFontRenderingEnabled();

  //---------------------------------------------------------------------------
  //---------------------------------------------------------------------------
  static std::string getDefaultSystemFontName();

protected:
  //---------------------------------------------------------------------------
  //---------------------------------------------------------------------------
  int    getFontIndex(const float fontSize) const;

  //---------------------------------------------------------------------------
  //---------------------------------------------------------------------------
  void   cleanup();

  //---------------------------------------------------------------------------
  //---------------------------------------------------------------------------
  bool   reloadFonts();

  //---------------------------------------------------------------------------
  //---------------------------------------------------------------------------
  void   preFontDraw(const bool overlay);

  //---------------------------------------------------------------------------
  //---------------------------------------------------------------------------
  void   doFontDraw(const float dx, const float dy,
                    const float fontSize, const float color[4],
                    const bool shadow, const char* asciiString, const wchar_t* optionalUnicodeString);

  //---------------------------------------------------------------------------
  //---------------------------------------------------------------------------
  void   postFontDraw(const bool overlay);

  //---------------------------------------------------------------------------
  //---------------------------------------------------------------------------
  bool   checkUTF8StringForUnicodeChars(const char* string, size_t length = 0) const;

  //---------------------------------------------------------------------------
  //---------------------------------------------------------------------------
  const char* copyAndConvertString(const char* string, size_t length, const wchar_t** optionalUnicodeString) const;

private:
  std::string _fontfile;

  std::string _fallback;

  int         _numFonts;

  FTFont*     _font[MAX_FONTS];

  float       _fontSize[MAX_FONTS];

  bool        _init;

  bool        _unicodeRendering;

  static GL2DFont* _defaultSystemFont;
};

ML_OPENGL_END_NAMESPACE
#endif