This page has been translated automatically.
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
API
Containers
Common Functionality
Controls-Related Classes
Engine-Related Classes
Filesystem Functionality
GUI-Related Classes
Math Functionality
Node-Related Classes
Networking Functionality
Pathfinding-Related Classes
Physics-Related Classes
Plugins-Related Classes
Rendering-Related Classes
Внимание! Эта версия документация УСТАРЕЛА, поскольку относится к более ранней версии SDK! Пожалуйста, переключитесь на самую актуальную документацию для последней версии SDK.
Внимание! Эта версия документации описывает устаревшую версию SDK, которая больше не поддерживается! Пожалуйста, обновитесь до последней версии SDK.

Unigine::Cigi::ICigiSymbolShortControl Class

Header:#include <CigiClientInterface.h>
Inherits:ICigiHostPacket

This class represents the CIGI Short Symbol Control packet interface.

Notice
CIGI plugin must be loaded.

ICigiSymbolShortControl Class

Members


int getSymbolID()

Returns the Symbol ID specified in the packet. It specifies the symbol to which this packet shall be applied.

Return value

Symbol ID parameter value.

int getSymbolState()

Returns the Symbol State specified in the packet.

Return value

Symbol State parameter value. The following values are supported:
  • 0 - Hidden.
  • 1 - Visible.
  • 2 - Destroyed.

int getAttachState()

Returns the value of the Attach State parameter specified in the packet. Determines whether the symbol will be attached as a child to a parent symbol.

Return value

Attach State parameter value. 1 the symbol is attached as a child; otherwise, 0.

int getFlashControl()

Returns the value of the Flash Control parameter specified in the packet. Defines whether the IG shall continue the symbol’s flash cycle from its present state or restart it from the beginning.

Return value

Flash Control parameter value: 0 if Continue; otherwise, 1.

int getInheritColor()

Returns the value of the Inherit Color parameter specified in the packet. Specifies whether this symbol inherits its color from the symbol to which it is attached.

Return value

Inherit Color parameter value: 1 if the color is inherited; otherwise, 0.

int getSelect1()

Returns the value of the Attribute Select 1 parameter specified in the packet. Identifies the attribute whose value is returned by the getData1 function.

Return value

Select 1 parameter value. One of the CIGI_SYMBOL_* values.

int getSelect2()

Returns the value of the Attribute Select 2 parameter specified in the packet. Identifies the attribute whose value is returned by the getData2 function.

Return value

Select 2 parameter value. One of the CIGI_SYMBOL_* values.

unsigned int getData1()

Returns the value of the Attribute Value 1 parameter specified in the packet. Specifies the value of the attribute identified by the getAttribute1 function.

Return value

Data 1 parameter value.

unsigned int getData2()

Returns the value of the Attribute Value 2 parameter specified in the packet. Specifies the value of the attribute identified by the getAttribute2 function.

Return value

Data 2 parameter value.
Last update: 10.08.2018
Build: ()