This page has been translated automatically.
视频教程
界面
要领
高级
实用建议
专业(SIM)
UnigineEditor
界面概述
资产工作流程
设置和首选项
项目开发
调整节点参数
Setting Up Materials
设置属性
照明
Landscape Tool
Sandworm
使用编辑器工具执行特定任务
如何擴展編輯器功能
嵌入式节点类型
Nodes
Objects
Effects
Decals
光源
Geodetics
World Nodes
Sound Objects
Pathfinding Objects
Players
编程
基本原理
搭建开发环境
使用范例
C++
C#
UnigineScript
UUSL (Unified UNIGINE Shader Language)
Plugins
File Formats
Materials and Shaders
Rebuilding the Engine Tools
GUI
双精度坐标
应用程序接口
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
创建内容
内容优化
Materials
Material Nodes Library
Miscellaneous
Input
Math
Matrix
Textures
Art Samples
Tutorials

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 <plugins/UnigineCIGIConnector.h>
Inherits from: CigiHostPacket

CigiSymbolTextDef Class

Enums

CIGI_TEXT_ALIGN#

NameDescription
CIGI_TEXT_ALIGN_TOP_LEFT = 0Text alignment in the top left corner.
CIGI_TEXT_ALIGN_TOP_CENTER = 1Text alignment in the top center position.
CIGI_TEXT_ALIGN_TOP_RIGHT = 2Text alignment in the top right corner.
CIGI_TEXT_ALIGN_CENTER_LEFT = 3Text alignment in the middle left position.
CIGI_TEXT_ALIGN_CENTER = 4Text alignment in the center of field.
CIGI_TEXT_ALIGN_CENTER_RIGHT = 5Text alignment in the middle right position.
CIGI_TEXT_ALIGN_BOTTOM_LEFT = 6Text alignment in the bottom left corner.
CIGI_TEXT_ALIGN_BOTTOM_CENTER = 7Text alignment in the bottom center position.
CIGI_TEXT_ALIGN_BOTTOM_RIGHT = 8Text alignment in the bottom right corner.

CIGI_TEXT_ORIENT#

NameDescription
CIGI_TEXT_ORIENT_LEFT_TO_RIGHT = 0Left to Right orientation of text.
CIGI_TEXT_ORIENT_TOP_TO_BOTTOM = 1Top to Bottom orientation of text.
CIGI_TEXT_ORIENT_RIGHT_TO_LEFT = 2Right to Left orientation of text.
CIGI_TEXT_ORIENT_BOTTOM_TO_TOP = 3Bottom to Top orientation of text.

Members


int getSymbolID ( ) const#

Returns the Symbol ID specified in the packet.

Return value

Symbol ID.

int getFontID ( ) const#

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 ( ) const#

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_ALIGN_* values.

int getOrientation ( ) const#

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_ORIENT_*_TO_* values.

float getFontSize ( ) const#

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 char * getText ( ) const#

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: 2021-11-30
Build: ()