This page has been translated automatically.
Video Tutorials
Interface
Essentials
Advanced
How To
Professional (SIM)
UnigineEditor
Interface Overview
Assets Workflow
Settings and Preferences
Working With Projects
Adjusting Node Parameters
Setting Up Materials
Setting Up Properties
Lighting
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
Materials and Shaders
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.

CigiSymbolLineDef 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

CigiSymbolLineDef Class

Enums

CIGI_LINE#

NameDescription
CIGI_LINE_POINT = 0Point primitive type.
CIGI_LINE_LINE = 1Line primitive type.
CIGI_LINE_LINE_STRIP = 2Line Strip primitive type.
CIGI_LINE_LINE_LOOP = 3Line Loop primitive type.
CIGI_LINE_TRIANGLE = 4Triangle primitive type.
CIGI_LINE_TRIANGLE_STRIP = 5Triangle Strip primitive type.
CIGI_LINE_TRIANGLE_FAN = 6Triangle fan primitive type.

Members


int getSymbolID ( ) const#

Returns the Symbol ID specified in the packet.

Return value

Symbol ID.

int getPrimitiveType ( ) const#

Returns the Primitive Type specified in the packet. Determines the type of point or line primitive defined by this packet.

Return value

Primitive Type parameter value. One of the CIGI_LINE_* values.

int getStipplePattern ( ) const#

Returns the value of the Stipple Pattern parameter specified in the packet. Determines the dash pattern to be used when drawing the line.

Return value

Stipple Pattern parameter value.
Notice
If the value of this parameter is 0xFFFF, then the IG shall draw a solid line. If the value is 0x00, then the IG shall not draw the line.

float getPatternLength ( ) const#

Returns the value of the Stipple Pattern Length parameter specified in the packet. Determines the length of one complete repetition of the stipple pattern.

Return value

Pattern Length parameter value.

float getLineWidth ( ) const#

Returns the value of the Line Width parameter specified in the packet. Specifies the line thickness that the IG shall use when drawing the primitives defined in this packet.

Return value

Line Width parameter value.

int getNumVertex ( ) const#

Returns the number of vertices in line. Determines the number of vertices by which the line is specified

Return value

Num Vertex.

Math::vec3 getVertex ( int num ) const#

Returns a three-component vector UV coordinates of the given vertex. This vector combines the values of the Center U and Center V parameters specified in the packet.

Arguments

  • int num - Index of vertex.

Return value

Three-component vector with the UV coordinates of the given vertex (Center U, Center V, Z), in symbol’s local coordinate system.
Notice
The third component of the vector is ignored.
Last update: 2022-10-10
Build: ()