gzFont.h

Go to the documentation of this file.

//*****************************************************************************
// File         : gzFont.h
// Module       : 
// Description  : Class definition of the gzFont class
// Author       : Anders Modén      
// Product      : Gizmo3D 2.1.1
//      
// Copyright © 2003- Saab Training Systems AB, Sweden
//          
// NOTE:    Gizmo3D is a high performance 3D Scene Graph and effect visualisation 
//          C++ toolkit for Linux, Mac OS X, Windows (Win32) and IRIX® for  
//          usage in Game or VisSim development.
//
//
// Revision History...                          
//                                  
// Who  Date    Description                     
//                                  
// AMO  001016  Created file    
//
//******************************************************************************
#ifndef __GZ_FONT_H__
#define __GZ_FONT_H__

#include "gzObject.h"
#include "gzDisplayList.h"

const gzString  GZ_FONT_DEFAULT_NAME        =   "courier";
const gzInt     GZ_FONT_DEFAULT_COUNT       =   256;
const gzInt     GZ_FONT_DEFAULT_HEIGHT      =   11;
const gzInt     GZ_FONT_DEFAULT_WIDTH       =   0;

// Built in fonts

#define GZ_FONT_ARIAL_24            "arial",256,24,0,FALSE,FALSE,FALSE,FALSE,TRUE
#define GZ_FONT_ARIAL_24_UNDERLINE  "arial",256,24,0,FALSE,FALSE,TRUE,FALSE,TRUE
#define GZ_FONT_ARIAL_24_BOLD       "arial",256,24,0,FALSE,TRUE,FALSE,FALSE,TRUE
#define GZ_FONT_ARIAL_24_ITALIC     "arial",256,24,0,TRUE,FALSE,FALSE,FALSE,TRUE

#define GZ_FONT_DOM_CASUAL_24       "dom casual",256,24,0,FALSE,FALSE,FALSE,FALSE,TRUE
#define GZ_FONT_SYMBOL_24           "symbol",256,24,0,FALSE,FALSE,FALSE,FALSE,TRUE
#define GZ_FONT_PALACE_SRIPT_24     "palace script mt",256,24,0,FALSE,FALSE,FALSE,FALSE,TRUE

class GZ_GRAPH_EXPORT gzFontInfo 
{
public:

    gzFontInfo( const gzString &    fontName        = GZ_FONT_DEFAULT_NAME , 
                const gzUShort      characterCount  = GZ_FONT_DEFAULT_COUNT,
                const gzInt         genericHeight   = GZ_FONT_DEFAULT_HEIGHT,
                const gzInt         genericWidth    = GZ_FONT_DEFAULT_WIDTH,
                gzBool              italic          = FALSE,
                gzBool              bold            = FALSE,
                gzBool              underline       = FALSE,
                gzBool              strikeout       = FALSE,
                gzBool              antialias       = FALSE ); 

    gzBool operator ==(const gzFontInfo &) const;

    gzULong hash() const ;

    //--- public attributes -------------------

    gzString    fontName;
    gzUShort    characterCount;
    gzInt       genericHeight;
    gzInt       genericWidth;
    gzInt       completeHeight;

    gzBool      italic;
    gzBool      bold;
    gzBool      underline;
    gzBool      strikeout;
    gzBool      antialias;
};

class GZ_GRAPH_EXPORT gzGlyphInfo 
{
public:

    gzGlyphInfo(gzFloat sizeX=0,gzFloat sizeY=0,gzFloat offsetX=0,gzFloat offsetY=0,gzFloat stepX=0,gzFloat stepY=0,gzFloat originX=0,gzFloat originY=0);

    gzFloat size_x;
    gzFloat size_y;

    gzFloat offset_x;
    gzFloat offset_y;

    gzFloat step_x;
    gzFloat step_y;

    gzFloat origin_x;
    gzFloat origin_y;
};


//******************************************************************************
// Class    : gzFont
//                                  
// Purpose  : -
//                                  
// Notes    : - 
//                                  
// Revision History...                          
//                                  
// Who  Date    Description                     
//                                  
// AMO  001016  Created 
//                                  
//******************************************************************************
class gzFont : public gzObject , public gzNameInterface
{
public:
    GZ_DECLARE_TYPE_INTERFACE_EXPORT(GZ_GRAPH_EXPORT);  // typed interface

    GZ_GRAPH_EXPORT gzFont( const gzFontInfo & fontInfo=gzFontInfo() , gzBool createFromSystem=TRUE);

    GZ_GRAPH_EXPORT virtual ~gzFont();

    // ---------- Clone interface ---------------------------------------
    GZ_GRAPH_EXPORT virtual gzReference* clone() const;
    GZ_GRAPH_EXPORT virtual gzBool  useDeepCopy();

    // ---------- Font interface ----------------------------------------

    GZ_GRAPH_EXPORT virtual gzVoid renderChar( gzContext *context , gzUShort index,gzFloat x,gzFloat y,gzFloat z);

    GZ_GRAPH_EXPORT virtual gzVoid beginRenderText(gzContext *context);

    GZ_GRAPH_EXPORT virtual gzVoid endRenderText(gzContext *context);

    GZ_GRAPH_EXPORT gzVec2      getSize( gzUShort index );

    GZ_GRAPH_EXPORT gzVec2      getStep( gzUShort index );

    GZ_GRAPH_EXPORT gzUShort    getCharacterCount();

    GZ_GRAPH_EXPORT gzFloat     getRowHeight();

    GZ_GRAPH_EXPORT gzFloat     getBaseOffset();

    GZ_GRAPH_EXPORT gzFontInfo  getFontInfo();

    GZ_GRAPH_EXPORT gzVoid      disposeImageData();

    // ---------- Global fonts ------------------------------------------

    GZ_GRAPH_EXPORT static gzFont *getFont( const gzFontInfo & fontInfo=gzFontInfo() , gzBool useBuiltIn=TRUE);

    GZ_GRAPH_EXPORT static gzVoid setFont(  const gzFontInfo & fontInfo , gzFont *font);

    GZ_GRAPH_EXPORT static gzVoid clearFontDictionary();

    // ---------- Serializing -------------------------------------------

    GZ_GRAPH_EXPORT virtual gzVoid  write(gzSerializeAdapter *adapter);
    GZ_GRAPH_EXPORT virtual gzVoid  read(gzSerializeAdapter *adapter);
    GZ_GRAPH_EXPORT virtual gzULong getDataSize(gzSerializeAdapter *adapter=NULL) const;

    // ---------- properties --------------------------------------------

    GZ_PROPERTY_EXPORT(gzTexturePtr,    FontTexture,    GZ_GRAPH_EXPORT);

protected:

    gzArray<gzGlyphInfo>                        m_fontItems;

    gzFontInfo                                  m_fontInfo;

    gzULong                                     m_texWidth;

    gzULong                                     m_texHeight;

    gzFloat                                     m_baseOffset;
    
private:

    static gzRefDict<gzFontInfo,gzFont>         s_fontDictionary;
    
};


#endif

---