Unigine::Plugins::Syncker::Syncker 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/UnigineSyncker.h>

This class represents the base interface of the Syncker, from which Master and Slave interfaces are inherited. It contains all common functions available for both Slave and Master.

Notice

Syncker plugin must be loaded.

Methods:

Name	Description View: Sort by:
setInterpolation	Sets a value indicating if interpolation and extrapolation should be enabled for the computer to tackle the problem of lost packets between the master and slaves.
isInterpolation	Returns a value indicating if interpolation and extrapolation are enabled for the computer to tackle the problem of lost packets between the master and slaves.
setInterpolationPeriod	Sets the interpolation period value for the computer.
getInterpolationPeriod	Returns the current interpolation period value for the computer.
setExtrapolationPeriod	Sets the extrapolation period value for the computer.
getExtrapolationPeriod	Returns the current extrapolation period value for the computer.
getAddressingMethod	Returns the packet addressing method currently used by the Syncker for communication.
setDisconnectTimeout	Sets the timeout period after which a Slave shall be considered as disconnected.
getDisconnectTimeout	Returns the current timeout period after which a Slave is considered as disconnected.
isInterpolation	Returns a value indicating if the given node is interpolated by the Syncker.
setView	Assigns the specified display or projector stored in the configuration file to the specified display of the computer.
getView	Returns the current display or projector stored in the configuration file and assigned to the given display of the computer.
clearViews	Clears all views assigned to the displays of the computer.
setDebug	Enables or disables displaying of debug information at the specified position on the screen.
isDebug	Returns a value indicating if the debug information is to be displayed.
getProjections	Returns the interface for managing projections configuration via API (see the Projections class).
getViewOffset	Returns the current view offset.
sendMessage	Sends a user message contained in the specified buffer using the given delivery method to the specified named channel via the UDP protocol.
setMessageReceivedCallback	Sets a callback function to be fired when a UDP user message is sent.
getSwapSyncMode	Returns the buffer swap synchronization mode currently used by the Syncker.
getTime	Returns the current Master frame time (even if called from a Slave computer), it is the time of the last buffer swap operation (i.
getIFps	Returns the duration of the last frame.

Syncker Class

Enums

DELIVERY_METHOD#

Delivery mode to be used by the Syncker.

Name	Description
UNRELIABLE = 0	Unreliable delivery mode. Pure UDP. Packets may be lost, duplicated, or received in an order that differs from the one they were sent. Packets are not compressed, fragmented, or merged.
SEQUENCED = 1	Sequenced delivery mode. Packets may be lost, but never duplicated, they arrive in the exact order they were sent.
RELIABLE = 2	Reliable delivery mode. Reliable and sequenced mode, enabled by default. All packets shall be delivered to the recipient in the exact order they were sent.

ADDRESSING_METHOD#

Addressing mode to be used by the Syncker.

Name	Description
BROADCAST = 0	Broadcast addressing mode (one-to-all): hosts have different IP-addresses, but a single port.
UNICAST = 1	Unicast addressing mode (one-to-one): hosts have different IP-addresses (some may be the same) and different ports.
MULTICAST = 2	Multicast addressing mode (one-to-many): hosts have different IP-addresses, but a single port.

SWAP_SYNC_MODE#

Buffer swap synchronization mode.

Name	Description
DEFAULT = 0	Default buffer swap synchronization.
NVIDIA = 1	NVIDIA buffer swap synchronization. Detailed information on current sync status is displayed in the console. Notice This mode is available only for NVIDIA Quadro GPUs with G-SYNC support.

Members

void setInterpolation ( bool interpolation ) #

Console: syncker_interpolation

Sets a value indicating if interpolation and extrapolation should be enabled for the computer to tackle the problem of lost packets between the master and slaves.

Arguments

bool interpolation - true to enable interpolation and extrapolation for the computer; false - to disable.

bool isInterpolation ( ) const#

Console: syncker_interpolation

Returns a value indicating if interpolation and extrapolation are enabled for the computer to tackle the problem of lost packets between the master and slaves.

Return value

true if interpolation and extrapolation are enabled for the computer; otherwise, false.

bool isInterpolation ( const Ptr<Node> & node ) const#

Returns a value indicating if the given node is interpolated by the Syncker.

Arguments

const Ptr<Node> & node - Node to be checked.

Return value

true if the given node is interpolated by the Syncker; otherwise, false.

void setInterpolationPeriod ( double period ) #

Console: syncker_interpolation_period

Sets the interpolation period value for the computer. It is recommended to use this method when setting the frequency of sending packets to Slaves.

Source code (C++)

//On the Master
master->setSendRate(15.0f); // send packets 15 times per second

//Both on the Master and all Slaves
syncker->setInterpolationPeriod(0.1f); // 100 ms delay

Arguments

double period - Interpolation period value, in seconds. The default value is 0.04.
Notice
The value should not be less than 1 / getSendRate(), otherwise the image shall be "stuttering".

double getInterpolationPeriod ( ) const#

Console: syncker_interpolation_period

Returns the current interpolation period value for the computer.

Return value

Interpolation period value, in seconds. The default value is 0.04.

void setExtrapolationPeriod ( double period ) #

Console: syncker_extrapolation_period

Sets the extrapolation period value for the computer.

Arguments

double period - Extrapolation period value, in seconds. The default value is 0.04.

double getExtrapolationPeriod ( ) const#

Console: syncker_extrapolation_period

Returns the current extrapolation period value for the computer.

Return value

Extrapolation period value, in seconds. The default value is 0.2.

void setView ( int display_num, const char * display_name ) #

Assigns the specified display or projector stored in the configuration file to the specified display of the computer.

Arguments

int display_num - Display number to assign the viewport to.
const char * display_name - Name of the display or projector stored in the configuration file that represents the viewport.

const char * getView ( int display_num ) const#

Returns the current display or projector stored in the configuration file and assigned to the given display of the computer.

Arguments

int display_num - Display number.

Return value

Name of the display or projector stored in the configuration file and assigned to the given display.

void clearViews ( ) #

Clears all views assigned to the displays of the computer.

void setDebug ( bool enabled, int x, int y, int align_mask ) #

Console: syncker_debug

Enables or disables displaying of debug information at the specified position on the screen.

Arguments

bool enabled - true to display the debug information; false - to hide it.
int x - Horizontal margin of the debug information block. The default value is 10.
int y - Vertical margin of the debug information block. The default value is 10.
int align_mask - Alignment mask. One of the Gui::ALIGN_* variables or their combination. The default value is Gui::ALIGN_RIGHT | Gui::ALIGN_BOTTOM.

bool isDebug ( ) #

Console: syncker_debug

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

Return value

true if the debug information is to be displayed; otherwise, false.

Syncker::ADDRESSING_METHOD getAddressingMethod ( ) const#

Returns the packet addressing method currently used by the Syncker for communication.

Return value

Packets addressing mode currently used by the Syncker.

void setDisconnectTimeout ( float timeout ) #

Sets the timeout period after which a Slave shall be considered as disconnected.

Arguments

float timeout - Duration of the timeout period, in seconds.

float getDisconnectTimeout ( ) const#

Returns the current timeout period after which a Slave is considered as disconnected.

Return value

Duration of the timeout period, in seconds.

Projections * getProjections ( ) const#

Returns the interface for managing projections configuration via API (see the Projections class).

Return value

Projections class instance.

Math::vec3 getViewOffset ( ) #

Returns the current view offset. The view offset is used in CAVE systems to reflect the current viewer's head position. It can also be used for parallax adjustment insid the cockpit.

Return value

A vec3 vector representing components of the the view offset along X, Y, and Z axes, in meters.

bool sendMessage ( const char * channel, const Ptr<Blob> & message, Syncker::DELIVERY_METHOD delivery_method = DELIVERY_METHOD.RELIABLE ) #

Sends a user message contained in the specified buffer using the given delivery method to the specified named channel via the UDP protocol.

Arguments

const char * channel - Channel name. Multiple systems may use Syncker's network simultaneously (e.g. IG and a users App application). For convenience, all messages are sent and received via named channels.
const Ptr<Blob> & message - Buffer, containing the user message.
Syncker::DELIVERY_METHOD delivery_method -

Return value

true if the message was sent successfully; otherwise, false.

void setMessageReceivedCallback ( const char * channel, Unigine::CallbackBase * func ) #

Sets a callback function to be fired when a UDP user message is sent. A callback is executed in the Main Thread, but it is undefined when exactly - either in update(), or postUpdate(), or swap().

Arguments

const char * channel - Channel name. Multiple systems may use Syncker's network simultaneously (e.g. IG and a users App application). For convenience, all messages are sent and received via named channels. If the specified channel does not exist, it shall be created.
Unigine::CallbackBase * func - Callback pointer.

Syncker::SWAP_SYNC_MODE getSwapSyncMode ( ) const#

Returns the buffer swap synchronization mode currently used by the Syncker.

Return value

Current swap synchronization mode used by the Syncker. One of the following:

DEFAULT - default syncronization mode.
NVIDIA - NVIDIA buffer swap synchronization. Detailed information on current sync status is displayed in the console (available only for NVIDIA Quadro GPUs with G-SYNC support).

double getTime ( ) const#

Returns the current Master frame time (even if called from a Slave computer), it is the time of the last buffer swap operation (i.e., beginning of the next frame). This method is more accurate than the same method of the Game class and returns a double-precision value.

Return value

Current Master frame time, in seconds.

double getIFps ( ) const#

Returns the duration of the last frame. This method is more accurate than the same method of the Game class and returns a double-precision value.

Return value

Duration of the previous frame, in seconds.

Last update: 2021-12-13

Help improve this article

Was this article helpful?

Report a problem related to this article

(or select a word/phrase and press Ctrl+Enter)