ObjectText Class

WarningThe scope of applications for UnigineScript is limited to implementing materials-related logic (material expressions, scriptable materials, brush materials). Do not use UnigineScript as a language for application logic, please consider C#/C++ instead, as these APIs are the preferred ones. Availability of new Engine features in UnigineScript (beyond its scope of applications) is not guaranteed, as the current level of support assumes only fixing critical issues.

Methods:

Name	Description View: Sort by:
ObjectText has overloads	Default constructor.
setText	Setter and Getter for the text set in the node.
getText	Setter and Getter for the text set in the node.
setTextColor	Setter and Getter for the color of the text.
getTextColor	Setter and Getter for the color of the text.
setTextWrapWidth	Setter and Getter for the text wrap width in units.
getTextWrapWidth	Setter and Getter for the text wrap width in units.
setDepthTest	Setter and Getter for the value indicating if the text object uses depth test.
getDepthTest
setFontOutline	Setter and Getter for the flag indicating if the text outline is enabled.
getFontOutline
setFontVSpacing	Setter and Getter for the vertical spacing between letters (kerning value).
getFontVSpacing
setFontHSpacing	Setter and Getter for the horizontal spacing between letters (kerning value).
getFontHSpacing
setFontResolution	Setter and Getter for the resolution of the texture into which the text will be rendered.
getFontResolution
setFontSize	Setter and Getter for the size of the text font.
getFontSize	Setter and Getter for the size of the text font.
setFontRich	Setter and Getter for the flag indicating if the rich text is enabled.
getFontRich
setFontName	Setter and Getter for the path to the TTF font.
getFontName	Setter and Getter for the path to the TTF font.
getTextWidth	Returns the current width of the text.
getTextHeight	Returns the current height of the text.
getTextAspect	Returns the current text aspect value, the proportional relationship between the text width and height.
getTextNumLines	Returns the current number of lines in the text.

ObjectText Class

Members

void setText ( string text ) #

Sets a new text set in the node.

Arguments

string text - The text set in the node.

const char * getText() const#

Returns the current text set in the node.

Return value

Current text set in the node.

void setTextColor ( vec4 color ) #

Sets a new color of the text.

Arguments

vec4 color - The color of the text in the RGBA range.

vec4 getTextColor() const#

Returns the current color of the text.

Return value

Current color of the text in the RGBA range.

void setTextWrapWidth ( ) #

Sets a new text wrap width in units. The text will wrap if its physical size will be greater than the set value.

Arguments

width - The text wrap width in units. The value of 0 means that text wrapping is disabled.

getTextWrapWidth() const#

Returns the current text wrap width in units. The text will wrap if its physical size will be greater than the set value.

Return value

Current text wrap width in units. The value of 0 means that text wrapping is disabled.

void setDepthTest ( int test ) #

Sets a new value indicating if the text object uses depth test.

Arguments

int test - The 1 to use depth test; otherwise, 0.

int getDepthTest() const#

Returns the current value indicating if the text object uses depth test.

Return value

Current 1 to use depth test; otherwise, 0.

void setFontOutline ( int outline ) #

Sets a new flag indicating if the text outline is enabled.

Arguments

int outline - The 1 — to enable the outline; 0 — to disable.

int getFontOutline() const#

Returns the current flag indicating if the text outline is enabled.

Return value

Current 1 — to enable the outline; 0 — to disable.

void setFontVSpacing ( int vspacing ) #

Sets a new vertical spacing between letters (kerning value). This parameter influences the text's physical size.

Arguments

int vspacing - The vertical spacing value.

int getFontVSpacing() const#

Returns the current vertical spacing between letters (kerning value). This parameter influences the text's physical size.

Return value

Current vertical spacing value.

void setFontHSpacing ( int hspacing ) #

Sets a new horizontal spacing between letters (kerning value). This parameter influences the text's physical size.

Arguments

int hspacing - The horizontal spacing value.

int getFontHSpacing() const#

Returns the current horizontal spacing between letters (kerning value). This parameter influences the text's physical size.

Return value

Current horizontal spacing value.

void setFontResolution ( int resolution ) #

Sets a new resolution of the texture into which the text will be rendered. The lower the value, the less detailed will be the text, the less video memory will be required for the texture. It doesn't influence the text's physical size.

Arguments

int resolution - The text font resolution value.

int getFontResolution() const#

Returns the current resolution of the texture into which the text will be rendered. The lower the value, the less detailed will be the text, the less video memory will be required for the texture. It doesn't influence the text's physical size.

Return value

Current text font resolution value.

void setFontSize ( int size ) #

Sets a new size of the text font. The more dots, the higher the size of the font. To match dots with a 3D space, there is a set value: 288 dots per unit. For example, if you have the Arial font with the size of 20, the physical height of the letter can be calculated as 20/288=0.0694 units.

Arguments

int size - The size of the text font, in dots.

int getFontSize() const#

Returns the current size of the text font. The more dots, the higher the size of the font. To match dots with a 3D space, there is a set value: 288 dots per unit. For example, if you have the Arial font with the size of 20, the physical height of the letter can be calculated as 20/288=0.0694 units.

Return value

Current size of the text font, in dots.

void setFontRich ( int rich ) #

Sets a new flag indicating if the rich text is enabled. When enabled, the following tags can be used for text formatting:

text specifies a bold text.
text specifies an italic text.
 text inserts a single line break.
<left>text</left> left-aligns the text.
<right>text</right> right-aligns the text.
<center>text</center> center-aligns the text.
text specifies the alignment of the text within a paragraph:
- left - left-aligns the text
- right - right-aligns the text
- center - center-aligns the text
- justify - stretches the lines so that each line has equal width (like in newspapers and magazines)
Notice
Text alignment requires text wrapping to be enabled: the value of the Wrap Width parameter must be greater than 0.
 text specifies the font face, font size, and color of text.
 text defines subscript text. Subscript text appears half a character below the normal line, and is sometimes rendered in a smaller font.
 text defines superscript text. Superscript text appears half a character above the normal line, and is sometimes rendered in a smaller font.

Notice

<image/> and <table/> tags are not available.

Arguments

int rich - The 1 — to enable the rich text; 0 — to disable.

int getFontRich() const#

Returns the current flag indicating if the rich text is enabled. When enabled, the following tags can be used for text formatting:

text specifies a bold text.
text specifies an italic text.
 text inserts a single line break.
<left>text</left> left-aligns the text.
<right>text</right> right-aligns the text.
<center>text</center> center-aligns the text.
text specifies the alignment of the text within a paragraph:
- left - left-aligns the text
- right - right-aligns the text
- center - center-aligns the text
- justify - stretches the lines so that each line has equal width (like in newspapers and magazines)
Notice
Text alignment requires text wrapping to be enabled: the value of the Wrap Width parameter must be greater than 0.
 text specifies the font face, font size, and color of text.
 text defines subscript text. Subscript text appears half a character below the normal line, and is sometimes rendered in a smaller font.
 text defines superscript text. Superscript text appears half a character above the normal line, and is sometimes rendered in a smaller font.

Notice

<image/> and <table/> tags are not available.

Return value

Current 1 — to enable the rich text; 0 — to disable.

void setFontName ( string name ) #

Sets a new path to the TTF font.

NoticeNames of font files for bold, italic and bold italic fonts must have the b, i and bi postfixes correspondingly. For example: myfontb.ttf, myfontbi.ttf.

Arguments

string name - The path to the TTF font relative to the data directory.

const char * getFontName() const#

Returns the current path to the TTF font.

NoticeNames of font files for bold, italic and bold italic fonts must have the b, i and bi postfixes correspondingly. For example: myfontb.ttf, myfontbi.ttf.

Return value

Current path to the TTF font relative to the data directory.

float getTextWidth() const#

Returns the current width of the text.

Return value

Current width of the text, in units.

float getTextHeight() const#

Returns the current height of the text.

Return value

Current height of the text, in units.

float getTextAspect() const#

Returns the current text aspect value, the proportional relationship between the text width and height.

Return value

Current proportional relationship between the text width and height.

int getTextNumLines() const#

Returns the current number of lines in the text.

Return value

Current number of lines in the text.

static ObjectText ( ) #

Default constructor. Creates an empty object with no text and font set.

static ObjectText ( string font_name ) #

Constructor. Creates an object with no text but with the specified font.

Arguments

string font_name - The path to the TTF font relatively to the data directory.

static ObjectText ( string font_name, string text ) #

Constructor. Creates an object with the set font and text.

Arguments

string font_name - The path to the TTF font relatively to the data directory.
string text - The text (can be either plain or rich).

_{The information on this page is valid for UNIGINE 2.20 SDK.}

Last update: 2025-02-19

Help improve this article

Was this article helpful?

Report a problem related to this article

(or select a word/phrase and press Ctrl+Enter)

ObjectText Class

In This Article:

Methods:

ObjectText Class

Members

void setText ( string text ) #

Arguments

const char * getText() const#

Return value

void setTextColor ( vec4 color ) #

Arguments

vec4 getTextColor() const#

Return value

void setTextWrapWidth ( ) #

Arguments

getTextWrapWidth() const#

Return value

void setDepthTest ( int test ) #

Arguments

int getDepthTest() const#

Return value

void setFontOutline ( int outline ) #

Arguments

int getFontOutline() const#

Return value

void setFontVSpacing ( int vspacing ) #

Arguments

int getFontVSpacing() const#

Return value

void setFontHSpacing ( int hspacing ) #

Arguments

int getFontHSpacing() const#

Return value

void setFontResolution ( int resolution ) #

Arguments

int getFontResolution() const#

Return value

void setFontSize ( int size ) #

Arguments

int getFontSize() const#

Return value

void setFontRich ( int rich ) #

Arguments

int getFontRich() const#

Return value

void setFontName ( string name ) #

Arguments

const char * getFontName() const#

Return value

float getTextWidth() const#

Return value

float getTextHeight() const#

Return value

float getTextAspect() const#

Return value

int getTextNumLines() const#

Return value

static ObjectText ( ) #

static ObjectText ( string font_name ) #

Arguments

static ObjectText ( string font_name, string text ) #

Arguments