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

Unigine::Syncker::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.

SynckerInterface 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.

int isInterpolation( const NodePtr & node )

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

Arguments

  • const NodePtr & node - Node to be checked.

Return value

1 if the given node is interpolated by the Syncker; 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 loadViewConfig( const char * name )

Loads view configuration from the specified *.proj file.

Arguments

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

void setView( int display, const char * surface_name )

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

Arguments

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

const char * getView( int display )

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

Arguments

  • int display - 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 useDefaultProjections( int enable )

Enables or disables an option to use default projections (FOV: 60) in case if a display (projection) was not found for the current sync_view.

Arguments

  • int enable - 1 to use default projections (FOV: 60); 0 - not to use.

int isDefaultProjectionsUsed( )

Returns a value indicating if default projections (FOV: 60) are used in case if a display (projection) was not found for the current sync_view.

Return value

1 if default projections are used; otherwise, 0.

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.

Unigine::CallbackBase * addCallback( int callback, Unigine::CallbackBase * func )

Adds a callback of the specified type. Callback functions can be used to determine actions to be performed when sending or receiving user messages, as well as when changing settings on the Master or a Slave. The signature of the callback function can be one of the following:
Source code (C++)
// for the Syncker::MasterInterface::TCP_USER_RECEIVE type
void callback_function_name(BlobPtr &received_message);

// for the Syncker::MasterInterface::UDP_USER_SEND type
void callback_function_name(BlobPtr &message_to_send);

// for the Syncker::MasterInterface::MASTER_SETUP_CHANGED type
void callback_function_name(void);

// for the Syncker::MasterInterface::SLAVE_SETUP_CHANGED type
void callback_function_name(int slave_num);

// for the Syncker::SlaveInterface::TCP_USER_RECEIVE type
void callback_function_name(BlobPtr &received_message);

// for the Syncker::SlaveInterface::UDP_USER_RECEIVE type
void callback_function_name(BlobPtr &received_message);

Arguments

Return value

Number of the last added callback of the specified type, if the callback was added successsfully; otherwise, -1.

void removeCallback( int callback, Unigine::CallbackBase * func )

Removes a given callback from the list of callbacks of the specified type. Callback functions can be used to determine actions to be performed when sending or receiving user messages, as well as when changing settings on the Master or a Slave.

Arguments

void clearCallbacks( int callback )

Clears all added callbacks of the specified type. Callback functions can be used to determine actions to be performed when sending or receiving user messages, as well as when changing settings on the Master or a Slave.

Arguments

Last update: 2018-12-27