Warning! This version of documentation is OUTDATED, as it describes an older SDK version! Please switch to the documentation for the latest SDK version.
Warning! This version of documentation describes an old SDK version which is no longer supported! Please upgrade to the latest SDK version.
No language code for this page. You can select other language.
No language code for this page,
shown in other instead.
shown in other instead.
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.
- An ObjectText class to edit text objects via API.
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 -> Object -> 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.
Names 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.
|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.
The resolution doesn't influence the text's physical size.
|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:
</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: 2017-07-03
Help improve this article
Was this article helpful?
(or select a word/phrase and press Ctrl+Enter)