Mouse click demo

This example demonstrates the different mouse click functionality in the ExperimentController class.

exp_name: MouseDemo
date: 2024-12-16 22_24_27.030601
file: /home/circleci/project/examples/experiments/mouse.py
participant: foo
session: 001
2024-12-16 22:24:27,030 - INFO    - Expyfun: Using version 2.0.0.dev0 (requested dev)
2024-12-16 22:24:27,031 - INFO    - Expyfun: Setting up sound card using pyglet backend with 2 playback channels
2024-12-16 22:24:27,261 - WARNING - Expyfun: Mismatch between reported stim sample rate (24414) and device sample rate (44100.0). Experiment Controller will resample for you, but this takes a non-trivial amount of processing time and may compromise your experimental timing and/or cause artifacts.
2024-12-16 22:24:27,261 - INFO    - Expyfun: Setting up screen
2024-12-16 22:24:27,292 - EXP     - Expyfun: Set screen visibility True
2024-12-16 22:24:27,302 - INFO    - Initialized [640 480] window on screen XlibScreen(display=<pyglet.canvas.xlib.XlibDisplay object at 0x7440b856db40>, x=0, y=0, width=1400, height=900, xinerama=0) with DPI 69.73
2024-12-16 22:24:27,303 - INFO    - Expyfun: Initializing dummy triggering mode
2024-12-16 22:24:27,304 - INFO    - Expyfun: Initialization complete
2024-12-16 22:24:27,305 - EXP     - Expyfun: Participant: foo
2024-12-16 22:24:27,305 - EXP     - Expyfun: Session: 001
2024-12-16 22:24:28,920 - INFO    - Expyfun: Exiting
2024-12-16 22:24:28,925 - EXP     - Expyfun: Audio stopped and reset.

# Author: Ross Maddox <rkmaddox@uw.edu>
#
# License: BSD (3-clause)

import expyfun.analyze as ea
from expyfun import ExperimentController, building_doc
from expyfun.visual import Circle, ConcentricCircles, Diamond, FixationDot, Rectangle

print(__doc__)


wait_dur = 3.0 if not building_doc else 0.0
msg_dur = 1.5 if not building_doc else 0.0
max_wait = float("inf") if not building_doc else 0.0

with ExperimentController(
    "MouseDemo",
    screen_num=0,
    window_size=[640, 480],
    full_screen=False,
    stim_db=0,
    noise_db=0,
    output_dir=None,
    participant="foo",
    session="001",
    version="dev",
) as ec:
    #################################
    # toggle_cursor and move_mouse_to
    ec.toggle_cursor(True)
    ec.move_mouse_to((0, 0))
    ec.screen_prompt(
        "Now you see it (centered on the window).", max_wait=msg_dur, wrap=False
    )

    ec.toggle_cursor(False)
    ec.screen_prompt(
        "Now you don't (maybe--Windows is buggy)", max_wait=msg_dur, wrap=False
    )
    ec.toggle_cursor(True)

    ################
    # wait_one_click
    ec.screen_text("Press any mouse button.", wrap=False)
    ec.flip()
    ec.wait_one_click(max_wait=max_wait)

    ec.toggle_cursor(False)
    ec.screen_text("Press the left button.", wrap=False)
    ec.flip()
    ec.wait_one_click(live_buttons=["left"], visible=True, max_wait=max_wait)
    ec.wait_secs(0.5)
    ec.toggle_cursor(True)

    ###########################
    # listen_clicks, get_clicks
    ec.screen_text("Press a few buttons in a row.", wrap=False)
    ec.flip()
    ec.listen_clicks()
    ec.wait_secs(wait_dur)
    clicks = ec.get_clicks()
    ec.screen_prompt("Your clicks:\n%s" % str(clicks), max_wait=msg_dur)

    ####################
    # get_mouse_position
    ec.screen_prompt("Move the mouse around...", max_wait=msg_dur, wrap=False)
    stop_time = ec.current_time + wait_dur
    while ec.current_time < stop_time:
        ec.screen_text(
            "%i, %i" % tuple([p for p in ec.get_mouse_position()]), wrap=False
        )
        ec.check_force_quit()
        ec.flip()

    ###################
    # wait_for_click_on
    ec.toggle_cursor(False)
    ec.wait_secs(1)
    c = Circle(ec, 150, units="pix")
    r = Rectangle(ec, (0.5, 0.5, 0.2, 0.2), units="norm", fill_color="r")
    cc = ConcentricCircles(
        ec, pos=[0.6, -0.4], colors=[[0.2, 0.2, 0.2], [0.6, 0.6, 0.6]]
    )
    d = Diamond(ec, (-0.5, 0.5, 0.4, 0.25), fill_color="b")
    dot = FixationDot(ec)
    objects = [c, r, cc, d, dot]

    ec.screen_prompt("Click on some objects...", max_wait=msg_dur, wrap=False)
    for ti in range(3):
        for o in objects:
            o.draw()
        screenshot = ec.screenshot()
        ec.flip()
        click, ind = ec.wait_for_click_on(objects, max_wait=max_wait)
        if ind is not None:
            objects[ind].draw()
            ec.flip()
            ec.wait_secs(0.2)

ea.plot_screen(screenshot)