GUI Font A font implementation that will parse the output of the AngelCode font tool available at: More...

#include <tdme/gui/renderer/GUIFont.h>

Collaboration diagram for GUIFont:

Public Member Functions
	GUIFont ()
	Public constructor. More...

	~GUIFont ()
	Destructor. More...

void	initialize ()
	Init. More...

void	dispose ()
	Dispose. More...

Texture *	getTexture ()

int32_t	getTextureId ()

GUICharacter *	getCharacter (uint32_t charId)
	Get character defintion. More...

float	getLineHeight ()

float	getBaseLine ()

int	getTextIndexX (const MutableString &text, int offset, int length, int index)
	Get text index X of given text and index. More...

int	getTextIndexByX (const MutableString &text, int offset, int length, int textX)
	Get text index by text and X in space of text. More...

int	getTextWidth (const MutableString &text)
	Text width. More...

int	getTextIndexXAtWidth (const MutableString &text, int width)
	Get text index X at width. More...

void	drawCharacter (GUIRenderer guiRenderer, GUICharacter character, int x, int y, const GUIColor &color=GUIColor::GUICOLOR_WHITE)
	Draw character. More...

void	drawCharacterBackground (GUIRenderer guiRenderer, GUICharacter character, int x, int y, int lineHeight, const GUIColor &color)
	Draw background. More...

void	drawString (GUIRenderer *guiRenderer, int x, int y, const MutableString &text, int offset, int length, const GUIColor &color, int selectionStartIndex=-1, int selectionEndIndex=-1, const GUIColor &backgroundColor=GUIColor::GUICOLOR_TRANSPARENT)
	Draw string. More...

Static Public Member Functions
static GUIFont *	parse (const string &pathName, const string &fileName)
	Parse the font definition file. More...

Private Member Functions
GUICharacter *	parseCharacter (const string &line)
	Parse a single character line from the definition. More...

Private Attributes
Texture *	texture { nullptr }

int32_t	textureId { -1 }

unordered_map< uint32_t, GUICharacter * >	chars

float	lineHeight { 0.0f }

float	baseLine { 0.0f }

Detailed Description

GUI Font A font implementation that will parse the output of the AngelCode font tool available at:

See also

http://www.angelcode.com/products/bmfont/ This implementation copes with both the font display and kerning information allowing nicer looking paragraphs of text. Note that this utility only supports the text format definition file. This was found by google and its origin seems to be Slick2D (http://slick.ninjacave.com) which is under BSD license Copyright (c) 2013, Slick2D All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
Neither the name of the Slick2D nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS ��AS IS�� AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Author: kevin, Andreas Drewke

Version: $Id$

Definition at line 47 of file GUIFont.h.

Constructor & Destructor Documentation

◆ GUIFont()

GUIFont ( )

Public constructor.

Definition at line 43 of file GUIFont.cpp.

◆ ~GUIFont()

~GUIFont ( )

Destructor.

Definition at line 47 of file GUIFont.cpp.

Member Function Documentation

◆ dispose()

void dispose ( )

Dispose.

Definition at line 168 of file GUIFont.cpp.

◆ drawCharacter()

void drawCharacter	(	GUIRenderer *	guiRenderer,
		GUICharacter *	character,
		int	x,
		int	y,
		const GUIColor &	color = `GUIColor::GUICOLOR_WHITE`
	)

Draw character.

Parameters

guiRenderer	gui renderer
character	character
x	x
y	y
color	color

Definition at line 228 of file GUIFont.cpp.

◆ drawCharacterBackground()

void drawCharacterBackground	(	GUIRenderer *	guiRenderer,
		GUICharacter *	character,
		int	x,
		int	y,
		int	lineHeight,
		const GUIColor &	color
	)

Draw background.

Parameters

guiRenderer	gui renderer
character	character
x	x
y	y
lineHeight	line height
color	color

Definition at line 263 of file GUIFont.cpp.

◆ drawString()

void drawString	(	GUIRenderer *	guiRenderer,
		int	x,
		int	y,
		const MutableString &	text,
		int	offset,
		int	length,
		const GUIColor &	color,
		int	selectionStartIndex = `-1`,
		int	selectionEndIndex = `-1`,
		const GUIColor &	backgroundColor = `GUIColor::GUICOLOR_TRANSPARENT`
	)

Draw string.

Parameters

guiRenderer	gui renderer
x	x
y	y
text	text
offset	offset
length	length or 0 if full length
color	color
selectionStartIndex	selection start index
selectionEndIndex	selection end index
backgroundColor	background color

Definition at line 294 of file GUIFont.cpp.

◆ getBaseLine()

float getBaseLine ( )

inline

Returns: base line

Definition at line 127 of file GUIFont.h.

◆ getCharacter()

GUICharacter * getCharacter ( uint32_t charId )

inline

Get character defintion.

Parameters

charId character id

Returns: character definition

Definition at line 111 of file GUIFont.h.

◆ getLineHeight()

float getLineHeight ( )

inline

Returns: line height

Definition at line 120 of file GUIFont.h.

◆ getTextIndexByX()

int getTextIndexByX	(	const MutableString &	text,
		int	offset,
		int	length,
		int	textX
	)

Get text index by text and X in space of text.

Parameters

text	text
offset	offset
length	length or 0 if full length
textX	text X

Returns: text index

Definition at line 186 of file GUIFont.cpp.

◆ getTextIndexX()

int getTextIndexX	(	const MutableString &	text,
		int	offset,
		int	length,
		int	index
	)

Get text index X of given text and index.

Parameters

text	text
offset	offset
length	length or 0 if full length
index	index

Returns: text index x

Definition at line 173 of file GUIFont.cpp.

◆ getTextIndexXAtWidth()

int getTextIndexXAtWidth	(	const MutableString &	text,
		int	width
	)

Get text index X at width.

Parameters

text text

Returns: text width

Definition at line 216 of file GUIFont.cpp.

◆ getTexture()

Texture * getTexture ( )

inline

Returns: texture

Definition at line 95 of file GUIFont.h.

◆ getTextureId()

int32_t getTextureId ( )

inline

Returns: texture id

Definition at line 102 of file GUIFont.h.

◆ getTextWidth()

int getTextWidth ( const MutableString & text )

Text width.

Parameters

text text

Returns: text width

Definition at line 204 of file GUIFont.cpp.

◆ initialize()

void initialize ( )

Init.

Definition at line 163 of file GUIFont.cpp.

◆ parse()

GUIFont * parse	(	const string &	pathName,
		const string &	fileName
	)

static

Parse the font definition file.

Parameters

pathName	font path name
fileName	font file name

Exceptions

tdme::os::filesystem::FileSystemException

Definition at line 53 of file GUIFont.cpp.

◆ parseCharacter()

GUICharacter * parseCharacter ( const string & line )

private

Parse a single character line from the definition.

Parameters

line	line The line to be parsed

Returns: The character definition from the line

Definition at line 130 of file GUIFont.cpp.

Member Data Documentation

◆ baseLine

float baseLine { 0.0f }

private

Definition at line 54 of file GUIFont.h.

◆ chars

unordered_map<uint32_t, GUICharacter*> chars

private

Definition at line 52 of file GUIFont.h.

◆ lineHeight

float lineHeight { 0.0f }

private

Definition at line 53 of file GUIFont.h.

◆ texture

Texture* texture { nullptr }

private

Definition at line 50 of file GUIFont.h.

◆ textureId

int32_t textureId { -1 }

private

Definition at line 51 of file GUIFont.h.

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

/home/andreas/Development/drewke.net/tdme2/src/tdme/gui/renderer/GUIFont.h
/home/andreas/Development/drewke.net/tdme2/src/tdme/gui/renderer/GUIFont.cpp

Public Member Functions

Static Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ GUIFont()

◆ ~GUIFont()

Member Function Documentation

◆ dispose()

◆ drawCharacter()

◆ drawCharacterBackground()

◆ drawString()

◆ getBaseLine()

◆ getCharacter()

◆ getLineHeight()

◆ getTextIndexByX()

◆ getTextIndexX()

◆ getTextIndexXAtWidth()

◆ getTexture()

◆ getTextureId()

◆ getTextWidth()

◆ initialize()

◆ parse()

◆ parseCharacter()

Member Data Documentation

◆ baseLine

◆ chars

◆ lineHeight

◆ texture

◆ textureId