This page has been translated automatically.
Видеоуроки
Interface
Essentials
Advanced
Подсказки и советы
Программирование на C#
Рендеринг
Принципы работы
Свойства (properties)
Компонентная Система
Рендер
Физика
Редактор UnigineEditor
Обзор интерфейса
Работа с ассетами
Настройки и предпочтения
Работа с проектами
Настройка параметров узла
Setting Up Materials
Setting Up Properties
Освещение
Landscape Tool
Sandworm
Использование инструментов редактора для конкретных задач
Extending Editor Functionality
Встроенные объекты
Nodes
Objects
Effects
Decals
Light Sources
Geodetics
World Objects
Sound Objects
Pathfinding Objects
Players
Программирование
Основы
Настройка среды разработки
Примеры использования
UnigineScript
C++
C#
Унифицированный язык шейдеров UUSL
File Formats
Rebuilding the Engine Tools
GUI
Двойная точность координат
API
Containers
Common Functionality
Controls-Related Classes
Engine-Related Classes
Filesystem Functionality
GUI-Related Classes
Math Functionality
Node-Related Classes
Objects-Related Classes
Networking Functionality
Pathfinding-Related Classes
Physics-Related Classes
Plugins-Related Classes
IG Plugin
Rendering-Related Classes
Работа с контентом
Оптимизация контента
Материалы
Art Samples
Tutorials
Внимание! Эта версия документация УСТАРЕЛА, поскольку относится к более ранней версии SDK! Пожалуйста, переключитесь на самую актуальную документацию для последней версии SDK.
Внимание! Эта версия документации описывает устаревшую версию SDK, которая больше не поддерживается! Пожалуйста, обновитесь до последней версии SDK.

CigiSymbolTextDef Class

Warning
The functionality described in this article is not available in the Community SDK edition.
You should upgrade to Sim SDK edition to use it.
Header: #include <UnigineCIGIConnector.h>

CigiSymbolTextDef Class

Members


int getSymbolID ( ) #

Returns the Symbol ID specified in the packet.

Return value

Symbol ID.

int getFontID ( ) #

Returns the value of the Font ID parameter specified in the packet. Determines the font that is used for this text symbol.

Return value

Font ID parameter value. The following values are supported:
  • 0 - IG Default.
Proportional:
  • 1 - Sans Serif.
  • 2 - Sans Serif Bold.
  • 3 - Sans Serif Italic.
  • 4 - Sans Serif Bold Italic.
  • 5 - Serif.
  • 6 - Serif Bold.
  • 7 - Serif Italic.
  • 8 - Serif Bold Italic.
Monospace:
  • 9 - Sans Serif.
  • 10 - Sans Serif Bold.
  • 11 - Sans Serif Italic.
  • 12 - Sans Serif Bold Italic.
  • 13 - Serif.
  • 14 - Serif Bold.
  • 15 - Serif Italic.
  • 16 - Serif Bold Italic.
  • 17-255 - IG-defined.

int getAlignment ( ) #

Returns the value of the Alignment parameter specified in the packet. Specifies the position at which the IG shall place the symbol’s reference point in relation to the text.

Return value

Alignment parameter value. One of the CIGI_TEXT_* values.

int getOrientation ( ) #

Returns the value of the Orientation parameter specified in the packet. Determines the orientation of text.

Return value

Orientation parameter value. One of the CIGI_TEXT_*_TO_* values.

float getFontSize ( ) #

Returns the value of the Font Size parameter specified in the packet. Specifies the font size in terms of the vertical units defined by the symbols surface's 2D coordinate system.

Return value

Font Size parameter value.

const String & getText ( ) #

Returns the value of the Octet parameter specified in the packet.

Return value

Octet parameter value.
Notice
The maximum length of the string, including a terminating NULL, is 236 bytes.
Last update: 09.04.2021
Build: ()