Skylicht::CGUIText Class Reference

This is the object class for displaying a text. More...

#include <Graphics2D/GUI/CGUIText.h>

Inheritance diagram for Skylicht::CGUIText:

Public Types
typedef std::vector< int >	ArrayInt
typedef std::vector< SModuleOffset * >	ArrayModuleOffset

Public Member Functions
virtual void	render (CCamera *camera)
void	setTextAlign (EGUIHorizontalAlign h, EGUIVerticalAlign v)
void	setFormatText (const char *formatText)
void	setColorFormat (int id, const SColor &c)
void	setText (const char *text)
void	setTextStrim (const char *text)
void	setText (const wchar_t *text)
void	setTextStrim (const wchar_t *text)
void	setTextId (const char *textId)
void	setTextId (const wchar_t *textId)
int	getStringWidth (const char *text)
int	getStringWidth (const wchar_t *text)
int	getCharWidth (wchar_t c)
const char *	getText ()
const char *	getDefaultText ()
void	setDefaultText (const char *text)
void	setDefaultText (const wchar_t *text)
const wchar_t *	getTextW ()
const char *	getTextId ()
const wchar_t *	getTextwId ()
int	getTextLength ()
bool	isStrim ()
void	setEnableTextFormnat (bool b)
bool	isEnableTextFormat ()
void	setPassword (bool b)
bool	isPassword ()
void	setCharPadding (int charPadding)
void	setLinePadding (int linePadding)
void	setMultiLine (bool b)
void	setCenterRotate (bool b)
void	setFontSource (const char *fontSource)
void	setFontSource (CFontSource *fontData)
void	setCustomFont (IFont *font)
IFont *	getCustomFont ()
CFontSource *	getFontData ()
const std::string &	getFontSource ()
const std::string &	getFontId ()
virtual CObjectSerializable *	createSerializable ()
virtual void	loadSerializable (CObjectSerializable *object)
void	getClosestCharacter (float posX, float posY, int &line, int &character)
void	showCaret (bool b)
void	setCaret (int line, int character)
void	setCaret (int charPos)
void	getCaretPosition (int &line, int &character)
int	getNumLine ()
int	getNumCharacter (int line)
bool	getWordAtPosition (int line, int charPosition, int &from, int &to)
bool	isCharacter (wchar_t c)
void	doBackspace ()
void	doDelete ()
void	insert (wchar_t c)
Public Member Functions inherited from Skylicht::CGUIElement
void	remove ()
void	removeAllChilds ()
CCanvas *	getCanvas ()
CGUIElement *	getParent ()
void	setName (const char *name)
const char *	getName ()
const char *	getID ()
void	setTagInt (int i)
void	setTagString (const char *s)
int	getTagInt ()
const std::string &	getTagString ()
void	setName (const wchar_t *name)
std::wstring	getNameW ()
void	setParent (CGUIElement *parent)
std::vector< CGUIElement * > &	getChilds ()
void	getAllChilds (std::vector< CGUIElement * > &childs)
void	setColor (const SColor &c)
const SColor &	getColor ()
float	getHeight ()
float	getWidth ()
void	setHeight (float h)
void	setWidth (float w)
const core::rectf &	getRect ()
virtual const core::rectf	getNativeRect ()
int	getDepth ()
int	getRenderOrder ()
void	setDock (EGUIDock dock)
EGUIDock	getDock ()
const SMargin &	getMargin ()
void	setMargin (const SMargin &m)
void	setMargin (float l, float t, float r, float b)
void	setRect (const core::rectf &r)
void	setWorldTransform (const core::matrix4 &world)
void	setRelativeTransform (const core::matrix4 &relative)
const core::vector3df	getAlignPosition ()
const core::vector3df &	getPosition ()
void	invalidate ()
void	setPosition (const core::vector3df &v)
const core::vector3df &	getScale ()
void	setScale (const core::vector3df &v)
const core::vector3df &	getRotation ()
void	setRotation (const core::vector3df &v)
core::quaternion	getRotationQuaternion ()
EGUIVerticalAlign	getVerticalAlign ()
EGUIHorizontalAlign	getHorizontalAlign ()
void	setVerticalAlign (EGUIVerticalAlign a)
void	setHorizontalAlign (EGUIHorizontalAlign a)
void	setAlign (EGUIHorizontalAlign h, EGUIVerticalAlign v)
void	setShaderID (int id)
int	getShaderID ()
int	getMaterialId ()
void	setMaterialId (int id)
void	setMaterial (CMaterial *material)
void	setMaterialSource (const char *materialFile)
CMaterial *	getMaterial ()
CGUIMask *	getMask ()
CGUIMask *	getParentMask ()
void	setMask (CGUIMask *mask)
void	setDrawBorder (bool b)
bool	isEnableMaterial ()
virtual void	update (CCamera *camera)
const core::matrix4 &	getRelativeTransform ()
const core::matrix4 &	getAbsoluteTransform ()
void	setVisible (bool b)
bool	isVisible ()
bool	isVisibleInHierarchy ()
CEntity *	getEntity ()
void	notifyChanged ()
CGUIElement *	getChildBefore (CGUIElement *object)
void	bringToNext (CGUIElement *object, CGUIElement *target, bool behind)
void	bringToChild (CGUIElement *object)
bool	isChild (CGUIElement *e)
CGUIElement *	getGUIByPath (const char *path)
void	generateNewId ()

Protected Member Functions
	CGUIText (CCanvas *canvas, CGUIElement *parent, IFont *font)
	CGUIText (CCanvas *canvas, CGUIElement *parent, const core::rectf &rect, IFont *font)
virtual void	renderText (ArrayModuleOffset &string, ArrayInt &format, int posX, int posY, int line)
void	init ()
void	updateCaret ()
void	updateSetCaret ()
void	updateSplitText ()
void	splitText (std::vector< ArrayModuleOffset > &split, std::vector< ArrayInt > &format, std::vector< ArrayInt > &id, int width)
void	getClosestCharacter (float posX, int x, int y, int line, const core::matrix4 &world, int &character)
wchar_t	getDisplayCharacter (wchar_t c) const
void	initFont (IFont *font)
IFont *	getCurrentFont ()
Protected Member Functions inherited from Skylicht::CGUIElement
	CGUIElement (CCanvas *canvas, CGUIElement *parent)
	CGUIElement (CCanvas *canvas, CGUIElement *parent, const core::rectf &rect)
void	applyCurrentMask (CGUIMask *mask)
CGUIMask *	getCurrentMask ()
bool	removeChild (CGUIElement *child)

Protected Attributes
IFont *	m_font
IFont *	m_customfont
int	m_charPadding
int	m_charSpacePadding
int	m_linePadding
bool	m_strim
std::string	m_defaultText
std::string	m_text
std::wstring	m_textw
ArrayInt	m_textFormat
bool	m_enableTextFormat
bool	m_password
std::string	m_textId
std::wstring	m_textwId
EGUIVerticalAlign	TextVertical
EGUIHorizontalAlign	TextHorizontal
int	m_textHeight
int	m_textOffsetY
bool	m_multiLine
bool	m_centerRotate
SColor	m_colorFormat [MAX_FORMATCOLOR]
bool	m_updateTextRender
std::vector< ArrayModuleOffset >	m_arrayCharRender
std::vector< ArrayInt >	m_arrayCharFormat
std::vector< ArrayInt >	m_arrayCharId
std::string	m_fontSource
std::string	m_fontGUID
CFontSource *	m_fontData
int	m_fontChanged
float	m_lastWidth
float	m_lastHeight
bool	m_showCaret
int	m_caretShader
int	m_setCaret
float	m_caretBlink
float	m_caretBlinkSpeed
core::vector2di	m_caret
Protected Attributes inherited from Skylicht::CGUIElement
CGUIElement *	m_parent
std::vector< CGUIElement * >	m_childs
CCanvas *	m_canvas
CGUIMask *	m_mask
CGUIMask *	m_applyCurrentMask
bool	m_drawBorder
bool	m_enableMaterial
int	m_renderOrder
ArrayMaterial	m_materials
int	m_materialId
CEntity *	m_entity
CWorldTransformData *	m_transform
CGUITransformData *	m_guiTransform
CGUIAlignData *	m_guiAlign
CGUIRenderData *	m_renderData
std::string	m_materialFile
int	m_tagInt
std::string	m_tagString

Friends
class	CCanvas

Additional Inherited Members
Public Attributes inherited from Skylicht::CGUIElement
std::function< void(CGUIElement *)>	OnRender

Detailed Description

This is the object class for displaying a text.

See also

CFontSource, CGlyphFont, CSpriteFont

CFontSource* fontSource = CFontManager::getInstance()->loadFontSource("SampleGUI/Fonts/Roboto.font");
IFont* font = NULL;
if (fontSource)
{
    fontSource->initFont();
    font = fontSource->getFont();
}
 
CCanvas *canvas = gameobject->addComponent<CCanvas>();
core::rectf r(0.0f, 0.0f, 100.0f, 100.0f);
CGUIText* gui = canvas->createText(r, font);
gui->setText("Hello");

Member Function Documentation

createSerializable()

virtual CObjectSerializable * Skylicht::CGUIText::createSerializable ( )

virtual

Reimplemented from Skylicht::CGUIElement.

loadSerializable()

virtual void Skylicht::CGUIText::loadSerializable ( CObjectSerializable * object )

virtual

Reimplemented from Skylicht::CGUIElement.

render()

virtual void Skylicht::CGUIText::render ( CCamera * camera )

virtual

Reimplemented from Skylicht::CGUIElement.

---

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

• Graphics2D/GUI/CGUIText.h