CEGUI::FreeTypeFont Class Reference

Implementation of the Font class interface using the FreeType library. More...

Inheritance diagram for CEGUI::FreeTypeFont:

Collaboration diagram for CEGUI::FreeTypeFont:

Public Member Functions
	FreeTypeFont (const String &font_name, const float point_size, const bool anti_aliased, const String &font_filename, const String &resource_group="", const AutoScaledMode auto_scaled=ASM_Disabled, const Sizef &native_res=Sizef(640.0f, 480.0f), const float specific_line_spacing=0.0f)
	Constructor for FreeTypeFont based fonts. More...
	~FreeTypeFont ()
	Destructor.
float	getPointSize () const
	return the point size of the freetype font.
bool	isAntiAliased () const
	return whether the freetype font is rendered anti-aliased.
void	setPointSize (const float point_size)
	return the point size of the freetype font.
void	setAntiAliased (const bool anti_alaised)
	return whether the freetype font is rendered anti-aliased.
Public Member Functions inherited from CEGUI::Font
virtual	~Font ()
	Destructor.
const String &	getName () const
	Return the string holding the font name.
const String &	getTypeName () const
	Return the type of the font.
const String &	getFileName () const
	Return the filename of the used font.
bool	isCodepointAvailable (utf32 cp) const
	Return whether this Font can draw the specified code-point. More...
float	drawText (GeometryBuffer &buffer, const String &text, const Vector2f &position, const Rectf *clip_rect, const ColourRect &colours, const float space_extra=0.0f, const float x_scale=1.0f, const float y_scale=1.0f) const
	Draw text into a specified area of the display. More...
void	setNativeResolution (const Sizef &size)
	Set the native resolution for this Font. More...
const Sizef &	getNativeResolution () const
	Return the native display size for this Font. This is only relevant if the Font is being auto-scaled. More...
void	setAutoScaled (const AutoScaledMode auto_scaled)
	Enable or disable auto-scaling for this Font. More...
AutoScaledMode	getAutoScaled () const
	Checks whether this font is being auto-scaled and how. More...
virtual void	notifyDisplaySizeChanged (const Sizef &size)
	Notify the Font that the display size may have changed. More...
float	getLineSpacing (float y_scale=1.0f) const
	Return the pixel line spacing value for. More...
float	getFontHeight (float y_scale=1.0f) const
	return the exact pixel height of the font. More...
float	getBaseline (float y_scale=1.0f) const
	Return the number of pixels from the top of the highest glyph to the baseline. More...
float	getTextExtent (const String &text, float x_scale=1.0f) const
	Return the pixel width of the specified text if rendered with this Font. More...
float	getTextAdvance (const String &text, float x_scale=1.0f) const
	Return pixel advance of the specified text when rendered with this Font. More...
size_t	getCharAtPixel (const String &text, float pixel, float x_scale=1.0f) const
	Return the index of the closest text character in String text that corresponds to pixel location pixel if the text were rendered. More...
size_t	getCharAtPixel (const String &text, size_t start_char, float pixel, float x_scale=1.0f) const
	Return the index of the closest text character in String text, starting at character index start_char, that corresponds to pixel location pixel if the text were to be rendered. More...
void	writeXMLToStream (XMLSerializer &xml_stream) const
	Writes an xml representation of this Font to out_stream. More...
const FontGlyph *	getGlyphData (utf32 codepoint) const
	Return a pointer to the glyphDat struct for the given codepoint, or 0 if the codepoint does not have a glyph defined. More...
Public Member Functions inherited from CEGUI::PropertySet
	PropertySet (void)
	Constructs a new PropertySet object.
virtual	~PropertySet (void)
	Destructor for PropertySet objects.
void	addProperty (Property *property)
	Adds a new Property to the PropertySet. More...
void	removeProperty (const String &name)
	Removes a Property from the PropertySet. More...
Property *	getPropertyInstance (const String &name) const
	Retrieves a property instance (that was previously added) More...
void	clearProperties (void)
	Removes all Property objects from the PropertySet. More...
bool	isPropertyPresent (const String &name) const
	Checks to see if a Property with the given name is in the PropertySet. More...
const String &	getPropertyHelp (const String &name) const
	Return the help text for the specified Property. More...
String	getProperty (const String &name) const
	Gets the current value of the specified Property. More...
template<typename T >
PropertyHelper< T >::return_type	getProperty (const String &name) const
	Gets the current value of the specified Property. More...
void	setProperty (const String &name, const String &value)
	Sets the current value of a Property. More...
template<typename T >
void	setProperty (const String &name, typename PropertyHelper< T >::pass_type value)
	Sets the current value of a Property. More...
bool	isPropertyDefault (const String &name) const
	Returns whether a Property is at it's default value. More...
String	getPropertyDefault (const String &name) const
	Returns the default value of a Property as a String. More...
PropertyIterator	getPropertyIterator (void) const
	Return a PropertySet::PropertyIterator object to iterate over the available Properties.
Public Member Functions inherited from CEGUI::EventSet
	EventSet ()
	Constructor for EventSet objects.
virtual	~EventSet (void)
	Destructor for EventSet objects.
void	addEvent (const String &name)
	Creates a new Event object with the given name and adds it to the EventSet. More...
void	addEvent (Event &event)
	Adds the given Event object to the EventSet. Ownership of the object passes to EventSet and it will be deleted when it is removed from the EventSet - whether explicitly via removeEvent or when the EventSet is destroyed. More...
void	removeEvent (const String &name)
	Removes the Event with the given name. All connections to the event are disconnected, and the underlying Event object is destroyed. More...
void	removeEvent (Event &event)
	Removes the given event from the EventSet. All connections to the event are disconnected, and the event object is destroyed. More...
void	removeAllEvents (void)
	Remove all Event objects from the EventSet. Add connections will be disconnected, and all Event objects destroyed.
bool	isEventPresent (const String &name)
	Checks to see if an Event with the given name is present in this EventSet. More...
virtual Event::Connection	subscribeEvent (const String &name, Event::Subscriber subscriber)
	Subscribes a handler to the named Event. If the named Event is not yet present in the EventSet, it is created and added. More...
virtual Event::Connection	subscribeEvent (const String &name, Event::Group group, Event::Subscriber subscriber)
	Subscribes a handler to the specified group of the named Event. If the named Event is not yet present in the EventSet, it is created and added. More...
template<typename Arg1 , typename Arg2 >
Event::Connection	subscribeEvent (const String &name, Arg1 arg1, Arg2 arg2)
	Subscribes a handler to the named Event. If the named Event is not yet present in the EventSet, it is created and added. More...
template<typename Arg1 , typename Arg2 >
Event::Connection	subscribeEvent (const String &name, Event::Group group, Arg1 arg1, Arg2 arg2)
	Subscribes a handler to the named Event. If the named Event is not yet present in the EventSet, it is created and added. More...
virtual Event::Connection	subscribeScriptedEvent (const String &name, const String &subscriber_name)
	Subscribes the named Event to a scripted funtion. More...
virtual Event::Connection	subscribeScriptedEvent (const String &name, Event::Group group, const String &subscriber_name)
	Subscribes the specified group of the named Event to a scripted funtion. More...
virtual void	fireEvent (const String &name, EventArgs &args, const String &eventNamespace="")
	Fires the named event passing the given EventArgs object. More...
bool	isMuted (void) const
	Return whether the EventSet is muted or not. More...
void	setMutedState (bool setting)
	Set the mute state for this EventSet. More...
Event *	getEventObject (const String &name, bool autoAdd=false)
	Return a pointer to the Event object with the given name, optionally adding such an Event object to the EventSet if it does not already exist. More...
EventIterator	getEventIterator (void) const
	Return a EventSet::EventIterator object to iterate over the events currently added to the EventSet.

Protected Types
typedef std::vector< Texture *CEGUI_VECTOR_ALLOC(Texture *)>	TextureVector
	Type definition for TextureVector.
typedef std::vector < BasicImage *CEGUI_VECTOR_ALLOC(BasicImage *)>	ImageVector
Protected Types inherited from CEGUI::Font
typedef std::map< utf32, FontGlyph, std::less< utf32 > CEGUI_MAP_ALLOC(utf32, FontGlyph)>	CodepointMap
	Definition of CodepointMap type.
Protected Types inherited from CEGUI::EventSet
typedef std::map< String, Event *, StringFastLessCompare CEGUI_MAP_ALLOC(String, Event *)>	EventMap

Protected Member Functions
void	drawGlyphToBuffer (argb_t *buffer, uint buf_width) const
	Copy the current glyph data into buffer, which has a width of buf_width pixels (not bytes). More...
uint	getTextureSize (CodepointMap::const_iterator s, CodepointMap::const_iterator e) const
	Return the required texture size required to store imagery for the glyphs from s to e. More...
void	addFreeTypeFontProperties ()
	Register all properties of this class.
void	free ()
	Free all allocated font data.
void	initialiseFontGlyph (CodepointMap::iterator cp) const
	initialise FontGlyph for given codepoint.
void	initialiseGlyphMap ()
const FontGlyph *	findFontGlyph (const utf32 codepoint) const
	finds FontGlyph in map and returns it, or 0 if none.
void	rasterise (utf32 start_codepoint, utf32 end_codepoint) const
	This function prepares a certain range of glyphs to be ready for displaying. This means that after returning from this function glyphs from d_cp_map[start_codepoint] to d_cp_map[end_codepoint] should have their d_image member set. If there is an error during rasterisation of some glyph, it's okay to leave the d_image field set to NULL, in which case such glyphs will be skipped from display. More...
void	updateFont ()
	Update the font as needed, according to the current parameters.
void	writeXMLToStream_impl (XMLSerializer &xml_stream) const
	implementaion version of writeXMLToStream.
Protected Member Functions inherited from CEGUI::Font
	Font (const String &name, const String &type_name, const String &filename, const String &resource_group, const AutoScaledMode auto_scaled, const Sizef &native_res)
	Constructor.
void	addFontProperties ()
	Register all properties of this class.
virtual void	onRenderSizeChanged (FontEventArgs &args)
	event trigger function for when the font rendering size changes.
void	setMaxCodepoint (utf32 codepoint)
	Set the maximal glyph index. This reserves the respective number of bits in the d_glyphPageLoaded array.
Protected Member Functions inherited from CEGUI::EventSet
void	fireEvent_impl (const String &name, EventArgs &args)
	Implementation event firing member.
ScriptModule *	getScriptModule () const
	Helper to return the script module pointer or throw.
	EventSet (EventSet &)
EventSet &	operator= (EventSet &)

Protected Attributes
float	d_specificLineSpacing
	If non-zero, the overridden line spacing that we're to report.
float	d_ptSize
	Point size of font.
bool	d_antiAliased
	True if the font should be rendered as anti-alaised by freeType.
FT_Face	d_fontFace
	FreeType-specific font handle.
RawDataContainer	d_fontData
	Font file data.
TextureVector	d_glyphTextures
	Textures that hold the glyph imagery for this font.
ImageVector	d_glyphImages
	collection of images defined for this font.
Protected Attributes inherited from CEGUI::Font
String	d_name
	Name of this font.
String	d_type
	Type name string for this font (not used internally)
String	d_filename
	Name of the file used to create this font (font file or imagset)
String	d_resourceGroup
	Name of the font file's resource group.
float	d_ascender
	maximal font ascender (pixels above the baseline)
float	d_descender
	maximal font descender (negative pixels below the baseline)
float	d_height
	(ascender - descender) + linegap
AutoScaledMode	d_autoScaled
	which mode should we use for auto-scaling
Sizef	d_nativeResolution
	native resolution for this Font.
float	d_horzScaling
	current horizontal scaling factor.
float	d_vertScaling
	current vertical scaling factor.
utf32	d_maxCodepoint
	Maximal codepoint for font glyphs.
uint *	d_glyphPageLoaded
	This bitmap holds information about loaded 'pages' of glyphs. A glyph page is a set of 256 codepoints, starting at 256-multiples. For example, the 1st glyph page is 0-255, fourth is 1024-1279 etc. When a specific glyph is required for painting, the corresponding bit is checked to see if the respective page has been rasterised. If not, the rasterise() method is invoked, which prepares the glyphs from the respective glyph page for being painted. More...
CodepointMap	d_cp_map
	Contains mappings from code points to Image objects.
Protected Attributes inherited from CEGUI::EventSet
EventMap	d_events
bool	d_muted
	true if events for this EventSet have been muted.

Additional Inherited Members
Public Types inherited from CEGUI::PropertySet
typedef ConstMapIterator < PropertyRegistry >	PropertyIterator
Public Types inherited from CEGUI::EventSet
typedef ConstMapIterator < EventMap >	EventIterator
Static Public Member Functions inherited from CEGUI::Font
static void	setDefaultResourceGroup (const String &resourceGroup)
	Sets the default resource group to be used when loading font data. More...
static const String &	getDefaultResourceGroup ()
	Returns the default resource group currently set for Fonts. More...
Static Public Attributes inherited from CEGUI::Font
static const argb_t	DefaultColour
	Colour value used whenever a colour is not specified.
static const String	EventNamespace
	Event namespace for font events.
static const String	EventRenderSizeChanged
Static Protected Attributes inherited from CEGUI::Font
static String	d_defaultResourceGroup
	Holds default resource group for font loading.

Detailed Description

Implementation of the Font class interface using the FreeType library.

This implementation tries to provide maximal support for any kind of fonts supported by FreeType. It has been tested on outline font formats like TTF and PS as well as on bitmap font formats like PCF and FON.

Glyphs are rendered dynamically on demand, so a large font with lots of glyphs won't slow application startup time.

Constructor & Destructor Documentation

CEGUI::FreeTypeFont::FreeTypeFont	(	const String &	font_name,
		const float	point_size,
		const bool	anti_aliased,
		const String &	font_filename,
		const String &	resource_group = "",
		const AutoScaledMode	auto_scaled = ASM_Disabled,
		const Sizef &	native_res = Sizef(640.0f, 480.0f),
		const float	specific_line_spacing = 0.0f
	)

Constructor for FreeTypeFont based fonts.

Parameters

font_name	The name that the font will use within the CEGUI system.
point_size	Specifies the point size that the font is to be rendered at.
anti_aliased	Specifies whether the font should be rendered using anti aliasing.
font_filename	The filename of an font file that will be used as the source for glyph images for this font.
resource_group	The resource group identifier to use when loading the font file specified by font_filename.
auto_scaled	Specifies whether the font imagery should be automatically scaled to maintain the same physical size (which is calculated by using the native resolution setting).
native_horz_res	The horizontal native resolution value. This is only significant when auto scaling is enabled.
native_vert_res	The vertical native resolution value. This is only significant when auto scaling is enabled.
specific_line_spacing	If specified (non-zero), this will be the line spacing that we will report for this font, regardless of what is mentioned in the font file itself.

Member Function Documentation

void CEGUI::FreeTypeFont::drawGlyphToBuffer ( argb_t *  buffer, uint  buf_width  ) const

protected

Copy the current glyph data into buffer, which has a width of buf_width pixels (not bytes).

Parameters

buffer	Memory buffer large enough to receive the imagery for the currently loaded glyph.
buf_width	Width of buffer in pixels (where each pixel is a argb_t).

Returns

Nothing.

uint CEGUI::FreeTypeFont::getTextureSize ( CodepointMap::const_iterator  s, CodepointMap::const_iterator  e  ) const

protected

Return the required texture size required to store imagery for the glyphs from s to e.

Parameters

s	The first glyph in set
e	The last glyph in set

void CEGUI::FreeTypeFont::rasterise ( utf32  start_codepoint, utf32  end_codepoint  ) const

protectedvirtual

This function prepares a certain range of glyphs to be ready for displaying. This means that after returning from this function glyphs from d_cp_map[start_codepoint] to d_cp_map[end_codepoint] should have their d_image member set. If there is an error during rasterisation of some glyph, it's okay to leave the d_image field set to NULL, in which case such glyphs will be skipped from display.

Parameters

start_codepoint	The lowest codepoint that should be rasterised
end_codepoint	The highest codepoint that should be rasterised

Reimplemented from CEGUI::Font.