Master Class

Master Class

Members

int getNumSlaves ( ) #

Return value

string getSlaveAddress ( int num ) #

Arguments

• int num - Slave number.

Return value

int getSlavePort ( int num ) #

Arguments

• int num - Slave number.

Return value

long getSlaveID ( int num ) #

Arguments

• int num - Slave number.

Return value

string getSlaveWorldName ( int num ) #

Arguments

• int num - Slave number.

Return value

string getSlaveView ( int num, int display_num ) #

Arguments

• int num - Slave number.
• int display_num - Display number.

Return value

void setSyncPlayer ( int enabled ) #

• Its transformation
• Projection matrix
• Viewport mask
• Mask for reflections
• Applied post-materials (if any)

Arguments

• int enabled - 1 to enable synchronization; 0 - to disable it.

int isSyncPlayer ( ) #

Return value

void setSyncRender ( int enabled ) #

Arguments

• int enabled - 1 to enable synchronization; 0 - to disable it.

int isSyncRender ( ) #

Return value

void addSyncNode ( Node node, int sync_mask = SYNC_MASK::NODE_FLAGS | SYNC_MASK::TRANSFORM ) #

Arguments

• Node node - Node to synchronize.
• int sync_mask - Synchronization mask.

void addSyncNodes ( Vector<Node> nodes, int sync_mask = SYNC_MASK::NODE_FLAGS | SYNC_MASK::TRANSFORM ) #

Arguments

• Vector<Node> nodes - List of nodes to synchronize.
• int sync_mask - Synchronization mask.

void setSyncNodeMask ( Node node, int sync_mask ) #

master.setSyncNodeMask(fan_small, MASTER_TRANSFORM);
master.setSyncNodeMask(fan_big, MASTER_TRANSFORM);

Arguments

• Node node - Node for which a new synchronization mask is to be set.
• int sync_mask - New synchronization mask to be set for the specified node.

bool isSyncNode ( Node node ) #

Arguments

• Node node - Node to be checked.

Return value

int getNumSyncNodes ( ) #

Return value

Node getSyncNode ( int num ) #

Arguments

• int num - Node number in the synchronization queue.

Return value

void removeSyncNode ( int num ) #

Arguments

• int num - Node number in the synchronization queue.

void removeSyncNode ( Node node ) #

Arguments

• Node node - Node to be removed from synchronization.

void removeSyncNodeID ( int node_id ) #

Arguments

• int node_id - ID of the node to be removed from the synchronization queue.

void removeSyncNodes ( Vector<Node> nodes ) #

Arguments

• Vector<Node> nodes - List of nodes to be removed from the synchronization queue.

void clearSyncNodes ( ) #

void addSyncMaterial ( Material material ) #

Arguments

• Material material - Material to synchronize.

void addSyncMaterials ( Vector<Material> materials ) #

Arguments

• Vector<Material> materials - List of materials to synchronize.

bool isSyncMaterial ( Material mat ) #

Arguments

• Material mat - Material to be checked.

Return value

int getNumSyncMaterials ( ) #

Return value

Material getSyncMaterial ( int num ) #

Arguments

• int num - Material number in the synchronization queue.

Return value

void removeSyncMaterial ( int num ) #

Arguments

• int num - Material number in the synchronization queue.

void removeSyncMaterial ( Material material ) #

Arguments

• Material material - Material to be removed from the synchronization queue.

void removeSyncMaterials ( Vector<Material> materials ) #

Arguments

• Vector<Material> materials - List of materials to be removed from the synchronization queue.

void clearSyncMaterials ( ) #

bool createNode ( Node node, int sync_mask = 0 ) #

Node node = new NodeDummy(); 
master.createNode(node);

Arguments

• Node node - Node to create.
• int sync_mask - Synchronization mask.

Return value

void deleteNode ( Node node ) #

Arguments

• Node node - Node to delete.

int isNodeCreatedBySyncker ( Node node ) #

Arguments

• Node node - Node to be checked.

Return value

bool setSlavePlayer ( int num, Player player ) #

Arguments

• int num - Slave number in the range from to the total number of slaves.
• Player player - Player to be set.

Return value

void setSendRate ( float rate ) #

Sets the frequency of sending packets to Slaves. Use this method when network load is too high and slows down the whole IG system. It is recommended to use this method with interpolation enabled.

//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

• float rate - Frequency of sending packets to Slaves. The default value is -1 (every frame).
  Notice

  The value should not be less than 1 / getInterpolationPeriod(), otherwise the image shall be "stuttering".

float getSendRate ( ) #

Return value

void setAllowExtraSlaves ( int slaves ) #

Arguments

• int slaves - 1 to permit new Slaves connecting to the Master after starting the session; 0 - to forbid it.

int isAllowExtraSlaves ( ) #

Return value

void setViewOffset ( vec3 offset ) #

Arguments

• vec3 offset - New player's head position coordinates to be set.

void setSyncViewOffset ( int offset ) #

Arguments

• int offset - 1 to enable synchronization; 0 - to disable it.

int isSyncViewOffset ( ) #

Return value

void setSyncWorldLoad ( int load ) #

Arguments

• int load - 1 to enable synchronization; 0 - to disable it.

int isSyncWorldLoad ( ) #

Return value

void setDefaultSyncNodes ( int nodes ) #

master.setDefaultSyncNodes(MASTER_WATER_GLOBAL | MASTER_CLOUD_LAYER);

Arguments

• int nodes - Mask defining types of nodes that will be synchronized automatically after world loading.

int getDefaultSyncNodes ( ) #

Return value

void loadWorld ( string name ) #

Arguments

• string name - Path to the *.world file to be loaded.

Node loadNode ( string name, int sync_mask = 0, mat4 init_transform ) #

Arguments

• string name - Path to the *.node file.
• int sync_mask - Synchronization mask, one of the SYNC_MASK values.
• mat4 init_transform - Initial transformation of the node.

Return value

NodeReference loadNodeReference ( string name, int sync_mask = 0, mat4 init_transform ) #

Arguments

• string name - Path to the *.node file.
• int sync_mask - Synchronization mask, one of the SYNC_MASK values.
• mat4 init_transform - Initial transformation of the node.

int isNodeLoadedBySyncker ( Node node ) #

Arguments

• Node node - Node to be checked.

Return value

Variable addCallback ( int callback, Variable func ) #

// for the Syncker.Master.SESSION_STARTED type
void callback_function_name(void);

// for the Syncker.Master.SESSION_FINISHED type
void callback_function_name(void);

// for the Syncker.Master.SLAVE_CONNECTED type
void callback_function_name(int slave_num);

// for the Syncker.Master.SLAVE_DISCONNECTED type
void callback_function_name(int slave_num);

// for the Syncker.Master.MASTER_SETUP_CHANGED type
void callback_function_name(void);

// for the Syncker.Master.SLAVE_SETUP_CHANGED type
void callback_function_name(int slave_num);

Arguments

• int callback - Callback type. One of the following values:
  • SESSION_STARTED
  • SESSION_CONTINUED
  • SESSION_FINISHED
  • SLAVE_CONNECTED
  • SLAVE_DISCONNECTED
  • MASTER_SETUP_CHANGED
  • SLAVE_SETUP_CHANGED
• 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.
    Notice

    An ID can be obtained via functionid().

Return value

bool removeCallback ( int callback, Variable func ) #

Arguments

• int callback - Callback type. One of the following values:
  • SESSION_STARTED
  • SESSION_CONTINUED
  • SESSION_FINISHED
  • SLAVE_CONNECTED
  • SLAVE_DISCONNECTED
  • MASTER_SETUP_CHANGED
  • SLAVE_SETUP_CHANGED
• 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.
    Notice

    An ID can be obtained via functionid().

Return value

int addMessageToBuffer ( string channel, Blob message ) #

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.

Return value

int getNumBufferedMessages ( string channel ) #

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.

Return value

int getBufferedMessageID ( string channel, int index ) #

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.
• int index - Message index number.

Return value

Blob getBufferedMessage ( string channel, int id ) #

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.
• int id - Message ID.

Return value

void removeBufferedMessage ( string channel, int id ) #

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.
• int id - Message ID.

void clearBufferedMessages ( string channel ) #

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.