sweetbean.extension.TouchButton

TouchButton

A class to create touch buttons as input instead of key presses (https://github.com/jspsych/jspsych-contrib/tree/main/packages/extension-touchscreen-buttons)

Source code in sweetbean/extension/TouchButton.py

class TouchButton:
    """
    A class to create touch buttons as input instead of key presses
    (https://github.com/jspsych/jspsych-contrib/tree/main/packages/extension-touchscreen-buttons)
    """

    def __init__(self, key, layout):
        """
        Arguments:
            key: the key that is emulated by the touch button
            layout: the layout of the touch button
        """
        self.key = key
        self.layout = layout

    def to_js(self):
        return f'"{self.key}"'

    def __eq__(self, other):
        return self.key == other.key

    def __hash__(self):
        return hash(self.key)

    @classmethod
    def left(cls, color=None):
        """
        Convenience Function to create a touch button on the left side of the screen
        """
        if color is None:
            color = "#fff"
        return cls(key="l", layout={"key": "l", "color": color, "preset": "left"})

    @classmethod
    def right(cls, color=None):
        """
        Convenience Function to create a touch button on the right side of the screen
        """
        if color is None:
            color = "#fff"
        return cls(key="r", layout={"key": "r", "color": color, "preset": "right"})

    @classmethod
    def bottom_left(cls, color=None):
        """
        Convenience Function to create a touch button on the bottom left side of the screen
        """
        if color is None:
            color = "#fff"
        return cls(
            key="l", layout={"key": "l", "color": color, "preset": "bottom_left"}
        )

    @classmethod
    def bottom_right(cls, color=None):
        """
        Convenience Function to create a touch button on the bottom right side of the screen
        """
        if color is None:
            color = "#fff"
        return cls(
            key="r", layout={"key": "r", "color": color, "preset": "bottom_right"}
        )

    @classmethod
    def top_left(cls, color=None):
        """
        Convenience Function to create a touch button on the top left side of the screen
        """
        if color is None:
            color = "#fff"
        return cls(key="l", layout={"key": "l", "color": color, "preset": "top_left"})

    @classmethod
    def top_right(cls, color=None):
        """
        Convenience Function to create a touch button on the top right side of the screen
        """
        if color is None:
            color = "#fff"
        return cls(key="r", layout={"key": "r", "color": color, "preset": "top_right"})

__init__(key, layout)

Parameters:

Name	Type	Description	Default
key		the key that is emulated by the touch button	required
layout		the layout of the touch button	required

Source code in sweetbean/extension/TouchButton.py

def __init__(self, key, layout):
    """
    Arguments:
        key: the key that is emulated by the touch button
        layout: the layout of the touch button
    """
    self.key = key
    self.layout = layout

bottom_left(color=None) classmethod

Convenience Function to create a touch button on the bottom left side of the screen

Source code in sweetbean/extension/TouchButton.py

@classmethod
def bottom_left(cls, color=None):
    """
    Convenience Function to create a touch button on the bottom left side of the screen
    """
    if color is None:
        color = "#fff"
    return cls(
        key="l", layout={"key": "l", "color": color, "preset": "bottom_left"}
    )

bottom_right(color=None) classmethod

Convenience Function to create a touch button on the bottom right side of the screen

Source code in sweetbean/extension/TouchButton.py

@classmethod
def bottom_right(cls, color=None):
    """
    Convenience Function to create a touch button on the bottom right side of the screen
    """
    if color is None:
        color = "#fff"
    return cls(
        key="r", layout={"key": "r", "color": color, "preset": "bottom_right"}
    )

left(color=None) classmethod

Convenience Function to create a touch button on the left side of the screen

Source code in sweetbean/extension/TouchButton.py

@classmethod
def left(cls, color=None):
    """
    Convenience Function to create a touch button on the left side of the screen
    """
    if color is None:
        color = "#fff"
    return cls(key="l", layout={"key": "l", "color": color, "preset": "left"})

right(color=None) classmethod

Convenience Function to create a touch button on the right side of the screen

Source code in sweetbean/extension/TouchButton.py

@classmethod
def right(cls, color=None):
    """
    Convenience Function to create a touch button on the right side of the screen
    """
    if color is None:
        color = "#fff"
    return cls(key="r", layout={"key": "r", "color": color, "preset": "right"})

top_left(color=None) classmethod

Convenience Function to create a touch button on the top left side of the screen

Source code in sweetbean/extension/TouchButton.py

@classmethod
def top_left(cls, color=None):
    """
    Convenience Function to create a touch button on the top left side of the screen
    """
    if color is None:
        color = "#fff"
    return cls(key="l", layout={"key": "l", "color": color, "preset": "top_left"})

top_right(color=None) classmethod

Convenience Function to create a touch button on the top right side of the screen

Source code in sweetbean/extension/TouchButton.py

@classmethod
def top_right(cls, color=None):
    """
    Convenience Function to create a touch button on the top right side of the screen
    """
    if color is None:
        color = "#fff"
    return cls(key="r", layout={"key": "r", "color": color, "preset": "top_right"})