This page has been translated automatically.
Video Tutorials
Interface
Essentials
Advanced
How To
UnigineEditor
Interface Overview
Assets Workflow
Settings and Preferences
Working With Projects
Adjusting Node Parameters
Setting Up Materials
Setting Up Properties
Lighting
Landscape Tool
Sandworm
Using Editor Tools for Specific Tasks
Extending Editor Functionality
Built-in Node Types
Nodes
Objects
Effects
Decals
Light Sources
Geodetics
World Nodes
Sound Objects
Pathfinding Objects
Players
Programming
Fundamentals
Setting Up Development Environment
Usage Examples
C++
C#
UnigineScript
UUSL (Unified UNIGINE Shader Language)
Plugins
File Formats
Rebuilding the Engine 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
Objects-Related Classes
Networking Functionality
Pathfinding-Related Classes
Physics-Related Classes
Plugins-Related Classes
IG Plugin
Rendering-Related Classes
Content Creation
Content Optimization
Materials
Material Nodes Library
Miscellaneous
Input
Math
Matrix
Textures
Art Samples
Tutorials
Warning! This version of documentation is OUTDATED, as it describes an older SDK version! Please switch to the documentation for the latest SDK version.
Warning! This version of documentation describes an old SDK version which is no longer supported! Please upgrade to the latest SDK version.

CigiSymbolShortControl 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/UnigineCIGIConnector.h>
Inherits from: CigiHostPacket

CigiSymbolShortControl Class

Enums

CIGI_SYMBOL#

NameDescription
CIGI_SYMBOL_NONE = 0Attribute Select None in Short Symbol Control.
CIGI_SYMBOL_SURFACE_ID = 1Attribute Select ID in Short Symbol Control.
CIGI_SYMBOL_PARENT_SYMBOL_ID = 2Attribute Select Parent Symbol ID in Short Symbol Control.
CIGI_SYMBOL_LAYER = 3Attribute Select Layer in Short Symbol Control.
CIGI_SYMBOL_FLASH_DUTY = 4Attribute Select Flash Duty in Short Symbol Control.
CIGI_SYMBOL_FLASH_PERIOD = 5Attribute Select Flash Period in Short Symbol Control.
CIGI_SYMBOL_POSITION_X = 6Attribute Select Position X (U) in Short Symbol Control.
CIGI_SYMBOL_POSITION_Y = 7Attribute Select Position Y (V) in Short Symbol Control.
CIGI_SYMBOL_ROTATION = 8Attribute Select Rotation in Short Symbol Control.
CIGI_SYMBOL_COLOR = 9Attribute Select Color in Short Symbol Control.
CIGI_SYMBOL_SCALE_X = 10Attribute Select Scale X (U) in Short Symbol Control.
CIGI_SYMBOL_SCALE_Y = 11Attribute Select Scale Y (V) in Short Symbol Control.

Members


int getSymbolID ( ) const#

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 ( ) const#

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 ( ) const#

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 ( ) const#

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 ( ) const#

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 ( ) const#

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 ( ) const#

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 ( ) const#

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 ( ) const#

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: 2021-12-13
Build: ()