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

Unigine::Cigi::ICigiHatHotRequest Class

Header: #include <CigiClientInterface.h>
Inherits: ICigiHostPacket
Warning
The CIGIClient plugin is deprecated and no longer supported. For more information on working with CIGI please refer to the IG Application section.

This class represents the CIGI HAT/HOT Request packet interface.

Notice
CIGI plugin must be loaded.

ICigiHatHotRequest Class

Members


int getHatHotID( )

Returns the value of the HAT/HOT ID parameter specified in the packet.

Return value

HAT/HOT ID parameter value.

int getEntityID( )

Returns the entity ID specified in the packet.

Return value

Entity ID.

int getRequestType( )

Returns the value of the Request Type parameter specified in the packet.

Return value

Request Type parameter value. The following values are supported:
  • 0 - HAT
  • 1 - HOT
  • 2 - Extended

int getCoordSystem( )

Returns the value of the Coordinate System parameter specified in the packet.

Return value

Coordinate System parameter value. The following values are supported:
  • 0 - Geodetic
  • 1 - Entity

unsigned int getUpdatePeriod( )

Returns the value of the Update Period parameter specified in the packet. Determines the interval between successive responses to this request.

Return value

Update Period parameter value. The following values are supported:
  • 0 - One-Shot request
  • > 0 - update period

const Math::Vec3 & getPosition( )

Returns the coordinates of the point, from which the HAT/HOT request is being made.

Return value

Coordinates of the point, from which the HAT/HOT request is being made.
Last update: 2019-02-14