deFont Class Reference

Text Font class. More...

#include <deFont.h>

Inheritance diagram for deFont:
deFileResource deResource deObject

List of all members.

Public Member Functions

Constructors and Destructors
 deFont (deFontManager *manager, const char *filename)
 Creates a new font object with the given resource manager and filename.
 ~deFont ()
 Cleans up the font.
Management
int GetLineHeight () const
 Retrieves the height of a line of text.
void SetLineHeight (int lineHeight)
 Sets the height of a line of text.
bool GetIsColorFont () const
 Determines if this is a color font that can not be tinted.
void SetIsColorFont (bool colorFont)
 Sets if this is a color font that can not be tinted.
int GetFontWidth () const
 Retrieves the width of the font glyphs.
void UpdateGlyphs ()
 Update the glyphs.
bool Verify ()
 Verify the settings of the font object.
deFontGlyphGetGlyph (int code) const
 Retrieves the glyph for the given code.
const char * GetImagePath () const
 Retrieves the path to the image if existing.
void SetImagePath (const char *imagePath)
 Sets the path to the image if existing.
deImageGetImage () const
 Retrieves the image object if existing.
void SetImage (deImage *image)
 Sets the image object or NULL if not used.
System Peers
deBaseGraphicFontGetGraphicFont () const
 Retrieves the graphic system peer.
void SetGraphicFont (deBaseGraphicFont *font)
 Sets the graphic system peer.

Detailed Description

Text Font class.

Provides support for fonts to be used in guis or 3d rendering. Fonts are based on skins and hence are bitmap fonts.

Author:
Plüss Roland
Version:
1.0
Date:
2008

Constructor & Destructor Documentation

deFont::deFont ( deFontManager manager,
const char *  filename 
)

Creates a new font object with the given resource manager and filename.

deFont::~deFont (  )

Cleans up the font.


Member Function Documentation

int deFont::GetFontWidth (  ) const [inline]

Retrieves the width of the font glyphs.

deFontGlyph* deFont::GetGlyph ( int  code ) const

Retrieves the glyph for the given code.

The code is supposed to be an UTF8 code in the range of 0 to 255 inclusive.

deBaseGraphicFont* deFont::GetGraphicFont (  ) const [inline]

Retrieves the graphic system peer.

deImage* deFont::GetImage (  ) const [inline]

Retrieves the image object if existing.

const char* deFont::GetImagePath (  ) const [inline]

Retrieves the path to the image if existing.

bool deFont::GetIsColorFont (  ) const [inline]

Determines if this is a color font that can not be tinted.

int deFont::GetLineHeight (  ) const [inline]

Retrieves the height of a line of text.

void deFont::SetGraphicFont ( deBaseGraphicFont font )

Sets the graphic system peer.

void deFont::SetImage ( deImage image )

Sets the image object or NULL if not used.

void deFont::SetImagePath ( const char *  imagePath )

Sets the path to the image if existing.

void deFont::SetIsColorFont ( bool  colorFont )

Sets if this is a color font that can not be tinted.

void deFont::SetLineHeight ( int  lineHeight )

Sets the height of a line of text.

void deFont::UpdateGlyphs (  )

Update the glyphs.

bool deFont::Verify (  )

Verify the settings of the font object.


The documentation for this class was generated from the following file: