Kanzi  3.9.9
Kanzi Engine C++ API
kanzi::FontFile Class Reference

FontFile is the base class for different font file resource implementations. More...

#include <kanzi/core.ui/font/font_file.hpp>

Inheritance diagram for kanzi::FontFile:
[legend]

Classes

class  GlyphData
 GlyphData contains the metrics for an individual rendered glyph and its bitmap. More...
 

Public Types

typedef shared_ptr< GlyphDataGlyphDataSharedPtr
 
- Public Types inherited from kanzi::PropertyObject
typedef PropertyStorageContainer::const_iterator PropertyStorageConstIterator
 
typedef vector< PropertyStoragePtrPropertyStorageContainer
 
typedef PropertyStorageContainer::iterator PropertyStorageIterator
 
typedef intrusive_ptr< AbstractPropertyTypeDescriptor::PropertyStoragePropertyStoragePtr
 
typedef PropertyStorageContainer::reverse_iterator PropertyStorageReverseIterator
 

Public Member Functions

virtual float getAdvance (unsigned int glyphIndex) const
 Returns the advance metric of the given glyph. More...
 
virtual float getAscender () const
 Returns the ascender of a font. More...
 
virtual RectangleFloat getBoundingBox (unsigned int glyphIndex) const
 Returns the bounding box of the given glyph. More...
 
virtual float getDescender () const
 Returns the descender of a font. More...
 
virtual FontEnginePlugin::FontEngine getEngineType () const
 Returns the font engine type used by this font. More...
 
virtual GlyphDataSharedPtr getGlyphData (unsigned int glyphIndex)
 Returns the bitmap data for the given glyph. More...
 
virtual unsigned int getGlyphIndex (char32_t character) const
 Returns the glyph index in a font for the given unicode code point. More...
 
FontHintingPreference getHintingPreference () const
 Gets the value of FontStyleConcept::HintingPreferenceProperty. More...
 
virtual float getKerning (unsigned int previousGlyphIndex, unsigned int glyphIndex) const
 Returns the kerning between the given pair of glyphs. More...
 
virtual float getLineHeight () const
 Returns the line height of a font. More...
 
virtual float getMaximumGlyphHeight () const
 Returns the maximum height of glyphs in a font. More...
 
virtual float getSize () const
 Returns the size of a font in pixels. More...
 
void setHintingPreference (FontHintingPreference hintingPreference)
 Sets the value of FontStyleConcept::HintingPreferenceProperty. More...
 
virtual void setSize (float size)
 Sets the size of a font in pixels. More...
 
 ~FontFile () override
 Destructor. More...
 
- Public Member Functions inherited from kanzi::Resource
virtual unsigned int getCPUMemoryUsage () const
 Function for getting the memory usage of a resource. More...
 
const string & getName () const
 Gets the resource name. More...
 
const string & getUrl () const
 Gets the resource URL. More...
 
bool isKeepAlive () const
 Tells if the resource has keep alive flag set. More...
 
void reload ()
 
void reloadFromFile (string_view filePath)
 
void reloadFromKzb (KzbFile &kzbFile, ReadOnlyMemoryFile &file, KzbMemoryParser &parser)
 
void setKeepAlive (bool keepAlive)
 Sets the keep alive flag. More...
 
void setUrl (string_view url)
 Sets the resource URL. More...
 
 ~Resource () override
 Destructor. More...
 
- Public Member Functions inherited from kanzi::Object
AppliedStyleEntrySharedPtr applyObjectStyle (kanzi::StyleSharedPtr style)
 Applies a style to an object. More...
 
void applyObjectStyles ()
 Apply all styles for an object node. More...
 
DomaingetDomain () const
 Returns the domain the object belongs to. More...
 
const MetaclassgetDynamicMetaclass () const override
 Returns the metaclass of the dynamic type of the object. More...
 
MainLoopSchedulergetMainLoopScheduler () const
 Returns the MainLoopScheduler instance of the associated Domain. More...
 
detail::MessageDispatcher * getMessageDispatcher () const
 Returns the message dispatcher of the object. More...
 
ResourceManagergetResourceManager () const
 Returns the resource manager of the object. More...
 
ScriptingContextSharedPtr getScriptingContext () const
 Gets the scripting context of the object. More...
 
 Object (Domain *domain)
 
void setScriptingContext (ScriptingContextSharedPtr context)
 Sets the scripting context of the object. More...
 
void unapplyObjectStyle (AppliedStyleEntrySharedPtr appliedStyleEntry)
 
void unapplyObjectStyles ()
 Unapplies and removes all applied styles. More...
 
 ~Object () override
 
- Public Member Functions inherited from kanzi::MetaObject
bool isTypeOf (const Metaclass *objectType) const
 Determines if the type of this object is the given type or derived from it. More...
 
virtual ~MetaObject ()
 
- Public Member Functions inherited from kanzi::PropertyObject
template<typename DataType >
void addPropertyModifier (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::ModifierCallback callback, void *owner)
 
template<typename DataType >
void addPropertyModifierWithoutNotifyingHandlers (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::ModifierCallback callback, void *owner)
 Adds a property modifier without notifying handlers. More...
 
template<typename DataType >
void addPropertyNotificationHandler (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::NotificationCallback callback, void *owner)
 
template<typename DataType >
void addPropertyValueSource (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::TypedValueSource *valueSource, PropertyValuePrecedence precedence, void *ownerPointer)
 
template<typename DataType >
void addPropertyValueSource (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::TypedValueSource *valueSource, PropertyValuePrecedence precedence, AbstractPropertyTypeDescriptor::ValueSourceOwner *owner)
 
PropertyStorageContainer::iterator beginPropertyStorage ()
 Returns the begin iterator to the internal property storage container. More...
 
PropertyStorageContainer::const_iterator beginPropertyStorage () const
 Returns the begin iterator to the internal property storage container. More...
 
void clearPropertyFlag (AbstractPropertyType propertyType, uint32_t flag)
 
void copyLocalValue (const PropertyObject &other, AbstractPropertyType propertyType)
 Copies local value of single property from another object. More...
 
void copyLocalValues (const PropertyObject &other)
 Copies all local values from another object. More...
 
PropertyStorageContainer::iterator endPropertyStorage ()
 Returns the end iterator to the internal property storage container. More...
 
PropertyStorageContainer::const_iterator endPropertyStorage () const
 Returns the end iterator to the internal property storage container. More...
 
template<typename DataType >
PropertyType< DataType >::Traits::ReturnType getAbstractProperty (AbstractPropertyType abstractPropertyType) const
 
template<typename DataType >
PropertyType< DataType >::Traits::ReturnType getAbstractPropertyBase (AbstractPropertyType abstractPropertyType) const
 
template<typename DataType >
optional< typename PropertyType< DataType >::Traits::ReturnType > getOptionalAbstractProperty (AbstractPropertyType abstractPropertyType) const
 
template<typename DataType >
optional< typename PropertyType< DataType >::Traits::ReturnType > getOptionalProperty (const PropertyType< DataType > &propertyType) const
 Evaluates the property value in the same way as the overload above but does not default to the value in property metadata if there are no inputs to the property value. More...
 
template<typename DataType >
optional< typename PropertyType< DataType >::Traits::ReturnType > getOptionalPropertyBase (const PropertyType< DataType > &propertyType) const
 Returns the current value of a property disregarding modifiers, but does not default to the value in property metadata if there are no inputs to the property value. More...
 
template<typename DataType >
PropertyType< DataType >::Traits::ReturnType getProperty (const PropertyType< DataType > &propertyType) const
 Returns the current value of a property type. More...
 
template<typename DataType >
PropertyType< DataType >::Traits::ReturnType getPropertyBase (const PropertyType< DataType > &propertyType) const
 Returns the current value of a property disregarding modifiers. More...
 
template<typename DataType >
size_t getPropertyNotificationHandlerCount (const PropertyType< DataType > &propertyType) const
 Gets number of current notification handlers for given property type. More...
 
bool hasBaseValue (AbstractPropertyType propertyType) const
 Evaluates whether there are any inputs into the property value, disregarding modifiers. More...
 
bool hasLocalValue (AbstractPropertyType propertyType) const
 Evaluates whether there is a local value set for the property. More...
 
bool hasNonClassValue (AbstractPropertyType propertyType) const
 Evaluates whether there is a value of any precedence higher than class default value set for the property. More...
 
bool hasValue (AbstractPropertyType propertyType) const
 Evaluates whether there are any inputs into the property value. More...
 
bool isPropertyFlagSet (AbstractPropertyType propertyType, uint32_t flag) const
 
virtual void onPropertyChanged (AbstractPropertyType propertyType, PropertyNotificationReason reason)
 Virtual function to handle property change notifications. More...
 
 PropertyObject ()
 
void removeKzbProperties (flat_set< AbstractPropertyType > *keepProperties)
 Remove all KZB properties that are not included in a given set. More...
 
void removeKzbProperties ()
 Remove all KZB properties. More...
 
template<typename DataType >
void removeLocalPropertyValueSource (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::TypedValueSource *valueSource, void *ownerPointer)
 
void removeLocalValue (AbstractPropertyType propertyType)
 Removes the local value associated with the property. More...
 
template<typename DataType >
void removePropertyModifier (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::ModifierCallback callback, void *owner)
 
template<typename DataType >
void removePropertyNotificationHandler (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::NotificationCallback callback, void *owner)
 
template<typename DataType >
void removePropertyValueSource (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::TypedValueSource *valueSource, void *ownerPointer)
 
template<typename DataType >
void setAbstractProperty (AbstractPropertyType abstractPropertyType, typename PropertyType< DataType >::Traits::ParameterType value)
 
template<typename DataType >
void setProperty (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Traits::ParameterType value)
 Sets the local value of a property type. More...
 
void setPropertyFlag (AbstractPropertyType propertyType, uint32_t flag)
 
KZ_DEPRECATED void validatePropertyModifiers (AbstractPropertyType propertyType)
 Validates property modifiers and notifies handlers. More...
 
void validatePropertyModifiersAndNotifyHandlers (AbstractPropertyType propertyType)
 Validates property modifiers and notifies handlers. More...
 
virtual ~PropertyObject ()
 

Static Public Member Functions

static FontFileSharedPtr create (Domain *domain, string_view name)
 Construct fonts using the corresponding font loader implementation, not directly with the create() function. More...
 
- Static Public Member Functions inherited from kanzi::Object
static const MetaclassgetStaticMetaclass ()
 Returns the metaclass of Object class. More...
 
static PropertyTypeEditorInfoSharedPtr makeEditorInfo ()
 Default implementation that returns empty editor info. More...
 
- Static Public Member Functions inherited from kanzi::MetaObject
static const MetaclassgetStaticMetaclass ()
 Returns the metaclass of Object class. More...
 
static PropertyTypeEditorInfoSharedPtr makeEditorInfo ()
 Default implementation that returns empty editor info. More...
 

Protected Member Functions

 FontFile (Domain *domain, string_view name)
 Construct fonts using the corresponding font loader implementation, not directly with the constructor. More...
 
void setAscender (float ascender)
 Sets the ascender for a font. More...
 
void setDescender (float descender)
 Sets the descender for a font. More...
 
void setLineHeight (float lineHeight)
 Sets the line height for a font. More...
 
- Protected Member Functions inherited from kanzi::Resource
virtual unsigned int getCPUMemoryUsageOverride () const
 
virtual void reloadFromFileOverride (string_view filePath)
 
virtual void reloadFromKzbOverride (KzbFile &kzbFile, ReadOnlyMemoryFile &file, KzbMemoryParser &parser)
 
virtual void reloadOverride ()
 
 Resource (Domain *domain, string_view name)
 Constructor. More...
 
- Protected Member Functions inherited from kanzi::Object
void initialize ()
 
void onCopy (const Object &other)
 
- Protected Member Functions inherited from kanzi::MetaObject
void initialize ()
 
 MetaObject ()
 
- Protected Member Functions inherited from kanzi::PropertyObject
AbstractPropertyTypeDescriptor::ValueSourceEntryacquireLocalValueSourceEntry (AbstractPropertyTypeDescriptor &descriptor, PropertyStoragePtr &propertyStorage)
 Acquires a local value source entry that is free for the assignment of a value. More...
 
AbstractPropertyTypeDescriptor::ModifierStorageacquireModifierStorage (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::PropertyStorage &propertyStorage)
 
AbstractPropertyTypeDescriptor::NotificationStorageacquireNotificationStorage (AbstractPropertyTypeDescriptor &descriptor)
 
PropertyStoragePtr acquirePropertyStorage (AbstractPropertyTypeDescriptor &descriptor)
 
template<typename DataType >
void addPropertyModifierBase (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::ModifierCallback callback, void *owner, bool notify)
 Adds a property modifier entry to the property modifier stack and validates them. More...
 
void addPropertyValueSource (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::ValueSource *valueSource, PropertyValuePrecedence precedence, void *ownerPointer)
 Internally adds a property value source. More...
 
void addPropertyValueSource (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::ValueSource *valueSource, PropertyValuePrecedence precedence, AbstractPropertyTypeDescriptor::ValueSourceOwner *owner)
 Internally adds a property value source. More...
 
AbstractPropertyTypeDescriptor::ValueSourceEntryconstructLocalValueSourceEntry (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::PropertyStorage &propertyStorage)
 
PropertyStoragePtr constructPropertyStorage (AbstractPropertyTypeDescriptor &descriptor)
 
void copyLocalValue (const AbstractPropertyTypeDescriptor::PropertyStorage &otherPropertyStorage)
 Copy local value from property storage. More...
 
AbstractPropertyTypeDescriptor::ModifierStoragefindModifierStorage (AbstractPropertyTypeDescriptor &descriptor)
 
AbstractPropertyTypeDescriptor::NotificationStoragefindNotificationStorage (AbstractPropertyTypeDescriptor &descriptor) const
 
AbstractPropertyTypeDescriptor::PropertyStoragefindPropertyStorage (AbstractPropertyTypeDescriptor &descriptor) const
 Gets the property storage for given property type descriptor. More...
 
PropertyStoragePtr findPropertyStoragePtr (AbstractPropertyTypeDescriptor &descriptor) const
 Gets property storage intrusive pointer which you can use to hold a reference until the end of the operation. More...
 
AbstractPropertyTypeDescriptorfindPropertyTypeDescriptorByNameAndDataType (string_view name, PropertyDataType dataType) const
 Finds a property type descriptor by name and data type. More...
 
AbstractPropertyTypeDescriptorfindPropertyTypeDescriptorByQualifiedNameAndDataType (string_view qualifiedName, PropertyDataType dataType) const
 Like findPropertyTypeDescriptorByNameAndDataType, but only searches by matching with qualified names. More...
 
AbstractPropertyTypeDescriptorfindPropertyTypeDescriptorByUnqualifiedNameAndDataType (string_view unqualifiedName, PropertyDataType dataType) const
 Like findPropertyTypeDescriptorByNameAndDataType, but only searches by matching with unqualified names. More...
 
AbstractPropertyTypeDescriptor::ValueSourcegetClassValueSource (AbstractPropertyTypeDescriptor &descriptor) const
 
AbstractPropertyTypeDescriptor::ValueSourcegetFinalValueSource (AbstractPropertyTypeDescriptor &descriptor) const
 
AbstractPropertyTypeDescriptor::ValueSourcegetNonClassValueSource (AbstractPropertyTypeDescriptor &descriptor) const
 
AbstractPropertyTypeDescriptor::ValueSourcegetTopValueSource (AbstractPropertyTypeDescriptor &descriptor) const
 Gets the top-level value source for a given property descriptor. More...
 
virtual void notifyPropertyHandlers (PropertyStoragePtr &storagePtr, PropertyNotificationReason reason)
 Notifies all property handlers on a property storage. More...
 
void onCopy (const PropertyObject &other)
 
void removeLocalValue (AbstractPropertyTypeDescriptor &descriptor, PropertyStoragePtr &propertyStorage)
 Removes a local value from the given property storage. More...
 
void removePropertyValueSource (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::ValueSource *valueSource, void *owner)
 Removes a property value source. More...
 
void validatePropertyModifiers (PropertyStoragePtr &propertyStorage)
 Validates property modifiers without notifying handlers. More...
 
void validatePropertyModifiersAndNotifyHandlers (PropertyStoragePtr &propertyStorage)
 Validates property modifiers and notifies handlers. More...
 

Friends

class FontLoader
 

Additional Inherited Members

- Protected Types inherited from kanzi::Object
typedef vector< AppliedStyleEntrySharedPtrAppliedStyleContainer
 Applied style container. More...
 
- Protected Attributes inherited from kanzi::Object
AppliedStyleContainer m_appliedStyles
 Listing of applied styles applied to this object. More...
 

Detailed Description

FontFile is the base class for different font file resource implementations.

The base class itself provides a mock implementation of a font file resource.

Member Typedef Documentation

Constructor & Destructor Documentation

kanzi::FontFile::~FontFile ( )
override

Destructor.

kanzi::FontFile::FontFile ( Domain domain,
string_view  name 
)
explicitprotected

Construct fonts using the corresponding font loader implementation, not directly with the constructor.

See also
FontManager::getFontLoader()
Parameters
domainPointer to domain object.
nameName of the font.

Member Function Documentation

static FontFileSharedPtr kanzi::FontFile::create ( Domain domain,
string_view  name 
)
static

Construct fonts using the corresponding font loader implementation, not directly with the create() function.

See also
FontManager::getFontLoader()
Parameters
domainPointer to the domain object.
nameName of the font.
virtual FontEnginePlugin::FontEngine kanzi::FontFile::getEngineType ( ) const
virtual

Returns the font engine type used by this font.

Returns
FontEngine type.

Reimplemented in kanzi::ItypeFontFile, and kanzi::FreeTypeFontFile.

virtual void kanzi::FontFile::setSize ( float  size)
virtual

Sets the size of a font in pixels.

Parameters
sizeSize in pixels.

Reimplemented in kanzi::BitmapFontFile, kanzi::ItypeFontFile, and kanzi::FreeTypeFontFile.

virtual float kanzi::FontFile::getSize ( ) const
virtual

Returns the size of a font in pixels.

Returns
Size of the font in pixels.

Reimplemented in kanzi::BitmapFontFile.

virtual float kanzi::FontFile::getLineHeight ( ) const
virtual

Returns the line height of a font.

Returns
Line height of the font.

Reimplemented in kanzi::BitmapFontFile.

virtual float kanzi::FontFile::getMaximumGlyphHeight ( ) const
virtual

Returns the maximum height of glyphs in a font.

Returns
The maximum height of glyphs in a font.
Since
Kanzi 3.9.7

Reimplemented in kanzi::FreeTypeFontFile.

virtual float kanzi::FontFile::getAscender ( ) const
virtual

Returns the ascender of a font.

Returns
Ascender of the font.

Reimplemented in kanzi::BitmapFontFile.

virtual float kanzi::FontFile::getDescender ( ) const
virtual

Returns the descender of a font.

Returns
Descender of the font.

Reimplemented in kanzi::BitmapFontFile.

virtual unsigned int kanzi::FontFile::getGlyphIndex ( char32_t  character) const
virtual

Returns the glyph index in a font for the given unicode code point.

Parameters
characterThe unicode code point to use.
Returns
Glyph index for the given code point.

Reimplemented in kanzi::BitmapFontFile, kanzi::ItypeFontFile, and kanzi::FreeTypeFontFile.

virtual float kanzi::FontFile::getAdvance ( unsigned int  glyphIndex) const
virtual

Returns the advance metric of the given glyph.

Parameters
glyphIndexIndex of the font glyph data acquired from getGlyphIndex().
Returns
Advance for the given glyph.

Reimplemented in kanzi::BitmapFontFile, kanzi::ItypeFontFile, and kanzi::FreeTypeFontFile.

virtual RectangleFloat kanzi::FontFile::getBoundingBox ( unsigned int  glyphIndex) const
virtual

Returns the bounding box of the given glyph.

Parameters
glyphIndexIndex of the font glyph data acquired from getGlyphIndex().
Returns
Bounding box of the given glyph.

Reimplemented in kanzi::BitmapFontFile, kanzi::ItypeFontFile, and kanzi::FreeTypeFontFile.

virtual float kanzi::FontFile::getKerning ( unsigned int  previousGlyphIndex,
unsigned int  glyphIndex 
) const
virtual

Returns the kerning between the given pair of glyphs.

Parameters
previousGlyphIndexIndex of the font glyph data of the preceding glyph.
glyphIndexIndex of the font glyph data acquired from getGlyphIndex().
Returns
Kerning between the given glyph pair.

Reimplemented in kanzi::BitmapFontFile, kanzi::ItypeFontFile, and kanzi::FreeTypeFontFile.

FontHintingPreference kanzi::FontFile::getHintingPreference ( ) const

Gets the value of FontStyleConcept::HintingPreferenceProperty.

See also
setHintingPreference()
Since
Kanzi 3.9.0
void kanzi::FontFile::setHintingPreference ( FontHintingPreference  hintingPreference)

Sets the value of FontStyleConcept::HintingPreferenceProperty.

Parameters
hintingPreferenceThe hinting preference of the font.
See also
getHintingPreference()
Since
Kanzi 3.9.0
virtual GlyphDataSharedPtr kanzi::FontFile::getGlyphData ( unsigned int  glyphIndex)
virtual

Returns the bitmap data for the given glyph.

Parameters
glyphIndexIndex of the font glyph data acquired from getGlyphIndex().
Returns
Bitmap data for the given glyph.

Reimplemented in kanzi::BitmapFontFile, kanzi::ItypeFontFile, and kanzi::FreeTypeFontFile.

void kanzi::FontFile::setLineHeight ( float  lineHeight)
protected

Sets the line height for a font.

The line height is based on the size of the font.

Parameters
lineHeightLine height to set.
void kanzi::FontFile::setAscender ( float  ascender)
protected

Sets the ascender for a font.

The ascender is based on the size of the font.

Parameters
ascenderAscender to set.
void kanzi::FontFile::setDescender ( float  descender)
protected

Sets the descender for a font.

The descender is based on the size of the font.

Parameters
descenderDescender to set.

Friends And Related Function Documentation

friend class FontLoader
friend

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