UnigineEditor
Interface Overview
Assets Workflow
Settings and Preferences
Adjusting Node Parameters
Setting Up Materials
Setting Up Properties
Landscape Tool
Using Editor Tools for Specific Tasks
FAQ
编程
Fundamentals
Setting Up Development Environment
Usage Examples
UnigineScript
C++
C#
UUSL (Unified UNIGINE Shader Language)
File Formats
Rebuilding the Engine and Tools
GUI
Double Precision Coordinates
应用程序接口
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
CIGI Client Plugin
Rendering-Related Classes

IG::ISymbolsController Class

Header: #include <UnigineIGInterface.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.

ISymbolsController Class

Members


ISymbol * createSymbol ( int type, int symbol_id ) #

Creates a new symbol.
Notice
ISymbol must be immediately added to ISymbolsPlane.

Arguments

  • int type - Type of the symbol:
    • 0 for POLYLINE
    • 1 for TEXT
    • 2 for CIRCLE
  • int symbol_id - ID of the symbol.

Return value

Pointer to the new created symbol interface.

ISymbol * 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.

ISymbolsPlane * createPlane ( int plane_id, IView * 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.
  • IView * view - View relative to which a new symbols surface is to be placed.

Return value

Pointer to the new created symbols surface interface.

ISymbolsPlane * createPlane ( int plane_id, IEntity * 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.
  • IEntity * entity - Entity relative to which a new symbols surface is to be placed.

Return value

Pointer to the new created symbols surface interface.

ISymbol * getSymbol ( int symbol_id ) #

Returns the interface of the specified symbol.

Arguments

  • int symbol_id - ID of the symbol.

Return value

Pointer to the symbol interface.

ISymbolsPlane * 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

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: 2019-08-16