Crazy Eddie's GUI System  0.8.7
CEGUI::PixmapFont Class Reference

Implementation of the Font class interface using static Imageset's. More...

+ Inheritance diagram for CEGUI::PixmapFont:
+ Collaboration diagram for CEGUI::PixmapFont:

Public Member Functions

 PixmapFont (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))
 Constructor for Pixmap type fonts. More...
 
 ~PixmapFont ()
 Destructor.
 
void defineMapping (const utf32 codepoint, const String &image_name, const float horz_advance)
 
void defineMapping (const String &value)
 
const StringgetImageNamePrefix () const
 Return the image name prefix that the font is using for it's glyphs.
 
void setImageNamePrefix (const String &name_prefix)
 Set image name prefix font should use for it's glyphs. More...
 
- Public Member Functions inherited from CEGUI::Font
virtual ~Font ()
 Destructor.
 
const StringgetName () const
 Return the string holding the font name.
 
const StringgetTypeName () const
 Return the type of the font.
 
const StringgetFileName () 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 SizefgetNativeResolution () 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 FontGlyphgetGlyphData (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...
 
PropertygetPropertyInstance (const String &name) const
 Retrieves a property instance (that was previously added) More...
 
void clearProperties (void)
 Removes all Property objects from the PropertySet.
 
bool isPropertyPresent (const String &name) const
 Checks to see if a Property with the given name is in the PropertySet. More...
 
const StringgetPropertyHelp (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...
 
EventgetEventObject (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 Member Functions

void reinit ()
 Initialize the imageset.
 
void addPixmapFontProperties ()
 Register all properties of this class.
 
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.
 
virtual 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 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.
 
virtual const FontGlyphfindFontGlyph (const utf32 codepoint) const
 finds FontGlyph in map and returns it, or 0 if none.
 
- Protected Member Functions inherited from CEGUI::EventSet
void fireEvent_impl (const String &name, EventArgs &args)
 Implementation event firing member.
 
ScriptModulegetScriptModule () const
 Helper to return the script module pointer or throw.
 
 EventSet (EventSet &)
 
 EventSet (const EventSet &)
 
EventSetoperator= (EventSet &)
 
EventSetoperator= (const EventSet &)
 

Protected Attributes

String d_imageNamePrefix
 The Image name prefix used for the glyphs.
 
float d_origHorzScaling
 Current X scaling for glyph images.
 
bool d_imagesetOwner
 true if we own the imageset
 
- 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 StringgetDefaultResourceGroup ()
 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
 
- 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
 
- 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 static Imageset's.

To create such a font you must create a Imageset with all the glyphs, and then define individual glyphs via defineMapping.

Constructor & Destructor Documentation

CEGUI::PixmapFont::PixmapFont ( 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) 
)

Constructor for Pixmap type fonts.

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.

Member Function Documentation

void CEGUI::PixmapFont::setImageNamePrefix ( const String name_prefix)

Set image name prefix font should use for it's glyphs.

This will potentially cause existing images to be destroyed (if they were created specifically by, and for, this Font). Images using the new name prefix must already exist within the system.

Parameters
name_prefixName prefix used by an existing set of images to be used as the glyph source for this Font.