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.

CigiViewControl 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

CigiViewControl Class

Members


int getViewID ( ) const#

Returns the view ID specified in the packet.

Return value

View ID.

int getGroupID ( ) const#

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

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.

Math::ivec3 getOffsetEnabled ( ) const#

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.

Math::ivec3 getRotationEnabled ( ) const#

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.

Math::vec3 getOffset ( ) const#

Returns the offset of the view specified in the packet.

Return value

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

Math::vec3 getRotation ( ) const#

Returns the rotation of the view specified in the packet.

Return value

View rotation euler angles.
Last update: 2021-12-13
Build: ()