/docs/source/api/iohub/device/mouse.rst

https://gitlab.com/braintech/psychopy-brain · ReStructuredText · 348 lines · 209 code · 139 blank · 0 comment · 0 complexity · 3213274a4dc3e58ff03e3edd1bcc4d1a MD5 · raw file 

    

  1. .. _iohub_mouse:
    2. 

  2. 

  3. ########################
    4. 

  4. The ioHub Mouse Device
    5. 

  5. ########################
    6. 

  6. 

  7. **Platforms:** Windows, macOS, Linux
    8. 

  8. 

  9. .. autoclass:: psychopy.iohub.devices.mouse.Mouse
    10. 

  10.     :members: getPosition, setPosition, getEvents, clearEvents, getPositionAndDelta, getScroll, setScroll
    11. 

  11.     :member-order: bysource
    12. 

  12. 

  13. Mouse Event Types
    14. 

  14. #####################
    15. 

  15. 

  16. The Mouse device supports the following event types. Device events returned by 
    17. 

  17. getEvents() are automatically converted to either namedtuple or dictionary 
    18. 

  18. objects with the same attributes / keys as the associated event class 
    19. 

  19. attributes.
    20. 

  20. 

  21. .. autoclass:: psychopy.iohub.devices.mouse.MouseMoveEvent(object)
    22. 

  22. 

  23.     .. attribute:: time
    24. 

  24. 

  25.         time of event, in sec.msec format, using psychopy timebase.
    26. 

  26.         
    27. 

  27.     .. attribute:: x_position
    28. 

  28. 

  29.         x position of the Mouse when the event occurred; in display 
    30. 

  30.         coordinate space.
    31. 

  31. 

  32.     .. attribute:: y_position
    33. 

  33. 

  34.         y position of the Mouse when the event occurred; in display 
    35. 

  35.         coordinate space.
    36. 

  36. 

  37.     .. attribute:: scroll_x
    38. 

  38. 

  39.         Horizontal scroll wheel absolute position when the event occurred.
    40. 

  40.         macOS only. Always 0 on other OS's.
    41. 

    42. 

  42.     .. attribute:: scroll_y
    43. 

  43. 

  44.         Vertical scroll wheel absolute position when the event occurred.
    45. 

  45. 

  46.     .. attribute:: modifiers
    47. 

  47. 

  48.         List of the modifiers that were active when the mouse event occurred,
    49. 

  49.         provided as a list of the modifier constant labels.
    50. 

  50. 

  51.     .. attribute:: display_id
    52. 

  52. 

  53.         The id of the display that the mouse was over when the event occurred.
    54. 

  54.         Only supported on Windows at this time. Always 0 on other OS's.
    55. 

    56. 

  56.     .. attribute:: window_id
    57. 

  57. 

  58.         Window handle reference that the mouse was over when the event occurred
    59. 

  59.         (window does not need to have focus).
    60. 

  60. 

  61.     .. attribute:: event_id
    62. 

  62. 

  63.         The id assigned to the device event. Every event generated by iohub
    64. 

  64.         during an experiment session is assigned a unique id, starting from 0.
    65. 

  65. 

  66.     .. attribute:: type
    67. 

  67. 

  68.         The type id for the event. This is used to create DeviceEvent objects
    69. 

  69.         or dictionary representations of an event based on the data from an
    70. 

  70.         event list.
    71. 

  71.     
    72. 

  72. .. autoclass:: psychopy.iohub.devices.mouse.MouseDragEvent(object)
    73. 

  73. 

  74.     .. attribute:: time
    75. 

  75. 

  76.         x position of the Mouse when the event occurred; in display 
    77. 

  77.         coordinate space.
    78. 

  78.         
    79. 

  79.     .. attribute:: x_position
    80. 

  80. 

  81.         x position of the Mouse when the event occurred; in display 
    82. 

  82.         coordinate space.
    83. 

  83. 

  84.     .. attribute:: button_state
    85. 

  85. 

  86.         1 if a mouse button press caused the event, 0 if button was released.
    87. 

  87.         
    88. 

  88.     .. attribute:: button_id
    89. 

  89. 

  90.         Index of the mouse button that caused the event. 
    91. 

  91.         MouseConstants.MOUSE_BUTTON_LEFT, MouseConstants.MOUSE_BUTTON_RIGHT
    92. 

  92.         and MouseConstants.MOUSE_BUTTON_MIDDLE are int constants
    93. 

  93.         representing left, right, and middle buttons of the mouse.
    94. 

  94. 

  95.     .. attribute:: pressed_buttons
    96. 

  96. 

  97.         All currently pressed button id's logically OR'ed together.
    98. 

  98.         
    99. 

  99.     .. attribute:: y_position
    100. 

  100. 

  101.         y position of the Mouse when the event occurred; in display 
    102. 

  102.         coordinate space.
    103. 

  103. 

  104.     .. attribute:: scroll_x
    105. 

  105. 

  106.         Horizontal scroll wheel absolute position when the event occurred.
    107. 

  107.         macOS only. Always 0 on other OS's.
    108. 

    109. 

  109.     .. attribute:: scroll_y
    110. 

  110. 

  111.         Vertical scroll wheel absolute position when the event occurred.
    112. 

  112. 

  113.     .. attribute:: modifiers
    114. 

  114. 

  115.         List of the modifiers that were active when the mouse event occurred,
    116. 

  116.         provided as a list of the modifier constant labels.
    117. 

  117. 

  118.     .. attribute:: display_id
    119. 

  119. 

  120.         The id of the display that the mouse was over when the event occurred.
    121. 

  121.         Only supported on Windows at this time. Always 0 on other OS's.
    122. 

    123. 

  123.     .. attribute:: window_id
    124. 

  124. 

  125.         Window handle reference that the mouse was over when the event occurred
    126. 

  126.         (window does not need to have focus).
    127. 

  127. 

  128.     .. attribute:: event_id
    129. 

  129. 

  130.         The id assigned to the device event. Every event generated by iohub
    131. 

  131.         during an experiment session is assigned a unique id, starting from 0.
    132. 

  132. 

  133.     .. attribute:: type
    134. 

  134. 

  135.         The type id for the event. This is used to create DeviceEvent objects
    136. 

  136.         or dictionary representations of an event based on the data from an
    137. 

  137.         event list.
    138. 

  138.         
    139. 

  139. .. autoclass:: psychopy.iohub.devices.mouse.MouseButtonPressEvent(object)
    140. 

  140. 

  141.     .. attribute:: time
    142. 

  142. 

  143.         x position of the Mouse when the event occurred; in display 
    144. 

  144.         coordinate space.
    145. 

  145.         
    146. 

  146.     .. attribute:: x_position
    147. 

  147. 

  148.         x position of the Mouse when the event occurred; in display 
    149. 

  149.         coordinate space.
    150. 

  150. 

  151.     .. attribute:: button_state
    152. 

  152. 

  153.         1 if a mouse button press caused the event, 0 if button was released.
    154. 

  154.         
    155. 

  155.     .. attribute:: button_id
    156. 

  156. 

  157.         Index of the mouse button that caused the event. 
    158. 

  158.         MouseConstants.MOUSE_BUTTON_LEFT, MouseConstants.MOUSE_BUTTON_RIGHT
    159. 

  159.         and MouseConstants.MOUSE_BUTTON_MIDDLE are int constants
    160. 

  160.         representing left, right, and middle buttons of the mouse.
    161. 

  161. 

  162.     .. attribute:: pressed_buttons
    163. 

  163. 

  164.         All currently pressed button id's logically OR'ed together.
    165. 

  165.         
    166. 

  166.     .. attribute:: y_position
    167. 

  167. 

  168.         y position of the Mouse when the event occurred; in display 
    169. 

  169.         coordinate space.
    170. 

  170. 

  171.     .. attribute:: scroll_x
    172. 

  172. 

  173.         Horizontal scroll wheel absolute position when the event occurred.
    174. 

  174.         macOS only. Always 0 on other OS's.
    175. 

    176. 

  176.     .. attribute:: scroll_y
    177. 

  177. 

  178.         Vertical scroll wheel absolute position when the event occurred.
    179. 

  179. 

  180.     .. attribute:: modifiers
    181. 

  181. 

  182.         List of the modifiers that were active when the mouse event occurred,
    183. 

  183.         provided as a list of the modifier constant labels.
    184. 

  184. 

  185.     .. attribute:: display_id
    186. 

  186. 

  187.         The id of the display that the mouse was over when the event occurred.
    188. 

  188.         Only supported on Windows at this time. Always 0 on other OS's.
    189. 

    190. 

  190.     .. attribute:: window_id
    191. 

  191. 

  192.         Window handle reference that the mouse was over when the event occurred
    193. 

  193.         (window does not need to have focus).
    194. 

  194. 

  195.     .. attribute:: event_id
    196. 

  196. 

  197.         The id assigned to the device event. Every event generated by iohub
    198. 

  198.         during an experiment session is assigned a unique id, starting from 0.
    199. 

  199. 

  200.     .. attribute:: type
    201. 

  201. 

  202.         The type id for the event. This is used to create DeviceEvent objects
    203. 

  203.         or dictionary representations of an event based on the data from an
    204. 

  204.         event list.
    205. 

  205.         
    206. 

  206. .. autoclass:: psychopy.iohub.devices.mouse.MouseButtonReleaseEvent(object)
    207. 

  207. 

  208.     .. attribute:: time
    209. 

  209. 

  210.         x position of the Mouse when the event occurred; in display 
    211. 

  211.         coordinate space.
    212. 

  212.         
    213. 

  213.     .. attribute:: x_position
    214. 

  214. 

  215.         x position of the Mouse when the event occurred; in display 
    216. 

  216.         coordinate space.
    217. 

  217. 

  218.     .. attribute:: button_state
    219. 

  219. 

  220.         1 if a mouse button press caused the event, 0 if button was released.
    221. 

  221.         
    222. 

  222.     .. attribute:: button_id
    223. 

  223. 

  224.         Index of the mouse button that caused the event. 
    225. 

  225.         MouseConstants.MOUSE_BUTTON_LEFT, MouseConstants.MOUSE_BUTTON_RIGHT
    226. 

  226.         and MouseConstants.MOUSE_BUTTON_MIDDLE are int constants
    227. 

  227.         representing left, right, and middle buttons of the mouse.
    228. 

  228. 

  229.     .. attribute:: pressed_buttons
    230. 

  230. 

  231.         All currently pressed button id's logically OR'ed together.
    232. 

  232.         
    233. 

  233.     .. attribute:: y_position
    234. 

  234. 

  235.         y position of the Mouse when the event occurred; in display 
    236. 

  236.         coordinate space.
    237. 

  237. 

  238.     .. attribute:: scroll_x
    239. 

  239. 

  240.         Horizontal scroll wheel absolute position when the event occurred.
    241. 

  241.         macOS only. Always 0 on other OS's.
    242. 

    243. 

  243.     .. attribute:: scroll_y
    244. 

  244. 

  245.         Vertical scroll wheel absolute position when the event occurred.
    246. 

  246. 

  247.     .. attribute:: modifiers
    248. 

  248. 

  249.         List of the modifiers that were active when the mouse event occurred,
    250. 

  250.         provided as a list of the modifier constant labels.
    251. 

  251. 

  252.     .. attribute:: display_id
    253. 

  253. 

  254.         The id of the display that the mouse was over when the event occurred.
    255. 

  255.         Only supported on Windows at this time. Always 0 on other OS's.
    256. 

    257. 

  257.     .. attribute:: window_id
    258. 

  258. 

  259.         Window handle reference that the mouse was over when the event occurred
    260. 

  260.         (window does not need to have focus).
    261. 

  261. 

  262.     .. attribute:: event_id
    263. 

  263. 

  264.         The id assigned to the device event. Every event generated by iohub
    265. 

  265.         during an experiment session is assigned a unique id, starting from 0.
    266. 

  266. 

  267.     .. attribute:: type
    268. 

  268. 

  269.         The type id for the event. This is used to create DeviceEvent objects
    270. 

  270.         or dictionary representations of an event based on the data from an
    271. 

  271.         event list.
    272. 

  272.         
    273. 

  273. .. autoclass:: psychopy.iohub.devices.mouse.MouseScrollEvent(object)
    274. 

  274. 

  275.     .. attribute:: time
    276. 

  276. 

  277.         x position of the Mouse when the event occurred; in display 
    278. 

  278.         coordinate space.
    279. 

  279.         
    280. 

  280.     .. attribute:: x_position
    281. 

  281. 

  282.         x position of the Mouse when the event occurred; in display 
    283. 

  283.         coordinate space.
    284. 

  284. 

  285.     .. attribute:: button_state
    286. 

  286. 

  287.         1 if a mouse button press caused the event, 0 if button was released.
    288. 

  288.         
    289. 

  289.     .. attribute:: button_id
    290. 

  290. 

  291.         Index of the mouse button that caused the event. 
    292. 

  292.         MouseConstants.MOUSE_BUTTON_LEFT, MouseConstants.MOUSE_BUTTON_RIGHT
    293. 

  293.         and MouseConstants.MOUSE_BUTTON_MIDDLE are int constants
    294. 

  294.         representing left, right, and middle buttons of the mouse.
    295. 

  295. 

  296.     .. attribute:: pressed_buttons
    297. 

  297. 

  298.         All currently pressed button id's logically OR'ed together.
    299. 

  299.         
    300. 

  300.     .. attribute:: y_position
    301. 

  301. 

  302.         y position of the Mouse when the event occurred; in display 
    303. 

  303.         coordinate space.
    304. 

  304. 

  305.     .. attribute:: scroll_x
    306. 

  306. 

  307.         Horizontal scroll wheel absolute position when the event occurred.
    308. 

  308.         macOS only. Always 0 on other OS's.
    309. 

    310. 

  310.     .. attribute:: scroll_dx
    311. 

  311. 

  312.         Horizontal scroll wheel position change when the event occurred.
    313. 

  313.         macOS only. Always 0 on other OS's.
    314. 

    315. 

  315.     .. attribute:: scroll_y
    316. 

  316. 

  317.         Vertical scroll wheel absolute position when the event occurred.
    318. 

  318. 

  319.     .. attribute:: scroll_dy
    320. 

  320. 

  321.         Vertical scroll wheel position change when the event occurred.
    322. 

  322. 

  323.     .. attribute:: modifiers
    324. 

  324. 

  325.         List of the modifiers that were active when the mouse event occurred,
    326. 

  326.         provided as a list of the modifier constant labels.
    327. 

  327. 

  328.     .. attribute:: display_id
    329. 

  329. 

  330.         The id of the display that the mouse was over when the event occurred.
    331. 

  331.         Only supported on Windows at this time. Always 0 on other OS's.
    332. 

    333. 

  333.     .. attribute:: window_id
    334. 

  334. 

  335.         Window handle reference that the mouse was over when the event occurred
    336. 

  336.         (window does not need to have focus).
    337. 

  337. 

  338.     .. attribute:: event_id
    339. 

  339. 

  340.         The id assigned to the device event. Every event generated by iohub
    341. 

  341.         during an experiment session is assigned a unique id, starting from 0.
    342. 

  342. 

  343.     .. attribute:: type
    344. 

  344. 

  345.         The type id for the event. This is used to create DeviceEvent objects
    346. 

  346.         or dictionary representations of an event based on the data from an
    347. 

  347.         event list.
    348.