Crazy Eddie's GUI System  0.8.4
CEGUI::FontManager Class Reference

Class providing a shared library of Font objects to the system. More...

+ Inheritance diagram for CEGUI::FontManager:
+ Collaboration diagram for CEGUI::FontManager:

List of all members.

Public Types

typedef ConstMapIterator
< ObjectRegistry
FontIterator
 ConstBaseIterator type definition.

Public Member Functions

 FontManager ()
 Constructor.
 ~FontManager ()
 Destructor.
FontcreateFreeTypeFont (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), XMLResourceExistsAction action=XREA_RETURN)
 Creates a FreeType type font.
FontcreatePixmapFont (const String &font_name, const String &imageset_filename, const String &resource_group="", const AutoScaledMode auto_scaled=ASM_Disabled, const Sizef &native_res=Sizef(640.0f, 480.0f), XMLResourceExistsAction action=XREA_RETURN)
 Creates a Pixmap type font.
void notifyDisplaySizeChanged (const Sizef &size)
 Notify the FontManager that display size may have changed.
void writeFontToStream (const String &name, OutStream &out_stream) const
 Writes a full XML font file for the specified Font to the given OutStream.
FontIterator getIterator () const
 Return a FontManager::FontIterator object to iterate over the available Font objects.

Detailed Description

Class providing a shared library of Font objects to the system.

The FontManager is used to create, access, and destroy Font objects. The idea is that the FontManager will function as a central repository for Font objects used within the GUI system, and that those Font objects can be accessed, via a unique name, by any interested party within the system.


Member Function Documentation

Font& CEGUI::FontManager::createFreeTypeFont ( 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),
XMLResourceExistsAction  action = XREA_RETURN 
)

Creates a FreeType type font.

Parameters:
font_nameThe name that the font will use within the CEGUI system.
point_sizeSpecifies the point size that the font is to be rendered at.
anti_aliasedSpecifies whether the font should be rendered using anti aliasing.
font_filenameThe filename of an font file that will be used as the source for glyph images for this font.
resource_groupThe resource group identifier to use when loading the font file specified by font_filename.
auto_scaledSpecifies 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_resThe horizontal native resolution value. This is only significant when auto scaling is enabled.
native_vert_resThe vertical native resolution value. This is only significant when auto scaling is enabled.
actionOne of the XMLResourceExistsAction enumerated values indicating what action should be taken when a Font with the specified name already exists.
Returns:
Reference to the newly create Font object.
Font& CEGUI::FontManager::createPixmapFont ( const String font_name,
const String imageset_filename,
const String resource_group = "",
const AutoScaledMode  auto_scaled = ASM_Disabled,
const Sizef native_res = Sizef(640.0f, 480.0f),
XMLResourceExistsAction  action = XREA_RETURN 
)

Creates a Pixmap type font.

Parameters:
font_nameThe name that the font will use within the CEGUI system.
imageset_filenameThe filename of an imageset to load that will be used as the source for glyph images for this font. If resource_group is the special value of "*", this parameter may instead refer to the name of an already loaded Imagset.
resource_groupThe resource group identifier to use when loading the imageset file specified by imageset_filename. If this group is set to the special value of "*", then imageset_filename instead will refer to the name of an existing Imageset.
auto_scaledSpecifies 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_resThe horizontal native resolution value. This is only significant when auto scaling is enabled.
native_vert_resThe vertical native resolution value. This is only significant when auto scaling is enabled.
actionOne of the XMLResourceExistsAction enumerated values indicating what action should be taken when a Font with the specified name already exists.
Returns:
Reference to the newly create Font object.

Notify the FontManager that display size may have changed.

Parameters:
sizeSize object describing the display resolution
void CEGUI::FontManager::writeFontToStream ( const String name,
OutStream out_stream 
) const

Writes a full XML font file for the specified Font to the given OutStream.

Parameters:
nameString holding the name of the Font to be written to the stream.
out_streamOutStream (std::ostream based) object where data is to be sent.
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends