Unigine::Cigi::CigiClientInterface Class

Header:

#include <CigiClientInterface.h>

List of functions:

List of Variables:

This class represents the CIGI Client interface.

Notice

CIGI plugin must be loaded.

CigiClientInterface Class

Members

init(int version, const char * host, int send, int recv, int size = 1432)

Initializes the CIGI Client using the given parameters.

Arguments

int version - CIGI protocol version. One of the CIGI_VERSION_* values.
const char * host - CIGI Host address.
int send - TCP port number to be used for sending packets to the CIGI Host.
int recv - TCP port number to be used for receiving packets from the CIGI Host.
int size - Packet size. The default value is 1432.

int isInitialized()

Returns a value indicating if the CIGI Client was initialized successfully.

Return value

1 if the CIGI Client was initialized successfully; otherwise, 0.

IView * getView(int view_id)

Returns the interface of the specified view.

Notice

The specified view will be created, if it doesn't exist yet.

Arguments

int view_id - ID of the view.

Return value

Pointer to the view interface.

IViewGroup * getViewGroup(int group_id)

Returns the interface of the specified view group.

Notice

The specified view group will be created, if it doesn't exist yet.

Arguments

int group_id - ID of the view group.

Return value

Pointer to the view group interface.

IEntity * getEntity(int entity_id)

Returns the interface of the specified entity.

Notice

The specified entity will be created, if it doesn't exist yet.

Arguments

int entity_id - ID of the entity.

Return value

Pointer to the entity interface.

void loadEntityTypes(const char * file_name)

Loads entity definitions from the specified .xml file.

Arguments

const char * file_name - Path to the .xml file with entity definitions. By default entity definitions will be loaded from the "entity_types.xml" file.

int findEntityType(const char * type_name)

Returns the entity type ID by its name.

Notice

Entity type IDs are defined in the entity definition file.

Arguments

const char * type_name - Entity type name.

Return value

Entity type ID.

int findComponentID(int entity_type, const char * name)

Returns the ID of the component with the given name, which belongs to the specified entity type.

Arguments

int entity_type - Entity type ID.
const char * name - Component name.

Return value

Component ID.

void setIGMode(int mode)

Sets the current IG mode.

Arguments

int mode - IG mode. One of the CIGI_MODE_* values.

int getIGMode()

Returns the current IG mode.

Return value

IG mode. One of the CIGI_MODE_* values.

void setIGStatus(int status)

Sets the current IG status.

Arguments

int status - IG status. The following values are supported:
- 0 - normal
- 1-255 - an error has occurred

int getIGStatus()

Returns the current IG status.

Return value

IG status. The following values are supported:

0 - normal
1-255 - an error has occurred

void setDatabase(int db)

Sets the database to be used.

Arguments

int db - ID of the database to be used.

int getDatabase()

Returns the database currently used.

Return value

ID of the database currently used.

int getInterpolation()

Returns a value indicating if interpolation and extrapolation are enabled.

Return value

1 if interpolation and extrapolation are enabled; otherwise, 0.

int getIGFrame()

Returns the number of the current frame for the IG.

Return value

Current IG frame number.

int getHostFrame()

Returns the number of the current frame for the Host.

Return value

Current Host frame number.

double getHostTime()

Returns the current Host time (with latency corrections).

Return value

Current Host time, in seconds.

double getLastReceivedHostTime()

Returns the last received Host time.

Return value

Last received Host time, in seconds.

int isPacketsReceived()

Returns a value indicating if packets where received from the Host after the last update().

Return value

1 if packets were received from the Host after the last update(); otherwise, 0.

void setConnectCallback(Unigine::CallbackBase * func)

Sets a callback function to be fired when the Host has connected.

Arguments

Unigine::CallbackBase * func - Callback pointer.

Unigine::CallbackBase * getConnectCallback()

Returns a callback to be fired when the Host has connected.

Return value

Callback pointer.

void setReceivePacketCallback(int cigi_opcode, Unigine::CallbackBase * func)

Sets a callback function to be fired when a packet of the specified type has been received from the Host.

Arguments

int cigi_opcode - CIGI data packet opcode. One of the CIGI_OPCODE_* values.
Unigine::CallbackBase * func - Callback pointer.

Unigine::CallbackBase * getReceivePacketCallback(int cigi_opcode)

Returns a callback to be fired when a packet of the specified type has been received from the Host.

Arguments

int cigi_opcode - CIGI data packet opcode. One of the CIGI_OPCODE_* values.

Return value

Callback pointer.

void setCreateComponentCallback(int component_class, int entity_type, int component_id, Unigine::CallbackBase * func)

Sets a callback function to be fired on creation of the specified type of component with the specified ID and the specified entity type.

Arguments

int component_class - CIGI component class. One of the CIGI_COMPONENT_* values.
int entity_type - Entity type ID.
Notice
This value is used only when the component type is set to CIGI_COMPONENT_ENTITY.
int component_id - Component ID.
Unigine::CallbackBase * func - Callback pointer.

Unigine::CallbackBase * getCreateComponentCallback(int component_class, int entity_type, int component_id)

Returns a callback to be fired on creation of the specified type of component with the specified ID and the specified entity type.

Arguments

int component_class - CIGI component class. One of the CIGI_COMPONENT_* values.
int entity_type - Entity type ID.
Notice
This value is used only when the component type is set to CIGI_COMPONENT_ENTITY.
int component_id - Component ID.

Return value

Callback pointer.

void setDestroyComponentCallback(int component_class, int entity_type, int component_id, Unigine::CallbackBase * func)

Sets a callback function to be fired on deletion of the specified type of component with the specified ID and the specified entity type.

Arguments

int component_class - CIGI component class. One of the CIGI_COMPONENT_* values.
int entity_type - Entity type ID.
Notice
This value is used only when the component type is set to CIGI_COMPONENT_ENTITY.
int component_id - Component ID.
Unigine::CallbackBase * func - Callback pointer.

Unigine::CallbackBase * getDestroyComponentCallback(int component_class, int entity_type, int component_id)

Returns a callback to be fired on deletion of the specified type of component with the specified ID and the specified entity type.

Arguments

int component_class - CIGI component class. One of the CIGI_COMPONENT_* values.
int entity_type - Entity type ID.
Notice
This value is used only when the component type is set to CIGI_COMPONENT_ENTITY.
int component_id - Component ID.

Return value

Callback pointer.

int getNumHostPackets()

Returns the total number of packets received from the Host.

Return value

Total number of packets received from the Host.

ICigiHostPacket * getHostPacket(int num)

Returns the specified CIGI Host packet.

Arguments

int num - ID of the Host packet.

Return value

CIGI Host packet.

void addIGPacket(ICigiIGPacket * packet)

Sends the specified IG packet to the Host.

Arguments

ICigiIGPacket * packet - IG Packet to be sent to the Host.

int showDebug()

Returns a value indicating if the debug information is to be displayed.

Return value

1 if the debug information is to be displayed; otherwise, 0.

int CIGI_VERSION_30

Description

CIGI protocol version 3.0.

int CIGI_VERSION_32

Description

CIGI protocol version 3.2.

int CIGI_VERSION_33

Description

CIGI protocol version 3.3.

int CIGI_NO_SWAP

Description

Byte-swapping of incoming data is enabled.

int CIGI_DO_SWAP

Description

Byte-swapping of incoming data is disabled.

int CIGI_MODE_RESET

Description

Reset mode of the IG. This is the IG's initial state upon start-up. When set to this mode, the IG will initialize/reinitialize the simulation. All entities that were instantiated during a previous mission will be destroyed. All environmental properties, views, components, and sensors will revert to their default settings. Any Host-defined rates, trajectories, and collision detection segments and volumes will be removed. The IG will only send the Start of Frame data packet to the Host and will ignore Host inputs except for the IG Mode attribute of the IG Control data packet. The IG will remain in this mode until directed otherwise by the Host or the IG's user interface.

int CIGI_MODE_OPERATE

Description

Operate mode of the IG. This is the normal real-time operating mode for the IG. All packets issued by the Host will be processed by the IG. The IG should not perform diagnostics in this mode.

int CIGI_MODE_DEBUG

Description

Debug mode of the IG. This mode is similar to the Operate mode but provides data and/or error logging and other debugging features to aid integration or troubleshooting of the Host and IG interface. Because of the overhead of these debugging features, the IG may not always operate in a hard real-time fashion.

int CIGI_MODE_OFFLINE

Description

Offline Maintenance mode of the IG. In this mode, the IG ignores all data from the Host and sends only Start of Frame packets. This mode can be activated only from the IG. Because the IG Control packets from the Host are ignored by the IG, the IG must be placed into Reset/Standby mode before the Host can initiate further mode changes.

int CIGI_STATE_DISABLED

Description

Entity state - disabled.

int CIGI_STATE_ENABLED

Description

Entity state - enabled.

int CIGI_STATE_DESTROYED

Description

Entity state - destroyed.

int CIGI_SYSTEM_GEODETIC

Description

Geodetic coordinate system.

int CIGI_SYSTEM_ENTITY

Description

Local entity coordinate system.

int CIGI_SYSTEM_MODEL

Description

Local submodel coordinate system.

int CIGI_SCOPE_GLOBAL

Description

Packet data shall be applied to the global scope.

int CIGI_SCOPE_REGIONAL

Description

Packet data shall be applied to the specified region.

int CIGI_SCOPE_ENTITY