KzuBitmapFont Struct Reference

Font structure for rendering text. More...

#include <user/util/font/kzu_bitmap_font.h>

Inheritance diagram for KzuBitmapFont:

Public Types
typedef kanzi::vector < kanzi::TextureSharedPtr >	TextureContainer

Public Member Functions
	KzuBitmapFont (kanzi::Domain *domain, kanzi::string_view name)
virtual	~KzuBitmapFont () KZ_OVERRIDE
Public Member Functions inherited from KzuFont
	KzuFont (kanzi::Domain *domain, kanzi::string_view name)
virtual	~KzuFont () KZ_OVERRIDE
Public Member Functions inherited from kanzi::Resource
KzcMemoryManager *	getMemoryManager () const
	Resource (Domain *domain, string_view name)
virtual	~Resource ()
virtual void	loadFromKZB (const KzuResourceLoaderThreadContext *threadContext, KzcInputStream *inputStream, const KzuBinaryFileInfo *file)
	Function for loading the resource from .KZB. More...
virtual void	finishLoadingOverride (const KzuResourceLoaderThreadContext *threadContext)
	Function for finishing the loading of the resource. More...
virtual void	unloadOverride ()
	Unload function for resource. More...
virtual kzUint	getCPUMemoryUsage () const
	Function for getting the memory usage of a resource. More...
void	setKZB (const KzuBinaryDirectory *binaryDirectory, kzString path)
void	setLoaded ()
kzString	getName () const
	Accessor. More...
void	load ()
void	unload ()
bool	isLoaded () const
void	kzuResourceLoad_private (const KzuResourceLoaderThreadContext *threadContext)
	Private function for kzuResourceLoad() with specified thread context. More...
void	kzuResourceFinishLoading_private (const KzuResourceLoaderThreadContext *threadContext)
	Private function for finishing the loading of the resource. More...
KzuResourceLoadingStrategy	getLoadingStrategy () const
void	setLoadingStrategy (KzuResourceLoadingStrategy loadingStrategy)
bool	getKeepAlive () const
	Tells if the resource has keep alive flag set. More...
void	setKeepAlive (bool keepAlive)
	Sets the keep alive flag. More...
Public Member Functions inherited from kanzi::Object
	Object (Domain *domain)
virtual	~Object ()
Domain *	getDomain () const
	Returns the domain the object belongs to. More...
KzuPropertyManager *	getPropertyManager () const
	Returns the property manager of the object. More...
KzuTaskScheduler *	getTaskScheduler () const
	Returns the task scheduler of the object. More...
KzuMessageDispatcher *	getMessageDispatcher () const
	Returns the message dispatcher of the object. More...
ResourceManager *	getResourceManager () const
	Returns the resource manager of the object. More...
virtual const Metaclass *	getDynamicMetaclass () const
	Returns the metaclass of the dynamic type of the object. More...
bool	isTypeOf (const Metaclass *objectType) const
	Determines if the type of this object is the given type or derived from it. More...
template<typename DataType >
void	setProperty (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::DataType value)
	Sets the local value of a property. More...
void	setProperty (const PropertyType< ResourceID > &propertyType, ResourceSharedPtr value)
	Sets the local value of a resource id property with a resource pointer. More...
template<typename DataType >
DataType	getProperty (const PropertyType< DataType > &propertyType) const
	Returns the current value of a property. More...
template<typename DataType >
bool	getProperty (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::DataType &value) 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 >
void	setAbstractProperty (AbstractPropertyType abstractPropertyType, typename PropertyType< DataType >::DataType value)
void	setAbstractProperty (AbstractPropertyType abstractPropertyType, ResourceSharedPtr value)
template<typename DataType >
DataType	getAbstractProperty (AbstractPropertyType abstractPropertyType) const
template<typename DataType >
bool	getAbstractProperty (AbstractPropertyType abstractPropertyType, typename PropertyType< DataType >::DataType &value) const
bool	hasValue (AbstractPropertyType propertyType) const
	Evaluates whether there are any inputs into the property value. More...
bool	hasLocalValue (AbstractPropertyType propertyType) const
	Evaluates whether there is a local value set for the property. More...
void	removeLocalValue (AbstractPropertyType propertyType)
	Removes the local value associated with the property. More...
void	copyLocalValues (const Object &other)
	Copies all local values from another object. More...
virtual void	onPropertyChanged (AbstractPropertyType propertyType, KzuPropertyNotificationReason reason)
	Virtual function to handle property change notifications. More...
AppliedStyleEntry *	applyObjectStyle (kanzi::StyleSharedPtr style)
	Applies a style to an object. More...
void	unapplyObjectStyle (AppliedStyleEntry *appliedStyleEntry)
void	applyObjectStyles ()
	Apply all styles for an object node. More...
void	unapplyObjectStyles ()
	Unapplies and removes all applied styles. More...

Public Attributes
struct KzuBitmapFontSystem *	system
	Reference to bitmap font system. More...
kanzi::ResourceManager *	resourceManager
	Resource manager for the bitmap font. More...
struct KzcHashMap *	characters
	Available characters. More...
struct KzcHashMap *	kerningPairs
	Available kerning pairs. More...
kzUint	size
	Height of font. More...
kzUint	lineHeight
	Height of a line. More...
kzUint	ascender
	Base line position. More...
kzUint	textureCount
	How many textures this font requires. More...
kzFloat	scale
	Font scale factor relative to the size which the bitmap font was generated. More...
struct KzcColorRGBA	color
	Current drawing color of the font. More...
TextureContainer	fontTextures
	Texture used with this font. More...
struct KzcDynamicArray *	textureNames
	Names of bitmap files constructing this font. More...
Public Attributes inherited from KzuFont
const struct KzuFontClass *	fontClass
	Class of the font. More...

Additional Inherited Members
Static Public Member Functions inherited from kanzi::Object
static const Metaclass *	getStaticMetaclass ()
	Returns the metaclass of Object class. More...
static PropertyTypeEditorInfoSharedPtr	makeEditorInfo ()
	Default implementation that returns empty editor info. More...
Protected Types inherited from kanzi::Object
typedef vector < AppliedStyleEntry * >	AppliedStyleContainer
	Applied style container. More...
Protected Member Functions inherited from kanzi::Resource
KzuResourceLoadState	getLoadState ()
	Access. More...
Protected Member Functions inherited from kanzi::Object
void	initialize ()
void	onCopy (const Object &other)
Protected Attributes inherited from kanzi::Object
AppliedStyleContainer	m_appliedStyles
	Listing of applied styles applied to this object. More...

Detailed Description

Font structure for rendering text.

Member Typedef Documentation

typedef kanzi::vector<kanzi::TextureSharedPtr> KzuBitmapFont::TextureContainer

Constructor & Destructor Documentation

KzuBitmapFont::KzuBitmapFont ( kanzi::Domain *  domain, kanzi::string_view  name  )

inline

virtual KzuBitmapFont::~KzuBitmapFont ( )

virtual

Member Data Documentation

struct KzuBitmapFontSystem* KzuBitmapFont::system

Reference to bitmap font system.

kanzi::ResourceManager* KzuBitmapFont::resourceManager

Resource manager for the bitmap font.

struct KzcHashMap* KzuBitmapFont::characters

Available characters.

<kzUint, KzuFontCharacter>

struct KzcHashMap* KzuBitmapFont::kerningPairs

Available kerning pairs.

<struct KzuFontKerningPairKey, kzInt>.

kzUint KzuBitmapFont::size

Height of font.

kzUint KzuBitmapFont::lineHeight

Height of a line.

kzUint KzuBitmapFont::ascender

Base line position.

kzUint KzuBitmapFont::textureCount

How many textures this font requires.

kzFloat KzuBitmapFont::scale

Font scale factor relative to the size which the bitmap font was generated.

struct KzcColorRGBA KzuBitmapFont::color

Current drawing color of the font.

TextureContainer KzuBitmapFont::fontTextures

Texture used with this font.

struct KzcDynamicArray* KzuBitmapFont::textureNames

Names of bitmap files constructing this font.

---

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

• user/util/font/kzu_bitmap_font.h