Module vrConnector

Functions

setConnectorMousePos(x, y, w, h)
Set mouse position.

setConnectorShowMouseOnClients(state)
Enables/disables displaying the mouse on the clients.

setVredFrameSync(state)
Enables/disables frame sync.

bool

startVredClient(serverIP, port)
Starts a Client.

bool

startVredServer(port)
With the vrConnector you can connect two VRED instances synchronizing the navigation as well as python commands.

stopVredClient()
Stop Client.

stopVredServer()
Stop the server.

Function Details

setConnectorMousePos(x, y, w, h)

Set mouse position.

Parameters:

x (int) - x pos.
y (int) - y pos.
w (int) - width.
h (int) - height.

setConnectorShowMouseOnClients(state)

Enables/disables displaying the mouse on the clients.

Parameters:

state (bool) - show mouse: On/Off.

setVredFrameSync(state)

Enables/disables frame sync.

Parameters:

state (bool) - Frame sync: On/Off.

startVredClient(serverIP, port)

Starts a Client. The client can be used like an ordinary instance but will execute all navigation and python commands from the server.

Parameters:

serverIP (string) - The IP address of the server.
port (integer) - The port number.

Returns: bool

Returns true on success, false otherwise.

startVredServer(port)

With the vrConnector you can connect two VRED instances synchronizing the navigation as well as python commands. One VRED instance will act as server which is sending all commands to the client. Both instances do not need to be running on the same machine, they can be run on different computers even over the internet as long as a connection between those can be established. Please note that only a lag-free connection ensures a fluent experience.

This function starts the server at the defined port.

Parameters:

port (integer) - The port number.

Returns: bool

Returns true on success, false otherwise.

stopVredClient()

Stop Client. An established connection to a server is interrupted.

stopVredServer()

Stop the server. An established connection to a client is interrupted.