This page has been translated automatically.
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
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::ICigiPositionRequest Class

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

This class represents the CIGI Position Request packet interface.

Notice
CIGI plugin must be loaded.

ICigiPositionRequest Class

Members


int getObjectID()

Returns the Object ID specified in the packet.

Return value

Object ID. The following ranges of values are supported depending on Object Class:
  • [0; 65535] - If Object Class is in the [0; 2] range.
  • [1; 255] - If Object Class=3.
  • [0; 255] - If Object Class=4.

int getPartID()

Returns the value of the Articulated Part ID parameter specified in the packet. Identifies the articulated part whose position is being requested.

Return value

Articulated Part ID.

int getUpdateMode()

Returns the value of the Update Mode parameter specified in the packet. Determines whether the IG will report the position of the requested object each frame.

Return value

Update Mode parameter value. The following values are supported:
  • 0 - One-Shot.
  • 1 - Continuous.

int getObjectClass()

Returns the value of the Object Class parameter specified in the packet. Indicates the type of object whose position is being requested.

Return value

Object Class parameter value. The following values are supported:

int getCoordSystem()

Returns the value of the Coordinate System parameter specified in the packet. Determines the desired coordinate system relative to which the position and orientation will be given.

Return value

Coordinate System parameter value. The following values are supported:
  • 0 - Geodetic. Position shall be specified as a geodetic latitude, longitude, and altitude. Orientation shall be given with respect to the reference plane.
  • 1 - Parent Entity. Position and orientation shall be with respect to the entity to which the specified entity or view is attached. This value shall be invalid for top-level entities.
  • 2 - Submodel. Position and orientation shall be specified with respect to the articulated part’s reference coordinate system. This value shall be valid only when Object Class is set to Articulated Part (1).
Notice
If Object Class is set to Motion Tracker (4), the coordinate system is defined by the tracking device and this parameter
Last update: 2018-08-10
Build: ()