WoopsiUI::FontBase Class Reference

#include <libwoopsi/include/fontbase.h>

Inheritance diagram for WoopsiUI::FontBase:

List of all members.

Public Member Functions
virtual	~FontBase ()
virtual const bool	isCharBlank (const u32 letter) const =0
virtual s16	drawChar (MutableBitmapBase *bitmap, u32 letter, u16 colour, s16 x, s16 y, u16 clipX1, u16 clipY1, u16 clipX2, u16 clipY2)=0
virtual s16	drawBaselineChar (MutableBitmapBase *bitmap, u32 letter, u16 colour, s16 x, s16 y, u16 clipX1, u16 clipY1, u16 clipX2, u16 clipY2)=0
virtual u16	getStringWidth (const WoopsiString &text) const =0
virtual u16	getStringWidth (const WoopsiString &text, s32 startIndex, s32 length) const =0
virtual u8	getCharWidth (u32 letter) const =0
virtual u8	getCharHeight (u32 letter) const =0
virtual s8	getCharTop (u32 letter) const =0
virtual const u8	getHeight () const =0

---

Detailed Description

Abstract class defining the basic properties of a font and providing some of the essential functionality. Should be used as a base class for all fonts.

---

Constructor & Destructor Documentation

virtual WoopsiUI::FontBase::~FontBase

(

)

[inline, virtual]

Destructor.

---

Member Function Documentation

virtual s16 WoopsiUI::FontBase::drawBaselineChar	(	MutableBitmapBase *	bitmap,
		u32	letter,
		u16	colour,
		s16	x,
		s16	y,
		u16	clipX1,
		u16	clipY1,
		u16	clipX2,
		u16	clipY2
	)		[pure virtual]

Draw an individual character of the font to the specified bitmap on a baseline.

Parameters:

bitmap	The bitmap to draw to.
letter	The character to output.
colour	The colour to draw with.
x	The x co-ordinate of the pen.
y	The y co-ordinate of the pen.
clipX1	The left edge of the clipping rectangle.
clipY1	The top edge of the clipping rectangle.
clipX2	The right edge of the clipping rectangle.
clipY2	The bottom edge of the clipping rectangle.

Returns:

The x co-ordinate for the next character to be drawn.

Implemented in WoopsiUI::PackedFontBase.

virtual s16 WoopsiUI::FontBase::drawChar	(	MutableBitmapBase *	bitmap,
		u32	letter,
		u16	colour,
		s16	x,
		s16	y,
		u16	clipX1,
		u16	clipY1,
		u16	clipX2,
		u16	clipY2
	)		[pure virtual]

Draw an individual character of the font to the specified bitmap.

Parameters:

bitmap	The bitmap to draw to.
letter	The character to output.
colour	The colour to draw with.
x	The x co-ordinate of the text.
y	The y co-ordinate of the text.
clipX1	The left edge of the clipping rectangle.
clipY1	The top edge of the clipping rectangle.
clipX2	The right edge of the clipping rectangle.
clipY2	The bottom edge of the clipping rectangle.

Returns:

The x co-ordinate for the next character to be drawn.

Implemented in WoopsiUI::PackedFontBase.

virtual u8 WoopsiUI::FontBase::getCharHeight

(

u32

letter

)

const [pure virtual]

Get the height of an individual character.

Parameters:

letter

The letter to get the height of.

Returns:

The height of the character in pixels.

Implemented in WoopsiUI::PackedFontBase.

virtual s8 WoopsiUI::FontBase::getCharTop

(

u32

letter

)

const [pure virtual]

Get the algebric distance from baseline to top of an individual character.

Parameters:

letter

The character to get the "top" of.

Returns:

The top of the character in pixels.

Implemented in WoopsiUI::PackedFontBase.

virtual u8 WoopsiUI::FontBase::getCharWidth

(

u32

letter

)

const [pure virtual]

Get the width of an individual character.

Parameters:

letter

The character to get the width of.

Returns:

The width of the character in pixels.

Implemented in WoopsiUI::PackedFontBase.

virtual const u8 WoopsiUI::FontBase::getHeight

(

)

const [pure virtual]

Gets the height of the font.

Returns:

The height of the font.

Implemented in WoopsiUI::PackedFontBase.

virtual u16 WoopsiUI::FontBase::getStringWidth

(

const WoopsiString &

text

)

const [pure virtual]

Get the width of a string in pixels when drawn with this font.

Parameters:

text	The string to check.

Returns:

The width of the string in pixels.

Implemented in WoopsiUI::PackedFontBase.

virtual u16 WoopsiUI::FontBase::getStringWidth	(	const WoopsiString &	text,
		s32	startIndex,
		s32	length
	)		const [pure virtual]

Get the width of a portion of a string in pixels when drawn with this font.

Parameters:

text	The string to check.
startIndex	The start point of the substring within the string.
length	The length of the substring in chars.

Returns:

The width of the substring in pixels.

Implemented in WoopsiUI::PackedFontBase.

virtual const bool WoopsiUI::FontBase::isCharBlank

(

const u32

letter

)

const [pure virtual]

Checks if supplied character is blank in the current font.

Parameters:

letter

The character to check.

Returns:

True if the glyph contains any pixels to be drawn. False if the glyph is blank.

Implemented in WoopsiUI::PackedFontBase.

---

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

• libwoopsi/include/fontbase.h