This page has been translated automatically.
Programming
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
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.

Unigine::Cigi::ICigiArticulatedControl Class

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

This class represents the CIGI Articulated Part Control packet interface.

Notice
CIGI plugin must be loaded.

ICigiArticulatedControl Class

Members


int getEntityID()

Returns the entity ID specified in the packet.

Return value

Entity ID.

int getPartID()

Returns the articulated part ID specified in the packet.

Return value

Articulated part ID.

int getPartEnabled()

Returns the value of the Articulated Part Enable parameter specified in the packet.

Return value

Articulated Part Enable parameter value: 1 if the articulated part is enabled; otherwise, 0.

iconst Math::vec3& getOffsetEnabled()

Returns a three-component vector combining Offset Enable values specified in the packet. Each value determines whether the offset for the corresponding axis(X - back, Y - left, Z - down) is enabled.

Return value

Vector of three integer values. Each value determines whether the offset for the corresponding axis(X - back, Y - left, Z - down) is enabled: 1 - enabled; 0 - disabled.

const Math::ivec3& getRotationEnabled()

Returns a three-component vector combining Roll/Pitch/Yaw Enable values specified in the packet. Each value determines whether the rotation around the corresponding axis(roll, pitch, yaw) is enabled.

Return value

Vector of three integer values. Each value determines whether the rotation around the corresponding axis(Roll, Pitch, Yaw) is enabled: 1 - enabled; 0 - disabled.

const Math::vec3& getOffset()

Returns the offset of the articulated part in the submodel coordinate system (SCS) specified in the packet.

Return value

Articulated part offset coordinates (X - back, Y - left, Z - down).

const Math::vec3& getRotation()

Returns the rotation of the articulated part in the submodel coordinate system (SCS) specified in the packet.

Return value

Articulated part rotation euler angles.
Last update: 2017-12-21
Build: ()