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
This class represents the IG Symbols Controller interface. A symbol is a single drawing primitive or a group of drawing primitives that may be drawn on a symbol surface (plane) within a particular view or placed in 3D space relative to a particular entity.
The following symbol types are available: Polyline, Text, Circle.
Notice
IG plugin must be loaded.
SymbolsController Class
Enums
SYMBOL_TYPE#
| Name | Description |
|---|---|
| POLYLINE = 0 | Polyline. |
| TEXT = 1 | Text. |
| CIRCLE = 2 | Circle. |
Members
Symbol * cloneSymbol ( int symbol_id, int new_symbol_id ) #
Clones a symbol with the specified ID.Arguments
- int symbol_id - ID of the symbol to be cloned.
- int new_symbol_id - ID of the new symbol.
Return value
SymbolsPlane * createPlane ( int plane_id, View * view ) #
Creates a new symbols surface (a virtual plane on which symbols are drawn).A new surface is placed in 3D space coincident with the near clipping plane of the specified view.Arguments
- int plane_id - ID of the symbol.
- View * view - View relative to which a new symbols surface is to be placed.
Return value
SymbolsPlane * createPlane ( int plane_id, Entity * entity ) #
Creates a new symbols surface (a virtual plane on which symbols are drawn). A new surface is placed in 3D space relative to the specified entity.Arguments
- int plane_id - ID of the symbol.
- Entity * entity - Entity relative to which a new symbols surface is to be placed.
Return value
Symbol * getSymbol ( int symbol_id ) #
Returns the interface of the specified symbol.Arguments
- int symbol_id - ID of the symbol.
Return value
SymbolsPlane * getPlane ( int plane_id ) #
Returns the interface of the specified symbols surface (a virtual plane on which symbols are drawn).Arguments
- int plane_id - ID of the symbols surface.
Return value
Last update:
2021-04-29
Help improve this article
Was this article helpful?
(or select a word/phrase and press Ctrl+Enter)