This page has been translated automatically.
视频教程
界面
要领
高级
实用建议
UnigineEditor
界面概述
资产工作流程
设置和首选项
项目开发
调整节点参数
Setting Up Materials
Setting Up Properties
照明
Landscape Tool
Sandworm
使用编辑器工具执行特定任务
Extending Editor Functionality
嵌入式节点类型
Nodes
Objects
Effects
Decals
光源
Geodetics
World Nodes
Sound Objects
Pathfinding Objects
Players
编程
基本原理
搭建开发环境
Usage Examples
C++
C#
UnigineScript
UUSL (Unified UNIGINE Shader Language)
Plugins
File Formats
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
CIGIConnector Plugin
Rendering-Related Classes
创建内容
Content Optimization
Materials
Art Samples
Tutorials

Unigine::Plugins::IG::SymbolsController 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/UnigineIG.h>

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#

NameDescription
SYMBOL_TYPE_POLYLINE = 0Polyline.
SYMBOL_TYPE_TEXT = 1Text.
SYMBOL_TYPE_CIRCLE = 2Circle.

Members


Symbol * createSymbol ( SymbolsController::SYMBOL_TYPE type, int symbol_id ) #

Creates a new symbol.
Notice
Symbol must be immediately added to SymbolsPlane.

Arguments

Return value

Pointer to the new created symbol interface.

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

Pointer to the new cloned symbol interface.

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

Pointer to the new created symbols surface interface.

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

Pointer to the new created symbols surface interface.

Symbol * getSymbol ( int symbol_id ) const#

Returns the interface of the specified symbol.

Arguments

  • int symbol_id - ID of the symbol.

Return value

Pointer to the symbol interface.

SymbolsPlane * getPlane ( int plane_id ) const#

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

Pointer to the symbols surface interface.

void removeSymbol ( int symbol_id ) #

Removes the symbol with the specified ID.

Arguments

  • int symbol_id - ID of the symbol to be removed.

void removePlane ( int plane_id ) #

Removes the symbols surface (plane) with the specified ID, and all symbols related to it.

Arguments

  • int plane_id - ID of the symbols surface (plane) to be removed.

void clear ( ) #

Removes all symbols and planes.
Last update: 2021-02-17
Build: ()