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
CIGI Client Plugin
Rendering-Related Classes

Unigine::Synker::SynckerInterface Class

Header:#include <SynckerInterface.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.

MasterInterface Class

Members


void setInterpolation(int enabled)

Sets a value indicating if interpolation and extrapolation should be enabled for the computer.

Arguments

int isInterpolation()

Returns a value indicating if interpolation and extrapolation are enabled for the computer.

Return value

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

void setInterpolationPeriod(double period)

Sets the interpolation period value for the computer.

Arguments

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

double getInterpolationPeriod()

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)

Sets the extrapolation period value for the computer.

Arguments

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

int getExtrapolationPeriod()

Returns the current extrapolation period value for the computer.

Return value

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

void loadViewMesh(const char * name)

Loads the configuration mesh from the specified .mesh file.

Arguments

  • const char * name - Path to the .mesh file.

const char * getViewMeshFile()

Returns the path to the .mesh file containing the current configuration mesh.

Return value

Path to the .mesh file containing the configuration mesh.

void setView(int display, const char * surface_name)

Assigns the specified surface of the configuration mesh to the specified display of the computer.

Arguments

  • int display - Display number to assign the viewport to.
  • const char * surface_name - Name of the surface of the configuration mesh, that represents the viewport.

const char * getView(int display)

Returns the current surface of the configuration mesh assigned to the given display of the computer.

Arguments

  • int display - Display number.

Return value

Name of the surface of the configuration mesh assigned to the given display.

void clearViews()

Clears all views assigned to the displays of the computer and unloads the configuration mesh.

Math::vec3 getCAVEHead()

Returns the current viewer's head position.

Return value

Viewer's head position coordinates.

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

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

Arguments

  • int enabled - 1 to display the debug information; 0 - 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.

int isDebug()

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.

void setUdpSendSize(int size)

Sets the maximum size of a UDP packet to be sent.

Arguments

  • int size - UDP packet size, in bytes. The default value is 1432.

int getUdpSendSize()

Sets the maximum size of a UDP packet to be sent.

Return value

UDP packet size, in bytes. The default value is 1432.
Last update: 2017-10-20