Syncker Class
Warning
The scope of applications for UnigineScript is limited to implementing materials-related logic (material expressions, scriptable materials, brush materials). Do not use UnigineScript as a language for application logic, please consider C#/C++ instead, as these APIs are the preferred ones. Availability of new Engine features in UnigineScript (beyond its scope of applications) is not guaranteed, as the current level of support assumes only fixing critical issues.
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.
You should upgrade to
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.
Syncker Class
Members
void setInterpolation ( int 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
- int interpolation - 1 to enable interpolation and extrapolation for the computer; 0 - to disable.
int isInterpolation ( ) #
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
1 if interpolation and extrapolation are enabled for the computer; otherwise, 0.bool isInterpolation ( Node node ) #
Returns a value indicating if the given node is interpolated by the Syncker.Arguments
- Node node - Node to be checked.
Return value
1 if the given node is interpolated by the Syncker; otherwise, 0.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 delayArguments
- double period - Interpolation period value, in seconds. The default value is 0.04.
NoticeThe value should not be less than 1 / getSendRate(), otherwise the image shall be "stuttering".
double getInterpolationPeriod ( ) #
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 ( ) #
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, string 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.
- string display_name - Name of the display or projector stored in the configuration file that represents the viewport.
string getView ( int display_num ) #
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.int getAddressingMethod ( ) #
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 ( ) #
Returns the current timeout period after which a Slave is considered as disconnected.Return value
Duration of the timeout period, in seconds.Projections getProjections ( ) #
Returns the interface for managing projections configuration via API (see the Projections class).Return value
Projections class instance.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 ( string channel, Blob message, int 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
- string 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.
- Blob message - Buffer, containing the user message.
- int delivery_method -
Return value
1 if the message was sent successfully; otherwise, 0.void setMessageReceivedCallback ( string channel, Variable 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
- string 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.
- Variable func - There are two ways you can specify a callback function:
- by name - when you call a function, declared globally.
- by ID - when you call a member function of a certain class.
NoticeAn ID can be obtained via functionid().
int getSwapSyncMode ( ) #
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 ( ) #
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 ( ) #
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:
2022-04-20
Help improve this article
Was this article helpful?
(or select a word/phrase and press Ctrl+Enter)