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.
You should upgrade to
| 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.
- 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.
- 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:
2020-11-24
Help improve this article
Was this article helpful?
(or select a word/phrase and press Ctrl+Enter)