init

2021-10-14 13:47:35 +02:00
commit 6625a8dfaa
4026 changed files with 844291 additions and 0 deletions
@@ -0,0 +1,58 @@
+/**
+ * \page BoxAlgorithm_KeypressEmulator Keypress Emulator
+__________________________________________________________________
+
+Detailed description
+__________________________________________________________________
+
+ * |OVP_DocBegin_BoxAlgorithm_KeypressEmulator_Description|
+Emulates a keyboard keypress when receiving a specific stimulation. In principle this box could be used to drive some 3rd party application that allows keyboard control but not any other communication from OpenViBE. Currently this box is implemented only on Windows.
+ * |OVP_DocEnd_BoxAlgorithm_KeypressEmulator_Description|
+__________________________________________________________________
+
+Inputs description
+__________________________________________________________________
+
+ * |OVP_DocBegin_BoxAlgorithm_KeypressEmulator_Inputs|
+ * |OVP_DocEnd_BoxAlgorithm_KeypressEmulator_Inputs|
+
+ * |OVP_DocBegin_BoxAlgorithm_KeypressEmulator_Input1|
+ Stimulation stream to listen to.
+ * |OVP_DocEnd_BoxAlgorithm_KeypressEmulator_Input1|
+
+__________________________________________________________________
+
+Settings description
+__________________________________________________________________
+
+ * |OVP_DocBegin_BoxAlgorithm_KeypressEmulator_Settings|
+ * |OVP_DocEnd_BoxAlgorithm_KeypressEmulator_Settings|
+
+ * |OVP_DocBegin_BoxAlgorithm_KeypressEmulator_Setting1|
+ The stimulation that will trigger the keypress.
+ * |OVP_DocEnd_BoxAlgorithm_KeypressEmulator_Setting1|
+
+ * |OVP_DocBegin_BoxAlgorithm_KeypressEmulator_Setting2|
+ The key to press.
+ * |OVP_DocEnd_BoxAlgorithm_KeypressEmulator_Setting2|
+ 
+ * |OVP_DocBegin_BoxAlgorithm_KeypressEmulator_Setting3|
+ The key modifier (alt, ctrl, ...)
+ * |OVP_DocEnd_BoxAlgorithm_KeypressEmulator_Setting3| 
+__________________________________________________________________
+
+Examples description
+__________________________________________________________________
+
+ * |OVP_DocBegin_BoxAlgorithm_KeypressEmulator_Examples|
+ An easy way to test the box is to make it receive stimulations from a Clock Stimulator box, and make a text editor active on the desktop after clicking Play. The characters corresponding to the key should appear in the editor.
+ * |OVP_DocEnd_BoxAlgorithm_KeypressEmulator_Examples|
+__________________________________________________________________
+
+Miscellaneous description
+__________________________________________________________________
+
+ * |OVP_DocBegin_BoxAlgorithm_KeypressEmulator_Miscellaneous|
+ The Keypress Emulator should be enhanced to be able to map an arbitrary number of different stimulations. This development would be relatively straightforward (e.g. look at VRPN boxes for example). Meanwhile if you need several keys pressed, you can use several Keypress Emulator boxes, each configured for a different stimulation+key.
+ * |OVP_DocEnd_BoxAlgorithm_KeypressEmulator_Miscellaneous|
+ */
@@ -0,0 +1,57 @@
+/**
+ * \page BoxAlgorithm_MessageSpy EBML stream spy
+__________________________________________________________________
+
+Detailed description
+__________________________________________________________________
+
+ * |OVP_DocBegin_BoxAlgorithm_MessageSpy_Description|
+ * The purpose of this box is to spy a message connection and
+ * decode its contents to the log manager. The box loops over
+ * the possible types and keys inside a message and prints
+ * the output.
+ *
+ * This box is mostly useful for debug purpose. It allows
+ * a developper to check what arrives to a box in a human
+ * readable way.
+ * |OVP_DocEnd_BoxAlgorithm_MessageSpy_Description|
+__________________________________________________________________
+
+Inputs description
+__________________________________________________________________
+
+ * |OVP_DocBegin_BoxAlgorithm_MessageSpy_Inputs|
+ * This box can receive as many message inputs as necessary. 
+ * |OVP_DocEnd_BoxAlgorithm_MessageSpy_Inputs|
+
+ * |OVP_DocBegin_BoxAlgorithm_MessageSpy_Input1|
+ * This is the default input of this box.
+ * |OVP_DocEnd_BoxAlgorithm_MessageSpy_Input1|
+__________________________________________________________________
+
+Settings description
+__________________________________________________________________
+
+ * |OVP_DocBegin_BoxAlgorithm_MessageSpy_Settings|
+ * |OVP_DocEnd_BoxAlgorithm_MessageSpy_Settings|
+
+ * |OVP_DocBegin_BoxAlgorithm_MessageSpy_Setting1|
+ * Indicates what log level will be used to
+ * print the message contents.
+ * |OVP_DocEnd_BoxAlgorithm_MessageSpy_Setting1|
+__________________________________________________________________
+
+Examples description
+__________________________________________________________________
+
+ * |OVP_DocBegin_BoxAlgorithm_MessageSpy_Examples|
+There is a simple example scenario provided in box-tutorials/ called messaging.xml.
+ * |OVP_DocEnd_BoxAlgorithm_MessageSpy_Examples|
+__________________________________________________________________
+
+Miscellaneous description
+__________________________________________________________________
+
+ * |OVP_DocBegin_BoxAlgorithm_MessageSpy_Miscellaneous|
+ * |OVP_DocEnd_BoxAlgorithm_MessageSpy_Miscellaneous|
+ */
@@ -0,0 +1,55 @@
+/**
+ * \page BoxAlgorithm_MouseTracking Mouse Tracking
+__________________________________________________________________
+
+Detailed description
+__________________________________________________________________
+
+ * |OVP_DocBegin_BoxAlgorithm_MouseTracking_Description|
+ Opens a gtk window and track mouse within that window.
+ * |OVP_DocEnd_BoxAlgorithm_MouseTracking_Description|
+__________________________________________________________________
+
+Outputs description
+__________________________________________________________________
+
+ * |OVP_DocBegin_BoxAlgorithm_MouseTracking_Outputs|
+ * |OVP_DocEnd_BoxAlgorithm_MouseTracking_Outputs|
+
+ * |OVP_DocBegin_BoxAlgorithm_MouseTracking_Output1|
+ Output the raw coordinates of mouse position.
+ * |OVP_DocEnd_BoxAlgorithm_MouseTracking_Output1|
+
+ * |OVP_DocBegin_BoxAlgorithm_MouseTracking_Output2|
+ Output relative coordinates to previous position of the mouse.
+ * |OVP_DocEnd_BoxAlgorithm_MouseTracking_Output2|
+__________________________________________________________________
+
+Settings description
+__________________________________________________________________
+
+ * |OVP_DocBegin_BoxAlgorithm_MouseTracking_Settings|
+ * |OVP_DocEnd_BoxAlgorithm_MouseTracking_Settings|
+
+ * |OVP_DocBegin_BoxAlgorithm_MouseTracking_Setting1|
+ Sampling frequency. 
+ * |OVP_DocEnd_BoxAlgorithm_MouseTracking_Setting1|
+
+ * |OVP_DocBegin_BoxAlgorithm_MouseTracking_Setting2|
+ Generated epoch sample count. Set the size of chunk. 1 in most cases : there is only one position at each time.
+ * |OVP_DocEnd_BoxAlgorithm_MouseTracking_Setting2|
+__________________________________________________________________
+
+Examples description
+__________________________________________________________________
+
+ * |OVP_DocBegin_BoxAlgorithm_MouseTracking_Examples|
+ * |OVP_DocEnd_BoxAlgorithm_MouseTracking_Examples|
+__________________________________________________________________
+
+Miscellaneous description
+__________________________________________________________________
+
+ * |OVP_DocBegin_BoxAlgorithm_MouseTracking_Miscellaneous|
+ * |OVP_DocEnd_BoxAlgorithm_MouseTracking_Miscellaneous|
+ */