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

Unigine::Cigi::ICigiViewControl Class

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

This class represents the CIGI View Control packet interface.

Notice
CIGI plugin must be loaded.

ICigiViewControl Class

Members


int getViewID()

Returns the view ID specified in the packet.

Return value

View ID.

int getGroupID()

Returns the view group ID specified in the packet.

Return value

View group ID.
Notice
0 - means the view is not a member of any group.

int getEntityID()

Returns the entity ID specified in the packet.
Notice
This value shall be ignored if the view is in a group.

Return value

Entity ID.

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 view specified in the packet.

Return value

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

const Math::vec3 & getRotation()

Returns the rotation of the view specified in the packet.

Return value

View rotation euler angles.
Last update: 04.06.2018