Text Object

A text object is an object representing a plain text in a 3D space. The text is rendered into a texture that is applied to a flat polygon. It uses trilinear filtering and mipmaps to correctly display the text at any distance. There is no noise influence to the object and it is not distorted by TAA.

The font can be represented as a TrueType font (TTF) or as a texture atlas with letters.

Adding a Text Object#

To add a text object to the scene via UnigineEditor, do the following:

Run the project with UnigineEditor.
On the Menu bar, click Create -> Text.
Place the text object somewhere in the world.

Editing a Text Object#

Text

Text input field. If the Rich text option is enabled, you can use tags for text formatting.

Name

Path to a *.ttf file or to a texture atlas with letters.

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.

Color

Text color in the RGBA range.

Wrap Width

Text wrap width in units. The text will wrap if its physical size will be greater than the set value. If 0 is set, text wrapping is disabled.


Wrap Width = 0	Wrap Width = 5

Size

Font size, in dots. 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.

Resolution

Resolution of the texture into which the text will be rendered. The lower the value, the less detailed will be the text and the less video memory will be required for the texture.

Notice

The resolution doesn't influence the text's physical size.


Resolution = 50	Resolution = 200

HSpacing

Horizontal spacing between letters (a kerning value). This parameter affects the text's physical size.

VSpasing

Vertical spacing between letters (a kerning value). This parameter affects the text's physical size.

Rich text

Flag indicating if the rich text formatting is enabled. The following tags are supported:

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.

Depth Test

Flag indicating if depth test is performed for the text.

Outline

Flag indicating if the text outline is enabled. The outline looks like the dark shadow in the right lower corner of the text and is displaced by one dot.

Last update: 24.11.2020

Помогите сделать статью лучше

Была ли эта статья полезной?

Сообщить о проблеме в этой статье

(или выберите слово/фразу и нажмите Ctrl+Enter

Text Object

In This Article:

See Also#

Adding a Text Object#

Editing a Text Object#