FIFE  2008.0
FIFE::IFont Class Referenceabstract

#include <ifont.h>

Inheritance diagram for FIFE::IFont:
Inheritance graph
Collaboration diagram for FIFE::IFont:
Collaboration graph

Public Member Functions

virtual void setRowSpacing (int32_t spacing)=0
 
virtual int32_t getRowSpacing () const =0
 
virtual void setGlyphSpacing (int32_t spacing)=0
 
virtual int32_t getGlyphSpacing () const =0
 
virtual void setAntiAlias (bool antiAlias)=0
 
virtual bool isAntiAlias ()=0
 
virtual ImagegetAsImage (const std::string &text)=0
 
virtual ImagegetAsImageMultiline (const std::string &text)=0
 
virtual void setColor (uint8_t r, uint8_t g, uint8_t b, uint8_t a=255)=0
 
virtual SDL_Color getColor () const =0
 
virtual int32_t getWidth (const std::string &text) const =0
 
virtual int32_t getHeight () const =0
 

Detailed Description

Pure abstract Font interface

Definition at line 43 of file ifont.h.

Member Function Documentation

virtual Image* FIFE::IFont::getAsImage ( const std::string &  text)
pure virtual

Gets given text as Image The rsulting image is pooled, so it's not that time critical

Implemented in FIFE::FontBase.

virtual Image* FIFE::IFont::getAsImageMultiline ( const std::string &  text)
pure virtual

Gets given text as Image. Text is splitted on multiple lines based "\n" marks The rsulting image is pooled, so it's not that time critical

Implemented in FIFE::FontBase.

virtual SDL_Color FIFE::IFont::getColor ( ) const
pure virtual

Get the color the text was rendered in

Implemented in FIFE::FontBase.

virtual int32_t FIFE::IFont::getGlyphSpacing ( ) const
pure virtual

Gets the spacing between letters in pixels.

Returns
the spacing.

Implemented in FIFE::FontBase.

virtual int32_t FIFE::IFont::getHeight ( ) const
pure virtual

gets height of this font

Implemented in FIFE::TrueTypeFont, and FIFE::ImageFontBase.

Referenced by FIFE::FontBase::getAsImageMultiline().

Here is the caller graph for this function:

virtual int32_t FIFE::IFont::getRowSpacing ( ) const
pure virtual

Gets the spacing between rows in pixels.

Returns
the spacing.

Implemented in FIFE::FontBase.

virtual int32_t FIFE::IFont::getWidth ( const std::string &  text) const
pure virtual

gets width of given text

Implemented in FIFE::TrueTypeFont, and FIFE::ImageFontBase.

virtual bool FIFE::IFont::isAntiAlias ( )
pure virtual

Checks if anti aliasing is used.

Returns
true if anti aliasing is used.

Implemented in FIFE::FontBase.

virtual void FIFE::IFont::setAntiAlias ( bool  antiAlias)
pure virtual

Sets the use of anti aliasing..

Parameters
antaAliastrue for use of antia aliasing.

Implemented in FIFE::FontBase.

virtual void FIFE::IFont::setColor ( uint8_t  r,
uint8_t  g,
uint8_t  b,
uint8_t  a = 255 
)
pure virtual

Set the color the text should be rendered in

virtual void FIFE::IFont::setGlyphSpacing ( int32_t  spacing)
pure virtual

Sets the spacing between letters in pixels. Default is 0 pixels. The spacing can be negative.

Parameters
spacingthe spacing in pixels.

Implemented in FIFE::FontBase.

virtual void FIFE::IFont::setRowSpacing ( int32_t  spacing)
pure virtual

Sets the spacing between rows in pixels. Default is 0 pixels. The spacing can be negative.

Parameters
spacingthe spacing in pixels.

Implemented in FIFE::FontBase.


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