VirtualCursorInterface_SetupInterface#

class myogestic.gui.widgets.visual_interfaces.virtual_cursor_interface.VirtualCursorInterface_SetupInterface(*args, **kwargs)[source]#

Setup interface for the Virtual Cursor Interface.

This class is responsible for setting up the Virtual Cursor Interface.

predicted_cursor__signal#

Signal that emits the predicted cursor data.

Type:

Signal

incoming_message_signal#

Signal that emits both an array and a string.

Type:

Signal

Parameters:

  • main_window (QMainWindow) – The main window of the application.

  • name (str) –

    The name of the interface. Default is “VirtualCursorInterface”.

    Important

    The name of the interface must be unique.

Methods

__init__(main_window[, name])

_get_cursor_py_executable()

Get the path to the Python main script for the cursor application.

_setup_timers()

Setup the timers for the Virtual Cursor Interface.

_update_status()

Update the status of the Virtual Cursor Interface.

clear_custom_signal_buffers()

Clear custom signal buffers for the Virtual Cursor Interface.

close_event(_)

Handle the close event of the Virtual Cursor Interface.

connect_custom_signals()

Connect custom signals for the Virtual Cursor Interface.

disconnect_custom_signals()

Disconnect custom signals for the Virtual Cursor Interface.

get_custom_save_data()

Get custom save data for the Virtual Cursor Interface.

initialize_ui_logic()

Initialize the UI logic for the Virtual Cursor Interface.

interface_was_killed()

Handle the case when the Virtual Cursor Interface was killed or finished.

online_predicted_cursor_update(data)

Update the predicted cursor data for the online protocol.

read_message()

Read a message from the Virtual Cursor Interface.

read_predicted_cursor()

Read the predicted cursor data from the Virtual Cursor Interface.

start_interface()

Start the Virtual Cursor Interface.

stop_interface()

Stop the Virtual Cursor Interface.

toggle_streaming()

Toggle the streaming of the Virtual Cursor Interface.

toggle_virtual_cursor_interface()

Toggle the Virtual Cursor Interface.

write_message(message)

Write a message to the Virtual Cursor Interface.

write_status_message()

Write a status message to the Virtual Cursor Interface.
incoming_message_signal#

alias of ndarray

predicted_cursor__signal#

alias of ndarray

clear_custom_signal_buffers()[source]#

Clear custom signal buffers for the Virtual Cursor Interface.

Return type:

None

close_event(_)[source]#

Handle the close event of the Virtual Cursor Interface.

Parameters:

_ (PySide6.QtGui.QCloseEvent)

Return type:

None

connect_custom_signals()[source]#

Connect custom signals for the Virtual Cursor Interface.

Return type:

None

disconnect_custom_signals()[source]#

Disconnect custom signals for the Virtual Cursor Interface.

Return type:

None

get_custom_save_data()[source]#

Get custom save data for the Virtual Cursor Interface.

Return type:

dict

initialize_ui_logic()[source]#

Initialize the UI logic for the Virtual Cursor Interface.

interface_was_killed()[source]#

Handle the case when the Virtual Cursor Interface was killed or finished.

Return type:

None

online_predicted_cursor_update(data)[source]#

Update the predicted cursor data for the online protocol.

Parameters:

data (ndarray)

Return type:

None

read_message()[source]#

Read a message from the Virtual Cursor Interface.

Return type:

None

read_predicted_cursor()[source]#

Read the predicted cursor data from the Virtual Cursor Interface.

Return type:

None

start_interface()[source]#

Start the Virtual Cursor Interface.

stop_interface()[source]#

Stop the Virtual Cursor Interface.

toggle_streaming()[source]#

Toggle the streaming of the Virtual Cursor Interface.

Return type:

None

toggle_virtual_cursor_interface()[source]#

Toggle the Virtual Cursor Interface.

write_message(message)[source]#

Write a message to the Virtual Cursor Interface.

Parameters:

message (PySide6.QtCore.QByteArray)

Return type:

None

write_status_message()[source]#

Write a status message to the Virtual Cursor Interface.

Return type:

None