MeVisLab Scripting Reference
MLRemoteRenderingWebChannelSlaveWrapper Class Reference

#include <mlRemoteRenderingWebChannelWrapper.h>

Inherits QObject, and ml::RemoteRendering::SlaveListener.

Public Slots

Scripting access


void reset ()
 
void sendMouseEvent (const QString &type, int clientX, int clientY, int button, bool shiftKey, bool ctrlKey, bool altKey, qlonglong timeStamp)
 
void sendWheelEvent (double deltaX, double deltaY, int deltaMode, bool shiftKey, bool ctrlKey, bool altKey)
 
void sendKeyEvent (const QString &type, const QString &key, int location, bool shiftKey, bool ctrlKey, bool altKey, bool repeat)
 
void resize (int x, int y)
 
void startStreaming ()
 
void stopStreaming ()
 
void acknowledgeImageReceived ()
 

Signals

Signals


void cursorChanged (const QByteArray &cursorStyle)
 
void imageReceived (const QByteArray &imageDataURL, const QVariantMap &metaInformation)
 
void sizeHintsChanged ()
 

Detailed Description

QObject wrapper for a single RemoteRendering slave, to be registered with a WebEngineView control.

The first method to call on a slave is setRenderSize(), otherwise the remote side does not know the reference viewport for the events and the image rendering.

You will also not get image updates before startStreaming is called.

Member Function Documentation

◆ acknowledgeImageReceived

void MLRemoteRenderingWebChannelSlaveWrapper::acknowledgeImageReceived ( )
slot

acknowledge an image received through streaming

◆ cursorChanged

void MLRemoteRenderingWebChannelSlaveWrapper::cursorChanged ( const QByteArray & cursorStyle)
signal

Emitted when the cursor changed.

◆ imageReceived

void MLRemoteRenderingWebChannelSlaveWrapper::imageReceived ( const QByteArray & imageDataURL,
const QVariantMap & metaInformation )
signal

Emitted when an image was received.

◆ reset

void MLRemoteRenderingWebChannelSlaveWrapper::reset ( )
slot

Reset the stored state (e.g. after a reload)

◆ resize

void MLRemoteRenderingWebChannelSlaveWrapper::resize ( int x,
int y )
slot

set requested size of rendering/viewport

◆ sendKeyEvent

void MLRemoteRenderingWebChannelSlaveWrapper::sendKeyEvent ( const QString & type,
const QString & key,
int location,
bool shiftKey,
bool ctrlKey,
bool altKey,
bool repeat )
slot

send key event (to be called from JavaScript)

◆ sendMouseEvent

void MLRemoteRenderingWebChannelSlaveWrapper::sendMouseEvent ( const QString & type,
int clientX,
int clientY,
int button,
bool shiftKey,
bool ctrlKey,
bool altKey,
qlonglong timeStamp )
slot

send mouse event (to be called from JavaScript)

◆ sendWheelEvent

void MLRemoteRenderingWebChannelSlaveWrapper::sendWheelEvent ( double deltaX,
double deltaY,
int deltaMode,
bool shiftKey,
bool ctrlKey,
bool altKey )
slot

send wheel event (to be called from JavaScript)

◆ sizeHintsChanged

void MLRemoteRenderingWebChannelSlaveWrapper::sizeHintsChanged ( )
signal

Emitted when size hints have changed.

◆ startStreaming

void MLRemoteRenderingWebChannelSlaveWrapper::startStreaming ( )
slot

start the image update streaming

◆ stopStreaming

void MLRemoteRenderingWebChannelSlaveWrapper::stopStreaming ( )
slot

stop the image update streaming